Platform Framework
R24 AMR | Min(s) read

TAFJ Management Bean Component Configuration

This section provides details about the TAFJManagementBean EJB configured in TAFJJEE_EAR.ear\TAFJJEE_EJB.jar META-INF\ejb-jar.xml within the <enterprise-beans> section.

<session>
        <ejb-name>TafjManagementBean</ejb-name>
        <env-entry>
                <description>Flag whether batch session should be logged off on container destroy - default is true since they can be long running process and prevent container to stop</description>
                <env-entry-name>logoffBatchSessionOnDestroy</env-entry-name>
                <env-entry-type>java.lang.Boolean</env-entry-type>
                <env-entry-value>true</env-entry-value>
        </env-entry>
        <env-entry>
                <description>Flag whether on line session should be logged off on container destroy - default is false to let them a chance to complete bafore container destroy</description>
                <env-entry-name>logoffOnLineSessionOnDestroy</env-entry-name>
                <env-entry-type>java.lang.Boolean</env-entry-type>
                <env-entry-value>false</env-entry-value>
        </env-entry>
        <env-entry>
                <description>Flag whether a scheduler has to be registered to shutdown idle sessions -  default is true</description>
                <env-entry-name>shutdownIdleOnLineSession</env-entry-name>
                <env-entry-type>java.lang.Boolean</env-entry-type>
                <env-entry-value>true</env-entry-value>
        </env-entry>
        <env-entry>
                <description> Idle session detection threshold and periodic cleaner scheduling period in seconds - default is 1h - min value is 10min</description>
                <env-entry-name>idleOnLineSessionThreshold</env-entry-name>
                <env-entry-type>java.lang.Long</env-entry-type>
                <env-entry-value>3600</env-entry-value>
        </env-entry>
        <env-entry>
                <description>Flag whether a scheduler has to be register to publish registration information to T24 management topic -  default is false</description>
                <env-entry-name>serverRegistration</env-entry-name>
                <env-entry-type>java.lang.Boolean</env-entry-type>
                <env-entry-value>false</env-entry-value>
        </env-entry>
        <env-entry>
                <description>Server registration message frequency - default is 10s - min value is 1s</description>
                <env-entry-name>registrationFrequency</env-entry-name>
                <env-entry-type>java.lang.Long</env-entry-type>
                <env-entry-value>10</env-entry-value>
        </env-entry>
        <env-entry>
                <description>Server registration expiration - default is 12s - min value is registrationFrequency plus 20 percent or 2s</description>
                <env-entry-name>registrationExpiration</env-entry-name>
                <env-entry-type>java.lang.Long</env-entry-type>
                <env-entry-value>12</env-entry-value>
        </env-entry>
        <env-entry>
                <description>Run ejb warmup to create the specified number of session for the specified ejb at server startup - pattern is EjbName=size with semi-colon separator</description>
                <env-entry-name>ejbWarmup</env-entry-name>
                <env-entry-type>java.lang.String</env-entry-type>
                <env-entry-value>OFSProcessingBean=0;BROWSERProcessingBean=0</env-entry-value>
        </env-entry>
        <env-entry>
                <description>Wait for warmup completion before continuing startup process - warmup could be run asynchronously when set to false</description>
                <env-entry-name>synchronousWarmup</env-entry-name>
                <env-entry-type>java.lang.Boolean</env-entry-type>
                <env-entry-value>false</env-entry-value>
        </env-entry>
        <env-entry>
                <description>Timeout used when synchronousWarmup is set to true - maximum time to wait in seconds for warmup to complete before continuing startup process</description>
                <env-entry-name>warmupTimeout</env-entry-name>
                <env-entry-type>java.lang.Long</env-entry-type>
                <env-entry-value>60</env-entry-value>
        </env-entry>
        <env-entry>
                <description>EJB warmup actions are handled by a managed executor service when set to true - When true synchronous mode is not available</description>
                <env-entry-name>managedWarmup</env-entry-name>
                <env-entry-type>java.lang.Boolean</env-entry-type>
                <env-entry-value>false</env-entry-value>
        </env-entry>	
        <env-entry>
                <description>Delay before triggering the EJB warmup in managed mode to have all necessary resources ready - EJB warmup is triggered immediately when set to 0</description>
                <env-entry-name>warmupDelay</env-entry-name>
                <env-entry-type>java.lang.Integer</env-entry-type>
                <env-entry-value>0</env-entry-value>
        </env-entry>		
        <env-entry>
                <description>Wait for tSA messages to be effectively sent before continuing startup process - could be run asynchronously when set to false</description>
                <env-entry-name>synchronousTsaStartup</env-entry-name>
                <env-entry-type>java.lang.Boolean</env-entry-type>
                <env-entry-value>false</env-entry-value>
        </env-entry>
        <env-entry>
                <description>Timeout used when synchronousTsaStartup is set to true - maximum time to wait in seconds for tSA messages to be sent before continuing startup process</description>
                <env-entry-name>tsaStartupTimeout</env-entry-name>
                <env-entry-type>java.lang.Long</env-entry-type>
                <env-entry-value>20</env-entry-value>
        </env-entry>
        <env-entry>
                <description>tSA messages are sent by a managed executor service when set to true - When true synchronous mode is not available</description>
                <env-entry-name>managedTsaStartup</env-entry-name>
                <env-entry-type>java.lang.Boolean</env-entry-type>
                <env-entry-value>false</env-entry-value>
        </env-entry>		
        <env-entry>
                <description>Delay before sending the tSA message in managed mode to have all necessary resources ready - messages are sent immediately when set to 0</description>
                <env-entry-name>tsaStartupDelay</env-entry-name>
                <env-entry-type>java.lang.Integer</env-entry-type>
                <env-entry-value>0</env-entry-value>
        </env-entry>				
        <resource-ref>
                <description>Used to get connections from T24 jdbc pool</description>
                <res-ref-name>jdbc/t24DataSource</res-ref-name>
                <res-type>javax.sql.DataSource</res-type>
                <res-auth>Container</res-auth>
        </resource-ref>
</session>

The parameters in the code block are explained in the following table.

Parameter

Description

Default value

logoffBatchSessionOnDestroy

Indicates if a management bean triggers a logoff for all active batch sessions. The values are:

  • true = Management bean triggers a logoff for all active batch sessions.
  • false = Management bean does not trigger a logoff for all active batch sessions.

The batch sessions can be long running process and could prevent a container to stop until their completion, when this parameter is set to true.

It is a Boolean configuration parameter used on container stop.

true

logoffOnLineSessionOnDestroy

Indicates if a management bean triggers a logoff for all active online sessions. The values are:

  • true = Management bean triggers a logoff for all active online sessions.
  • false = Management bean does not trigger a logoff for all active online sessions.

The online sessions are short living process which needs to be completed before the container goes down, when this parameter is set to false.

It is a Boolean configuration parameter used on container stop.

false

shutdownIdleOnLineSession

Schedules a periodic idle online sessions detection when set to true.

The execution runs periodically according to the idleOnLineSessionThreshold parameter and triggers a logoff on online sessions which are idle for the same idleOnLineSessionThreshold period.

It is a Boolean parameter for configuration.

true

idleOnLineSessionThreshold

Indicates the time in seconds for both periodic cleaner scheduling and session idle detection threshold.

The minimum session time is 600 seconds. You need to avoid a very short idle detection since the cost of initialising a session is high and impacts the application response time.

A session will be shutdown as soon as the idle threshold is reached and the periodic cleaner execution is triggered, which indicates a session can be idle for almost two periodic cleaner execution cycles.

It is an integer parameter.

3600 seconds

serverRegistration

Schedules a periodic server registration when set to true.

The registration is a JMS message published to the t24ManagementTopic periodically according to the registrationFrequency parameter.

The JMS registration message is an object message containing a com.temenos.tafj.sb.T24Server object, representing the server identity and its current background sessions.

The server registration is not enabled by default, if this parameter is set to false.

It is a Boolean parameter for configuration.

false

registrationFrequency

Indicates the JMS notification frequency period in seconds. It cannot be more than one notification per second and the minimum value is one second

It is an integer parameter.

10 seconds

registrationExpiration

Indicates server registration validity period in seconds. If a new registration notification for a specific server is not received before the registration expiration threshold, the server entry is removed from the server registry.

It is an integer parameter.

12 seconds

This default value must be higher than the registration frequency (10 seconds) plus 20% of the registration frequency which is at least by 2

ejbWarmup

Defines a set of EJBs to be initialised at server startup. This parameter must follow the pattern “EJBName=size”;”EJBName=size”, in which EJBName is the targeted ejb name as seen in the ejb-jar.xml. For example, in case of GCS ofs source channel, the command is:

<ejb-name>OFSProcessingBean</ejb-name>

The size is an integer value indicating the number of sessions to be created for the channel.

The temn.tafj.appserver.ejb.warmup property can also be used to define the warmup pattern and takes precedence over the EJB property.

It is a string parameter.

OFSProcessingBean=0;BROWSERProcessingBean=0 –

This warmup pattern is an example and does not trigger any initialisation since the size is set to zero for both the EJBs defined.

synchronousWarmup

Indicates if the management bean waits for warmup completion before continuing the startup process. To avoid deadlock in case of warmup error, a timeout can be set through warmupTimeout property. The values are:

  • true = Management bean waits for warmup completion before continuing the startup process.
  • false = ejb warmup is asynchronous and does not block the application startup.

The warmup operation returns immediately when this parameter is set to false.

The synchronous mode might not be supported by all EE containers.

It is a Boolean parameter used along with ejbWarmup.

False

warmupTimeout

Indicates the maximum waiting time (in seconds) for warmup to complete before continuing the startup process, when synchronousWarmup is set to true. The warmup operation waits for maximum of 60 seconds before returning.

For example, if the warmup pattern for EJB1=1 and EJB2=10, the initialisation time for EJB1 and EJB2 are 5 seconds and 12 seconds, repectively. Since initialisation is triggered concurrently for all EJBs, warmupTimeout should be higher than the longest initialization duration which is 12 seconds in this example.

This parameter should be set accordingly with the highest session initialisation time. This parameter is not used when synchronousWarmup=false.

It is a long parameter used along with synchronousWarmup=true.

60 seconds

managedWarmup

Indicates if the warmup actions are triggered by a different thread other than the startup thread. The values are:

  • true = Warmup actions are triggered by a different thread other than the startup thread
  • false = Warmup actions are triggered by the startup thread.

The synchronous mode is not available when this parameter is set to true.

It is a Boolean parameter.

False

warmupDelay

Indicates if a delay is introduced between the startup and warmup invocation. Introducing a delay might be required by the platform to allow resources startup completion before EJB invocation.

Setting this parameter to zero indicates that there is no delay between startup and warmup actions trigger.

It is an integer parameter used along with managedWarmup=true.

0

synchronousTsaStartup

Indicates the number of tSAs. The number of tSAs defined through this property indicate the number of tSA messages sent to the phantom queue.

The tSA messages action returns immediately when this parameter is set to false.

The synchronous mode might not be supported by all EE containers. The tSA messages action is asysnchronous by default.

It is a Boolean parameter used along with the system property temn.tafj.appserver.start.tsa=x or tsaStart=x.

False

tsaStartupTimeout

Indicates the maximum waiting time (in seconds) to send tSA messages to the phantom queue before continuing the startup process. The tSA startup messaging will wait for a maximum of 20 seconds before returning.

This parameter is not used when synchronousTsaStartup =false.

It is a long parameter used along with synchronousTsaStartup =true.

20 seconds

managedTsaStartup

Indicates if the message actions are triggered by a different thread other than the startup thread. The values are:

  • true = Message actions are triggered by a different thread other than the startup thread
  • false = Message actions are triggered by the startup thread.

The synchronous mode is not available when this parameter is set to true.

It is a Boolean parameter.

False

tsaStartupDelay

Indicates if a delay is introduced between the startup and tSA message invocation. Introducing a delay might be required by the platform to allow resources startup completion before JMS invocation.

Setting this parameter to zero indicates that there is no delay between startup and tSA message actions trigger.

It is an integer parameter used along with managedTsaStartup =true.

0

Resources Reference Configuration

resource-ref\ res-ref-name

jdbc/t24DataSource

Configures the application server JDBC resource for Temenos Transact database.

resource-ref\ res-ref-name

jdbc/t24LockingDataSource

Configures the application server JDBC resource for Temenos Transact locking in database. This property needs to be mapped in the application server configuration file.

Copyright © 2020- Temenos Headquarters SA

Contact Us

knowledge@temenos.com

Published on :
Monday, May 27, 2024 5:10:12 PM IST