Configuring a remote queue manager for managed file transfers using IBM MQ Managed File Transfer

Configure a remote queue manager for managed file transfers using IBM® MQ Managed File Transfer .

About this task

When you use an independent integration server (either in a development environment or within a container), it is possible to associate the integration server with a remote default queue manager. Starting from IBM App Connect Enterprise 12.0.7.0 the use of a remote default queue manager by an independent integration server was extended to include the use case of sending or receiving files by using IBM MQ Managed File Transfer . If you decide to use a remote queue manager, some additional configuration is required.
  • A remote default queue manager MQEndpoint policy is needed for the IBM App Connect Enterprise server to connect to the remote queue manager. The MQEndpoint policy is referenced from the server.conf.yaml file.
  • The IBM MQ File Transfer Agent must also be configured separately with additional properties files to successfully connect to the remote default queue manager.
  • The IBM MQ File Transfer Agent must be named explicitly rather than relying on the name of the server when you connect remotely.
  • The IBM MQ File Transfer Agent and message flow nodes rely on channels, queues, and topics to be defined on the remote queue manager before the integration server is started. You must create these items in advance by completing the steps in the following procedure.

Procedure

  1. For remote default queue manager usage, the IBM App Connect Enterprise server must be configured with an MQEndpoint policy. The server configuration must also specify the location of the FTE agent configuration files and the name of the FTE agent.
    1. Configure the remote default queue manager with an IBM MQ endpoint policy as described in Configuring an integration server to use a remote default queue manager.
    2. Update the server.conf.yaml file to specify the location of the IBM MQ File Transfer Agent configuration files and the IBM MQ File Transfer Agent name, which must match the name in the agent.properties configuration file. If you specify a coordination queue manager in the server.conf.yaml file, it must also match the name in the coordination.properties configuration file. An example server.conf.yaml configuration is as follows:
      
      ResourceManagers:
        FTEAgent:
          coordinationQMgr: 'FTEQM'
          agentConfigurationDirectory: '/home/aceuser/generic/agent-config'
          agentName: 'DEMOAGENT'

    The property agentConfigurationDirectory, specifies the directory on the file system where the integration server initially locates the properties files that are required by the IBM MQ File Transfer Agent that runs as part of the IBM App Connect Enterprise integration server. When the integration server is first started, these properties files are copied into the working directory of the integration server (into the config/FTE/default subdirectory structure). The copying process happens only the first time that the integration server is started, so if you make configuration mistakes you must correct the files in the config/FTE/default subdirectory structure of the server's working directory.

  2. The IBM MQ File Transfer Agent configuration is made up of a minimum of three files:
    • agent.properties
    • coordination.properties
    • command.properties
    1. Configure the agent.properties file as described in https://www.ibm.com/docs/en/ibm-mq/9.0?topic=reference-mft-agentproperties-file. For example:
      
      agentQMgr=FTEQM
      transferRoot=/tmp/mqft-transfer
      agentName=DEMOAGENT
      agentQMgrHost=10.0.0.216
      agentQMgrPort=11003
      agentQMgrChannel=SYSTEM.BKR.CONFIG
    2. Configure the cooordination.properties file as described in https://www.ibm.com/docs/en/ibm-mq/9.0?topic=reference-mft-coordinationproperties-file. For example:
      
      
      coordinationQMgr=FTEQM
      coordinationQMgrHost=10.0.0.216
      coordinationQMgrPort=11003
      coordinationQMgrChannel=SYSTEM.BKR.CONFIG
    3. Configure the command.properties file as described in https://www.ibm.com/docs/en/ibm-mq/9.0?topic=reference-mft-commandproperties-file. For example:
      
      connectionQMgr=FTEQM
      connectionQMgrHost=10.0.0.216
      connectionQMgrPort=11003
      connectionQMgrChannel=SYSTEM.BKR.CONFIG
    4. Save the files in the directory that you specified earlier by using the agentConfigurationDirectory property in server.conf.yaml file so that the server copies them into the correct location on its initial startup.
    5. Other supporting files, for example, keystores, must also be accessible to the server, and referenced by the correct path at runtime. Only the properties files are copied into different locations.
  3. You must configure the standard IBM App Connect Enterprise queues and channels but if you use a remote default queue manager, some additional configuration is required.
    1. Configure the standard IBM App Connect Enterprise queues and channels as described in Configuring connections to IBM MQ.
    2. Create the IBM MQ File Transfer Agent configuration by running the IBM MQ command fteDefine. In the following example, DEMOAGENT is used as the IBM MQ File Transfer Agent name, and FTEQM is used as the queue manager name. If you use the same names consistently in all of the .properties files, you can use any names for these components:
      fteDefine -t agent DEMOAGENT | runmqsc FTEQM
    3. Run the following MQSC commands on the queue manager:
      
      DEFINE TOPIC('SYSTEM.FTE') TOPICSTR('SYSTEM.FTE') REPLACE
      ALTER TOPIC('SYSTEM.FTE') NPMSGDLV(ALLAVAIL) PMSGDLV(ALLAVAIL)
      DEFINE QLOCAL(SYSTEM.FTE) LIKE(SYSTEM.BROKER.DEFAULT.STREAM) REPLACE
      ALTER QLOCAL(SYSTEM.FTE) DESCR('Stream for MQMFT Pub/Sub interface')
      ALTER NAMELIST(SYSTEM.QPUBSUB.QUEUE.NAMELIST) NAMES(SYSTEM.BROKER.DEFAULT.STREAM,SYSTEM.BROKER.ADMIN.STREAM,SYSTEM.FTE)
      ALTER QMGR PSMODE(ENABLED)

Results

You have configured a remote queue manager for managed file transfers using IBM MQ Managed File Transfer .