global.properties file

The global.properties file defines the global system Global Mailbox properties that apply to all nodes in all data centers. The Mailbox configuration properties are the combination of three different property files: the global system properties (global.properties), the local data center properties (datacenter.properties), and the local node properties (mailbox.properties).

Usage

One datacenter.properties file is required for the local data center. Each data center has its own config_root in the shared resource directory specified during installation. Data center 1 cannot access the properties of data center 2. Properties defined in the datacenter.properties file override the same properties defined in the global.properties file.

Edit the properties file with a text editor.

File location

The global system properties and the local data center properties are stored on a directory tree on a shared file system that must be accessible by all nodes (Sterling B2B Integrator clients and Global Mailbox Admin servers) in the same data center. The full path is: <config_root>/global.properties

Where config_root is the path to a directory on a shared file system that designates the start of the configuration tree (for example: /DMShare/config). The path to the config_root directory is specified by the individual Mailbox nodes through a property in their local mailbox.properties file (com.ibm.mailbox.config.root.path). This property is initially set by the installation program.

Environment

Linux®, UNIX, and Windows

Authorization

Only users with administrative permissions can edit the global.properties file.

Syntax

parmname=value

Option descriptions

com.ibm.mailbox.admin.password.lowercase.required: Whether at least one lowercase character is required. If true, password must contain at least one lowercase character. If false, password can contain any number of lowercase characters, including zero. Default value is false.

com.ibm.mailbox.admin.password.minimum.length: Minimum password length. Default value is 6 characters.

com.ibm.mailbox.admin.password.numeric.required: Whether at least one numeric character is required. If true, password must contain at least one numeric character. If false, password can contain any number of numeric characters, including zero. Default value is false.

com.ibm.mailbox.admin.password.uppercase.required: Whether at least one uppercase character is required. If true, password must contain at least one uppercase character. If false, password can contain any number of uppercase characters, including zero. Default value is false.

com.ibm.mailbox.controlcenter.event.batchSize: Number of events that are posted at one time.

com.ibm.mailbox.controlcenter.event.maxPostInterval: Maximum amount of time, in seconds, that can elapse before events are posted (regardless of how many accumulate).

com.ibm.mailbox.controlcenter.event.password: The password of the IBM® Control Center event repository.

com.ibm.mailbox.controlcenter.event.url: The URL of the IBM Control Center event repository in the format http://<cc-hostname>:<cc-port>/sccwebclient/events For more information, see http://iccserver:58082/sccwebclient/events

com.ibm.mailbox.controlcenter.event.username: The user name of the IBM Control Center event repository.

com.ibm.mailbox.controlcenter.external.systems.enabled: Whether external systems events (such as, Cassandra down, ZooKeeper down, IBM Control Center down, Cassandra read/write consistency cannot be achieved, ZooKeeper cannot issue a lock) are enabled. Valid values are true and false. Default is false.

com.ibm.mailbox.controlcenter.heartbeats.enabled: Whether heartbeats events are enabled. Valid values are true and false. Default is false.

com.ibm.mailbox.controlcenter.heartbeats.minutes: Specify how often, in minutes, to send a heartbeat event to IBM Control Center. If another heartbeat event is not sent before this interval IBM Control Center marks the server as down.

com.ibm.mailbox.controlcenter.mbx.activities.enabled: Whether mailbox activities events (processes with matching begin and end events) are enabled. Valid values are true and false. Default is false.

Note: Following properties are available in Sterling B2B Integrator v6.2.0.1 and above and they are applicable to inline payloads (Size < 10 KB) only:

com.ibm.mailbox.crypto.key.pregenerator.capacity
com.ibm.mailbox.crypto.key.pregenerator.enabled
com.ibm.mailbox.crypto.key.pregenerator.threads

com.ibm.mailbox.crypto.key.pregenerator.capacity: The maximum capacity of the encryption key pre-generator.

com.ibm.mailbox.crypto.key.pregenerator.enabled: If set to true, encryption keys will be generated in advance based on the configuration specified as part of the properties com.ibm.mailbox.crypto.key.pregenerator.threads and com.ibm.mailbox.crypto.key.pregenerator.capacity. If set to false, single encryption key will be used for all document encryption. So, it means anytime you restart Sterling B2B Integrator/Global Mailbox, a new single key will be generated and used until Sterling B2B Integrator/Global Mailbox is restarted again.
Important: Using single key for encryption for multiple payloads is not recommended as per the security standards.

com.ibm.mailbox.crypto.key.pregenerator.threads: The number of threads used to pre-generate encryption keys.

com.ibm.mailbox.database.cassandra.host.<n>: The IP address or host name of each additional Cassandra server that is configured in the cluster. Each Cassandra node in the cluster is represented by a unique integer value, <n>, for example, 2. Default is (none).

com.ibm.mailbox.database.cassandra.host.1: The host name or IP address of first Cassandra server. Default value is the localhost.

com.ibm.mailbox.database.cassandra.jmx.port: JMX port number for Cassandra. Default JMX port is 7199.

com.ibm.mailbox.database.cassandra.jmx.username: The user name for Cassandra JMX. All Cassandra nodes must be configured with the same user and password for JMX Security. There is no default value.

com.ibm.mailbox.database.cassandra.jmx.password: The password for Cassandra JMX. All Cassandra nodes must be configured with the same user and password for JMX Security. There is no default value.

com.ibm.mailbox.database.cassandra.native.transport.port: Native port number for Cassandra. Default Native port is 9042.

com.ibm.mailbox.database.cassandra.rpc.port: RPC port number for Cassandra. Default RPC port is 9160.

com.ibm.mailbox.database.cassandra.ssl.ciphers: The list of cipher suites to use to communicate with servers when SSL is enabled. Default value is TLS_RSA_WITH_AES_128_CBC_SHA.
Restriction: Must be set by running the dbConfigUtility setSSL command.

com.ibm.mailbox.database.cassandra.ssl.enabled: Whether to secure client-to-node communications with SSL. Default value is false.
Restriction: Must be set by running the dbConfigUtility setSSL command.

com.ibm.mailbox.database.cassandra.ssl.protocol: The security protocol to use to communicate with servers when SSL is enabled. Default value is TLS.
Restriction: Must be set by running the dbConfigUtility setSSL command.

com.ibm.mailbox.database.cassandra.ssl.trust.any: Whether the client can trust any certificate presented by the server. Default value is true.
Restriction: Must be set by running the dbConfigUtility setSSL command.

com.ibm.mailbox.database.cassandra.ssl.truststore.file: The fully-qualified path of the trust store file containing the list of server certificates that the client will trust when trust any is disabled. Default value is (none).
Restriction: Must be set by running the dbConfigUtility setSSL command.

com.ibm.mailbox.database.cassandra.ssl.truststore.type: The type (for example: PKCS12, JKS) of the trust store file. Default value is (none).
Restriction: Must be set by running the dbConfigUtility setSSL command.

com.ibm.mailbox.database.cassandra.ssl.truststore.password: The password of the trust store file. Default value is (none).
Restriction: Must be set by running the dbConfigUtility setSSL command.

com.ibm.mailbox.database.zookeeper.conn.<n>: More zookeeper contact points. N=2,3,4, an so on. Default value is none.

com.ibm.mailbox.database.zookeeper.conn.1: ZooKeeper contact point consisting of host:port. Default value is (none).
Tip: This is slightly different than the Cassandra property.

com.ibm.mailbox.database.zookeeper.connection.timeout: ZooKeeper connection timeout indicated in seconds. Default value is 15 seconds.

com.ibm.mailbox.database.zookeeper.session.timeout: ZooKeeper session timeout indicated in seconds. Default value is 60 seconds.

com.ibm.mailbox.event.queue.processing.retry.limit: The number of times the system checks that a particular file has been replicated. The default value is -1. Any value less than 0 causes infinite retries.
Restriction: This property can only be set in the global.properties file. To avoid unprocessed files during a data center failure, do not change it unless directed by IBM Support.

com.ibm.mailbox.master.passphrase: The master passphrase used to generate the PBE key that encrypts the value of sensitive properties in the database. Default value is (none).
Restriction: The master passphrase must be set through the command line utility. It is not sufficient to manually edit global.properties and write the passphrase there. The utility must be run so that any existing passwords which are initially xor-encoded get to be encrypted with the passphrase.

com.ibm.mailbox.maximum.allowed.inline.storage.limit: The maximum size a message payload can be to be stored inline. This property protects Global Mailbox from excessively large payloads that are created in Sterling B2B Integrator. Ensure that the value set for the corresponding parameter, inlinePayloadMaxSize, in the global_mailbox.properties file for Sterling B2B Integrator, is less than or equal to com.ibm.mailbox.maximum.allowed.inline.storage.limit. Default value is 10240 bytes.

com.ibm.mailbox.message.bulk.delete.threadpool.size: The maximum numbers of messages to delete in one operation with the Mailbox Delete service. And integer value. Default value is 30.

com.ibm.mailbox.message.query.results.max.size: The number of messages to be retrieved as a query result which can be used to delete the messages or return the list. Default value is 10000.

com.ibm.mailbox.message.expired.ttl: The maximum number of days that a file is visible in the Admin Console after it is purged. The default value is 30 days.

com.ibm.mailbox.payload.purge.queue.rescan.days: The purge job scans in past for a given number of days to clean up any missed record. The default value is 3.

com.ibm.mailbox.message.incomplete.ttl: The time-to-live period for an incomplete message after which it is purged. The 'time to live' is defined in the number of days. The default value is 2 days.

com.ibm.mailbox.messaging.event.notification.enabled: Whether event notifications are enabled. If enabled, individual applications can override. Default value is true.

com.ibm.mailbox.replication.barrier.maxwaittime: The maximum time in milliseconds to wait for an immediate (synchronous) replication request to complete. Default value is 1800 milliseconds.

com.ibm.mailbox.replication.encrypt: Defines the encryption status for the connection between replication servers. Valid values are true and false. The default value is true.

com.ibm.mailbox.replication.hang.threshold: If a replication request remains in IN_PROGRESS state for the specified time (in seconds), the request is considered hung, and moved to PENDING status. Requests in PENDING status are retried, when the replication polling agent runs again. If a replication request failed because the replication server became non-functional in the middle of a transfer, the incomplete file is overwritten when the next replication request starts. Valid range for hang threshold is 1 - 9999 seconds.

com.ibm.mailbox.replication.impl: Custom exit point implementation for IReplicationConfiguration interface. Default value is null.

com.ibm.mailbox.replication.monitor.interval: Time in seconds that the system checks for hung replication requests. Default value is 60 seconds.

com.ibm.mailbox.replication.polling.interval: Time in seconds that the system checks for pending replication requests. Default value is 1 second.

com.ibm.mailbox.replication.polling.threads: The number of threads that run the replication polling task. Default value is 4 threads.

com.ibm.mailbox.replication.queue.depth: The maximum number of replication requests that can be queued for a single replication server connection. The value of this property multiplied by the value of the com.ibm.mailbox.replication.server.max.sessions property is the number of PENDING replication request records that is read from the database each time the replication polling task is run. Default value is 10 replication requests.

com.ibm.mailbox.replication.segment.size: The minimum MB size limit which is used to segment a payload for faster replication. Default value is 100 MB.

com.ibm.mailbox.replication.server.max.consecutive.failures: The number of times the polling agent tries to reach a replication server. If consecutive attempts to reach the replication server fails, the server is marked offline. Valid range for maximum consecutive failures is 1 - 99999.

com.ibm.mailbox.replication.server.max.sessions: The maximum number of sessions on a replication server. Default value is 10 sessions.

com.ibm.mailbox.replication.server.offline.time: The time (in minutes) for which a replication server is marked offline after consecutive connection failures. Valid range for server offline time is 1 - 99999 minutes.

com.ibm.mailbox.replication.type

The type of replication. Valid values are:

asynchronous - delayed (default)
synchronous - immediate

com.ibm.mailbox.storage.async.thread.max: The maximum number of threads to be used for asynchronous requests in storage. Default value is 10 threads.

com.ibm.mailbox.maximum.allowed.inline.storage.limit: The maximum size a message payload can be to be stored inline. This property protects Global Mailbox from excessively large payloads that are created in Sterling B2B Integrator. Ensure that the value set for the corresponding parameter, inlinePayloadMaxSize, in the global_mailbox.properties file for Sterling B2B Integrator, is less than or equal to com.ibm.mailbox.maximum.allowed.inline.storage.limit. Default value is 10240 bytes.

com.ibm.mailbox.event.scan.query.buckets: Number of buckets to scan for unprocessed events for resending. Default value is 60 (one hour worth of events, which at a load of 100 events/sec writes 360,000 events in a bucket). Increasing this value might cause time outs or excessive tombstones to accumulate.

com.ibm.mailbox.messaging.check.application.queue.reader

Indicates whether the Event Consuming application check is enabled. The valid values are true and false. The default value is true.

Note: Set the value to false when using MQ Alias Queue.

Note: When the property com.ibm.mailbox.messaging.check.application.queue.reader is set as false, the Health Check tool does not check the status of the event consuming application. The Health Check tool displays the following message:

Event consuming application: Status check disabled.

Example

The following code is an example global.properties file, with default values for Cassandra, ZooKeeper, storage and other settings.

# global.properties
# Provide properties that are global for all nodes.
	com.ibm.mailbox.master.passphrase=null
	com.ibm.mailbox.database.cassandra.host.1=127.0.0.1
	com.ibm.mailbox.database.cassandra.rpc.port=9160
	com.ibm.mailbox.database.cassandra.native.transport.port=9042
	com.ibm.mailbox.database.cassandra.jmx.port=7199
	com.ibm.mailbox.database.cassandra.jmx.username=
	com.ibm.mailbox.database.cassandra.jmx.password=
	com.ibm.mailbox.database.cassandra.ssl.enabled=false
	com.ibm.mailbox.database.cassandra.ssl.protocol=TLS
	com.ibm.mailbox.database.cassandra.ssl.ciphers=TLS_RSA_WITH_AES_128_CBC_SHA
	com.ibm.mailbox.database.cassandra.ssl.trust.any=true
	com.ibm.mailbox.database.cassandra.ssl.truststore.file=null
	com.ibm.mailbox.database.cassandra.ssl.truststore.type=null
	com.ibm.mailbox.database.cassandra.ssl.truststore.password=null
	com.ibm.mailbox.database.zookeeper.conn.1=null
	com.ibm.mailbox.database.zookeeper.conn.<n>=null
	com.ibm.mailbox.database.zookeeper.session.timeout=60
	com.ibm.mailbox.database.zookeeper.connection.timeout=15
	com.ibm.mailbox.messaging.event.notification.enabled=true
	com.ibm.mailbox.replication.type=ASYNCHRONOUS
	com.ibm.mailbox.replication.encrypt=true
	com.ibm.mailbox.replication.impl=null
	com.ibm.mailbox.replication.barrier.maxwaittime=1800
	com.ibm.mailbox.replication.queue.depth=10
	com.ibm.mailbox.replication.server.max.sessions=10
	com.ibm.mailbox.replication.polling.threads=4
	com.ibm.mailbox.replication.polling.interval=1
	com.ibm.mailbox.replication.server.offline.time=10
	com.ibm.mailbox.replication.server.max.consecutive.failures=5
	com.ibm.mailbox.replication.hang.threshold=600
	com.ibm.mailbox.replication.monitor.interval=60
	com.ibm.mailbox.replication.segment.size=100
	com.ibm.mailbox.storage.async.thread.max=10
	com.ibm.mailbox.admin.password.minimum.length=6
	com.ibm.mailbox.admin.password.numeric.required=false
	com.ibm.mailbox.admin.password.uppercase.required=false
	com.ibm.mailbox.admin.password.lowercase.required=true
	com.ibm.mailbox.maximum.allowed.inline.storage.limit=10240
       com.ibm.mailbox.messaging.check.application.queue.reader=true