3.10 Archiving UM Labs Messages

3.10.1 Creating a UM Labs Module

The UM Labs 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 UM Labs and Retain systems and the data flows into the Retain archive as it created in the UM Labs system. Data is archived immediately as it enters or is created in the UM Labs system.

REST data flow can be monitored by the Archive User by Module Report. See Archive Summary by Module in the Retain 4.9.2: Configuration and Administration.


Configure the Retain Push-based Archiving Connection

Make sure you have completed the instructions in First, Configure the Retain Server or Router Connection.

Creating a REST Collector—UM Labs Module

Create a REST collector under Server Configuration in the REST Collectors Panel. Export the key and secret and send them to your service provider.

Configure the UM Labs Module

Path: Retain Server Manager > Configuration > Module Configuration > UM Labs-Configure > Core Settings

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 lets you send UM Labs items to an external system using FTP or SMTP. In most cases this should be disabled so that items are archived in Retain. To select the SMTP Forwarding or FTP features, you must first add and configure them in the Module Forwarding Tab on the Server Configuration page, otherwise the drop-down list is empty.

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 UM Labs to Work with Retain

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

Once the connection is made data will begin to flow into Retain from UM Labs 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. See Archive Summary by Module in the Retain 4.9.2: Configuration and Administration.