Global Mailbox REST Services adapter

The following table provides an overview of the Global Mailbox REST Services adapter:

Note: By default, the Global Mailbox REST Services adapter runs on the Application Server Independent (ASI) node.
System name Global Mailbox REST Services adapter
Graphical Process Modeler (GPM) category None
Description  
Business usage Use this adapter to put files into, or get files from, a Global Mailbox.
Usage example A configuration of the Global Mailbox REST Services adapter is installed, but disabled by default. You can enable the preconfigured Global Mailbox REST Services adapter or create a new configuration.
Preconfigured? No
Requires third party files? No
Platform availability All supported platforms
Related services
  • User Lookup service
  • Event Property service
Application requirements All supported platforms
Initiates business processes? No
Invocation Not used in business processes
Business process context considerations None
Returned status values None
Restrictions None
Persistence level None. This adapter does not have a pre-set persistence level.
Testing considerations At application start up, attempt to access the FTP server using a supported FTP client with the configured IP address and port. Debug information can be found in the FTP logs. Select Logging Level from the following values:
  • Error – Errors only
  • Communication Trace – Errors, requests from clients, and responses from the Server adapter, including ACL violations
  • All - for debugging, all activities

Implementing the Global Mailbox REST Services adapter

To implement the Global Mailbox REST Services adapter, complete the following tasks:
  1. Create an Global Mailbox REST Services adapter configuration (or enable the installed configuration and edit parameters as needed).
  2. Configure the Global Mailbox REST Services adapter.

Configuring the Global Mailbox REST Services adapter

To configure the Global Mailbox REST Services 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.
Select a Group Not applicable for this adapter. Do not change default value.
Use SSL Whether SSL Server authentication must be enabled or not. Valid values are:
  • Must – SSL is enabled
  • None – SSL is disabled
Default is None. Required.
TLS Version Select the TLS protocol version from the drop-down menu. Required if SSL option is Must. The default value is System Default. Valid values are:
  • TLS1.3
  • TLS1.0-TLS1.3
  • TLS1.2-TLS1.3
  • SystemDefault
Important:
  • The TLSVersionUIOptions property in the security.properties file specifies which TLS versions are available for selection from the drop-down menu.
  • You can customize the property by adding any of the permissible values to the list or removing any existing values. Permissible values are:
    • TLS1.3
    • TLS1.2
    • TLS1.0-TLS1.3
    • TLS1.2-TLS1.3
    • SystemDefault
  • It is important to note that any other value will be ignored. In such cases, the handshake will proceed using the SSLHelloProtocol property value as a fallback option to ensure secure communication.
Note:
  • System Default uses the value from security.properties file.
  • In case of NIST Strict, the SSLHelloProtocolForNISTStrict property is used. Otherwise, SSLHelloProtocol property is used.
  • When TLSv1.3 is selected, ensure TLS 1.3 ciphers are configured in the security.properties file under the TLSv13Ciphers property. For the list of supported ciphers, see Cipher suites.
Restriction: The FIPS 140-2 standard does not define support for TLSv1.3 or the new cipher suites defined for it. Enabling both the TLSv1.3 protocol and FIPS support results in an error.