global_mailbox.properties file

The global_mailbox.properties file defines the Global Mailbox Client adapter (GMCA) that is deployed in a Sterling B2B Integrator instance.

Usage

Edit the properties file with a text editor.

There are no default values in the installed properties file. You must edit this file upon installation with the values for your configuration. Sterling B2B Integrator must be started after the properties file is edited and saved for the values to take effect.

You can deploy multiple Sterling B2B Integrator instances, in different data centers, that all share Global Mailbox infrastructure. All of the Sterling B2B Integrator instances must use the same values in their global_mailbox.properties file.

File location

This properties file is created during installation, in the standard properties directory of a Sterling B2B Integrator installation:

 <SI_Install_Root>/properties

Environment

Linux® and Windows

Authorization

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

Syntax

parmname=value

Option descriptions

globalMailboxClientAdapterInstanceName: The default adapter lookup name for the GMCA instance. Used by communication adapters and mailbox services to locate the adapter instance to connect with Global Mailbox.
storagePollTimeInSeconds: The poll time in seconds, which specifies the frequency that Sterling B2B Integrator checks for events when a storage bucket is created, retired, or deleted. Valid values for the storagePollTimeInSeconds property are integers greater than 0.; If you want to monitor storage buckets with the native watch service, instead of polling, specify the value of -1 for the storagePollTimeInSeconds property.
sessionCacheExpireTimeInSeconds: The time in seconds that session data is cached after a session is ended.
sessionCacheMaxSize: The maximum number of client sessions that are stored by the cache.
inlinePayloadMaxSize: The maximum size in bytes for global mailbox inline payload storage. Any payloads larger than the value defined by inlinePayloadMaxSize are written to the storage file system. Set the value of inlinePayloadMaxSize to -1 to disable the use of inline payloads. Default value is 10240 bytes.
Important: Ensure that the Global Mailbox property, com.ibm.mailbox.maximum.allowed.inline.storage.limit is set to a value that is equal to the value defined in inlinePayloadMaxSize. If the value of com.ibm.mailbox.maximum.allowed.inline.storage.limit is less than the value of inlinePayloadMaxSize, Sterling B2B Integrator attempts to store payloads inline that are greater than com.ibm.mailbox.maximum.allowed.inline.storage.limit but less than inlinePayloadMaxSize, which can result in a failure.
eventRuleOnFaultPauseInterval: How long the system waits to retry after a failure of an event rule. The default wait time is 300 seconds (5 minutes).

Example 1

Increase the storage poll time value from 3 seconds to 5 seconds:

storagePollTimeInSeconds=5

Example 2

Enable the native watch service:

storagePollTimeInSeconds=-1

The following code is an example of a global_mailbox.properties file:


# NLS_MESSAGEFORMAT_NONE
# NLS_ENCODING=UTF-8

## PROPERTY_FILE_NAME
## global_mailbox.properties.in (for initialization)
## global_mailbox.properties (for operations)
## PROPERTY_FILE_DESCRIPTION
## 

## PROPERTY_START
## PROPERTY_NAME: globalMailboxClientAdapterInstanceName
## PROPERTY_TYPE: String
## PROPERTY_DESCRIPTION
## The default adapter lookup name for the Global Mailbox client adapter instance.
globalMailboxClientAdapterInstanceName=TestDistributedMailboxClientAdapter_DistributedMailboxClientAdapter_node1AC1
## PROPERTY_END

## PROPERTY START
## PROPERTY_NAME: storagePollTimeInSeconds
## PROPERTY_TYPE: String
## PROPERTY_DESCRIPTION
## The poll time in seconds to check for storage bucket creates, retirements, and deletes.
## Use value of -1 to use native watch service instead of polling.
storagePollTimeInSeconds=5
## PROPERTY_END

## PROPERTY_START
## PROPERTY_NAME: sessionCacheExpireTimeInSeconds
## PROPERTY_TYPE: String
## PROPERTY_DESCRIPTION
## The time in seconds after which to expire session cache entries.
## If a user's virtual root changes frequently, this value may need to be lowered.
sessionCacheExpireTimeInSeconds=30
## PROPERTY_END

## PROPERTY_START
## PROPERTY_NAME: sessionCacheMaxSize
## PROPERTY_TYPE: String
## PROPERTY_DESCRIPTION
## The maximum session cache size.
## Should be on the order of the number of concurrently logged in trading partners.
sessionCacheMaxSize=100
## PROPERTY_END


## PROPERTY_START
## PROPERTY_NAME: inlinePayloadMaxSize
## PROPERTY_TYPE: String
## PROPERTY_DESCRIPTION
## The maximum size in bytes for Global Mailbox inline payload storage.
## Any payloads larger than this will use normal storage.
## Set to -1 to disable usage of inline payloads.
## Default value if not specified is 10240 bytes.
inlinePayloadMaxSize=10240