5.15 TeleMessage Module

The TeleMessage module allows Retain to archive those messages. This is different from most modules in that there are no Profiles or Jobs. A REST API collector is connected between the TeleMessage and Retain systems and the data flows into the Retain archive as it created in the TeleMessage system. Data is archived immediately as it enters or is created in the TeleMessage system.

REST data flow can be monitored by the Archive User by Module Report Archive Summary by Module

5.15.1 Prerequisites

5.15.2 Configure Retain Server Connection

Under Server Configuration/Communications you must setup the Retain Server Connection. This is the hostname or the public IP Address of the Retain server the host will be entered into the system to connect to Retain. The port will be 48080 for http or 443 for https protocols.

5.15.3 Create REST Collector

Create a REST collector under Server Configuration REST API. Export the key and secret and send to your service provider.

5.15.4 Configure the Module

The module needs to be enabled on this page to make it active in the Retain system.

The module can be given a name.

The Send Method option enables either the SMTP Forwarding or FTP features. For either feature to appear and function, the Module Forwarding tab must be configured on the Server Configuration page. See that section for more information.

To configure the module, all that is required is to enable the Jobs in the module and Save Changes.

The “Enable Jobs” box must be checked to have data archiving functionality.

Save changes and the module is configured. You may need to disable and re-enable "Enable Job" before it will allow you to Save Changes.

Configure TeleMessage

The REST connection to the collector needs to configured by the Admin on the TeleMessage system side.

Once the connection is made data will begin to flow into Retain from TeleMessage and will appear in the user's Retain mailbox.

There are no Profiles or Jobs associated with this Module. Data flow can be monitored with the Archive Summary by Module report Archive Summary by Module.