1.3 Retain Message Router Configuration Page

Path: Retain Server Manager > Configuration > Router Configuration

For tab information, see the following sections.

NOTE:Although this sets up a connection with the Retain Message Router, it does not require installing the Router software on the Retain server.

1.3.1 Communications tab

The Communications tab sets communications parameters for the Retain server to communicate with the Message Router.

Path: Retain Server Manager > Configuration > Router Configuration > Communications tab

Table 1-2 Using the Communications tab

Field, Option, or Button		Information and/or Action
Tenant ID Panel This identifies the Retain server to the Message Router and other REST applications.
Tenant ID		Retain automatically creates this the first time you open the page.
Message Router Connections Panel This provides the Retain server with network contact details for the Message Router. The Router should be installed in your network’s DMZ so that Retain is behind the firewall and not directly exposed to the Internet.
Host		Host name or IP address of the server where the Router software is installed.
Port		Port on which Retain and the Router communicate. Defaults: SSL = 443, Plain Text = 48080.
Security		SSL (default) or Plain Text
Test Connection button		Make sure you click this to verify that the connection with the Message Router is working.
Cloud Router Configuration Panel
Connected to Cloud Router		Enable this if you are setting up and using the Retain Cloud Router.
Key		Retain generates this when you click the Generate Credentials button.
Secret		Retain generates this when you click the Generate Credentials button.
Local URL		The Retain server’s complete URL, including its port, for use by anyone to reach the Retain server. For security reasons, Micro Focus recommends always using SSL (port 443) rather than Plain Text.
Use Message Router Connections		Enable this to have the Cloud Router send data to the Message Router rather than to the Retain server. This assumes, of course, that a Message Router is also installed. Otherwise, the Cloud Router should use a secure connection (SSL) for data transfers to Retain.
Get Connection Status		Click this to get status for the Cloud Router connection to Retain.
Generate Credentials		Click this to generate credentials for Retain to use in communications with the Cloud Router.

1.3.2 Storage tab

The storage tab contains the path to the temporary storage location that you create on the Message Router.

Path: Retain Server Manager > Configuration > Router Configuration > Storage tab

Table 1-3 Using the Storage tab

Field, Option, or Button		Information and/or Action
Message Router REST Storage Panel The Router stores data here (usually for only a few seconds but longer if needed) before sending it to Retain.
Storage Path		You create this when setting up the Message Router. See Installing a Retain Message Router on Linux and Installing a Retain Message Router on Windows.

1.3.3 Logging tab

The logging tab contains settings to enable logging, dictate the logging level of the Router, and settings to purge old logs from the system after a specified age.

Table 1-4 Using the Logging tab

Field, Option, or Button		Information and/or Action
Message Router Logging Options Panel
Logging enabled		Select this to enable Message Router logging.
Log level		Select a level of events to log: Diagnostic (Trace), Verbose (Debug), Normal (Info), Error Only.
Compress logs		Select this to store the logs using file compression.
Remove old logs		Select this to prevent the log directory from running out of disk space.
When age exceeds (days)		Set this to the number of days you want log files kept before deletion.