Configuring Records Retention for Actiance Vantage

You can configure Records Retention for Actiance Vantage (via REST) from the Admin Console.

Actiance Vantage (or Connected Capture) is a service that captures communications over various channels and sends them to an archive for storage. For more information about Actiance Vantage, see Connected Capture on the Smarsh portal at https://www.smarsh.com/products/connected-capture/vantage-modal.

Enabling Records Retention for Actiance Vantage

When configuring Records Retention for XML, you enable the Records Retention plugin and set the parameters to deliver the gathered information as XML to Actiance Vantage service.

Fastpath: Admin Console: System > Management > System Properties
Fastpath: Admin Console: Records Retention

To enable Records Retention:

  1. In the Admin Console, select System > Management > System Properties.
  2. To enable the Records Retention plugin, set the jive.module.records retention.enabled property to true.
    The Records Retention tab appears in the top menu.

  3. To select email (SMTP) as the destination, set the __retention.delivery.task.bean.name parameter to actianceTask.
  4. Go to the Records Retention tab.
  5. Set the following required parameters:
    • retention.actiance.vantage.authkey: The consumer key for the network.
    • retention.actiance.vantage.authsecret: The consumer secret for the network.
    • retention.actiance.vantage.hosts: The domain name of the Actiance Vantage server to send messages to. This value should not include a protocol or port.
    • retention.actiance.vantage.networkid: The Network ID assigned to the collaboration network registered in Actiance Vantage.
    • retention.actiance.vantage.company.id: The Company ID provided by Actiance Vantage
  6. If necessary, set the additional parameters.

    For more information about the available parameters, see Configuring Records Retention for SMTP.

  7. Click Save Settings.

Records Retention properties for Actiance Vantage

When configuring Records Retention, you set it to deliver information as XML file to Actiance Vantage.

Once you enable the Records Retention plugin, you can configure it for your environment from the Records Retention tab. This tab contains a list of configurable settings.

Required properties

The following properties must be changed to set up Records Retention for Actiance Vantage:

  • retention.actiance.vantage.authkey: The consumer key for the network.
  • retention.actiance.vantage.authsecret: The consumer secret for the network.
  • retention.actiance.vantage.hosts: The domain name of the Actiance Vantage server to send messages to. This value should not include a protocol or port.
  • retention.actiance.vantage.networkid: The Network ID assigned to the collaboration network registered in Actiance Vantage.
  • retention.actiance.vantage.company.id: The Company ID provided by Actiance Vantage

Additional useful properties

The following properties are optional and can be changed as desired:

  • retention.actiance.vantage.logresponses: Whether to log Records Retention activity. Defaults to true. If true, the plugin outputs additional debugging information in the logs (provided the com.jivesoftware.retention.task.restapi.impl logger is set to INFO or lower).
  • retention.deletes.processing.on: Whether to capture or delete events. Defaults to false. Note that delete records have very little information about the content that was deleted.
  • retention.include.author.details: Whether to include author details in the header. Defaults to false. Set this property to true to add an X-AuthorUsername header with the author's username as the value.
  • retention.reaper.messagearchive.number.of.days.to.keep: The number of days for which records are retained after they are sent. Records can be saved for a while, so that you can replay events. Defaults to 30.
  • retention.reaper.capturedbinary.number.of.days.to.keep: The number of days for which records are kept. Once a record is sent, it is considered "done" by the retention module. However, records can be saved for a period of time so you can "replay" events. This setting refers to binaries, including attachments, images and uploaded files.
  • retention.resolve.and.store.cclists.for.spaces: Whether to send activity to emails specified in the settings for a given space. Defaults to true. This feature can be turned off to improve performance.