Configuring the Enterprise Message Bank
The Enterprise Message Bank is an optional remote archiving facility where you can collect messages, Event Log items, and search table entries from multiple
InterSystems IRIS™ client productions.
This chapter describes how to configure it. It discusses the following topics:
Configuring the Message Bank Link
The [Interoperability] > [Configure] > [Message Bank Link]
page allows you to configure a link (for this namespace) to the Enterprise Message Bank. To access this page, click Interoperability
, and Message Bank Link
On this page, provide the following information so the InterSystems IRIS™ can connect to the Message Bank (if defined):
Web Server Port Number
Specify the port number used by the web server that is serving InterSystems IRIS on that machine.
Specify the path for the instance of InterSystems IRIS on the web server. Typically, this is not needed on development systems using the web server installed with InterSystems IRIS. If you have deployed InterSystems IRIS to provide its services through another web server, potentially with other instances of InterSystems IRIS using the same web server, or on a VMS system, you must specify this prefix so that the Message Bank can construct URLs that connect with the correct InterSystems IRIS instance through the web server.
Configuring a Client Production to Send Messages
You must configure each desired client production to send messages to the Message Bank. For each client production, perform the following configuration steps:
If you have not yet done so, configure the link to the Message Bank, as described in the previous section
Or navigate to the [Interoperability] > [View] > [Enterprise Message Bank]
page. The first time you enter the
page, InterSystems IRIS prompts you for information to define the link. This information is the same as described earlier.
Now the production is configured to send messages to the Message Bank, and the Management Portal has a link to the Message Bank web pages.
Configuring a Message Bank Business Operation
Configure the following settings specifically for the Message Bank:
Set to True. This starts messages queuing from all business hosts in the client production. Note that this queueing continues even if you disable the operation and while it is not able to connect to the Message Bank. The operation forwards any queued messages to the Message Bank server whenever it is enabled.
If set to False, the operation does not queue any messages for the Message Bank.
IP address of the Message Bank production. Note that this does not include the web server port number.
TCP port number used by the Message Bank production input service (9192 is the default).
Optionally configure the following additional settings:
Controls which messages to send to the Message Bank. The default behavior is to archive everything except scheduler messages as shown by the value:
How frequently should we check for conforming Event Log events that may need to be forwarded to the Message Bank server. 0 means check only when messages are being forwarded.
If set to True, send empty event submissions periodically if no conforming events need to be submitted.
For information on other settings, see the following:
Details for the Archive Items Setting
The Archive Items
setting controls which messages the production sends to the Message Bank. It is a comma-separated list of configuration names of items whose messages are to be archived to the Message Bank server.
Archive log events for each item using the following colon-separated syntax:
Within the event type brackets, you can use the following characters in your selection list:
||include all event types
||at the front of an item
||exclude the type from archiving entirely
||at the end of an item
||exclude message bodies from archiving
||at the end of an item
||exclude search table entries from archiving
||at the end of an item
||exclude message headers from archiving
||for events of type Trace
||optionally used to select a particular category of trace event. Event type Trace without a suffix means Trace events of all categories.
Archive all events, headers, and bodies but not SearchTable entries; but do not archive bodies or events from item Ens.Alert
InterSystems IRIS only archives trace events if it has logged them. You can use these settings only to restrict which logged
events get archived, not to archive any events that you did not configure to be logged.
Configuring the Message Bank Service on the Server
There are two cases where it there may be conflicting information to identify the enterprise system sending the message:
Although it is not a recommended configuration, it is possible to terminate an enterprise system and restart a new one with the exact same configuration and name but resetting the message IDs. Since the message IDs are not related to the ones in the messages sent by the previous enterprise system, the Message Bank should treat it as a new enterprise system. In this case you should clear the Ignore Client IP Changes
check box on the Ens.Enterprise.MsgBank.TCPService