Link Search Menu Expand Document (external link)

Refinitiv Eikon Chat

This topic provides details on how to capture Refinitiv Eikon Chat (aka Eikon Messenger) via Collect.

  1. Requirements
    1. License requirements
    2. Versions supported
  2. Considerations
    1. Current Limitations
    2. Data Filtering
    3. Data Format
  3. Information Captured
    1. Activities captured
    2. Activities not captured
    3. Metadata
  4. Setup instructions
    1. Prerequisites
      1. Standard prerequisites
    2. Authentication
      1. Obtaining Credentials
      2. Whitelist Relativity IP Addresses
    3. Setup in Trace
      1. Collect
      2. Data source


Before using this data source, note the following license requirements, version support, and special considerations.

License requirements

The following licenses are required to use this data source:

There are no specific license requirements.

Versions supported

There are no specific version requirements.


Current Limitations

  • “Chat2email” functionality no longer supported by Refinitiv.
  • Potentially duplicative data from History Requests cannot be filtered out.

Data Filtering

There are two levels of filtering data:

  • Data Source - Data is being filtered according to specified Monitored Individuals. No filter is applied at message level. So, if a Monitored Individual exists in a channel, we will ingest the whole conversation for the day. If a conversation does not have any Monitored Individuals as participants for that day, we don’t ingest the conversation at all.
  • Data Batch - Only messages with data for the date that matches the Data Batch collection period will be captured. For example, a message that has been exported for 10/1/2021 will be captured by the Data Batch that has collection period from “10/1/2021 00:00” to “10/2/2021 00:00”.

Data Format

Eikon Chat content will be displayed in the Relativity Short Message Format (RSMF) in the Relativity Viewer to provide reviewers with a native chat like review experience. You can find more information on the Relativity Short Message Format here.

Information Captured

Activities captured

The following table lists activities captured by this data source:

Activity Notes

Activities not captured

The following table lists activities not captured by this data source:

Activity not captured Notes


In addition to standard metadata populated during extracting data, the Eikon Chat Data Source captures the following ones:

Field Description
DATE Start date of a chat or start date of a slice in the chat split into slices.
SUBJECT Friendly name of the team and channel.
FROM The first person to send a message in that respective slice.
TO Chat attendees.
CONVERSATION-ID The unique identifier. When creating a Data Mapping, set “Read From Other Metadata Column” to “Yes.”
X-RSMF-EndDate Number of messages in the chat / slice. When creating a Data Mapping, set “Read From Other Metadata Column” to “Yes.”
Distribution list emailsX-RSMF-MessageCount A copy of any email sent to a distribution list is captured from each mailbox that is on the distribution list. A distribution list itself is not a mailbox.
X-RSMF-AttachmentCount Number of attachments in the chat / slice. When creating a Data Mapping, set “Read From Other Metadata Column” to “Yes.”

A “Slice” of data refers to a start and end time of data that will be captured in one Relativity Document. Unless specified, a slice will contain one days worth of data.

Setup instructions

This section provides details on the prerequisites and steps for setting up this data source.


You must have the following in order to complete the setup instructions for this data source.

Standard prerequisites

You must have Collect installed in the workspace to set up this data source, since Collect will be used for data retrieval.

For details on installing Collect, see Using Relativity Collect.


Because Eikon Chat data is collected from the Eikon Chat SFTP account you will need SFTP credentials and ensure Relativity IP addresses are added to Eikon’s whitelist prior to configuring the data source.

Obtaining Credentials

Obtain the following information about Eikon Chat SFTP server:

  1. Host
  2. User and password

Whitelist Relativity IP Addresses

Eikon must add Relativity IP addresses to a whitelist so the system can connect and collect data. Please refer to the Common Collect Data Source Functionality page and the “IP Address Whitelisting Pre-work” for details.

Setup in Trace

The following sections provide the steps for installing Collect and configuring the data source.


Prior to creating the Data Source, install the Collect application and configure the appropriate instance settings by following the Using Relativity Collect page.

Data source

Most parameters work the same for all Collect Data Sources. Follow the instructions from common_collect_data_source_functionality section.

Refinitiv Eikon Chat specific parameters:

General section:

  • Data Source Type: Eikon Chat.

Settings section:

  • Username: SFTP user.
  • Password: SFTP password.
  • Ignore Historic: If set to FALSE, when a new user joins a chat, all of the messages that were sent since the last time they joined the chat will be collected. This can cause a lot of duplicative data collection. The default value is TRUE.
  • Host: SFTP location.
  • Path: Folder path on SFTP.
  • Port: TCP port number. Default value is 22.