In the Events workspace, you can search by event type and if you bring up Message Stream process only, you can see options and additional columns specific to message streams. Message streams are Eagle's rules-based packaged instructions for extracting, transforming, and loading data from multiple file formats into and out of Eagle databases. You can manage data triggered and scheduled streams and copy and customize Eagle-provided default streams. To schedule message streams, access the Schedule workspace and schedule Message Stream Process events.
| Table of Contents |
|---|
You can also submit message streams to run ad hoc, test the stream syntax prior to execution, and view stream messages. In the Monitor workspace, you can view the status of all message streams, reprocess messages that failed, and review and resolve any message stream exceptions. Message streams are also used in Eagle Job Management (EJM) processes that allow you to manage communication and data exchange workflows between Eagle and third party systems.You can manage message streams as follows:
About Data Triggered Message Streams
When you create message streams that will be triggered by events outside of Automation Center, such as arrival of data files from third party vendors, you can only monitor the stream status and resolve any generated exceptions in the Automation Center. These message streams cannot be scheduled.
About Scheduled Message Streams
When you create message streams that will be scheduled, you can add them to jobs, and schedule Message Stream events to run on demand or on a schedule.
About Default Message Streams
Eagle provides a set of default message streams that you can copy and modify to suit the needs of your business. Eagle's default message steams display a negative number in the Message Stream ID column (for example, -2108) and have the following naming convention:
...
Note
Eagle recommends that you do not create custom message streams with eagle_* names and that you do not change or delete Eagle's default message streams.
About Data Formatting Files
From the Events workspace, you can access and modify data formatting files used by message streams to transform and prepare data for loading into and out of Eagle databases. Reviewing and modifying data formatting files may be useful when troubleshooting message stream issues.
Each message stream specifies data delivery instructions (inbound or outbound in relation to Eagle databases), supports a single data format, and uses a single Ruleset file. A Ruleset file directs data in the message stream to the appropriate Rule file for formatting based on the message type. For example, if the message stream is designed to load security reference data, the Ruleset file may route fixed income securities to one Rule file for processing and equity securities to another Rule file.
For inbound message streams, the Rule file parses the incoming data and performs any additional lookups and validations. The data elements are then mapped to the Eagle tag format to allow loading into Eagle databases. For outbound message streams, the Rule file maps the data extracted from Eagle databases to the external system's specified format and performs any additional processing, if required.
| Info | ||
|---|---|---|
|
| Eagle also supports the Eagle ML 2.0 XSD specification with a set of generic XML-based interfaces described as XSD and implemented on the Message Center framework as message streams. Eagle ML allows you to exchange data with increased accuracy and achieve optimal data exchange efficiency. For more information about EagleML, visit the EagleML wiki pages. |
You can test message streams to ensure they are valid prior to being run.
- In Automation Desk, click Events in the left navigation. Or, click Monitor in the left navigation and in the upper left corner of the Monitor workspace, under Select Type, click Message Streams.
- In Events workspace, search for message streams and filter by status (Disabled Streams or Enabled Streams). You can add other search criteria as needed. In the Monitor workspace, search by Stream Name, Stream Category, or DB Partition.
- Click the message stream you wish to test and click Test.
- Click OK in the confirmation dialog box.
- If the message stream did not pass the test, click the message stream and click Edit to make the edits.
In Automation Desk, you can run message streams ad hoc with or without overrides, or send a data file to the message stream to trigger it to run. For example, you can run a scheduled message stream outside of the existing schedule if the required data files are available. To monitor the status of message streams submitted ad hoc, access the Monitor workspace.
Run a Message Stream without Overrides
To run a message stream without overrides:
- In Automation Desk, click Message Streams in the left navigation. Or, click Monitor in the left navigation and in the upper left corner of the Monitor workspace, under Select Type, click Message Streams.
- In Message Streams workspace, search for message streams based on the Stream Status (Show All Streams (default), Disabled Streams, or Enabled Streams). You can add other search criteria as needed. In the Monitor workspace, search by Stream Name, Stream Category, or DB Partition.
- If needed, you can test the message stream before running.
- Click the message stream you wish to run, click the Run Now drop down and click Selected.
.png?version=1&modificationDate=1506385177800&cacheVersion=1&api=v2&width=985)
- Click OK in the confirmation dialog box.
- To view the message stream status, click Monitor in the left navigation.
Run a Message Stream with Overrides
To run a message stream with overrides:
- In Automation Desk, click Events or Schedule in the left navigation. Or, click Monitor in the left navigation and in the upper left corner of the Monitor workspace, under Select Type, click Message Streams.
- In Events or Schedule workspace, search for message stream(s) and you can add other search criteria as needed. In the Monitor workspace, search by Stream Name, Stream Category, or DB Partition.
- If needed, you can test the message stream before running.
- Click the message stream you wish to run, click the Submit drop down and click Submit with Overrides.
- If the QueryEvent Rule file does not exist, click OK in the information dialog box.
In the Run with Overrides dialog box:
- Click the Tags tab and click the green plus sign to add an override. Click the red X to remove an override.
- Click the Parameters tab and click the green plus sign to add a parameter. Click the red X to remove a parameter.
- If applicable, click the Load From Rules button to read the MSGEXCHANGE definition in the query event rule and parse it into parameters.
- Click OK in the Run with Overrides dialog box to save your changes.
- Click the Tags tab and click the green plus sign to add an override. Click the red X to remove an override.
- Click OK in the confirmation dialog box.
- To view the message stream status, click Monitor in the left navigation.
Trigger Message Stream with a File
| Info | ||
|---|---|---|
| ||
| If the message stream you selected is a data triggered stream, the file will be processed immediately. If the message stream is a scheduled stream, the file will be processed according to the existing schedule options. |
| Info | ||
|---|---|---|
| ||
| The system displays a warning message if the uncompressed data exceeds 500MB or its compressed copy exceeds 28MB. The Internet Information Server (IIS) settings limitation of 28MB is the default, but it can be modified by the Administrator. |
To trigger a message stream with a file:
- In Automation Desk, click Events in the left navigation. Or, click Monitor in the left navigation and in the upper left corner of the Monitor workspace, under Select Type, click Message Streams.
- In Events workspace, search for message streams and you can add other search criteria as needed. In the Monitor workspace, search by Stream Name, Stream Category, or DB Partition.
- If needed, you can test the message stream before running.
- Click the message stream you wish to run, click the Submit drop down and click Send File.
- In the Open dialog box, select the appropriate file and click Open.
- Click OK in the confirmation dialog box.
- To view the message stream status, click Monitor in the left navigation.
You can view messages processed by each stream by accessing the Message Status workspace from the Message Streams workspace or from the Monitor workspace.
View Message Streams
To view message stream messages:
- In Automation Desk, click Events in the left navigation. Or, click Monitor in the left navigation and in the upper left corner of the Monitor workspace, under Select Type, click Message Streams.
- In Events workspace, search for message streams and you can add other search criteria as needed. In the Monitor workspace, search by Stream Name, Stream Category, or DB Partition.
- Right click the message stream and select Last 50, Failed, or Data Errors from Show Messages. In this example, we will select the Last 50 and the Failed options.
- For the Last 50 option, review the latest messages that were generated for the selected message stream.
- For the Failed option, review only the messages that failed for the select message stream.
- From the Message Status workspace, you can also reprocess failed messages. Right click the message and select Reprocess.