IT19291: The ScheduleLog XML element is sometimes missing from MFT transfer log started publications

APAR status

• Closed as program error.

Error description

• After defining scheduled transfers on a busy MQ Managed File
  Transfer (MFT) agent, some of the transfer log started
  publications do not contain the ScheduleLog XML element that
  specifies the identifier for the schedule from which the
  transfer originated.
  

Local fix

Problem summary

• ****************************************************************
  USERS AFFECTED:
  This issue affects users of:
  
  - WebSphere MQ Managed File Transfer
  - IBM MQ Managed File Transfer
  
  who have agents configured to run scheduled transfers.
  
  
  Platforms affected:
  MultiPlatform
  
  ****************************************************************
  PROBLEM DESCRIPTION:
  When an IBM MQ Managed File Transfer (MFT) agent processes
  scheduled transfers, it performs the following steps:
  
  1. The agent uses a thread to poll for work request messages on
  its SYSTEM.FTE.COMMAND.<agent_name> using a 30 second wait time
  period.
  
  2. If the MQGET call times out without a message being returned
  or sufficient time has passed since the last scheduled transfer
  had been submitted for processing, then the agent checks if any
  there are any scheduled transfers defined on the agent that need
  to be submitted as new transfer requests to the agent.
  
  3. If there is an instance of a particular scheduled transfer
  that needs to be started, the agent checks an internal map of
  scheduled ids to transfer ids in order to determine the transfer
  identifier for the previous submitted instance of that scheduled
  transfer.
  
  4. The agent then checks to see if a transfer with the
  determined transfer identifier is running.
  
  4a. If it is, then the new scheduled transfer is skipped because
  the agent determines an instance is already running.
  
  4b. However, if the transfer identifier associated with
  scheduled transfer is not known to the agent transfer processing
  mechanism, then a new transfer request for that schedule is
  submitted to the agents SYSTEM.FTE.COMMAND queue.
  
  5. Once all scheduled transfers have been checked, return to
  step 1.
  
  Now, if the processing of a transfer request was delayed
  (including those submitted via defined schedules) then there was
  a possibility that the scheduled transfer instance was not known
  to the agent's transfer processing mechanism the next time there
  was a poll of scheduled transfers to run.  When this happened,
  the agent started a new instance of the scheduled transfer and
  replaced the entry in the internal map of schedule identifiers
  to transfer request identifiers, to store information about the
  newly submitted scheduled transfer instance.
  
  The updating of the internal map overwrote the existing map
  entries where the transfer identifier for the delayed schedule
  instance was stored.
  
  When the delayed scheduled transfer instance eventually started,
  the agent did not find an associated schedule identifier to
  associate with it.  As such, when the transfer log started
  message was published to the SYSTEM.FTE/Log topic, the
  ScheduleLog XML element was omitted. As such, the transfer log
  started publication did not contain an element such as:
  
    <scheduleLog ID="1"/>
  

Problem conclusion

• The IBM MQ Managed File Transfer (MFT) agent has been modified
  such that the schedule identifier is recorded as a meta-data
  entry with the key "com.ibm.wmqfte.ScheduleId" within the
  transfer request XML message submitted to the agent.  The agent
  can then parse this meta-data from the transfer request at the
  start of the transfer processing in order to determine the
  identifier of the schedule to include in the ScheduleLog
  element.
  
  Note that after this APAR an additional meta-data entry, with
  the key:
  
    com.ibm.wmqfte.ScheduleId
  
  will be included in the started and completed log publications
  for transfers originating from defined schedules.
  
  ---------------------------------------------------------------
  The fix is targeted for delivery in the following PTFs:
  
  Version    Maintenance Level
  v7.5       7.5.0.9
  v8.0       8.0.0.10
  v9.0 LTS   9.0.0.4
  
  The latest available MQ maintenance can be obtained from
  'WebSphere MQ Recommended Fixes'
  http://www-1.ibm.com/support/docview.wss?rs=171&uid=swg27006037
  
  If the maintenance level is not yet available information on
  its planned availability can be found in 'WebSphere MQ
  Planned Maintenance Release Dates'
  http://www-1.ibm.com/support/docview.wss?rs=171&uid=swg27006309
  ---------------------------------------------------------------
  

Temporary fix

Comments

APAR Information

• APAR is sysrouted FROM one or more of the following:

• APAR is sysrouted TO one or more of the following:

Fix information

• Fixed component name

  WMQ MFT

• Fixed component ID

  5724H7242

Applicable component levels

• R750 PSY

     UP