Global Mailbox Client Adapter

The Global Mailbox Client Adapter (GMCA) is an adapter for managing access to an external Global Mailbox system. The GMCA uses configuration information from property files that are in the specified configuration directory.

Note: By default, the GMCA is installed and preconfigured on the Application Server Independent (ASI) node. The GMCA must be installed and configured on any node that has an adapter or service that requires access to Global Mailbox functionality. For example, if you wish to run the Global Mailbox-enabled FTP Server Adapter on an Adapter Container, you must also have a Global Mailbox Client Adapter on that Adapter Container.
The following table provides an overview of the Global Mailbox Client Adapter:
Table 1. Global Mailbox Client Adapter overview. The following table provides an overview of the Global Mailbox Client Adapter:
System name Global Mailbox Client
Graphical Process Modeler (GPM) category None
Description An adapter for managing access to an external Global Mailbox system
Business usage Centralized control over Global Mailbox client that can be used by other Sterling B2B Integrator components such as protocol adapters and mailbox services
Usage example  
Preconfigured? A default instance of this Adapter that is named GlobalMailboxClientAdapter is installed on node1AC1.
Requires third-party files? No
Platform availability All supported platforms
Related services None
Application requirements Java 7 is required.

This adapter must run in a container. See Running Adapters in a Separate JVM for more details about adapter container management.
Initiates business processes? No
Invocation Used by mailbox services and protocol adapters
Business process context considerations None
Returned status values None
Restrictions None
Persistence level None. This adapter does not have a preset persistence level.
Testing considerations Debug information can be found in the logs file:
logs/node<X>AC<Y>/distmailbox.log
  • The value <X> represents the ASI node number
  • The value <Y> represents the AC node number
For example, the ASI node number is 1 and the AC node number is 1:
logs/node1AC1/distmailbox.log

Implementing the Global Mailbox Client Adapter

To implement the Global Mailbox Client Adapter, complete the following tasks:
  1. Create a Global Mailbox Client Adapter configuration (or enable the installed configuration and edit parameters as needed).
  2. Configure the Global Mailbox Client Adapter.

Configuring the Global Mailbox Client Adapter

To configure the Global Mailbox Client Adapter, you must specify settings for the following fields:

Field Description
Name Unique and meaningful name for the adapter configuration. Required.
Description Meaningful description for the adapter configuration. Required.
Environment The Environment field is displayed only in a cluster setup. Required.

Select the node in which the adapter should be deployed. If you do not select any node, all nodes are selected by default and the adapter is started on the node that is started first. You must create the SFTP, FTP, and Connect:Direct server adapter instances in the adapter container that also holds an instance of the Global Mailbox Client Adapter. The adapter container node values are listed.
Select a Group Not applicable for this adapter. Do not change default value.
Application Name The name that is supplied in the output from the registration of this application in Global Mailbox.

If you are replicating data across multiple data centers, same application name must be configured for all instances of the Global Mailbox Client Adapter.
Data Center Name The name of the local data center where the Sterling B2B Integrator instance is installed. The Global Mailbox Client Adapter instance must be configured and running in the Sterling B2B Integrator instance. The data center name must be the same as the local Sterling B2B Integrator instance data center name. The data center name is mandatory for multi-data center or single-data center deployments.

A copy of the message that is uploaded through a Global Mailbox enabled FTP, SFTP, or Connect:Direct server adapter is created in the specified data center. Based on the replication configuration, the replication can be synchronous or asynchronous.
Configuration Directory The location of the directory where the Global Mailbox Client adapter obtains configuration information from global.properties or, if specified, datacenter.properties.
Important: Properties that are defined in the datacenter.properties file override the same properties that are defined in the global.properties file.
Bucket base file path The location of the variant directories.
Bucket name Bucket name for creating new data.
Key Passphrase The pass phrase that corresponds to the variant specified in Bucket base file path.