Integrate Sterling File Gateway with WebSphere MQ File Transfer Edition

Before you can integrate Sterling File Gateway with WebSphere® MQ File Transfer Edition, you must perform the tasks to Configure Sterling B2B Integrator to transfer files to WebSphere MQ File Transfer Edition. Sterling File Gateway uses the services and adapters that you create in Sterling B2B Integrator for transfers with WebSphere MQ File Transfer Edition. There are Business Processes and a WebSphere MQ File Transfer Edition Listening Consumer protocol provided with Sterling File Gateway that simplify configuring Sterling File Gateway for WebSphere MQ File Transfer Edition transfers.

Before you configure Sterling File Gateway to work with WebSphere MQ File Transfer Edition, you must have:
  1. Created the mailboxes listed in the filegateway.properties file wmqfteSourceMailbox property.
  2. Created a Sterling B2B Integrator user account with permissions to the mailboxes you created and a virtual root matching the filegateway.properties wmqfteSourceUserVirtualRoot property.
  3. Created an instance of the WebSphere MQ File Transfer Edition Create Transfer service with the name listed in the filegateway.properties wmqfteCreateTrasnferServiceName property.
  4. Created an Adapter Container in Sterling B2B Integrator,
  5. Created a FTP Server Adapter instance in Sterling B2B Integrator.
  6. Created a WMQFTE User Map in Sterling B2B Integrator that contains:
    • A mapping for outbound transfers between the MQMD User Id associated with transfer operations initiated by within Sterling B2B Integrator and the Sterling B2B Integrator user account you created.
    • Mappings for inbound transfers between the MQMD User Ids associated with transfer requests initiated outside of Sterling B2B Integrator and Sterling B2B Integrator user accounts with the appropriate mailbox permissions.
  7. Created a WebSphere MQ File Transfer Edition Agent adapter instance in Sterling B2B Integrator.
  8. Created a local queue for reply messages within the agent queue manager used by the WebSphere MQ File Transfer Edition Agent Adapter you created in Sterling B2B Integrator.
  9. Created a WebSphere MQ Suite Async Receive service in Sterling B2B Integrator that is configured to receive reply messages from the reply queue you created.

Sterling File Gateway Integration Tasks

To integrate Sterling File Gateway and WebSphere MQ File Transfer Edition you need to:

  1. Create a community. Include WebSphere MQ File Transfer Edition in the list of listening protocols available to partners in this community.
  2. Create a static routing channel template appropriate for your business needs.
  3. Create a Partner that is a Producer and add it to the community you created.
    Table 1. Partner that is Producer Settings
    Parameter Value
    Authentication Type Local
    Given Name FTE
    Surname Producer
    Partner Role Partner Is a Producer of Data
    Connection Direction Initiate Connection
    Will the Producer use either SSH/SFTP or SSH/SCP protocol to initiate connections? No
  4. Create a Partner that is a Listening Consumer and add it to the community you created.
    Table 2. Partner that is Listening Consumer Settings
    Parameter Setting
    Authentication Type Local
    Consumer of Data Partner will listen for a connection to consume data
    Select Protocol Listen for Websphere MQ FTE Connections
    WebSphere MQ File Transfer Edition Agent Adapter Information that will be given to the business process used for transfers. You must specify the WebSphere MQ File Transfer Edition Agent Adapter required information:
    • Source Agent to the WMQFTE Agent Adapter - Source Agent Name and Source Agent Queue Manager are determined from adapter name. Drop-down.
    • Destination Agent Name - Name of the destination Agent.
    • Destination Agent Queue Manager - Name of the destination agent's queue manager
    • Destination Type - The type of the destination. Valid values are:
      • file (default)
      • partitioned data set
      • sequential data set
      • file space
    • Destination Agent Directory, Data Set, or file space - If Destination Type is ‘file’ then DestName is concatenation of this value, a ‘/’ and the destination message name defined by the Sterling File Gateway route. If the Destination Type is ‘partitioned data set’ or ‘sequential data set’, the first occurrence of the string ${FileName} will be replaced with the delivery file name generated by the routing channel. For other Destination Types, the value in this field is passed in unchanged.
    • Destination File Already Exists - What should be done if the file already exists on the destination. Valid values are:
      • error (default)
      • overwrite
    • Queue for Transfer Status Reply Messages - Name of the queue where reply messages will be placed. This must match the configuration of the WebSphere MQ Suite Async Receive instance that you created.
    • Queue Manager Containing Reply Queue - Name of the queue manager for the reply queue. This must match the configuration of the WebSphere MQ Suite Async Receive instance that you created.
    • Priority -
    • Transfer mode - Mode for the transfer. Valid values are:
      • binary (no conversion) (default)
      • text (automatic conversion)
    • Checksum Method - Method used to check data integrity. Valid values are:
      • MD5 (default)
      • none
    PGP Settings Select No for the router settings.
  5. Create a new routing channel, using a routing channel template appropriate for you business needs, between the producer and the consumer you just created.
  6. Add Sterling File Gateway properties to the customer overrides properties. Edit customer_overrides.properties file and add:
    Table 3. Entries for customer_overrides.properties File
    Property Comment
    filegateway.ignoreFilename=.*[.]part[0-9]* Configures File Gateway to ignore the temporary 'part' files created by a WebSphere MQ File Transfer Edition protocol bridge agent. If this parameters is not set, then the WebSphere MQ File Transfer Edition Agent Adapter will fail to start up on any Sterling B2B Integrator system that also has File Gateway installed.
    filegateway.wmqfteFtpAdapterNames=FTE_FTP_SA FTE_FTP_SA is a comma separated list of the system names of each FTP Server Adapter referenced in WebSphere MQ File Transfer Edition Agent Adapter configurations on the system.
    Remember that any change to the properties file requires a restart of Sterling File Gateway.

Troubleshoot the Sterling File Gateway and WebSphere MQ File Transfer Edition Configuration

Some of the issues you may encounter include:
Issue Resolution
A delivery from Sterling File Gateway is shown as pending but the file has been received by the destination agent. Verify that the WebSphere MQ Suite Async Receive Service has been configured properly.
A delivery from Sterling File Gateway is shown as pending and the file has not been received by the destination agent. Verify that the WebSphere MQ File Transfer Edition Agent Adapter is enabled and that the destination agent is available.