Manage Default Message Streams

Owned by Natalie Gesin (Deactivated)
Last updated: Jan 31, 2024 by Kinga Huszno
5 min read

You can customize Eagle default message streams to suit your file specification requirements if they are different from the standard incoming message format defined for a particular message stream.

Eagle's default message streams package includes several components that can all be customized using Eagle's Accounting Center:

  • Standard set of message stream definitions

  • RuleSet files (RSFs) to route messages

  • Rule files (XML) to enhance and map message content

  • Panels to submit the edited message to the system for processing

There are two methods to manage client modifications to the Eagle default message streams logic. You can insert INCLUDE statements that override stream behavior within the message rule files located in Eagle Web server folders. Or, you can apply modifications to copied message stream components located within a client folder.

Add INCLUDE Statements to a Default Message Stream

You can use Message Center Editor to override stream behavior using INCLUDE statements. You can insert these either as Before INCLUDE statements or as After INCLUDE statements, using the Auto Include option within the editor.

This is Eagle's recommended approach for customizing default message stream logic because it simplifies the upgrade path for new releases of Eagle software.

To create/update message stream rule files using INCLUDE statements:

  1. From any Eagle window, click the Eagle Navigator button to access the Eagle Navigator.

  2. Enter message center editor in the Start Search text box. To clear the information you entered, click X to the right of the text box. As you type, the Eagle Navigator uses type-ahead to show you all centers and components that match the text you entered.

  3. Click the link to launch Message Center Editor. You see the Message Center Editor main window.

  4. Click Message Center Streams in the left pane. You see the list of message streams.

  5. Double click the stream you wish to edit and navigate to the folder with the rule file (.xml).

  6. Click the Rule file (.xml) for the stream.

  7. Click the Message Mapping tab. You see the Advanced Mapping for the rule.

  8. Select any statement in the rule and then right click Auto Include. An include may be inserted or edited for processing before the initial rule interface mapping, insert/edit an include for processing after the rule interface mapping, or both.

  9. Click OK to save the INCLUDE statement. Includes are stored in the custom_includes root directory under the folder associated with the Eagle generic default message streams.

For most implementations, the use of Eagle generic default message streams includes Web Panel overlays that extend the utility of the Standard Interfaces for client configurations. With the Message Center Editor, you can modify message streams to implement the following:

  • Addition of fields to be used during processing

  • Execution of lookups to translate data or resolve cross reference information

  • Calculation of values to augment upstream limitations

  • Addition of Edit Checks to trap and configure errors for segmentation/reprocessing

  • Preprocessing logic to determine whether to use an add or update transaction

Modify a Client Copy of the Default Message Stream

Alternatively, you can create a standalone copy located within a Client folder location using the Message Center Editor and then customize the message stream properties, rules, and panels.

This is not Eagle's recommended approach because it complicates the upgrade path for new releases of Eagle software.

To copy and edit an Eagle default message stream:

  1. From any Eagle window, click the Eagle Navigator button to access the Eagle Navigator.

  2. Enter automation center in the Start Search text box. To clear the information you entered, click X to the right of the text box. As you type, the Eagle Navigator uses type-ahead to show you all centers and components that match the text you entered.

  3. In Automation Center, click Automation Desk in the left navigation.

  4. In Automation Desk, click Message Streams in the left navigation to access the Message Streams workspace. To access the Message Streams workspace from the Monitor workspace, click Monitor in the left navigation and in the upper left corner of the workspace, under Select Type, click Message Streams.

  5. In the Message Streams workspace, click the message stream you wish to copy and click Duplicate.

  6. Enter a new message stream name and complete the required message stream options.

  7. Click Save to save your changes. You see the message stream you copied in the Message Streams workspace.

  8. To edit a message stream, click the message stream and click Edit.

  9. Make the appropriate changes and click Save.

Eagle strongly recommends that you do NOT directly alter or otherwise corrupt Eagle default message stream components in the Eagle web server file locations.

Activate a Default Message Stream

Before you can process data files, you must ensure that the message streams are properly activated. That is, the message streams are enabled and operating with the correct log levels. When Eagle installs the default message streams, several streams are disabled to conserve resources.

To activate a disabled Eagle default message stream after installation:

  1. From any Eagle window, click the Eagle Navigator button to access the Eagle Navigator.

  2. Enter automation center in the Start Search text box. To clear the information you entered, click X to the right of the text box. As you type, the Eagle Navigator uses type-ahead to show you all centers and components that match the text you entered.

  3. In Automation Center, click Automation Desk in the left navigation.

  4. In Automation Desk, click Message Streams in the left navigation to access the Message Streams workspace. To access the Message Streams workspace from the Monitor workspace, click Monitor in the left navigation and in the upper left corner of the workspace, under Select Type, click Message Streams.

  5. In the Message Streams workspace, click the message stream you wish to enable and click Enable. You see Enabled in the Status column of the selected message stream.

Set Error Log Options for a Default Message Stream

You should review the message stream error log options. Default message streams are configured with the MC Events Log option set to Errors only, such that event details are available only for messages with errors. This setting conserves resources, but hides the successful messages which can be of interest during smaller volume quality assurance activities. For example, you can set MC events log to All information to view successful and failed messages, which also reduces the effective load rate for the execution of the message stream.

To modify the error log level of a default message stream:

  1. In Automation Center, click Automation Desk in the left navigation.

  2. In Automation Desk, click Message Streams in the left navigation to access the Message Streams workspace.

  3. In the Message Streams workspace, click the message stream you wish to edit and click Edit.

  4. In the Parameters dialog box, lick the MC Events log drop down and select the log option you wish to use.

  5. Click Save to save your changes.