How to create a custom x-header in Merge1 to identify custom message types

book

Article ID: 100063797

calendar_today

Updated On:

Description

Description

There can be times when a custom message type needs to be added to the Enterprise Vault (EV) and Compliance Accelerator (CA)/Veritas Advanced Supervision (VAS) or Discovery Accelerator (DA)  to allow for unique identification of items in CA/VAS or DA searches or exports. Bloomberg Instant Messages (IMs) over standard Bloomberg emails is one example that will be used in this Article.

This can be accomplished using Merge1 through the creation of a custom x-header definition for the message type identification.  To add a custom x-header to Merge1, such as BloombergID, execute the following steps:

  1. Sign into the Merge1 portal with an account that has permission to edit importer settings.
  2. Locate the Bloomberg Importer on the Importers page.
  3. Click the EDIT option under its IMPORTER SETTINGS column.
  4. Expand the MESSAGE HEADERS section.
  5. In the Header name field, enter the value of x-kvs-messagetype.
  6. In the Value field, enter the name to be used.  For example, BloombergIM.
  7. Click the plus sign (+) to the right of the Value field to create the new x-header.
  8. Click the Save button in the lower right of the page to save the new x-header.

The next step is to create a new x-header in Enterprise Vault to match the x-header created in Merge1 using the following steps:

  1. Open the Enterprise Vault Administration Console (VAC) with an account assigned the permissions to manage configurations, such as the Vault Service Account.
  2. Navigate to the Enterprise Vault > {Site name} > Policies > SMTP leaf.
  3. Locate the SMTP Policy for Bloomberg Instant Messages, or create it if one does not already exist.
  4. Open the SMTP Policy for Bloomberg Instant Messages.
  5. Click on the X-Headers tab.
  6. Click on the Add button to add a new x-header.
  7. Enter the name of the x-header in the X-Header column. Using the example of BloombergIM and for EV to know about this message type, enter BloombergIM.
  8. Click on the Save button to save the changes to the policy.

Note: The x-header label can be set to anything that is not already configured within Merge1.

The final step is to create a new Message Type in CA/VAS or DA using the following steps:

  1. Launch the CA or DA Client using an account with the Manage Message Types permission. 
  2. Click on the Configuration tab > Message Types sub-tab.
  3. Click on the New button to access the New Message Type page.
  4. Enter into the Name: field the name for the new message type, such as Bloomberg Instant Messages.
  5. Enter into the Value: field the name of the message type to begin with IM to denote Instant Message, followed by the name specified in EV.  In this example, IM.BloombergIM would be the value to match the x-header added to Merge1 and EV and to confirm the message is an IM..
  6. Click the Save button to create the new message type.

Note: The VAS interface currently does not present an option to create new message types.

New messages with this message type should be found in searches after they have been archived and indexed in EV.  Messages archived prior to the new message type will not have the property needed to be found by CA/VAS or DA searches.

 

Issue/Introduction

How to create a custom x-header in Merge1 to identify custom message types