Configuring an integration server to record messages

You can configure an integration server to record message assembly files for all messages that are propagated through the message flow.

Before you begin

Read the following topics:

About this task

The recorded message assembly files are XML files that have a .mxml file suffix. A recorded message assembly file is written each time a message flow node propagates a message from an output terminal to the input terminal of the next node in the message flow. You can import these files into a test project and use them in your tests as:
  • Input data when invoking a message flow node
  • Expected data for comparisons of the test results
  • Substitute data to be returned by a Node Stub instead of invoking the actual node

You can configure an integration server to record all messages that pass through a message flow by setting properties in the RecordedMessageManager section of your integration server's server.conf.yaml file:


ResourceManagers:
   RecordedMessageManager:
      recordedMessagePath: 'C:\temp\IntegrationServer\recorded_messages'   # Set the directory to store recorded messages
      recordAllMessages: true  # Set to 'true' to enabling recording of messages from all message flows

Procedure

Complete the following steps to configure the recording of messages as they pass through a message flow:

  1. Open the server.conf.yaml configuration file for your integration server by using a YAML editor.

    You can edit the file by using the built-in YAML editor that is provided in the IBM App Connect Enterprise Toolkit, either by double-clicking the file in the Application Development view or by right-clicking the file and selecting Open with > YAML editor. If you choose to edit the file by using a plain text editor, ensure that you do not include any tab characters (which are not valid in YAML) and use a YAML validation tool to validate the contents of your file.

  2. Enable recording of all messages that pass through all message flows, by setting the recordAllMessages property to true.
  3. Set the recordedMessagePath property to specify the location where the recorded message assembly files will be saved when recording is enabled.
  4. Stop and restart the integration server for the changes to take effect.

    The recorded message assemblies are saved in .mxml files, in a subdirectory of the directory specified by the recordedMessagePath property.