Define message actions
Use this procedure to define a Message Handler message action. You may use the default attributes or set up attributes for message actions. See Message attributes.
By default, message actions apply to all messages, including messages containing payloads or receipts. To exclude receipts from a message action, add a condition that sets Is Receipt to false. Use the up and down arrows in the user interface to set the order for executing actions.
- Click Message Handler in the Processing configuration graphic to open the Message Handler page.
- Click Manage message processing actions.
- In the list of tasks at the bottom of the page, click Add a new processing action.
- Select an attribute from the drop-down list to use as a filtering condition for the action and click Next.
Note: For a description of the default attributes that you can select, see the list under Set up message-processing actions.
- Specify an operator and value for triggering the action and click Next. See Set up message-processing actions for definitions of operators.
- Select the action to perform, complete the applicable fields and click Finish. The following list describes the available actions.
- Send a copy of the message to – Specify one or more parties as recipients of a copy of the message. A copy can be sent only in the same direction as the original. For example, if a community sends a message to partner A, a copy can be sent to partner B. However, after receiving a message from partner A, a community cannot send a copy to partner B.
- Reject the message – Select this option to reject messages that meet the specified conditions. You can type a text that provides the reason for the rejection.
- Perform inline processing via a Java class – The extensible architecture of Activator allows system integrators to apply custom logic to in-process messages as an integral part of the processing pipeline. The custom processing logic, implemented as a user-defined Java class, can be selectively applied at runtime to inbound or outbound messages as determined by message actions. Use of this feature requires obtaining an optional developer’s license.
- Rename the production file – Enables you to change the original file name of a message to a name generated according to a format you specify. In the outbound case, the name is changed after the message is consumed from the back end but before it is sent to a partner. In the inbound case, the name is changed after the message is received from a partner but before it is sent to the delivery exchange. Message Tracker reports both the original and delivery file names.
- You must construct a valid pattern for the new file names. The correct format consists of one or more optional text strings and delimited substitution variables in any order. Use of underscores to separate variables or as character separators within variables is optional. The following is an example of a valid file pattern:
- Do not specify a file name or a date containing any of the following characters: \ / < > ? * : " |
- When specifying a date format, use upper-case MM for months and lower-case mm for minutes. The year format can be yyyy or yy. For the time format, you can use underscores to separate hours, minutes and seconds.
- For details on how to enter a renaming pattern, see File renaming patterns.
- Apply a message attributes template – Select this option if you want to apply a message attributes template to messages that meet the specified conditions. See Message attributes templates for information about these templates. Note, a template must already be created prior to applying when. When you select this option you must also select one of the following dependent options:
- Select the message attributes template to use – Select a message attributes template from the list of available templates.
- Provide metadata variable to identify message attributes template to use –
- You must also select an action to execute if the template cannot be applied:
- Fail the message
- Log a warning
- Perform record format transformation – Select this option if you want to transform the formatting of the file records. You can specify a format for the original (before transformation) and target (after transformation) file. See File transformation and Setting transformations. See Metadata for record file management for descriptions of the file formats in the drop-down lists.
- When the transformation is attempted, the message attribute RecordTransformationAttempted is set to true. If the transformation succeeds:
- The local file record format attributes will have the target format.
- The transformed payload will be associated to the Actioned state (backup file).
- Original format – Specify the format of the source file. The parameters you set are used instead of the message's local file format attributes. To use the values from the message's local file format attributes, use these parameters:
- File format – From the drop-down list select a file format option.
- Record length – Leave empty if you want to use the protocol value.
- Record padding character – Enter
- Character set – Leave blank or enter the character set used in the original file (for example, ASCII or EBCDIC).
- Target format – The format of the destination file. The formatting information must be identified on this screen. The message's virtual file record format attributes are ignored.
- (Optional) Enter a Friendly name to help identify this action.
- Click Finish. The new message processing action is displayed.