WebSphere MQ File Transfer Edition Agent Adapter

Use the WebSphere® MQ File Transfer Edition Agent adapter to interact with WebSphere MQ File Transfer Edition as a fully functioning WebSphere MQ File Transfer Edition agent.

Important: Use WebSphere MQ V7.5.x with Sterling B2B Integrator V5.2.3 - 5.2.5 and the WebSphere MQ File Transfer Edition services and adapters. WebSphere MQ V8.0.0.2 is supported with the WebSphere MQ File Transfer Edition services and adapters in Sterling B2B Integrator V5.2.6 or later.
The following table provides an overview of the WebSphere MQ File Transfer Edition Agent Adapter:
System Name WebSphere MQ File Transfer Edition Agent Adapter
Graphical Process Modeler (GPM) category Not in GPM
Description This adapter receives and processes WebSphere MQ File Transfer Edition transfer requests.
Business usage The WebSphere MQ File Transfer Edition Agent Adapter is used as a fully functioning FTE agent. It interacts with the Sterling B2B Integrator mailboxing subsystem through the FTP server adapter to deposit and extract messages into mailboxes.
Usage example The WebSphere MQ File Transfer Edition Agent adapter enables file exchanges between Sterling B2B Integrator and agents on an existing WebSphere MQ File Transfer Edition.
Preconfigured? No
Requires third party files? No
Platform availability All platforms supported by the application
Related services The WebSphere MQ File Transfer Edition Agent Adapter is tightly integrated with the following adapters/services:
  • WebSphere MQ File Transfer Edition Create Transfer Service
  • FTP Server Adapter
  • WebSphere MQ Suite Async Receive
The listed service can be invoked from a business process, and after invocation, it uses the WebSphere MQ File Transfer Edition Agent Adapter to perform specified activities with the WebSphere MQ File Transfer Edition agent.
Application requirements Requires existing WebSphere MQ and WebSphere MQ File Transfer Edition network
Initiates business processes? No
Invocation This adapter is not invoked from a business process.
Business process context considerations None
Returned status values None
Restrictions Adapter must run within an Adapter Container and cannot run in an ASI node. To use bindings mode, the agent queue manager must be running on the same server as Sterling B2B Integrator and the WebSphere MQ java JNI libraries must be available.

On environments where Sterling File Gateway is also installed, the adapter will not start unless the ignoreFileName property is set to ignore temporary files created by the agent. Add the following property filegateway.ignoreFilename=.*[.]part[0-9]* to your customer_overrides.properties file prior to attempting to start the adapter on environments where Sterling File Gateway is also installed.
Special Considerations The WebSphere MQ File Transfer Edition Agent adapter is a fully functioning FTE agent embedded within Sterling B2B Integrator, with similar configuration requirements as a regular FTE agent. Specifically, a script is generated during the adapter configuration in Sterling B2B Integrator, and this script must be executed on the MQ FTE Queue Manager before the embedded agent in Sterling B2B Integrator can be fully functional. The adapter configured in Sterling B2B Integrator can only be enabled after the script has been executed on the Queue Manager. Any attempt to enable the adapter in Sterling B2B Integrator before the Queue Manager set up will fail. The <agentname>-delete.mqsc, is also generated. There are links on the dashboard that allow you to download the associated scripts.
Persistence level Not Applicable
Testing considerations Debug information for this adapter can be found in the WebSphere MQ File Transfer Edition Agent Adapter log files.

Implementing the WebSphere MQ File Transfer Edition Agent Adapter

Create an instance of this adapter in Sterling B2B Integrator to integrate it with WebSphere MQ File Transfer Edition. You must create an FTP Server Adapter instance and a WMQFTE User Map before you create an instance of the WebSphere MQ File Transfer Edition Agent Adapter.

Configuring the WebSphere MQ File Transfer Edition Agent Adapter

The following table presents the configuration parameters for the WebSphere MQ File Transfer Edition Agent Adapter. For more information on each of the parameters below, please see the IBM WebSphere MQ File Transfer Edition Documentation and search for the equivalent WebSphere MQ File Transfer Edition term that is provided.
Field Description
Name Name that the service will have in Sterling B2B Integrator. String. Required.
Description Description of service. String.
Environment The adapter container this adapter instance will run within. The WebSphere MQ File Transfer Edition Agent Adapter only runs within Adapter Containers. Required.
Select a Group Not applicable for this adapter. Leave at default.
Agent Name The agent name used to identify the agent on the WebSphere MQ File Transfer Edition network. String. Maximum of 28 characters. Required. Equivalent WebSphere MQ File Transfer Edition property: agentName
Agent Description A user provided description of the agent. String. Maximum of 255 characters. Optional. Required. Equivalent WebSphere MQ File Transfer Edition property: agentDesc
Agent Queue Manager The Agent Queue Manager used by this agent. String. Maximum of 48 characters. Required. Equivalent WebSphere MQ File Transfer Edition property: agentQMgr
Coordination Queue Manager The Coordination Queue manager for the WebSphere MQ File Transfer Edition network. String. Maximum of 48 characters. Required. Equivalent WebSphere MQ File Transfer Edition property: coordinationQMgr
Enable User Authority Checking Enables user authority checking for this agent. Valid values are:
  • TRUE
  • FALSE (default)
Required. Equivalent WebSphere MQ File Transfer Edition property: authorityChecking
Trace Classes Comma separated list of java package names to trace. Example: 
com.ibm.mq,com.ibm.wmqfte
Optional. Equivalent WebSphere MQ File Transfer Edition property: traceClasses (pre 7.0.3 format)
Trace Level Trace Level for packages selected in Trace Classes parameter. Optional. Equivalent WebSphere MQ File Transfer Edition property: traceLevel (pre 7.0.3 format)
Connection Mode To Agent Queue manager Defines how the agent connects to the agent queue manager. Valid values are:
  • Client Mode uses a TCP network connection between the agent and the queue manager. (default)
  • Bindings Mode uses shared memory to connect the agent and the queue manager, requiring that MQ and Sterling B2B Integrator are running on the same server
Required.
Agent Queue Manager Host Name The hostname or IP address of the server running the agent queue manager. String. Required if Client Mode is used. Equivalent WebSphere MQ File Transfer Edition property: agentQMgrHost
Agent Queue Manager Port The TCP port of the listener on the agent queue manager. Required if Client Mode is used. Equivalent WebSphere MQ File Transfer Edition property: agentQMgrPort
Agent Queue Manager Channel The MQ channel used when established a client mode connection to the agent queue manager. String. Optional. If left blank, default is SYSTEM.DEF.SVRCONN. Equivalent WebSphere MQ File Transfer Edition property: agentQMgrChannel
Multi-Instance Standby Agent Queue Manager The IP address or host name and port of the standby queue manager. Format is hostname(port) or ip(port). String. Optional. Equivalent WebSphere MQ File Transfer Edition property: agentQMgrStandby
SSL On Connection To Agent Queue Manager Enables SSL on network connection between the agent and the agent queue manager. Valid Values:
  • None (Default)
  • Must
Drop-down. Required.
SSL Cipher Specification Cipher Specification used for SSL connection to queue manager. Must match the Cipher Specification used on the MQ channel. Valid Values:
  • DES_SHA_EXPORT
  • DES_SHA_EXPORT1024
  • FIPS_WITH_3DES_EDE_CBC_SHA
  • FIPS_WITH_DES_CBC_SHA
  • NULL_MD5
  • NULL_SHA
  • TLS_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_RSA_WITH_AES_128_CBC_SHA
  • TLS_RSA_WITH_AES_256_CBC_SHA
  • TLS_RSA_WITH_DES_CBC_SHA
  • TRIPLE_DES_SHA_US
Drop-down. Required if SSL On Connection To Agent Queue Manager set to Must. Equivalent WebSphere MQ File Transfer Edition property: agentSslCipherSpec
SSL Peer Name The distinguished name skeleton that must match the name provided by the agent queue manager. The distinguished name is used to check the identifying certificate presented by the queue manager on connection. String. Optional. Equivalent WebSphere MQ File Transfer Edition property: agentSslPeerName
SSL Trust Store Location The location of the certificates that the agent trusts. The value is a file path. If it is a Windows file path the backslash character (\) must be escaped (\\). String. Required if SSL On Connection To Agent Queue Manager set to Must. Equivalent WebSphere MQ File Transfer Edition property: agentSslTrustStore
SSL Trust Store Password Specifies the password required to access the truststore. Required if SSL On Connection To Agent Queue Manager set to Must. Equivalent WebSphere MQ File Transfer Edition property: agentSslTrustStorePassword
SSL Key Store Location The location of the private key of the agent. The value is a file path. If it is a Windows file path the backslash character (\) must be escaped (\\). This property is required if the agent queue manager requires client authentication. String. Optional. Equivalent WebSphere MQ File Transfer Edition property: agentSslKeyStore
SSL Key Store Password The password required to access the private key of the agent. This property is required only if the SSL Key Store property is specified. Optional. Equivalent WebSphere MQ File Transfer Edition property: agentSslKeyStorePassword
FTP Server Adapter Selects the FTP Server Adapter instance used by this agent. A list is populated from the FTP Server Adapter instances configured in this Sterling B2B Integrator instance. Required.
SSL On Connection To FTP Server Determines if SSL is used on FTP connection. Valid values are:
  • None (default)
  • Must
Required.
Additional Agent Property File Name Name of a property file, located in the Sterling B2B Integrator properties directory, containing additional parameters for this agent. The format of this property file matches that of the agent.properties file as defined in the WebSphere MQ File Transfer Edition documentation. String. Optional. Properties that can not be set because they are defined in the user interface include:
  • agentName
  • agentDesc
  • agentQMgr
  • authorityChecking
  • agentQMgrHost
  • agentQMgrPort
  • agentQMgrChannel
  • agentQMgrStandby
  • agentSslCipherSpec
  • agentSslPeerName
  • agentSslTrustStore
  • agentSslTrustStorePassword
  • agentSslKeyStore
  • agentSslKeyStorePassword
  • protocolBridgeCredentialExitClasses
  • destinationTransferEndExitClasses
  • destinationTransferStartExitClasses
  • sourceTransferEndExitClasses
  • sourceTransferStartExitClasses
  • protocolServerType
  • userIdForClientConnect
Quiescent Period Before Immediate Shutdown (seconds) Number of seconds the adapter will wait for the agent to complete a ‘non-immediate' shutdown where pending transfers are allowed to finish before the agent stops. If the agent is still running after this period, it will be stopped, interrupting any pending transfers. Default is 20 seconds. Required.
Trust Store Location The location of the certificates that the agent trusts when interacting with the FTP server. The value is a file path. If it is a Windows file path the backslash character (\) must be escaped (\\). String. Optional.
Trust Store Password Specifies the password required to access the truststore. Optional.
Key Store Location The location of the private key of the agent. The value is a file path. If it is a Windows file path the backslash character (\) must be escaped (\\). This property is only required if the agent queue manager requires client authentication. String. Optional.
Key Store Password The password required to access the private key of the agent. This property is required only if the Key Store Location property is specified. Optional.
WMQFTE User Map Name The map name selected will be used by the agent adapter to obtain the credentials used when logging into the FTP server by mapping from the MQMD User Id presented to the agent in each transfer request. A list is populated from WMQFTE User Maps configured on the Sterling B2B Integrator instance. Required.

Additional Agent Property File Example

The Additional Agent Property File Name parameter can be used to specify the name of a property file that contains values altering the agent’s behavior. The use of such a file is optional and is only required to change the default behavior of an agent. An example properties file that changes the number of concurrent source and destination transfers allowed as well as the maximum number of queued transfers would be:


maxQueuedTransfer=1500
maxSourceTransfers=50
maxDestinationTransfer=50

Parameters Passed from Business Process to Service

None

Parameters Passed from Service to Business Process

None