engine.properties properties

engine.properties is stored as a row in the CC_FILES database table. When IBM® Control Center event processors (EPs) start, EPs read engine.properties. Some of the system properties are used by IBM Control Center EPs and some are used by Java. 

You can access engine.properties in the IBM Control Center web console by clicking your user ID and then clicking System configuration > Properties > engine.properties.

Cognos properties

Table 1. Cognos properties
Property name Property description Property values

COGNOS_TEMP_REPORTS_
CLEANUP_INTERVAL

Specifies the number of days a Cognos Temporary report is retained before it is deleted. Valid values are 1 - 2,147,483,647. This value must contain an integer greater than or equal to 1. The default is 1 day. It is highly suggested to not change the default value of 1 day.
DB_BATCH_SIZE Specifies the number of records to use for batch insertion when temporary tables are created for use by Cognos Reports. Valid values are 1 - 2,147,483,647. This value must contain an integer greater than or equal to 1. The default is 1000 rows. Increasing the batch size above the default of 1000 rows might improve the speed of the report by one or two seconds. However, increasing the batch size could result in out of memory errors occurring.
JDBC_DRIVER_MAX_ROWS Specifies the maximum number of rows that are used for the Sterling File Gateway report. Valid values are 1 - 2,147,483,647. This value must contain an integer greater than or equal to 1. The default is 10000 rows. It is highly suggested to not change the default value of 10000 rows.
QS_INIT_JVM_HEAP_SIZE Specifies the initial JVM heap size for the query service in MB. Valid values are 1 - 2,147,483,647. The default is 4096.
QS_JVM_HEAP_SIZE_LIMIT JVM heap size limit for the query service in MB. Valid values are 1 - 2,147,483,647. The default is 4096.
RS_MAXIMUM_PROCESSES Specifies the maximum number of report service processes that can be started by a dispatcher during non-peak hours. Valid values are 1 - 2,147,483,647. This value must contain an integer greater than or equal to 1. The default value is 8.
RS_PEAK_AFFINE_CONNECTIONS Specifies the number of connections that a report service process can use to run high affinity requests during peak hours. This property limits the number of these requests that can be ran concurrently by a report service process. Valid values are 1 - 2,147,483,647. The default value is 2. This value must contain an integer greater than or equal to 1.
RS_PEAK_MAXIMUM_PROCESSES Specifies the maximum number of report service processes that can be started by a dispatcher during peak hours. Valid values are 1 - 2,147,483,647. The default value is 8. This value must contain an integer greater than or equal to 1.
RS_QUEUE_LIMIT Specifies the number of seconds that a request for the report service can be queued before it exceeds the timeout period. Valid values are 5 - 2,147,483,647. This value must contain an integer greater than or equal to 5. The default is 240 seconds.

WAIT_TIME_FOR_COGNOS_
TO_STOP

Specifies the number of seconds to wait for the Cognos Tomcat Server to shut down when the IBM Control Center engine is shutting down. Valid values are 1 - 2,147,483,647. This value must contain an integer greater than or equal to 1. The default is 10 seconds.

Logging properties

Table 2. Logging properties
Property name Property description Property values
LogEncoding Specifies whether to encode the logs that are found in the IBM Control Center log folder. To decode the logs, run logConverter.bat or logConverter.sh. Valid values are true | false. The default is false. If true, do the following encoding:
  • & to &
  • > to >
  • < to &It;
  • ' to &apos;
  • " to &quote;
logging Specifies whether the IBM Control Center engine produces logs or not. Valid values are true | false. The default is true. In this case, true means that the engine produces logs.

Security properties

Table 3. Security properties
Property name Property description Property values
com.ibm.jsse2.overrideDefaultProtocol Specifies the secure connection protocol used between the classic GUI and engine.

If the com.ibm.jsse2.overrideDefaultProtocol or the WEBSERVER_SECURE_PROTOCOLS property is set, the com.ibm.jsse2.sp800-131 property is automatically set to off.

When a secure connection is enabled for Cognos in configCC, you can perform one of the following tasks. Otherwise, the connection to Cognos fails:
  • Set the com.ibm.jsse2.overrideDefaultProtocol property to SSL_TLSv2 and WEBSERVER_SECURE_PROTOCOLS property to TLSv12
  • Set both the com.ibm.jsse2.overrideDefaultProtocol and WEBSERVER_SECURE_PROTOCOLS properties to TLS
  • Comment out both the com.ibm.jsse2.overrideDefaultProtocol and WEBSERVER_SECURE_PROTOCOLS properties
TLS | TLSv11 | TLSv12| SSL_TLSv2
com.ibm.jsse2.sp800-131 Specifies whether IBM Control Center runs in NIST mode or not. Valid values are transition | strict | off. The default is off.
https.cipherSuites Specifies the cipher suites that are enabled by IBM Control Center to use. Valid values are a list of comma-separated ciphers.
SEAS_CIPHER_SUITES Specifies the ciphers suites that are enabled for secure connections between the engine and SEAS. Valid values are a list of comma-separated ciphers
SEAS_PERSISTENT_CONNECTION You can confirm persistent or non-persistent connections are in effect by viewing the SeasService_yyyymmdd_hhmmssnnn.log. The first line will indicate this. For example:

dd Mon yyyy hh:mm:ss,nnn [main] - using non-persistent connections (SEAS_PERSISTENT_CONNECTION=false)

Valid values are true | false. The default is true. In this case, true means that there is a persistent connection to Sterling External Authentication Server. False means you must connector disconnect to or from Sterling External Authentication Server each time you sign on.
SEAS_SECURE_PROTOCOL Specifies secure connection protocol used between the engine and Sterling External Authentication Server (SEAS).
Important: If you do not specify this property, SEAS uses com.ibm.jsse2.overrideDefaultProtocol as the protocol for secure connections.
TLS | TLSv1.1 | TLSV1.2
WEBSERVER_SECURE_PROTOCOL Specifies secure connection protocol used between the browser and web console.

If the com.ibm.jsse2.overrideDefaultProtocol or the WEBSERVER_SECURE_PROTOCOLS property is set, the com.ibm.jsse2.sp800-131 property is automatically set to off.

When a secure connection is enabled for Cognos in configCC, you can perform one of the following tasks. Otherwise, the connection to Cognos fails:
  • Set the com.ibm.jsse2.overrideDefaultProtocol property to SSL_TLSv2 and WEBSERVER_SECURE_PROTOCOLS property to TLSv12
  • Set both the com.ibm.jsse2.overrideDefaultProtocol and WEBSERVER_SECURE_PROTOCOLS properties to TLS
  • Comment out both the com.ibm.jsse2.overrideDefaultProtocol and WEBSERVER_SECURE_PROTOCOLS properties
TLS | TLSv1.1 | TLSv1.2

Database properties

Table 4. Database properties
Property name Property description Property values
BULK_DB_PURGE Specifies whether the purges of database records are done in bulk or not. Valid values are true | false. The default is false.
EVENT_MONITOR_SELECT_EVENT_TIME_WARNING Represents the maximum duration (in milliseconds) that the event monitor is allowed to get events from the EVENTS table for processing. If the duration exceeds the value that is specified, event CCTR138I is generated. Valid values are integers from 1 to 2147483647. The default value is 2000.
INSERT_EVENT_DB_WARN_RETRY_COUNT Specifies the maximum acceptable attempts to insert the monitored server data into the IBM Control Center EVENTS database. When the actual attempts exceed the value that is specified, a warning message CCTR134I is triggered.
Attention: The system tries to limit the CCTR134I events to no more than one per hour. However, because no synchronization is done between or within event processors, you may see more than one event per hour.
Valid values are integers greater than 1. If the value specified is less than or equal to 1 or is not an integer, the default value 6 is applied.
INSERT_EVENT_DB_WARN_TIME Specifies the maximum acceptable amount of time (in milliseconds) that IBM Control Center can take to insert the monitored server data into the EVENTS database. When the actual amount of time exceeds the value that is specified, a warning message CCTR135I is triggered.
Attention: The system tries to limit the CCTR135I events to no more than one per hour. However, because no synchronization is done between or within event processors, you might see more than one event per hour.
Valid values are integers greater than 0. If the value specified is less than or equal to 0 or is not an integer, the default value 2000 is applied.
MAX_RESULTSET_ROWS Specifies the maximum Sterling File Gateway SQL result set for Oracle queries. Valid values are n | 0x7fffffffffffffffL. Defaults to the maximum long values.
Start of changeSUMMARY_TABLES_PURGE_BATCH_SIZEEnd of change Specifies the number of records that are deleted in each batch operation of the summary table purge. Valid values are integers greater than 0. The default value is 100.
Start of changeSUMMARY_TABLES_PURGE_ROLL_UPEnd of change Specifies whether to purge the ROLL_UP table during the summary table purge. The ROLL_UP table stores data that is used to populate the Recent File Transfer Activity on the Dashboard in the web console. Valid values are true | false. The default value is false. In this case, false means the ROLL_UP table is not to be purged.
UNPARTITION Specifies whether a partitioned production or staging IBM Control Center database unpartions during a configCC reinitialization set. Valid values are true | false. The default is false. In this case, false means that partitioned database reinitializes as partitioned.
UPDATE_EVENT_DB_WARN_TIME Specifies the amount of time, in milliseconds, it takes IBM Control Center to update the monitored server dasta in the EVENTS database. If the actual amount of time exceeds the value that is specified, then the warning message CCTR137I is triggered.
Attention: The system tries to limit the CCTR137I events to no more than one per hour. However, because no synchronization is done between or within event processors, you might see more than one event per hour.
Valid values are integers greater than 0, and the default value is 1000 in milliseconds.

Node service properties

Table 5. Node service properties
Property name Property description Property values
B2B_PREFERRED_TIME_TO_GET_DATA_MAX Specifies the maximum amount of time (in milliseconds) that the IBM Sterling B2B Integrator server takes to satisfy a request for data from IBM Control Center. Valid values are integers greater than 0. If the value specified is less than or equals to 0 or is not an integer, the default value 5000 is applied.
B2B_PREFERRED_TIME_TO_LOG_DATA_MAX Specifies the maximum amount of time (in milliseconds) that IBM Control Center takes to insert the IBM Sterling B2B Integrator server events that are created from data received from an IBM Sterling B2B Integrator server to the EVENTS table. Valid values are integers greater than 0. If the value specified is less than or equals to 0 or is not an integer, the default value 3000 is applied.
B2B_PREFERRED_TIME_TO_PROCESS_DATA_MAX

Specifies the maximum amount of time (in milliseconds) that IBM Control Center takes to construct event data to be inserted into the EVENTS table from the data that is received from an IBM Sterling B2B Integrator server.

The value that is specified here is used when the server's metrics are displayed in the server properties display.

Valid values are integers greater than 0. If the value specified is less than or equals to 0 or is not an integer, the default value 5000 is applied.
DONT_OVERRIDE_POLLRATE For a Windows node, the code does not allow the monitor rest time (polling rate) be less than 5 seconds. If this value set, this check is not done.  
SFG_IGNORE_KEYS Specifies which keys are removed from Sterling File Gateway custom protocols before being added to events. Valid values are key or a list of comme seperated values.
SI_INIT_CACHE If set, initialize cache for Sterling File Gateway route, arrived, and delivery records. Allocate maps used to cache information received from the server. The bigger the caches, the less database I/O that will be required to find information previously gotten.  
SI_METRICS Determines whether a database statistics thread starts to report Sterling B2B Integrator database statistics. Valid values are true | false.
SI_OPT Specifies whether the Sterling B2B Integrator optimization is used. If true, the Sterling File GatewayHistory handler does not attempt to go to the database to look for records that are not found in the memory. If false and the SI_INIT_CACHE is not set, then the Sterling File Gateway History handler does attempt to go to the database to look for records that are not found in the memory. Valid values are true | false. The default is false.
SI_SERVER_LICENSE Determines whether IBM Control Center issues a getLicense request to Sterling B2B Integrator during login, and information is present on the Sterling B2B Integrator server license tab in the GUI. Valid values are true | false. The default is true.
SOAP_SYNC_ONLY Determines whether Sterling B2B Integrator Node service logic only uses synchronous SOAP calls. Valid values are true | false. The default is false.

SLC and rule properties

Table 6. SLC and rule properties
Property name Property description Property values
COLD_START If the value is set to true, do not use any of the SLC recovery information because it is a cold start. Valid values are true | false. The default is false.

Other properties

Table 7. Other properties
Property name Property description Property values
<CC_RULE_IMPL>
com.sterlingcommerce.component.rule.util.RuleSessionMatchersImpl
</CC_RULE_IMPL>
This property can have an improved performance when you are evaluating rules and DVGs with your IBM Control Center event processors. This property is turned on be default. If you want to disable this property, you must change the tag to
<CC_RULE_IMPL>
com.sterlingcommerce.component.rule.util.RuleSessionImpl
</CC_RULE_IMPL>
and restart your IBM Control Center event processor.
IS_INITALIZE_EXISTING_PROCESSES If the value is set to true, the CC_Process table is going to be cleared and reinitialized when an event processor is restarted. This process can take time depending on the volume of your Events table. After the migration of processes is complete, the property is automatically set back to false. You must set it to true if you need to reinitialize the CC_Process table again. Valid values are true | false. The default is false.
IS_INITIALIZE_EXISTING_ALERTS If the value is set to true, the CC_Alert table is going to be cleared and reinitialized when an event processor is restarted. This process can take time depending on the volume of your Events table. After the migration of processes is complete, the property is automatically set back to false. You must set it to true if you need to reinitialize the CC_Alert table again. Valid values are true | false. The default is false.
PROCESS_SUMMARY_THREADS The number of running process summary threads. If you increase the number from the default, then you might have to add more CPU to handle the process summary speed. Valid values are integers between 0 and 60. The default is 4.
PROCESS_SUMMARY_UPGRADE_DAYS The number of previous days that are going to be migrated.. If you set a lower value, then a decrease in the total number of processes that are migrated and the time it takes to migrate the processes occurs. Valid values are 0 | -1. The default is -1. If you set the value to -1, then all of the process are migrating to the Events table. If you set the value to 0, then no processes are migrated to the Events table.
TIME_TO_START_EPS_MINUTES When a controller event processor (controller EP) starts, the time period (in minutes) that it waits before reassigning the servers from EPs that were down when the controller EP started. Valid values are integers from 0 to 2147483647. The default value is 0. If the value is set to 0, the controller EP never reassigns the servers of an EP that was down when the controller EP started.
WLP_PW_ENCODER_SPECIAL_CHARACTERS
Specifies a comma delimited list of special characters to be escaped when you encode the database connection password that is used by the web server (WebSphere® Application Server) for database user authentication.
Important: When this property is specified in the engine.properties file in XML format, the special characters must be enclosed in <![CDATA[]]> with syntax <![CDATA[comma,delimited,special,character,list,here]]>.
With the CDATA control sequence, the XML parser processes the enclosed characters as text data only.

The following example illustrates the exact syntax of this property using the predefined default special character list:

<WLP_PW_ENCODER_SPECIAL_CHARACTERS><![CDATA[\,^,&,*,@,[,],{,},:,=,!,‑,(,),%,+,?,',~,|,$,.,#,_,<,>,COMMA]]></WLP_PW_ENCODER_SPECIAL_CHARACTERS>

Specify a list of character values that you want to be treated as special characters.
The following list shows the default special characters: \,^,&,*,@,[,],{,},:,=,!,‑,(,),%,+,?,',~,|,$,.,#,_,<,>,COMMA]
Important: COMMA is used to indicate a , character. Because the special character list is delimited by commas, a comma cannot be specified in the list.