0% found this document useful (0 votes)
297 views

Merge1 User Guide

This document is the user guide for Merge1 version 7.0.2305. It contains information about system requirements, installation, configuration, navigation, and using the various features of Merge1. The document also provides legal notices regarding the licensing and use of the software.

Uploaded by

Qammar Abbas
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
297 views

Merge1 User Guide

This document is the user guide for Merge1 version 7.0.2305. It contains information about system requirements, installation, configuration, navigation, and using the various features of Merge1. The document also provides legal notices regarding the licensing and use of the software.

Uploaded by

Qammar Abbas
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 435

Copyright © 2023 Veritas Technologies LLC. All rights reserved.

User Guide
Version 7.0.2305

Merge1
Merge1 | User Guide

LEGAL NOTICE
The software described in this guide is furnished under a license agreement and may be used only in accordance
with the terms of the agreement.

Copyright © 2023 Veritas Technologies LLC. All rights reserved.

Veritas and the Veritas Logo are trademarks or registered trademarks of Veritas Technologies LLC or
its affiliates in the U.S. and other countries. Other names may be trademarks of their respective
owners.

This product may contain third-party software for which Veritas is required to provide attribution to
the third party (“Third-party Programs”). Some of the Third-party Programs are available under open
source or free software licenses. The License Agreement accompanying the Software does not alter
any rights or obligations you may have under those open source or free software licenses. Refer to
the Third-party Legal Notices document accompanying this Veritas product or available at:
https://www.veritas.com/about/legal/license-agreements.

The product described in this document is distributed under licenses restricting its use, copying,
distribution, and decompilation/reverse engineering. No part of this document may be reproduced in
any form by any means without the prior written authorization of Veritas Technologies LLC and its
licensors, if any.

THE DOCUMENTATION IS PROVIDED "AS IS" AND ALL EXPRESS OR IMPLIED CONDITIONS,
REPRESENTATIONS, AND WARRANTIES, INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT, ARE DISCLAIMED, EXCEPT TO THE
EXTENT THAT SUCH DISCLAIMERS ARE HELD TO BE LEGALLY INVALID. VERITAS TECHNOLOGIES LLC
SHALL NOT BE LIABLE FOR INCIDENTAL OR CONSEQUENTIAL DAMAGES IN CONNECTION WITH THE
FURNISHING, PERFORMANCE, OR USE OF THIS DOCUMENTATION. THE INFORMATION CONTAINED IN
THIS DOCUMENTATION IS SUBJECT TO CHANGE WITHOUT NOTICE.

The Licensed Software and Documentation are deemed to be commercial computer software as
defined in FAR 12.212 and subject to restricted rights as defined in FAR Section 52.227-19
"Commercial Computer Software - Restricted Rights" and DFARS 227.7202, et seq. "Commercial
Computer Software and Commercial Computer Software Documentation," as applicable, and any
successor regulations, whether delivered by Veritas as on-premises or hosted services. Any use,
modification, reproduction release, performance, display, or disclosure of the Licensed Software and
Documentation by the U.S. Government shall be solely in accordance with the terms of this
Agreement.

Veritas Technologies LLC


2625 Augustine Dr
Santa Clara, CA 95054
http://www.veritas.com

2
Merge1 | User Guide

CONTENTS
WELCOME TO MERGE1 .................................................................................................................................... 5
INTRODUCTION .................................................................................................................................................. 6
SYSTEM REQUIREMENTS .................................................................................................................................. 14

GETTING STARTED ......................................................................................................................................... 15


PREINSTALLATION CHECKLIST .......................................................................................................................... 16
PREINSTALLATION STEPS .................................................................................................................................. 17
INSTALLATION .................................................................................................................................................. 20
AGENT POOLS ................................................................................................................................................... 28
DATABASE CONFIGURATION ............................................................................................................................ 33

NAVIGATING TO MERGE1 .............................................................................................................................. 34


SIGNING IN ....................................................................................................................................................... 35
CONFIGURING THE SSO AUTHENTICATION ...................................................................................................... 38
NAVIGATION PANE ........................................................................................................................................... 55
ACCOUNT SETTINGS ......................................................................................................................................... 56

DASHBOARD .................................................................................................................................................. 58
DASHBOARD SECTION ...................................................................................................................................... 59
IMPORTER JOBS ................................................................................................................................................ 61

IMPORTERS.................................................................................................................................................... 63
AMAZON S3 ...................................................................................................................................................... 80
BLACKBERRY ..................................................................................................................................................... 81
BLOOMBERG .................................................................................................................................................... 83
BOX ................................................................................................................................................................... 91
CHATTER ........................................................................................................................................................... 96
CHATTER CIPHER CLOUD ................................................................................................................................ 104
CISCO WEBEX TEAMS ..................................................................................................................................... 106
CITRIX WORKSPACE & SHAREFILE ................................................................................................................... 113
CROWD COMPASS .......................................................................................................................................... 119
DB ................................................................................................................................................................... 121
DROPBOX BUSINESS ....................................................................................................................................... 124
EML................................................................................................................................................................. 129
EWS ................................................................................................................................................................ 131
EXCHANGE GRAPH API ................................................................................................................................... 148
FX CONNECT ................................................................................................................................................... 154
GOOGLE DRIVE ............................................................................................................................................... 157
ICECHAT .......................................................................................................................................................... 167
JABBER ENTERPRISE ....................................................................................................................................... 168
JSON ............................................................................................................................................................... 176
MICROSOFT TEAMS ........................................................................................................................................ 178
MICROSOFT TEAMS MEETINGS ...................................................................................................................... 192
MICROSOFT TEAMS VIA EXPORT API .............................................................................................................. 200
MICROSOFT TEAMS VIA WEBHOOKS .............................................................................................................. 213
ONEDRIVE FOR BUSINESS ............................................................................................................................... 227
PIVOT .............................................................................................................................................................. 235

3
Merge1 | User Guide

REDTAIL SPEAK ............................................................................................................................................... 237


REFINITIV ........................................................................................................................................................ 238
RINGCENTRAL ................................................................................................................................................. 241
SERVICENOW .................................................................................................................................................. 246
SHAREPOINT ................................................................................................................................................... 250
SKYPE FOR BUSINESS ...................................................................................................................................... 260
SLACK EDISCOVERY ......................................................................................................................................... 265
SYMPHONY ..................................................................................................................................................... 270
TEXT-DELIMITED ............................................................................................................................................. 275
TWITTER ......................................................................................................................................................... 280
UBS ................................................................................................................................................................. 282
WEB PAGE CAPTURE ....................................................................................................................................... 284
WORKPLACE FROM FACEBOOK ...................................................................................................................... 287
XIP .................................................................................................................................................................. 293
XSLT/XML ....................................................................................................................................................... 295
YAMMER ........................................................................................................................................................ 297
YIELDBROKER ................................................................................................................................................. 308
YOUTUBE ........................................................................................................................................................ 310
ZOOM CHAT.................................................................................................................................................... 321
ZOOM MEETINGS ........................................................................................................................................... 324
ZOOM MEETINGS CHATS ................................................................................................................................ 330
ZOOM MEETINGS VIA ARCHIVING API ............................................................................................................ 333
MONITORED USERS ........................................................................................................................................ 337
FILTERS ........................................................................................................................................................... 348
TARGETS ......................................................................................................................................................... 357
IMPORTER SETTINGS ...................................................................................................................................... 383

USERS & GROUPS ........................................................................................................................................ 391


REPORTS ...................................................................................................................................................... 395
OVERVIEW ......................................................................................................................................................... 396
MANAGING THE REPORTS..................................................................................................................................... 396

SETTINGS ..................................................................................................................................................... 403


BRANDING SETTINGS ................................................................................................................................... 409
LICENSING.................................................................................................................................................... 411
OVERVIEW ......................................................................................................................................................... 412

API CLIENTS ................................................................................................................................................. 415


MANAGING API CLIENTS ...................................................................................................................................... 416
MANAGING SECRETS............................................................................................................................................ 418
MANAGING JSON WEB KEYS ................................................................................................................................ 421

JOB MONITORING ........................................................................................................................................ 423


OVERVIEW ......................................................................................................................................................... 424
MANAGING JOB MONITORING............................................................................................................................... 426

APPENDIX .................................................................................................................................................... 428

4
WELCOME TO MERGE1

CHAPTER 1

Welcome to Merge1

This chapter represents:


• General Overview
• Document Version Control
• Sources
• System Requirements
Merge1 | User Guide
WELCOME TO MERGE1

INTRODUCTION

General Overview
Merge1 aids financial service firms in complying with SEC rule 17-a4, CFTC rule 1.31, Dodd-Frank
requirements, FINRA, and other regulatory agencies. It also greatly reduces legal risks by streamlining
the discovery of e-communications data, aiding organizations across all verticals with internal
investigations, lawsuits, and audits. Merge1 offers excellent compatibility with Microsoft Exchange,
Microsoft Office 365, and many other applications.

Merge1 is an internal cloud computing environment that is deployed and administered within a
private network. Internal cloud environments can be utilized anywhere within the same network by
several people on multiple machines simultaneously while demanding very few system resources.

Note
Merge1 collectors are designed to be deployed for scheduled ongoing capture runs. Even though
collectors can be run against older data for targeted discovery purposes, using Merge1 collectors to
migrate large amounts of data is not supported. The capture platform is not built as a migration tool
designed to run long term migration tasks with accompanying monitoring/reconciliation/reporting
features that are required for such a tool. Running tasks for long periods of time runs the risk of
failure to complete successfully.

6
Merge1 | User Guide
WELCOME TO MERGE1

Document Version Control


This section includes:
• May 1, 2023
• April 3, 2023
• March 6, 2023
• February 6, 2023
• January 2, 2023
• December 5, 2022
• November 7, 2022
• October 3, 2022
• September 5, 2022
• August 1, 2022
• July 4, 2022

May 1, 2023
The changes are represented in the table below:

Chapter/Section Changes
System Requirements/Software Requirements Added a note for software compatibility lists.
Getting Started/ Merge1 Upgrade Added a new section.
Configuring the SSO Authentication/JIT Added a new functionality.
Provisioning
Microsoft Teams via Export API/Activities Updated the list of captured activities.
Captured
Microsoft Teams via Export API/Requesting Updated the section.
Access to Protected APIs
Microsoft Teams via Export API/Enabling Added a new section.
Billing for Microsoft Teams APIs in Microsoft
Graph
Microsoft Teams via Webhooks/Requesting Updated the section.
Access to Protected APIs
Microsoft Teams via Webhooks/ Enabling Added a new section.
Billing for Microsoft Teams APIs in Microsoft
Graph
Yammer/Activities Captured Added new notes.
Monitored Users Updated the UI of the Monitored Users tab.
Monitored Users Updated the section.
Targets/Microsoft Office 365 EWS Target Updated the section.

7
Merge1 | User Guide
WELCOME TO MERGE1

April 3, 2023
The changes are represented in the table below:

Chapter/Section Changes
Cisco Webex Teams/Miscellaneous Settings Updated the section.
Microsoft Teams/Advanced Configuration Updated the section.
Options
Microsoft Teams via Export API/Advanced Updated the section.
Configuration Options
Microsoft Teams via Webhooks/Advanced Updated the section.
Configuration Options
Microsoft Teams via Export API/Activities Updated the list of captured activities.
Captured
Microsoft Teams via Export API/Threading and Updated the section.
Formatting
RingCentral/Advanced Configuration Options Updated the section.
ServiceNow/Advanced Configuration Options Updated the section.
Yammer/Advanced Configuration Options Updated the section.
YouTube/Advanced Configuration Options Updated the section.
Licensing/License Details Updated the User Interface.
Targets/Azure Blob Target Added a new target.

March 6, 2023
The changes are represented in the table below:

Chapter/Section Changes
Introduction/General Overview Added a note.
JSON Added a new collector.
Yammer/Activities Captured Updated the list of captured activities.
Yammer/Advanced Configuration Options Added new fields.
Zoom Chat Added a new collector.
Zoom Meetings/Activities Captured Removed a footnote.

February 6, 2023
The changes are represented in the table below:

Chapter/Section Changes
Microsoft Teams via Export API/Activities Updated the list of captured activities.
Captured

8
Merge1 | User Guide
WELCOME TO MERGE1

Microsoft Teams via Export API/Threading and Added a note about the message formatting.
Formatting
Zoom Meetings Chats Added a new collector.
Reports/Audit Added new event types.

January 2, 2023
The changes are represented in the table below:

Chapter/Section Changes
Getting Started/Preinstallation Checklist Updated the list of prerequisites.

Navigating to Merge1/Signing In Updated the section.

Signing In/Configuring SSO Authentication in Added the Signed Authentication Request to the
Merge1 SSO Authentication.
Microsoft Teams via Export API/Activities Updated the list of captured activities.
Captured
Microsoft Teams via Webhooks/Activities Updated the list of captured activities.
Captured
OneDrive for Business/Activities Captured Updated the list of captured activities.

Settings/Database Configuration Updated the section.

Job Monitoring/Filtering Importer Jobs Added a new section.

Reports/Audit Added new event types.

December 5, 2022
The changes are represented in the table below:

Chapter/Section Changes

Monitor Jobs Added a new section.


Microsoft Teams via Export API/Activities Updated the list of captured activities.
Captured
Microsoft Teams via Webhooks/Activities Updated the list of captured activities.
Captured
Zoom Meetings Removed JWT implementation.

9
Merge1 | User Guide
WELCOME TO MERGE1

November 7, 2022
The changes are represented in the table below:

Chapter/Section Changes

Navigating to Merge1/Signing In Updated the section.

Microsoft Teams Meetings/Target Audience Added a new section.

Microsoft Teams via Webhooks/Configuring Added a new section.


the Microsoft Teams via Webhooks Collector
OneDrive for Business/Activities Captured Updated the list of captured activities.

Targets/EWS Server Target Added a new field.

October 3, 2022
The changes are represented in the table below:

Chapter/Section Changes

Exchange Graph API Added a new collector.


Dashboard Added ability to customize the day ranges.
Microsoft Teams Meetings/Activities Captured Updated the list of captured activities.

Microsoft Teams Meetings/Areas to Capture Updated the list of captured activities.


Microsoft Teams via Webhooks/Configuring Removed Model B.
the Microsoft Teams via Webhooks Collector
XSLT/XML/Activities Captured Updated the list of captured activity.
Monitored Users Updated the list of collectors.
Users&Groups Updated the UI.

September 5, 2022
The changes are represented in the table below:

Chapter/Section Changes

Signing In /Configuring SSO Authentication Added a new authentication method.


SharePoint/Attachments Configuration Added Attachments Configuration option.
Microsoft Teams via Webhooks/Activities Updated the list of captured activities.
Captured
Microsoft Teams via Export API/Activities Updated the list of captured activities.
Captured
Jive Removed the collector.

10
Merge1 | User Guide
WELCOME TO MERGE1

August 1, 2022
The change is represented in the table below:

Chapter/Section Changes

Getting Started/Preinstallation Checklist Updated the list of prerequisites.

Box/Advanced Configuration Options Added Do not download data modified after


option.
Citrix Workspace & ShareFile/Activities to be Added Edit activity to the list.
Processed
Merge1 File-Based Collector Options/PGP Removed PGP key generation functionality.
Configurations
Bloomberg/SSH Key Authentication Removed SSH Key generation functionality.

EML/SSH Key Authentication Removed SSH Key generation functionality.

IceChat/SSH Key Authentication Removed SSH Key generation functionality.

Redtail Speak/SSH Key Authentication Removed SSH Key generation functionality.

Symphony/SSH Key Authentication Removed SSH Key generation functionality.

Microsoft Teams via Export API/Configuring Captured Modern Attachment has been added to
the Collector in Merge1 the Attachments Configuration section.
Microsoft Teams via Export API/Configuring Updated the list of captured activities.
the Collector in Merge1
MobileGuard Removed the collector.

July 4, 2022
The changes are represented in the table below:

Chapter/Section Changes

Importers/Merge1 File Based Added Azure Storage to the file sources.


Collector Options
Microsoft Teams Meetings Added a new collector.

Twitter/Source Configuration Added new sections to the source configuration.

OneDrive for Business/Configuring the Include original data as the attachment has been
Collector in Merge1 moved to the Attachments Configuration section.

11
Merge1 | User Guide
WELCOME TO MERGE1

Microsoft Teams via Export Include original data as the attachment has moved to
API/Configuring the Collector in Attachments Configuration section.
Merge1
Microsoft Teams via Export Added Splitting messages section.
API/Configuring the Collector in
Merge1

12
Merge1 | User Guide
WELCOME TO MERGE1

Sources
Merge1 collects data from an array of e-communication media.
New sources are frequently being added, feel free to contact Veritas Technologies LLC Support for
new additions or requests.

Please note that files and attachments, greater than 2 GB are not being processed.

13
Merge1 | User Guide
WELCOME TO MERGE1

SYSTEM REQUIREMENTS

Minimum Hardware Requirements


• 2.4 GHz 64-bit quad-core processor
• 16 GB RAM
• 1 GB hard-disk space

Having more processor cores will ensure adequate performance in instances where multiple
importers are consistently being run simultaneously.

Software Requirements
For Merge1 Web Servers:
• Internet Information Services 8.0 or higher
• SQL Server 2014 or later
• .NET Framework 4.8

For Merge1 Agent Servers:


• .NET 6.0 Runtime
• ASP.NET Core 6.0 Runtime

Please ensure to consult the latest version of the Merge1 Compatibility Chart for information on all
supported components including OS and SQL available at
https://www.veritas.com/support/en_US/doc/Merge1_7.0_CompatibilityCharts.

Important Notes

• Merge1 Web Services and Agent VM must be on the same time zone.
• Any path that is used for Merge1 should be visible to the Agent

14
GETTING STARTED

CHAPTER 2

Getting Started
This chapter represents:
• Preinstallation Checklist
• Installation
• Database Configuration
• Signing In
• Activating a License
Merge1 | User Guide
GETTING STARTED

PREINSTALLATION CHECKLIST
Merge1 utilizes port 443 on the host machine for network distribution as well as OAuth pull calls to
ensure that it is not occupied by another application. The default ports used for SSH Authentication
by Bloomberg and IceChat are 30206 and 22, respectively. The default FTP port for any Source is 21.
Microsoft Internet Explorer versions 8 and below will not properly display some elements of the user
interface and should not be used. Merge1 will never prompt you to update your browser.

Ensure that all the hardware and software requirements are met:

• 2.4 GHz or faster quad-core processor with at least 16 GB RAM and 1 GB hard-disk space
• Windows Server 2016 or later, x64-based
• Internet Information Services 8.0 or higher (see Installing Internet Information Services)
• SQL Server 2014 or later
• .NET Framework 4.8 (see Verifying .Net Framework Requirements)
• NET 6.0 Runtime
• ASP.NET Core 6.0 Runtime

Please ensure to consult the latest version of the Merge1 Compatibility List for information on all
supported components including OS and SQL available at
https://www.veritas.com/support/en_US/doc/Merge1_7.0_CompatibilityCharts.

Ensure that all relevant Target requirements are met:

• EV Targets:
- Veritas Enterprise Vault 12.1 up to 14.3
- Enterprise Vault API Runtime 12 or 14 (on the Merge1 host)
• EWS Targets:
- Microsoft Exchange Server 2007 SP1, 2010 (GA – SP3), 2013, 2016, and 2019
• SMTP Targets:
- Microsoft Exchange Server 2003, 2007, 2010, 2013, 2016, and 2019

Notes
• You can acquire the username and password of the administrator account on the host
machine.
• Make a note of the address and authentication parameters of the SQL server that will host
Merge1's databases.
• Acquire an SSL certificate (see Creating a Self-Signed Certificate in the PREINSTALLATION
STEPS).
• All processes, services, and folder paths (the installation path and paths specified in the
collector settings) related to Merge1 should be added to the exclusion list of the antivirus
software, if there is one installed on the machine.

Service Account Permissions


The service account used to run Merge1 should have the following permissions on the Merge1 server:
• Local Administrator (must be a member of the Administrators’ group)
• Log on as Service rights
• Log on as a batch job right

16
Merge1 | User Guide
GETTING STARTED

PREINSTALLATION STEPS
Installing Internet Information Services
To install Internet Information Services on Windows Server 2012 and later versions:
1. Click Start > Administrative Tools > Server Manager.
2. On the left panel of the Server Manager dialog box, click Roles.
- If IIS has not been enabled, click Add Roles on the Roles Summary panel. Click Next
and enable Web Server (IIS) on the list. Then, click Next and select Role Services in
the left panel.
- If IIS is already enabled, but not all required components have been enabled, click
Add Role Services in the Web Server (IIS) panel on the right.
3. On the Select Role Services dialog box, verify that the web server components listed below
are enabled.
4. After enabling the required IIS components, click Next > Install.

Web Server
▪ Common HTTP features
- Default document
- Static content

▪ Security
- Basic authentication
- Request Filtering
- Windows authentication

▪ Application Development
- All .NET extensibility components
- All ASP.NET components
- ISAPI extensions
- ISAPI filters

• Web Management Tools


- IIS management console
- IIS 6 management compatibility
- Metabase and IIS 6 configuration compatibility
- IIS management scripts and tools
- IIS management service

To install Internet Information Services:


1. Open the Control Panel and click Programs and Features > Turn Windows features on or off.
2. Enable Internet Information Services.
3. Expand the Internet Information Services feature and verify that the web server components
listed below are enabled and click OK.

17
Merge1 | User Guide
GETTING STARTED

Verifying .Net Framework Requirements


Internet Information Services must be installed before installing .NET Framework 4.8 for all the
necessary framework components.

To verify the .NET Framework version 4.8:


1. Open Windows PowerShell and enter the Get-ItemProperty
"HKLM:\SOFTWARE\Microsoft\NET Framework Setup\NDP\v4\Full" command.

Figure 1: .NET Framework Features

Application pools can be viewed in IIS Manager. If the .NET v4.8 and .NET v4.8 Classic application
pools do not appear on the list, please reinstall, or repair .NET Framework 4.8 after installing Internet
Information Services.

Creating a Self-Signed Certificate


To create a self-signed certificate:
1. In Internet Information Services (IIS) Manager, click the name of the host machine in the
Connections pane on the left, then double-click Server Certificates.

Figure 2: Self-Signed Certificate

2. In the Actions column to the right, click Create Self-Signed Certificate.

18
Merge1 | User Guide
GETTING STARTED

Figure 3: Creating a Self-Signed Certificate

3. Specify a name and click OK and on the next window, select your certificate from the list and
click Export in the Actions column to the right.

Figure 4: Exporting Certificate

4. Specify an export location and password, then click OK.

Figure 5: Exporting Certificate Form

The certificate location and password must be provided when installing Merge1.

19
Merge1 | User Guide
GETTING STARTED

INSTALLATION
Starting from version 7.0, Merge1 comes up with two installers – Merge1 7.0 Setup and Merge1
Agent MSIs. Note that both should have the same version.

Merge1 Setup
To install Merge1:
1. Run the Merge1 7.0 Setup installer with administrator permissions and click Next.

Figure 6: The Setup Wizard

2. Read and accept the End-User License Agreement by scrolling down.

Figure 7: End User License Agreement

3. Select the feature and click Next.

20
Merge1 | User Guide
GETTING STARTED

Figure 8: Selecting Features

4. Specify an SMTP host and click Next.

Figure 9: Specifying an SMTP Host

The Sender Email will appear in the From field when a confirmation email is sent to new users or
when passwords are reset.

5. Click Next. Merge1 will automatically fetch the Host IP.

21
Merge1 | User Guide
GETTING STARTED

Figure 10: Specifying the local IP Address

6. Enter the Username and Password of the administrator account of the host machine and
specify the SSL certificate path and password. Make a note of the Host URL - this URL is
needed to access the Merge1 platform, then click Next.

Figure 11: Specifying Merge1 Options

7. Enter the name of your organization and click Next.

22
Merge1 | User Guide
GETTING STARTED

Figure 12: Specifying Invitation Email Variables

The Provider Name may be changed to assign a unique name to an environment (useful when
multiple environments are deployed within the same network, i.e., Merge1 HR, Merge1 PR, etc.

8. Click Install to begin the installation. The installation window will open.

Figure 13: Ready to Install Merge1

9. Click Finish to close the Merge1 Setup window.

23
Merge1 | User Guide
GETTING STARTED

Figure 14: Installation Process Completed

You will have a 30-day free trial license period after the installation. Then, contact us to prolong the
license.

After Merge1 installation, it is recommended to reset the IIS via PowerShell as an administrator.

Merge1 Agent
To install Merge1 Agent:
1. Run the Merge1 Agent installer and click Next.

Figure 15: Merge1 Agent - Setup

2. Read and accept the End-User License Agreement by scrolling down and clicking Next.

24
Merge1 | User Guide
GETTING STARTED

Figure 16: End-User License Agreement

3. Click Next to install to this folder or click Change.

Figure 17: Selecting the Destination Folder

4. Click Install.

Figure 18։ Custom Setup

When the installation is completed, the Merge1 Agent folder will be in C:\Program
Files\Veritas Technologies LLC. For more information on how to manage Agent Pools, see
AGENT POOLS.

25
Merge1 | User Guide
GETTING STARTED

Merge1 Upgrade
Uninstall all previous versions of Merge1 before version 6.21.2203 prior to attempting to install
version 7.0 and later versions.

Before the installation of a newer version:


• In case your Merge1 version is earlier than 6.17.1129:
1. Uninstall it and install Merge1 v. 6.21.2203.
2. Update the database.
3. Upgrade the Merge1 version to 7.0.

• In case your Merge1 version is between 6.17.1129 and 6.21.2202:


1. Upgrade Merge1 to 6.21.2203.
2. Update the database.
3. Upgrade the Merge1 version to 7.0.

To upgrade Merge1 web services:


1. Stop all collectors that are in progress. If they are importing, wait for them to finish the
import and then stop them.
2. Take a backup of the Merge1 DB.
3. Take a snapshot from the Merge1 hosting VM.
4. Run the Merge1 Installer file.
5. Connect the same database if asked.

To upgrade Merge1 Agent:


1. Disable the agent.

Figure 19: Disabling the Agent

2. Run the Merge1 Agent installer.


3. Go to Services and turn on Merge1 Agent.

26
Merge1 | User Guide
GETTING STARTED

Figure 20: Starting Merge1 Agent Services

In case the database is not updated, the user will have to create a new database for Merge1 version
7.0.

27
Merge1 | User Guide
GETTING STARTED

AGENT POOLS
This section describes agent pools and agents which can execute a particular Import Job.
The Agent Pool is a virtual/logical container for one or multiple Agents.

The Agent is the component that executes Jobs. When a job execution request is queued, the Agent
manager selects an agent from the pool and sends the job request to the agent. For an agent to get
elected by the manager, it must meet certain conditions:

• It must be on the same version of Merge1 Web


• It must be online and enabled
• It must be idle or have the capacity1 to execute a job

Note
Each agent must be registered in Merge1 Web and Agent Pool by the user. All jobs are assigned to the
default agent pool.

Managing Agent Pools


This section represents how agents are registered, started, configured, and deleted/unregistered.

Figure 21: Agent Pools

In the Agent Pools section of the Navigation Pane, the following information is available:
• Name. The name of the Agent Pool.
• Agent Count. The count of the agents in the specific pool.

Note that an Agent Pool cannot be added. Only Default Agent Pool is available for managing agents.

Registering an Agent
1. Open the Merge1 Agent folder from C:\Program Files\Veritas Technologies LLC
folder in Windows PowerShell as an administrator.

1
The capacity is set by the user during agent registration.

28
Merge1 | User Guide
GETTING STARTED

Figure 22: Opening Windows PowerShell

1. In PowerShell, type the following command to unblock the possible blocked files:
dir -Path ./ -Recurse | Unblock-File
2. Use the following command to register an Agent:
./agentConfigurator.exe register -u "<Portal>" -i "<ApplicationID>" s"<ClientSecret>" -a
"<AgentName>"
3. Make sure to set the following variables in the command:
a. -u "<Portal>". The Merge1 instance URL. You can find it in
</Merge1_installation_directory/Globanet Consulting
Services\Merge1 7.0 >. 1
b. -i "<ApplicationID>". The application ID of the created application in API
Clients (see Adding a New Application).
c. -s "<ClientSecret>". The secret of the above-used application copied and saved
priorly (see Adding a Secret).
d. -a "<AgentName>". The agent name.

Figure 23: Registering an Agent

1 In case of Merge1 version 6.0, the path will be \Merge1 Installation Directory\Globanet Consulting Services\Merge1 6.0\.

29
Merge1 | User Guide
GETTING STARTED

-c <capacity>. Defines the maximum capacity of parallel jobs that an Agent


should execute.
<PoolName>. Specify the name of the pool under which the agent should be
registered.
--serviceUsername. Windows Service logs on account username.
--servicePassword. Windows Service log-on account password.
--autostart. Windows Service start behavior.
--sslNoVerify. Use this command to skip SSL validation both for the configurator
and the agent.

Starting an Agent
The Agent can be started in two ways:
1. If the --noservice command was used during an Agent registration, type the following
command to start the Agent (see the above section for Agent registration):

Figure 24: Starting an Agent

• The port is not a required parameter. By default, the port is 55222.


• Make sure the port is not busy when using it for starting an Agent.
2. If the --noservice command was not used during an Agent registration, a windows service
will be created after registration. In this case, an Agent will be started/stopped using the
Services app.

Figure 25: Starting an Agent in Services

30
Merge1 | User Guide
GETTING STARTED

To open the Services app, click Windows Start, and type Services.

Figure 26: Agent Registration

Configuring an Agent
1. Click Default Agent Pool and the Agent Pool details page will open.

Figure 27: Agent Details

It consists of the following columns:


• Name. The name of the Agent.
• Capacity. The maximum number of parallel jobs that the Agent should execute.
• Running Job. The number of ongoing jobs that the Agent is executing.
• Version. The Agent version.
• Database Version. Merge1 database version.
• Status. The status of the Agent:
o Online. The Agent is up and can receive commands.
o Offline. The Agent is down and cannot receive commands.
• Actions:
o Edit. Agent name and capacity can be edited.
o Delete. See Deleting/Unregistering an Agent.
o Enable/Disable.

Figure 28: Editing an Agent

Note that when an Agent is online, but it is disabled, it will not run a job.

2. Click the Expand button left to the Agent name to see the following additional information
(Figure 29):
• InstalledMemoryDB. Shows the actual memory available for an Agent job.

31
Merge1 | User Guide
GETTING STARTED

• ProcessorCount. Shows the available resources on an Agent server. This is the number of
logical processors of the CPU installed on the Agent server.

Figure 29: Default Agent Pool Details

Deleting/Unregistering an Agent
An Agent can be deleted/unregistered in two ways:
1. Deleting an Agent from the Agents grid.
a. Go to Agent Pools > Default Agent Pool.
b. Click the Delete button under Actions and the Agent will be deleted.
2. Unregister an Agent using a command line.
a. Stop the Agent from the Windows Services App, or in Windows PowerShell (Ctrl + c) if
it is registered with the --noservice flag.
b. Use the following command to unregister the Agent:

./agentConfigurator.exe unregister

32
Merge1 | User Guide
GETTING STARTED

DATABASE CONFIGURATION
To access the Merge1 portal, use the shortcut in the Start Menu or use the Merge1 Host URL from
the installation wizard using a web browser of your choice. Merge1's configuration settings will
appear.

Figure 30: Database Configuration

Note
Never attempt to access or administer Merge1 using localhost in place of the URL as callback
functions will not work properly, and critical errors may occur.

To manage database configuration, see SETTINGS.

33
NAVIGATING TO MERGE1

CHAPTER 3

Navigating to Merge1

This chapter represents:


• Navigation Pane
• Account Settings
Merge1 | User Guide
NAVIGATING TO MERGE1

SIGNING IN
The starting screen of the Merge1 is the Login Screen. It serves as a gateway to viewing and modifying
the data in the application.

To sign in to Merge1:
1. Navigate to the Start Menu shortcut to access the Merge1 portal.

For enhanced security, it is recommended disabling spell-checking (also known as Writing


Assistance in Microsoft Edge) in your web browser.

2. Select the Authentication Method from the drop-down list:


• Merge1 Authentication
• Windows Authentication
• Single Sign-On with SAML 2.0

By default, only the Merge1 Authentication and Windows Authentication options are available as
Authentication Types to select at the time of login. The Single Sign On (SSO) option will become visible
in the drop-down list after CONFIGURING THE SSO AUTHENTICATION.

For Merge1 Authentication, sign in using the following credentials:


• Email: [email protected]
• Password: a

The password should be changed after entering the temporary password.

Figure 31: Login Screen

For Windows Authentication, add an account from the domain where Merge1 is hosted. Use the SAM
account name in the Username field.

• Username: exampledomain.com\admin
• Password: <user’s password>.

To log in with Windows Authentication, you should have already selected an AD user. For more
information, see Select an AD User Account (Recommended per industry best practice).
The AD user must have login access to the Merge1 Server, to login into the Merge1 Portal using the
Windows Authentication mode.

35
Merge1 | User Guide
NAVIGATING TO MERGE1

Figure 32: Windows Authentication

For Single Sign-On with SAML 2.0, see CONFIGURING THE SSO AUTHENTICATION.

Password Recovery
The system is designed to provide the functionality of retrieving user passwords in case of forgetting
or for some other reason. Passwords are retrieved through the identification link sent to the user’s
email address contained in the user profile. When a user clicks the link in the email, the user identity
will be verified, and an opportunity for defining new password will be provided.

You CANNOT recover the password of [email protected].

To recover the password:


1. Click the Forgot Password link in the Sign-in window.
2. Provide the email used for signing in to the Merge1 account so that the recovery link is sent
to this address.

Figure 33: Password Reset

36
Merge1 | User Guide
NAVIGATING TO MERGE1

3. Check your email and click the recovery link.


4. Provide a new password and re-enter it for verification.

Figure 34: Password Reset

Password requirements:
• Minimum length of 12 characters.
• Combination of upper and lowercase letters, numbers, and symbols.

Upon logging in for the first time, navigate to the Licensing section for licensing (see LICENSING).

37
Merge1 | User Guide
NAVIGATING TO MERGE1

CONFIGURING THE SSO AUTHENTICATION


This section describes managing Merge1 authentication types.

Figure 35: SSO Authentication Configuration

Below are described all the steps for configuring Okta (IDP) and Microsoft Azure Application, but you
can use any Identity provider's service that supports SAML 2.0.

Configuring the SSO Authentication via Microsoft Azure


Application
To configure the SSO authentication via Microsoft Azure, the admin should:
1. Create an enterprise application
2. Assign the application to a User
3. Obtain the Metadata URL value
Or,
4. Obtain the Metadata Content Value

Creating an Enterprise Application


To use Single Sign-On as an Authentication method, an Enterprise Application on Microsoft Azure
should be created.
1. Go to Azure Portal using admin role credentials.
2. Click Enterprise applications under Azure services.

38
Merge1 | User Guide
NAVIGATING TO MERGE1

Figure 36: Enterprise Applications

3. Click +New registration.

Figure 37: Creating a New Application

4. Click +Create your own application.

Figure 38: Creating Your Own Application

5. Enter a Name for the application and click Create.

39
Merge1 | User Guide
NAVIGATING TO MERGE1

Figure 39: Naming the Application

6. Under Getting Started, select Set up single sign-on.

Figure 40: Selecting Single Sign on

7. Select SAML as a single sign-on method.

Figure 41: Selecting SAML

8. Click Edit to add the Identifier (Entity ID) and Reply URL (Assertion Consumer Service
URL) from the Merge1 portal Authentication section.

40
Merge1 | User Guide
NAVIGATING TO MERGE1

Figure 42: Editing SAML

9. Go to Merge1 Authentication and enable the Single Sign-On (SSO) With SAML 2.0
checkbox. The SAML 2.0 Configuration section opens.
10. Under the Metadata URL option in the Merge1 Authentication section:
a. Copy the value of Entity ID and provide it as an Identifier (Entity ID) in the Microsoft
Azure application.
b. Copy the value of SSO URL and provide it as a Reply URL (Assertion Consumer Service
URL) in the Microsoft Azure application.
11. Click Save.

Assigning the Application to a User


1. Go to Users and groups and select +Add user/group.

Figure 43: Navigating to Users and Groups

2. Click None Selected under Users and groups, select the user, and click Assign.

41
Merge1 | User Guide
NAVIGATING TO MERGE1

Figure 44: Users and Groups

The assigned user details will appear on the Users and groups page.

3. Make sure the user is also created in Merge1.

Obtaining the Metadata URL Value

1. Scroll down to SAML Certificates on the same Single sign-on page.


2. Copy the App Federation Metadata Url and provide it to Merge1 in case of
configuring SSO by Metadata URL.

Figure 45: Obtaining the Metadata URL Value

Obtaining the Metadata Content Value


1. Scroll down to SAML Certificates on the same Single sign-on page.
2. Download the Federation Metadata XML. Copy the XML file content and provide it to
Merge1 in case of configuring SSO by Metadata Content.

42
Merge1 | User Guide
NAVIGATING TO MERGE1

Figure 46: Obtaining the Metadata Content Value

Configuring the SSO Authentication via OKTA


To configure the SSO authentication via OKTA, the admin should:
1. Create an application integration
2. Assign the application to people
3. Obtain the Metadata URL value
Or,
4. Obtain the Metadata Content value

Creating an Application Integration


To use Single Sign-On as an authentication method an Application Integration on Okta (IDP) should be
created.
1. Login in with your business account and select Applications > Applications from the left-side
Navigation Pane.

Figure 47: Navigating to Applications

2. Click Create App Integration.

43
Merge1 | User Guide
NAVIGATING TO MERGE1

Figure 48: Creating App Integration

3. Select SAML 2.0 and click Next.

Figure 49: Selecting SAML 2.0

4. Provide an App name and click Next.

Figure 50: Providing App Name

5. Go to Merge1 > Authentication.

44
Merge1 | User Guide
NAVIGATING TO MERGE1

Figure 51: Navigating to Authentication

6. Copy the value of the SSO URL and paste it as a Single sign-on URL in the Okta application.
7. Copy the value of Entity ID and paste it as Audience URI (SP Entity ID) in the Okta application.
8. In the Okta application, scroll down to Attribute Statement (optional).

Figure 52: Attribute Statements

9. Provide the http://schemas.xmlsoap.org/ws/2005/05/identity/claims/name


URI for Name, select URI Reference as a Name format, and user. login as a Value.
10. Click Add Another and provide
http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress for
Name, select URI Reference as a Name format and user.email as a Value.

45
Merge1 | User Guide
NAVIGATING TO MERGE1

Figure 53: Entering Statements

11. Click Next, select I'm a Software vendor, and then click Finish.

Assigning the Application to People

1. Go to Directory > People and select Add person.

Figure 54: Navigating to Assigning People

2. Provide First name, Last name, and Username, and click Save.
3. Click Activate Person and go by the link sent to the email for confirmation.

Figure 55: Activating Person

46
Merge1 | User Guide
NAVIGATING TO MERGE1

4. Go to Applications > Applications and select the application that was created.

Figure 56: Assigning People

5. Go to Assignments > Assign > Assign to People.

Figure 57: Navigating to Assign to People

6. Select the user and click Done.

Figure 58: Assigning People

47
Merge1 | User Guide
NAVIGATING TO MERGE1

Obtaining the Metadata URL Value


1. Go to Applications > Applications and select Sign On.

Figure 59: Navigating to Sign On

2. Scroll down to SAML Signing Certificates.


3. Find the certificate with an active status.
4. Click in Actions > View IDP metadata.

Figure 60: Navigating to View IDP Metadata

5. The metadata URL will be opened in a new tab. Copy and save it for later use in case of
configuring SSO via Metadata URL.

Figure 61: Copying Metadata URL

48
Merge1 | User Guide
NAVIGATING TO MERGE1

Obtaining the Metadata Content Value


1. Go to Applications > Applications and select Sign On.

Figure 62: Navigating to Sign On Page

2. Scroll down and click View SAML Setup Instructions.

Figure 63: View SAML Setup Instructions

3. Copy the IDP metadata and save it for later use in case of configuring SSO via Metadata
Content.

Just-In-Time Provisioning (JIT)


Just-in-time user provisioning (JIT provisioning) allows users to be created and updated automatically
when they log in through SAML SSO.

Creating an App Role for JIT User Provisioning


Before enabling Just-In-Time User Provisioning in the Merge1 portal, a role must be created in Azure
and assigned to the given user by following the steps below.
1. Find your SAML/SSO App in Azure AD App Registrations and click App roles.
2. Click Create app role.

49
Merge1 | User Guide
NAVIGATING TO MERGE1

Figure 64: Navigating to App Roles

3. Populate the following fields:


• Display name
• Allowed member types - Users/Groups
• Value - Enter M1_Administrator for the Merge1 Admin role and M1_Reviewer for the
Merge1 Reviewer role.
Note
Only M1_Administrator and M1_Reviewer values are supported for the Merge1 SSO in
case Enable Just-In-Time User Provisioning (Azure AD Only) is activated.
• Description.
• Keep Do you want to enable this app role box checked.
• Click Apply.

Figure 65: Creating App Role

Assigning a Role to the User


1. Navigate to the Enterprise Applications page to assign the role to the user.
2. Click Add user/group.

50
Merge1 | User Guide
NAVIGATING TO MERGE1

3. Select the User or Group, a respective role to the user/group, and click Assign.

Figure 66: Assigning a Role to the User

Enabling JIT User Provisioning


Navigate to the Merge1 Authentication section, check Enable Just-In-Time User Provisioning (Azure
AD Only) and click Save.

Figure 67: Enabling JIT User Provisioning

1. Sign in with SSO on the login page, authenticate with the user which is assigned to the Azure
app and the user will be automatically created in the Users and Groups section with a role
that you have provided in Azure.

Note
The role cannot be changed from Merge1. If you want to change the role for the JIT user, you
need to change it in Azure. Next time, when the user is signed in to Merge1, the role would
be already changed.

2. Check it by navigating to the Merge1 Users & Groups section and clicking the edit button next
to the user.

51
Merge1 | User Guide
NAVIGATING TO MERGE1

Figure 68: Updating the User

Configuring SSO Authentication in Merge1


Open the Authentication section from Navigation Pane.

Figure 69: Single Sign-On (SSO) with SAML 2.0

When enabling Single Sign-On (SSO) with SAML 2.0, the SAML 2.0 Configuration opens. The user can
select configuring SSO either via Metadata URL or Metadata Content.

To configure the SSO via Metadata URL:


1. Select Metadata URL under SAML 2.0 Configuration.
2. Enter the copied Metadata URL in the Metadata URL field in case of using an Okta Application
for SSO.
Or,
3. Enter the copied Metadata URL in the Metadata URL field in case of using a Microsoft Azure
Application for SSO.

52
Merge1 | User Guide
NAVIGATING TO MERGE1

Figure 70: Metadata URL

4. Click Save. The Single Sign-On (SSO) option will become visible in the Authentication method
drop-down list.

To configure SSO via Metadata Content:


1. Select Metadata Content under SAML 2.0 Configuration.
2. Provide the copied IDP metadata in the Metadata Content field in case of using an Okta
Application for SSO.
Or,
3. Provide the copied IDP metadata in the Metadata Content field in case of using a Microsoft
Azure Application for SSO.

Figure 71: Metadata Content

4. Enable Signed Authentication Request to sign in using the X.509 Certificate.


5. Provide X.509 Certificate Thumbprint in case you activate the Local machine radio button as
the X.509 Certificate source.

Figure 72: Providing Credentials

6. In case you activate Upload file (*.pfx), click the Select button to upload the certificate and
then provide X.509 Certificate Password.
7. Check Enable Just-In-Time User Provisioning (Azure AD Only). For more information see Just-
In-Time Provisioning (JIT).

53
Merge1 | User Guide
NAVIGATING TO MERGE1

Figure 73: Enable Just-In-Time User Provisioning (Azure AD Only)

8. Click Save. The Single Sign-On (SSO) option will become visible in the Authentication method
drop-down list.

54
Merge1 | User Guide
NAVIGATING TO MERGE1

NAVIGATION PANE
The UI of Merge1 consists of two parts: Main screen and Navigation Pane. You can easily switch
between the different sub-sections of the software through the Pane. Merge1 Navigation Pane
consists of the following shortcuts:

DASHBOARD
Here you can view all the statistical and logistical information about your Merge1 activities.

IMPORTERS

Here you can connect or remove company-relevant Importers, configure targets, and set
filters.

USERS & GROUPS

Here you can view the basic information of all the users and groups who can log in to the
company’s Merge1 account.

REPORTS

Here you can export Audit reports of each collector in a PDF or CSV format.

SETTINGS
Here you can view and/or customize the database, audit, proxy, and authentication
configurations, as well as manage Message settings.

BRANDING SETTINGS
Here you can make Merge1 on your own!

LICENSING

Here you can activate a license and view the version of your Merge1.

API CLIENTS
Here client applications can have access to the Merge1 API.

AGENT POOLS

Here are Agent Pools available for running Importers.

AUTHENTICATION
Here Merge1 authentication types can be configured.

JOB MONITORING
Here Merge1 import jobs can be monitored.

55
Merge1 | User Guide
NAVIGATING TO MERGE1

ACCOUNT SETTINGS
On the top right corner of the Main Screen, you can find your Account Settings which allows
modifying your account default settings.

Figure 74: Account Settings

To view your user Account Settings, click next to your username. A pop-up window will open. Click
ACCOUNT INFORMATION.

On the Account Information page, you can modify your default User Information, as well as change
your password configurations. The following settings refer solely to your personal account and have
no connection with general Merge1 Settings.

The Account Information section consists of two parts: User Information and Change Password.

Figure 75: Account Information

User Information
To edit the user information:
1. Update your account First Name and Last Name fields when needed.
2. Update phone/mobile number when necessary.
3. Click the SAVE button in the User Information section.

Note that the E-Mail or UPN fields are not editable.

56
Merge1 | User Guide
NAVIGATING TO MERGE1

Logging Out
To log out from your Merge1 Account, click next to your username and then click the SIGN OUT
button.

Changing the Password


To change the password:
1. Enter the current password in the Old Password field.
2. Enter the new password in the New Password field.
3. Re-enter the new password in the Re-type field.
4. Click the SAVE under the Change Password section.

Once you have made all the relevant changes, click SAVE.
Please note that your account information will be visible to everyone on your company’s Merge1
account.

57
DASHBOARD

CHAPTER 4

Dashboard
This chapter represents:
• Managing Dashboard Section
• Managing Importer Jobs
Merge1 | User Guide
DASHBOARD

DASHBOARD SECTION
The Merge1 Dashboard provides interactive visual modules that represent statistical and logical
information about your Merge1 activity.

Figure 76: Dashboard Section

Merge1 Dashboard consists of four screens:


1. Importer Jobs
2. Monitored Users by Source
3. Messages Proceeded by Merge1
4. Number of Messages by Importer

You can view the details of each job, user, or messages by hovering the mouse over the job you want,
and you will see the details of it.

Figure 77: Viewing the Details

You can download the information included in the Messages Proceeded by Merge1 and Number of

Messages by Importer in PDF, JPG, PNG or SVG formats by clicking the button. A pop-up list of
available formats will open.

59
Merge1 | User Guide
DASHBOARD

Figure 78: Downloading Dashboard

Select the format and the dashboard of the messages by Merge1 or the number of messages by
importers will be downloaded to your local PC.

60
Merge1 | User Guide
DASHBOARD

IMPORTER JOBS
The paragraphs that follow will describe how you can browse and set the number of entries per page
in the importer jobs.

Exporting to CSV
This section allows the user to export the dashboard for:
• The specified importer by selecting the collector from the Collectors list drop-down list
• The specified date range by selecting FROM and TO dates from the calendar

Figure 79: Exporting to CSV

Browsing Importer Jobs


This sub-section has been enhanced with the pagination option. This means that it is enabled with the
possibility of splitting the list of records in the sub-section into pages for paged navigation.

Figure 80: Browsing Importer Jobs

61
Merge1 | User Guide
DASHBOARD

Setting the Number of Entries per Page


By default, each sub-section is set to display 20 entries per page to ensure fast page loading.
However, you can define to view a lower/greater number of entries per page.

Figure 81: Setting the Number of Entries per Page

62
IMPORTERS

CHAPTER 5

Importers
This chapter represents:
• Importers
• File-Based Collector Options
• Configuration Wizard
• Monitored Users
• Filters
• Targets
• Importer Settings
Merge1 | User Guide
IMPORTERS

Overview
The Importers section allows you to add, connect or remove company relevant importers, configure
targets, and set filters.

Figure 82: Importers Section

Each importer has its own configuration options:


• Clone, edit, rename, and delete importers
• Schedule, start/stop imports
• Add, edit, and delete collectors/ monitored users /filters /targets
• Retry failed items
• Delete data
• Rename components

Importer Panels
Merge1 importer panel is comprised of the following components:
• COLLECTORS (SOURCES). Contains general information about the collector and how to
manage it.
• MONITORED USERS. Contains information about all the users of the collector and its
configurations.
• TARGETS. Allows setting up where the collector information should be is sent.
• IMPORTER SETTINGS. Helps to configure settings to load filtered data to the destination
target.

You can also:


1. Drag importer panels to re-arrange their order in the Merge1 GUI.
2. Double-click the top part of the importer panel and the importer will collapse.

64
Merge1 | User Guide
IMPORTERS

Adding a New Importer


As a first-time user, you will see a blank page to get started.

Figure 83: Getting Started

To add a new importer:


1. Click Get Started. A configuration wizard of adding a new importer will appear (the same
wizard will open when clicking Add Importer on the top left corner.

Figure 84: Adding an Importer

2. Fill in the Name and the Description fields and click NEXT. The next wizard will open where
you can find all the sources provided by Merge1.

65
Merge1 | User Guide
IMPORTERS

Figure 85: Selecting the Source

Here you can make use of:


• Searching option. Type the name of the source in the search box located above the
sources.
• Filtering option. Select one of the following source types from the drop-down list
above the sources:
o Financial Platforms
o Enterprise Social
o Mobile
o Enterprise Tools and File Sharing
o Other
3. Select your source and click NEXT. The Configuration Wizard of the Source tab opens.

66
Merge1 | User Guide
IMPORTERS

Figure 86: Configuring the Source

Note
From collector to collector the Source tab may vary.

Managing an Importer
The options for managing the importers are:
• Clone. Allows copying the importer with all the previously configured settings.
• Edit. Allows editing the settings of the collector.
• Rename. Allows changing the name and the description of the importer.
• Delete. Deletes the importer with all the configured settings.

Note
If the importer is deleted, it will not be possible to recover it.

Running an Importer
An importer can be run using 2 ways: using the scheduler or using the start import button.

Figure 87: Scheduler and Start Import Button

67
Merge1 | User Guide
IMPORTERS

To run a job using the scheduler:


1. When enabling the scheduler, the running status will remain Idle until the running time is
achieved set by Importer Schedule (see Importer Schedule).

Figure 88: Scheduler: On, Status: Idle

2. When the time is achieved and a free agent is available, the running status will become
Queued.
3. After 30 seconds the status will be changed to Running: the job will run.

To run a job using the start import button:


1. If the scheduler is off, the job can be run by clicking the start import button. The status will be
changed from Idle to Queued.

Figure 89: Scheduler: Off, Status: Queued

2. When a free agent is available, after 30 seconds the status will be changed to Running: the
job will run.

.
Figure 90: Scheduler: Off, Status: Running

68
Merge1 | User Guide
IMPORTERS

If the scheduler is enabled for an importer and the start import button is set to Queued for the same
importer, even if the running time is not achieved set by Importer Schedule, the job will run (in case a
free agent is available).

Notes
• When the start import button is set to on for a job, and a scheduler is enabled for another
one, a free agent will run the job which was scheduled earlier.
• Even if the Importer Schedule is set, but the scheduler is not enabled, the job will not be
queued.

Collector History Deletion


There are two ways of deleting the collector history.
The first one is to use the Delete Data option under the Source section. This removes all collector data
history from the previous runs and processed data.

Figure 91. Deleting Data

The second way is to select Delete under Importer Settings. It also removes all collector data history
from the previous runs.

Figure 92: Data Cleanup

If the Delete <Collector Name>'s associated components’ data option is checked, all the failed
messages and failed sessions are also deleted from the database.

69
Merge1 | User Guide
IMPORTERS

File-Based Collector Options

File Source

For file collectors there are the following options to configure the source:
• None
• FTP
• Amazon S3
• Azure Storage1

Figure 93: File Sources

If None is selected, the files from the Import folder are processed.

To configure FTP configurations:

For Connection:
1. Enter the hostname of the remote FTP server and the folder path in the Host and Path text
boxes, respectively. The default port is 21.
2. Choose FTP connection type from the Connection Type drop-down list. FTP can run in either
passive or active mode. The information about the connection type should be provided by the
FTP host. If you wish to use FTP over SSL, mark the Use Security checkbox and choose the
connection method Implicit SSL, Explicit SSL or SSH.

Figure 94: FTP Connection

For Authentication:
1. Enter the Username and Password fields, respectively.
2. To enable anonymous FTP connections, enable the Anonymous Access checkbox which is the
default settings.

1 This source is not applicable to the Symphony collector.

70
Merge1 | User Guide
IMPORTERS

Figure 95: FTP Authentication

To capture data from Amazon S3, triggers and a Lambda function need to be created on the Amazon
S3 site. The trigger is run when specific actions occur within a bucket and the source bucket items
with their metadata are imported to the archive bucket. Merge1 will then capture the data from the
archive bucket.

If the Amazon S3 source is selected, the Amazon S3 Configuration window opens.

Figure 96: Amazon S3 Configuration

The following information is required:


• Access Key – enter the access key which you can find in the Users > Security Credentials of
your Amazon S3 account.
• Secret Key – enter the secret key acquired while setting up the Security Credentials. Save it in
a secure place as that secret key is provided only once.
• Bucket Name – enter the archive bucket name.
• Region Endpoint – enter the Region Endpoint which you can find in the Bucket Overview >
Properties of your Amazon S3 bucket. Note that if Region Endpoint is not set correctly, the
archive content will not be captured and processed.

Figure 97: Bucket Overview

71
Merge1 | User Guide
IMPORTERS

To capture data stored from different sources in Azure Blob storage, Azure storage should be
configured accordingly. For more information on how to configure Azure Storage, see the Configuring
Azure Storage section.

Merge1 will then capture the stored data from the storage.

To configure Azure Storage:


1. Enable Connection String and enter the Connection String copied in step 10.
Or,
2. Enable Service SAS URL and enter the Service SAS URL copied in step 10.
3. Enter Blob Container Name from step 11.

Figure 98: Azure Storage

For File Filter a wildcard can be used to denote the file types to be included or excluded. Each type of
filter is separated by the vertical pipe character |. For example: *.tar.gz | “.txt.

Figure 99: FTP File Filter

For Filter by Time:


1. If None is selected, the data is not filtered by time.
2. When Only download files modified within the last X days is selected, only the data modified
within the mentioned days will be downloaded.
3. When Only download files modified earlier than/later than is selected only the data modified
earlier than or later than the mentioned date will be downloaded. Both options can be
selected simultaneously to choose a period.

72
Merge1 | User Guide
IMPORTERS

Figure 100: FTP Filter by Time


For Options:
1. Maintain history of downloaded file for X days (0 = infinite) sets how many days the history of
downloaded files will remain. If the number of days is set to 0, the history is maintained
forever.
2. If Download subdirectories recursively is checked, files from the subdirectories of mentioned
path will be downloaded too.
3. If Delete files on server after downloading is checked, the downloaded files will be deleted
from the server.

Figure 101: FTP Options

SSH Key Authentication


To use SSH key authentication method:
1. Enable Use SSH Key Authentication to open the configuration window. SSH Key
Authentication is used for connecting to the source SFTP Server.

Figure 102: Enabling SSH Key Authentication

73
Merge1 | User Guide
IMPORTERS

2. Make sure the connection settings match those of the SFTP server. Enter the Path to the
required folder.
3. For Authentication, enter the Username provided by the source.
4. Click the Import Private Key button and Import SSH Key will open.
5. Copy and paste the Private Key.

Figure 103: Import SSH Key

6. Click Import and the Public Key field will be populated automatically.

Execute Script Against Source Files


This allows the user to utilize alternative methods of data download or acquisition methods other
than FTP. For example, batch script files that download information an FTP alternative and move it
into the appropriate processing folder.

Figure 104: Executing Script Against Source Files

PGP Configurations
For PGP configurations:
1. Enable the Use PGP Decryption checkbox and PGP Decryption Options will be opened.

Figure 105: PGP Decryption Options

74
Merge1 | User Guide
IMPORTERS

2. Click IMPORT PRIVATE KEY. The Import PGP Private Key window will appear.
3. Enter the Password of the Private key if it is encrypted with a password.
4. Enter Private Key and click Import.

Figure 106: Import PGP Private Key

5. Log into your source control panel and enable PGP encryption by adding Merge1 Keys.
6. In your source control panel, click Add and the Add Public Key window will appear. From the
Key Type drop-down menu, select Encryption and paste the full contents of the public key
(including the block header and footer) under the Public Keys tab at control panel in your
terminal.
7. Click the Decryption button. (The key appears in the Public Keys section). To save the PGP
encryption key to your account, click Submit.
8. Enter the Password of the Private key if it is encrypted with a password.
9. Enter the Imported Public Key.

Folder Configurations
Merge1 Folder is a required setting option. In case you miss to fill in the information, you will not be
allowed to proceed to the next screen.

After successfully setting up the FTP and PGP Configurations, you will have to change the folder
configurations. In Merge1 you will have to specify the Import folder, where you can store the data
after retrieving it from Amazon S3, as well as Quarantine folder where all the failed messages will be
archived.

If you have subfolders under your Import folder, you can enable Traverse subdirectories to maintain
the subfolder structure of imported data and include the data in your Yieldbroker Merge1.

75
Merge1 | User Guide
IMPORTERS
Figure 107: Folder Configuration

Under After Successful Importing settings, you can provide Merge1 what to do with the original files.
You can either Move the original files in a subfolder within an Importer Folder or you can Delete the
files. Note that once deleted, the files cannot be recovered.

The files in Quarantine folder are not automatically reprocessed. During the next import, the same
files from the FTP server or Import folder will be checked and, in case they are available, will be
reprocessed.

Miscellaneous Settings

If you want to import specific files or filetypes, note them in the Files to import form. You can
separate each file or filetype with a vertical bar I. Simply write the name of the file or use wildcards to
import the whole filetype) (e.g., *.txt | *.xml). The default setting formats is *.csv as Amazon S3
parses messages with these source files.

The Subject Prefix is added to the subject line of imported emails. This is useful for organizing
imported data especially when multiple sources share a common target.

Figure 108: Miscellaneous Settings

Timestamp Formatting
In addition to the primary stamp, a second timestamp can be enabled with its time zone. From the
drop-down menu you can choose the time zone of the timestamp.
The format of the timestamp in the output message can also be specified from the six options in the
Date time Format drop-down list.

Figure 109: Timestamp Formatting

76
Merge1 | User Guide
IMPORTERS

Attachment Validation
Merge1 enables you to develop customized notes for attachment validation. The default setting is
Fail Messages with missing Attachments, as a result of which the messages that do not have
attachments are failed and can be viewed under the Reports. Note that Advanced Processing should
not be selected for this to happen.

If you select the Replace all the attachments with the following note and input your custom note, all
the attachments to the messages will not be processed and in their place the input note will be added
to the message.

If you select the Replace missing attachments with the following note and input your custom note, all
the missing attachments of the messages will not be processed, and you will see only the custom
message that you have entered.

Figure 110: Attachment Validation


Configuring Azure Storage
For Azure Blob storage:
1. Login to your Azure portal account.
2. Navigate to Storage Accounts.

Figure 111: Navigating to Storage Accounts

3. Click the account Name.

77
Merge1 | User Guide
IMPORTERS

Figure 112: Storage Accounts


4. On the left side navigation pane, navigate to Shared Access Signature.
5. For Allowed services, enable Blob.
6. For Allowed resource types, enable Container and Object.
7. For Allowed permissions, enable
• Read
• Delete1
• List
8. For Allowed blob index permissions, enable Read/Write and Filter.
9. Specify the Expiration start and end date and click Generate SAS and connection string.
10. Copy Connection string or Blob service URL for Connection configuration.

Figure 113: Shared Access Signature

11. On the left side navigation pane, select Containers (1) and click the name of the container you
want (2).

1 This is needed in case the 6th step is enabled.

78
Merge1 | User Guide
IMPORTERS

Figure 114: Containers

79
Merge1 | User Guide
IMPORTERS

AMAZON S3
Amazon S3 is an object storage service that offers industry-leading scalability, data availability,
security, and performance. It provides easy-to-use management features so you can organize your
data and configure access controls to meet your business, organizational, and compliance specific
requirements.

Activities Captured
• Folder activities - created/renamed
• Files and file operations - created (upload)/renamed/updated (by uploading another file with
the same exact name)

For Merge1 to capture Amazon S3 data, triggers and a Lambda function need to be created on the
Amazon S3 site. The trigger is run when specific actions occur within a bucket. And the source bucket
items with their metadata are imported to the archive bucket. Merge1 will then capture the data
from the archive bucket.

Collector Configuration
For information on how to configure the following sections of the Source tab, see:
• File Source
• SSH Key Authentication
• PGP Configurations
• Folder Configurations
• Miscellaneous Settings
• Timestamp Formatting

An example of a processed message:

Figure 115: Sample Message

Next Steps
After setting up the collector, follow the links below to continue with the configuration of:
• Monitored Users (N/A)
• Filters
• Targets
• Importer Settings

80
Merge1 | User Guide
IMPORTERS

BLACKBERRY
The BlackBerry smartphone was once the most popular mobile device for enterprise use. Merge1
captures BlackBerry communications and stores them in existing email archive, whether on-prem or
in the Cloud.

Activities Captured
• Pin-to-pin
• Messenger
• SMS/MMS

Collector Configuration
For information on how to configure the following sections of the Source tab, see:
• File Source
• PGP Configurations
• Folder Configurations

BlackBerry Options

The BlackBerry source can only process one format at a time. You have the following Collector Types
to choose from the drop-down list:

• P2P (default)
• SMS
• Messenger (BBM)
• Video chat

Figure 116: BlackBerry Options

Once you have selected the Collector Type, you can also provide the Source Time Zone information.
Merge1 assumes that the messages in the source file are of the set time zone and based on that data,
the dates in the messages are processed to UTC time zone. By default, Merge1 sets the Source time
zone as Local timezone.

BlackBerry Filtering

Use BlackBerry Filtering configurations to determine which status types, subtypes, or commands are
imported (Figure 117). Separate each name with the following symbol: |. Note, that wildcards are
NOT supported for the following field. Each source type has different filtering options. P2P type can
be filtered with status types and commands. SMS sources can be filtering by all displayed options.

81
Merge1 | User Guide
IMPORTERS

Messenger type can be filtered only by commands. Video chats cannot be filtered at all. If you want
to process the whole data, leave all three fields blank.

Figure 117: BlackBerry Filtering

Miscellaneous Settings

For information on how to configure the folder, see Miscellaneous Settings.

Example of SMS message:

Figure 118: SMS Sample


Example of Video chat message:

Figure 119: Video Chat Message Sample

Next Steps
After setting up the collector, follow the links below to continue with the configuration of:
• Monitored Users (N/A)
• Filters
• Targets
• Importer Settings

82
Merge1 | User Guide
IMPORTERS

BLOOMBERG
Bloomberg delivers business and markets news, data, analysis, and video to the world, featuring
stories from Business week and Bloomberg News. Bloomberg Vault is a hosted end-to-end
information management service that delivers compliance and IT solutions by leveraging the
scalability and reliability of Bloomberg’s global infrastructure.

Merge1 imports and processes the files from Bloomberg.

Activities Captured
• Disclaimers (.dscl)
• Instant Bloomberg Messages (.ib), attachments (.att)
• Email Messages (.msg), attachments (.att)

Notes
• To process current schema files, the file filter should be configured with the following
extensions: *.ib19.*.xml.gpg | *.msg.*.xml.gpg | *.dscl.*.xml.gpg | *.ib19.att.*.tar.gz.gpg |
*.msg.att.*.tar.gz.gpg.
• Quarantine sources column on the Dashboard shows the number of the files moved to the
quarantine folder while processing source files with the below listed configured formats. All
other files have initially been considered unwanted files and have been moved to the
quarantine folder.

Collector Configuration
For information on how to configure the following sections of the Source tab, see:
• File Source
• SSH Key Authentication
• PGP Configurations
• Folder Configurations

Bloomberg Options

In Merge1, you will have the following Bloomberg options:

83
Merge1 | User Guide
IMPORTERS

Figure 120: Bloomberg Options

• Advanced Reprocessing - For more details see Advanced Reprocessing: Attachment Validation
and Advanced Reprocessing: Disclaimer Validation.
• Use Legacy Bloomberg Importer style of date processing - Merge1 will scan the date and time
stamp of dump files and assume their time zones correspond with those of the device on
which Merge1 is running (recommended for dump files created before March of 2009).
If this option is not selected, Merge1 will assume that date processing should be
accomplished based on the Universal Time Coordinated (UTC) time zone, which is used for all
current Bloomberg files. However, Bloomberg files created before March 2009 will be
processed successfully, even if this option is not selected (selection, however, is
recommended).
• Full attachment validation - If enabled, the entire source (file group) will be quarantined, in
case the attachment of a message is missing or corrupted, i.e., the Fail messages with missing
attachments under Attachment Validation will be ignored. If disabled, the selection under
Attachment Validation will be applied to the messages that are missing attachments.
• Full disclaimer validation - If enabled, the entire source (file group) will be quarantined, in
case the disclaimer of a message is missing or corrupted, i.e., the Fail messages with missing
disclaimers under Disclaimer Validation will be ignored. If disabled, the selection under
Disclaimer Validation will be applied to the messages that are missing disclaimers.
• Split IB Conversations by day - If checked messages with the same UTC Day will be imported
in one message.
• Max IB Message Size: (MB) - When this option is checked and the maximum size is set, the
messages with larger message size will be split. Note that attachments with larger size will not
be split.
• For IB: use EndTime as SentTime instead of StartTime - The SentTime in the imported
message of IB source files will be replaced with the EndTime of the message, instead of
StartTime. See the examples below.Note that if Split IB Messages by day is enabled,
DateTimeUTC is prioritized.
• For MSG: exclude TO, CC and BCC data from message body - When this option is checked, TO,
CC, and BCC data of the source MSG message is removed from the body of the message.
• For IB: Easy Review Mode - When this option is checked, Participant Entered and Participant
Left events are shown in a separate table at the bottom of the message.
• For IB: Ignore Historical Data - When this option is checked, there will not be any historical
events from prior days.
• For IB: Ignore Data with History Tag - When this option is checked, data with “History” tag will
be ignored.

84
Merge1 | User Guide
IMPORTERS

Note that in the below examples the timestamps in the body message are UTC, while the SentTime of
the generated output is UTC +4. The SentTime of the message is adjusted to the time zone of the
device it is opened on.

Also note that the mapping of SentDate (10:26 PM) can be changed using the "For IB: use EndTime as
SentTime instead of StartTime" checkbox.

By default, SentTime of the email is shown the same as StartTime:

Figure 121: Sample Message

If For IB: use EndTime as SentTime instead of StartTime is enabled the SentTime of the
generated email is shown the same as the EndTime of the message:

Figure 122: Sample Message

Advanced Reprocessing: Attachment Validation

Advanced Reprocessing is for processing messages that failed because of either missing attachments
or disclaimers.

85
Merge1 | User Guide
IMPORTERS

If Advanced Reprocessing and Full Attachment Validation is enabled and Fail Messages with missing
Attachments is selected, the following happens:

In case an attachment file is either missing or corrupted, Merge1 starts processing the source files
and quarantines them due to missing attachment. When running the next import, on condition that
the missing attachment is available now, Merge1 successfully processes all the files. This way Merge1
processes the messages previously quarantined just like any new complete file group.

If Full Attachment Validation is disabled:


In case attachment file is either missing or corrupted, Merge1 starts processing the source files. The
messages that have available attachments are processed and sent to the target. The messages that
have reference to missing attachments are not delivered to the target, they are stored in the
database and marked as failed. The record of these failed messages can be found in Reports > Report
Type (Missing Attachment Failure). When running the next import, on condition that the missing
attachment is available now, Merge1 reprocesses the failed messages.

Advanced Reprocessing: Disclaimer Validation

If Advanced Reprocessing and Full Disclaimer Validation is enabled and Fail Messages with missing
Disclaimers is selected, the following happens:

In case disclaimer file is either missing or corrupted, Merge1 starts processing the source files and
quarantines them due to missing attachment. When running the next import, if the missing disclaimer
is available now, Merge1 successfully processes all the files. So, Merge1 processes the messages
previously quarantined just like any new complete file group.

If Full Disclaimer Validation is disabled:


In case disclaimer file is either missing or corrupted, Merge1 starts processing the source files. The
messages with available disclaimers are processed and sent to the target. The messages that have
reference to missing disclaimers are not delivered to the target, they are stored in the database and
marked as failed. The record of these failed messages can be found in Reports > Report Type (Missing
Disclaimer Failure). When running the next import, in case the missing disclaimer is available now,
Merge1 reprocesses the failed messages.

Attachment Validation

For information on how to configure attachments, see Attachment Validation.

Bloomberg Full Disclaimer Validation

Merge1 enables you to develop customized notes for disclaimer validation. The default setting is Fail
messages with missing disclaimers, so the messages that do not have disclaimers are failed and can
be viewed under the Reports. Note that Advanced Processing should not be selected for this to
happen.

86
Merge1 | User Guide
IMPORTERS

If you select the Replace all disclaimer with the following note and input your custom note, all the
disclaimers will not be processed and instead of them the input note will be added to the message.
If you select the Replace missing disclaimers with the following note and input your custom note, all
the missing disclaimers will not be processed and instead of them the input note will be added to the
message.

Figure 123: Disclaimer Validation

Email Address to Use

Select the email address type you would like Merge1 to use when processing data from users that
have both their personal email address and their corporate email address registered on Bloomberg.

Figure 124: Selecting Primary Address Type

In case Both email addresses is selected, you can make either the Bloomberg or Corporate email
address primary by clicking the corresponding button.

IB Message Body

In the Bloomberg collector, you can choose from the following IB message body options:
1. Plain mode
2. Grid mode |Select style
3. Light grid mode

Figure 125: Selecting IB Message Body

When you select Plain mode option (default) you will see the interactions below each other. Plain
mode displays the message in its basic form.

87
Merge1 | User Guide
IMPORTERS

Figure 126: Displaying the Message in a Plain Mode

If you enable Grid mode option, you will see the information in the following columns:
• Interaction Type, which contains information about participants and messages, such as
Participant Entered, Participant Left, Participant Invited, Message, Attachment.
• Date, which shows the date and time the message was sent.
• User Info, where you can view the user's Full Name (Company Name) <Email Address>
• Content.
• Device Type, if the message was sent from a mobile device, it will be displayed as M in that
field.

Figure 127: Displaying a Message in a Grid Mode

When you select the Light grid mode, the data is two-toned an easy to be viewed with limited
metadata.

88
Merge1 | User Guide
IMPORTERS

Figure 128: Message in a Light Grid Mode

Miscellaneous Settings

For information on how to configure the settings, see Miscellaneous Settings.

Processing Bloomberg Firm-Level Files

An ideal technique for processing Bloomberg's firm-level files is to set Ignored Target as the default.
Then a filter should be configured to match segments for the necessary account numbers and route
them to a secondary target, and likewise, another filter to match segments to account numbers that
are unnecessary and route them to a Failed Target.

This way, new account numbers can be discovered using the reporting feature in the Importer's
settings (Reporting). Unconditional hit default target and Process all filters must be disabled
(Filtering).

However, if you intend to set other Targets for your importer, click the exact target type to see how it
is set up.

Managing Quarantine Files

There are mainly two reasons that cause a file to become quarantined. The first occurs when a file
cannot be parsed, or in simpler terms, the file format is incorrect. The second reason is caused by an
IB (instant messages) or an MSG (message) file that is missing attachments or disclaimers. To address
these quarantine files, the client will typically ask Bloomberg to resupply the ATT (attachments) or the
DSCL (disclaimer) files. Once provided, the corrected file including the IB and MSG file (the file that
was quarantined) will need to be added into the IMPORT folder (the name of this folder is decided at
the time of configuration by the client). Once the importer starts again, this information will be
reprocessed. This is the way the reprocessing works if Full Attachment/Disclaimer Validation and
Advanced Reprocessing are not enabled.

89
Merge1 | User Guide
IMPORTERS

Another option is to ignore the missing attachments and disclaimers. Messages can be processed
without attachments. For this, Full Attachment/Disclaimer Validation should be enabled, and the
default settings set to Replace missing attachments/disclaimers with the following note. This option is
only set if there is no interest in the missing attachment/disclaimer of a message and only a reference
to the missing file name is enough. Choosing this option will create a reference for the missing
attachment within the messages once delivered to the target.

Next Steps
After setting up the collector, follow the links below to continue with configuration of:
• Monitored Users (N/A)
• Filters
• Targets
• Importer Settings

90
Merge1 | User Guide
IMPORTERS

BOX
Box platform is a cloud content management platform and can be accessed using the Box Content
API. Box platform provides a suite of cloud content services that lets build content apps quickly.

Activities Captured
• Uploads
• Downloads and task assignments1
• Comments
• Box quick notes (in Box generated special format)
• New version upload (in the message subject, event type is displayed as edited)
• Task completed/rejected (displayed in the message body as task deleted)
• Comment deletion
• Move/Copy/Edits (only Box quick notes)/Preview/Rename
• Report export

Note
Original files are attached for all the events unless the files have been deleted previously. In that case,
the message about the captured event will include information about the deleted file.

Creating a Box Application


To create a Box application:
1. Go to https://developer.box.com/, sign into an existing account or create a new one.
2. Click Create New App.

Figure 129: Creating New App

3. Choose Custom App and click Next.

1
During the first run we will only get folder structure.

91
Merge1 | User Guide
IMPORTERS

Figure 130: Selecting Custom App

4. Select the User Authentication (OAuth 2.0) method, enter the name of the app in the App
name field, and click Create App.

Figure 131: Selecting Authentication Method

5. Go to the Configuration section, copy, and save Client ID and Client Secret.

Figure 132: Copying Client ID and Client Secret

6. Add Merge1 IP address to Redirect URI.

92
Merge1 | User Guide
IMPORTERS

Figure 133: Adding Redirect URL

7. Set the following permissions:


• Application Scopes:
o Read all files and folders stored in Box
o Write all files and folders stored in Box
o Manage users
o Manage enterprise properties
• Advanced Features: Make API calls the as-user header.

Figure 134: Advanced Scopes and Features


8. Click Save Changes.

Collector Configuration
For configuring the Box application on the Merge1 site:
1. After entering a Name and a Description (optional) for the collector and then selecting the
collector from the list, in the Application ID field, add the Client ID copied previously, and in
the field of Application Secret/Key, enter copied Client Secret, click NEXT.

93
Merge1 | User Guide
IMPORTERS
Figure 135: Providing Credentials

2. Grant access to Box in the opened pop-up window. Make sure that pop-ups are not blocked
by your browser.

Figure 136: Granting Access

Additionally Processed Data


Once you set up the Box application, you can also configure a few optional settings.
• If Process File Downloads is checked, the download file events from the events feed will be
processed.
• To ignore the downloads while being connected to the Merge1 application, add the
application ID in the Skip downloads initiated by service field. Follow these steps to retrieve
the ID:
1. Log in to Box and navigate to https://developers.box.com/.
2. At the top right corner, click My Apps.
3. Select your application to navigate to its details page.
4. Copy the last number from the URL in the browser address field, e.g.,
(https://<merge1_domain>.app.box.com/developers/console/app/THIS-NUMBER)

Figure 137: Additionally Processed Data

Advanced Configuration Options


To configure the advanced options:
• Options Do not download data modified before and Do not download data modified after
allow cutting off data outside the set date range. If the before date is set to 08/17/2022 and
the after date is set to 08/25/2022, only the data between these two dates will be

94
Merge1 | User Guide
IMPORTERS

downloaded. Data outside that timeframe will be ignored. Note that both options can be
used independently as well.

Figure 138: Advanced Configuration Options

Example of output message:

Figure 139: Output Message

Next steps
After setting up the collector, follow the links below to continue with the configuration of:
• Monitored Users
• Filters
• Targets
• Importer Settings

95
Merge1 | User Guide
IMPORTERS

CHATTER
Chatter is an enterprise collaboration platform from Salesforce, a cloud-based customer relationship
management (CRM) vendor.

Merge1 Chatter collector needs to log into the Salesforce account with an Admin user and get user
personal token to import data. Besides, triggers need to be published on the Chatter site to be able to
capture updates, deletions, and edits. The triggers will create a post in a channel and Merge1 will
capture the information from the channel. For more information on triggers, see Installation
Instructions document listed in the References.

Merge1 supports Shield Platform Encryption without any additional configuration in Merge1, since
the data is encrypted by Salesforce "At rest" and the API provides the data decrypted.

Use Chatter Cipher Cloud if you have a host domain.

Activities Captured
• Posts
• Files
• Comments
• Shares (including group posts)
• Comments of shared posts
• Deletes (requires triggers)
• Edits (requires triggers)
• Links
• Polls
• Private chats
• Group chats
• Feed poll choices (If Modify all data permission is enabled)
• New event/task contact/opportunity/case/lead
• All online communication, including attachments and deleted information (if the triggers are
set)

Activities not Captured


• Log a call
• Topics

Creating a Salesforce Application


To perform the steps below you will need a Salesforce account with a System Administrator profile. If
you do not have access to a System Administrator user, please contact your Salesforce admin and ask
for permissions.

Step 1: Creating a profile

96
Merge1 | User Guide
IMPORTERS

1. Login to Salesforce using an account that has the System Administrator profile and switch to
Salesforce Classic (if you are using the Lightning Experience).

Figure 140: Switching to Salesforce Classic

2. Click Setup, then expand Manage Users and click Profiles.

Figure 141: Navigating to Profiles

3. Find the Read Only profile and click the Clone button.

97
Merge1 | User Guide
IMPORTERS

Figure 142: Cloning

4. Enter a Name for in the Profile Name field and click the Save button.

Figure 143: Cloning Profile

5. Click Edit.

Figure 144: Navigating to Profile Editing

The required administrative permissions for Merge1 are:


• API Enabled
• Select Files from Salesforce

98
Merge1 | User Guide
IMPORTERS

• Manage Chatter Messages and Direct Messages


• Manage Unlisted Groups (Required only if the Unlisted Groups feature is enabled in
the given Salesforce environment.)
• View All Data
• Modify All Data (Only if capturing Feed poll Choices is required, otherwise can be
ignored but errors will be present in the collector log. This is a limitation from
Salesforce).
6. Under General User Permissions, make sure the following checkboxes are enabled:
• Access Activities
• Allow View Knowledge
• Knowledge One
7. Under Standard Object Permissions, disable all the Create, Edit, Delete and Modify All
checkboxes. Only the Read and View All permissions should stay.
8. Scroll down and click Save.

Step 2: Creating a User (Service Account)

1. Go to the Users page and click New User.

Figure 145: Navigating to Users

2. Populate the required fields and select Salesforce as User License, and the profile will be
created as in Figure 143 (in this case the profile name is Merge1), then scroll down and click
Save.

99
Merge1 | User Guide
IMPORTERS

Figure 146: Setting the User License

Step 3: Retrieving Access Token

1. Click your Username at the top right corner of the screen and select My Settings.

Figure 147: Navigating to My Settings

2. In the navigation pane to the left, under the Personal section, choose Reset My Security
Token, then click Reset Security Token. The new token will be sent to the email associated
with your account.

Figure 148: Resetting the Security Token

100
Merge1 | User Guide
IMPORTERS

If you want to enable Merge1 to collect deleted or updated comments and posts in Chatter, ask your
Salesforce administrator to perform the following steps in the Chatter UI:

1. Create a new Private Group ensuring they do not automatically archive this group and the
Private option and the Broadcast Only checkbox are selected.

Figure 149: Creating a New Private Group

2. Locate and make a note of the Group ID in the page URL.

Figure 150: Locating the Page URL

3. Create a new label Private Group Id.


• Go to Setup > Custom Labels.
• Click New Custom Label.

Figure 151: Creating a New Label

• For Short Description - Private Group Id

101
Merge1 | User Guide
IMPORTERS

• For Name - Private_Group_Id


• Value - Insert Group Id of Private group.

Figure 152: Editing Custom Label


4. For further instructions on how to create apex triggers, refer to Chatter Triggers guide in the
installation folder.

Collector Configuration
For Chatter configuration:
1. Enter the Username and Password of the Chatter Admin account used for app creation.
2. Enter the previously copied Security Token.
3. Specify the days for messages that should be processed.

Figure 153: Chatter Configuration

Advanced Configuration Options


To configure advanced options:
1. Specify the Subject Prefix in the subject line of imported emails. This is useful for organizing
imported data, i.e., when multiple sources share a common target.
2. Specify Do not download data modified before and Do not download data modified after to
allow cutting off data outside the set date range. If the before date is set to 08/17/2022 and
the after date is set to 08/25/2022, only the data between these two dates will be
downloaded. Data outside that timeframe will be ignored. Note that both options can be
used independently as well.

102
Merge1 | User Guide
IMPORTERS

Figure 154: Advanced Configuration Options

Example of a sample message:

Figure 155: Sample Message

Next Steps
After setting up the collector, follow the links below to continue with the configuration of:
• Monitored Users
• Filters
• Targets
• Importer Settings

103
Merge1 | User Guide
IMPORTERS

CHATTER CIPHER CLOUD


Chatter is an enterprise collaboration platform from Salesforce, a cloud-based customer relationship
management (CRM) vendor. The Chatter collector needs to log into the Salesforce with Admin and
get user personal token to import data. Besides, triggers need to be published on Chatter site to be
able to capture updates, deletes, and edits. The triggers will create a post in a channel and Merge1
will capture the information from the channel. For more information on triggers, see Installation
Instructions document listed in the References.

Merge1 supports Shield Platform Encryption without any additional configuration in Merge1, since
the data is encrypted by Salesforce "At rest" and the API provides the data decrypted.

Activities Captured
• Posts
• Files
• Comments
• Shares (including group posts)
• Comments of shared posts
• Deletes (requires triggers)
• Edits (requires triggers)
• Links
• Polls
• Private chats
• Group chats
• Feed poll choices (If Modify all data permission is enabled)
• New event/task contact/opportunity/case/lead
• All online communications, including attachments and deleted information (if the triggers are
set)

Activities not Captured


• Log a call
• Topics

Creating a Salesforce Application


For more details on how to create Salesforce application and acquire a token see Creating a
Salesforce Application .

Collector Configuration
For Chatter configuration:
1. Specify Host.
2. Enter the Username and Password of the Chatter Admin account used for app creation.
3. Enter the previously copied Security Token.

104
Merge1 | User Guide
IMPORTERS

4. Specify the days for messages that should be processed.

Figure 156: Chatter Configuration

Advanced Configuration Options


For more information on how to configure Advanced Configuration Options, see Advanced
Configuration Options.

Example of a sample message:

Figure 157: A Sample Message

Next Steps
After setting up the collector, follow the links below to continue with the configuration of:
• Monitored Users
• Filters
• Targets
• Importer Settings

105
Merge1 | User Guide
IMPORTERS

CISCO WEBEX TEAMS


Cisco Webex Teams enables people to meet, message, share, whiteboard, and call in a secure way,
that meets legal, regulatory, and compliance mandates, and provides comprehensive business
insights.

Activities Captured
• Direct messages during a call
• Persistent chats and channels
• Group members in a group or persistent chat
• Attachments
• Emojis
• Edited messages
• Deleted messages
• Conversations related to all newly added users
• Message threading/post threading/group chats threading

Notes
• The Webex environment allows inviting users from the other networks/domains (i.e., external
users). These users can then create groups and teams like internal users. The chats/teams
created by the External users are stored outside of the internal domain, i.e., in the Consumer
organization storage. Consumer Organization owns this space. So, the data in the external
domain are not captured by the collector.
• Deleted attachments are not captured due to API temporary limitations.

Cisco Webex Teams App Creation


To create an app:
1. Go to https://developer.webex.com/ and log into your account.

Figure 158: Logging into the Account

106
Merge1 | User Guide
IMPORTERS

Note that the account should have the Full administrator permission and be a Compliance Officer.
Permissions for full administrator privileges can be checked at https://admin.webe.g.com/users >
Select User > Administrator Roles under Organization Administrator Roles and Functional
Administrator Roles accordingly.

Figure 159: Full Administrative Privileges

2. When you are logged in and permissions are set, click Start Building Apps.

Figure 160: Navigating to the Apps Creation Page

3. Choose Create an Integration.

107
Merge1 | User Guide
IMPORTERS

Figure 161: Creating an Integration

4. Fill in the Integration Name, Contact Email, Icon, Description fields.


5. In the Redirect URI(s) field add https://<merge1_domain>/Configuration/OAuthCallback URL
address.

Figure 162: Filling in the Fields

6. Select the following scopes:

108
Merge1 | User Guide
IMPORTERS

• spark:all
• spark-admin:license_read
• spark-admin:organizations_read
• spark-admin:people_read
• spark-admin:roles_read
• spark-compliance:events_read
• spark-compliance:memberships_read
• spark-compliance:messages_read
• spark-compliance:rooms_read
• spark-
compliance:team_memberships_read
• spark-compliance:teams_read

Figure 163: Selecting Scopes

7. Click Add Integration at the bottom of the page.


8. Copy the Client ID and Client Secret and save it in a secure location.

Collector Configuration
To configure the collector:
1. Add the Client ID into Application ID field.
2. Fill in Application Secret/Key with the Client Secret.
3. Click NEXT.

109
Merge1 | User Guide
IMPORTERS

Figure 164: Configuring the Collector

Time Stamp Formatting


In addition to the primary stamp, a second timestamp can be enabled with its time zone. From the
drop-down menu, you can choose the time zone of the timestamp.

The format of the timestamp in the output message can also be specified from the six options in the
Date time format drop-down list.

Figure 165: Time Stamp Formatting

Miscellaneous Settings
• The Subject Prefix is added to the subject line of imported emails. This is useful for organizing
imported data, i.e., when multiple sources share a common target.
• If the option Merge Messages by Thread is enabled, Merge1 retrieves the data from a thread
and archives it as one message.
• Select the time zone by which the messages from the drop-down menu.
• Options Do not download data modified before and Do not download data modified after
allow cutting off data outside the set date range. If the before date is set to 08/17/2022 and
the after date is set to 08/25/2022, only the data between these two dates will be
downloaded. Data outside that timeframe will be ignored. Note that both options can be
used independently as well.

110
Merge1 | User Guide
IMPORTERS

Figure 166: Misc Settings

Attachments Configuration
• When Do not download files greater than X megabyte(s) is selected, the files bigger than the
filled-in number of megabytes, are not downloaded. In this Custom Message field, a text for
those excluded files can be specified. For example: “Files {0} are not imported, because they
are greater than {1) megabytes”. {0} is used to add the name of the file and {1} is used to add
the number of megabytes specified above.
• In the File Types field the types of files that should not be downloaded can be specified in the
following format: e.g., .txt | .xml. The vertical bar is used to separate the file types.

Figure 167: Attachments Configuration

Note that in case of using file filtering by size and by type we recommend using custom messages.

111
Merge1 | User Guide
IMPORTERS

Split Message
Check the Split messages box in case you want to split big files into smaller files. The size of a split part
of the message can be specified so that each part does not exceed the set size.

Figure 168: Splitting Messages by Size

Example of Merged Messages by Thread output:

Figure 169: Merged Message by Thread

Next Steps
After setting up the collector, follow the links below to continue with the configuration of:
• Monitored Users
• Filters
• Targets
• Importer Settings

112
Merge1 | User Guide
IMPORTERS

CITRIX WORKSPACE & SHAREFILE


Citrix Workspace & ShareFile provides secure file sharing, storage, sync and more - all built for
business. The collector requires a service account to create the API.

Activities Captured
• Files - uploaded/deleted1/archived/renamed/downloaded/viewed2/shared3/moved/checked
in/out
• Folders - created/moved4/shared/deleted
• Login info
• Share file requests
• Text-only messages
• Share file request message

We recommend using the owner account for authentication. Note that activities performed by the
user of the Org. Owner account are not captured.

Notes
• We can upload several files with the same name in File Box. The generated report contains
only path info for the uploaded files, which is the same for all the items having the same
name. Hence, Merge1 attaches the same file (generally, the latest among the ones with the
same name) to all the generated messages.
• If files having the same name are downloaded, in all the generated messages we will have the
same file attached. The reason for this issue is the same, as for the File upload.
• If the file is permanently deleted/archived, the activity is not captured.
• In case files are sent via Outlook and the shared information is not recorded in the Citrix
environment, the captured message will have an empty body.

Citrix Workspace & ShareFile App Creation


To create an app:
1. Navigate to https://api.sharefile.com/rest/.
2. Log into your Citrix ShareFile account. Note that the account should be a Service Account.
3. Click Get an API Key.

1 Only the activity is captured.


2 Audio_Listen and Video_View for MP3/MP4 file types accordingly.
3 Including encrypted messages.
4 Currently, only the activity is captured.

113
Merge1 | User Guide
IMPORTERS

Figure 170: Getting an API Key

4. Fill in the Application Name field.


5. In the Redirect URI field add the URL of your local Merge1 environment with the following
format: https://< merge1_domain>/Configuration/OAuthCallback.
6. Click Generate API Key.

Figure 171: API Key Generator

7. Copy the generated Client Id and Client Secret.

Figure 172: API Keys

Granting Permissions
To be able to capture data, Org Owner must give the Access other users’ File Boxes and Sent Items
specific permission. To give the permission:
1. Navigate to your ShareFile instance.
2. Log into your Citrix ShareFile Org Owner account.
3. Go to People > Browse Employees.

Figure 173: Browse Employees

114
Merge1 | User Guide
IMPORTERS

4. Select the employee to which the permission must be granted.


5. Scroll down to Employee User Settings and click User Access.

Figure 174: User Access

6. In the Files and Folder sub-section, enable the Access other users’ File Boxes and Sent Items
checkbox.

Figure 175: Granting Permission

7. Scroll down and click Save Changes.

Collector Configuration
To configure the collector:
1. In the Application ID field, fill in the copied Client Id.
2. In the Application Secret/Key field, fill in the copied Client Secret.
3. Add subdomain of the ShareFile workspace into the SubDomain field. (SubDomain is located
under Admin settings > Company info > Edit company Branding).

115
Merge1 | User Guide
IMPORTERS

Figure 176: Configuring the Collector

4. In the opened window, enter your accounts subdomain, and then sign into ShareFile account.
Make sure that pop-ups are not blocked by the browser. This can be checked from the top
right corner of the address field.

Figure 177: Signing into ShareFile

Activities to Be Processed
It is possible to choose which activities Merge1 processes from Citrix Workspace & ShareFile.

116
Merge1 | User Guide
IMPORTERS

Figure 178: Activities to Be Processed

• Archive only ShareFile shared files: Only shared files are imported.
• Archive all activities in ShareFile: All activities are captured and imported.
• Archive only certain selection of activities in ShareFile: Activities to be captured and imported
can be selected separately from the list below:
o Upload
o Download/View
o Folder create
o Check in/Check out
o Edit
o Delete/Archive
o Login
o Move
o File share
o Share file requests
o Text-only messages

In case Upload activity is activated, the following options become available:


• Internal users – when enabled, only the upload activity of internal users will be captured.
• External users – when enabled, only the upload activity of external users will be captured.
• Internal and external users – when enabled, the upload activity of both the internal and
external user will be captured.

Figure 179: Upload Activity

Advanced Configuration Options


For more information on how to configure Advance Configuration Options, see Advanced
Configuration Options.
Example of Login activity message:

117
Merge1 | User Guide
IMPORTERS

Figure 180: Login Activity

Attachments Configuration
For more information on how to configure attachments, see Attachments Configuration.

Note when the Ignore Attachments checkbox is checked, all the attachments are being excluded from
the message which will enhance the collector performance. Each message will contain only
information and the link of the excluded attachment.

In case of using file filtering by size and by type, we recommend using custom messages.

Next Steps
After setting up the collector, follow the links below, to continue with the configuration of:
• Monitored Users
• Filters
• Targets
• Importer Settings.

118
Merge1 | User Guide
IMPORTERS

CROWD COMPASS
Crowd Compass creates custom-branded mobile event apps for upcoming events or conferences.
Event managers can communicate with Attendees.

Merge1 captures data from the Crowd Compass using an API. The connection is established using an
Access Token. The access token provided by Crowd Compass support corresponds to an Event Center
user. The token will be able to access any event that the user does i.e., if you are an event admin for
the Sandbox event only, and can’t see any other events in the account, your access token will not be
able to make API calls to the other events in the account.

Activities Captured
• ‘From’ details
• ‘To’ details
• Invitations
• Event IDs
• Messages

Collector Configuration
To configure the source, fill in the Access-Token for your Crowd Compass Configuration environment.

Figure 181: Crowd Compass Configuration

Advanced Configuration Options


Advanced Configuration options are:
• The Subject Prefix is added to the subject line of imported emails. This is useful for organizing
imported data, i.e., when multiple sources share a common target.
• The Do not download data modified before check will ensure that old or irrelevant data is
excluded. For example, if the date selected is 8/1/2022, it will not retrieve any data modified
before August 1 of 2022. Only the data after 8/1/2022 will be retrieved, archived, and
imported.

Figure 182: Advanced Configuration Options

Example of Login activity message:

119
Merge1 | User Guide
IMPORTERS

Figure 183: Login Activity Message

Next Steps
After setting up the collector, follow the links below to continue with the configuration of:
• Monitored Users (N/A)
• Filters
• Targets
• Importer Settings.

120
Merge1 | User Guide
IMPORTERS

DB
Merge1 DB collector is designed as an open SDK platform to allow our customers to rapidly import a
table or part of the table from an MS SQL or Oracle Database. With the DB source you can collect and
process data from a table from any MS SQL database.

The objective of the collector is to map the columns of the table to specific email required fields
format. We are looking to map the "Sender", "To", "Title", "ActivityDateTime", "Content" fields to
appropriate columns in the text delimited file. Merge1 keeps a history of data imported to make sure
the same data is not re-imported (note multiple columns could be added to the body of the email).

With the DB source you can collect and process data from any database. To do so, use XML mapping
(see XML Mapping Sample).

Upload the XML file containing your formatting preferences and click Next. And by clicking the
Download button in the collector configuration wizard, download a DB configuration and mapping
XML file.

Figure 184: DB Configuration and Mapping

XML Mapping Sample


<?xml version="1.0" encoding="utf-16"?>
<DBCollector Mapping xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsdd="http://www.w3.org/2001/XMLSchema">
<Version>2.0</Version>
<ConnectionString> {Database Connection String}; Initial Catalog=DB_Connect;Integrated Security=True;
</ConnectionString>
<DbProvider>MsSql</DbProvider>
<TableName> {Source Table Name} </TableName>
<Columns>
<ColumnMetaInfo>

121
Merge1 | User Guide
IMPORTERS

<Name> {Column Name} </Name>


<DataType> {Column Type} </DataType>
<Nullable>{true/false} </Nullable>
</ColumnMetaInfo>
<ColumnMetaInfo>
……
</ColumnMetaInfo>
……
</Columns>
<ColumnMaps>
<ColumnMapping>
<CanBeEmpty>{true/false} </CanBeEmpty>
<MessagePropertyName> {Message Field Name} </MessagePropertyName>
<ColumnNames>
<string> {Column Name from above} </string>
<string>…</string>
</ColumnNames>
</ColumnMapping>
<ColumnMapping>
……
</ColumnMapping>
……
</ColumnMaps>
</DBCollector Mapping>

To connect to the relevant database, use a sample code idea presented below:

<add name=”NAME” connectionString=”data source=.\SQLSERVER;Integrated Security=SSPI;Initial


Catalog=SOURCE_DB/>

For MS SQL Database:

<ConnectionString>
Data Source=.; Initial Catalog=MyDb;Integrated Security=True;
</ConnectionString>

For Oracle Database:

<ConnectionString>
Data Source=(DESCRIPTION=(ADDRESS=(PROTOCOL=TCP)
(HOST=192.168.10.253)(PORT=1540))
(CONNECT_DATA=(SERVICE_NAME=TestDb))); User ID = <username>; Password =
<password>;
</ConnectionString>

There can be as many <ColumnMetaInfo> tags as there are columns in the source table.
There should not be any duplicates. Names are not case-sensitive.

122
Merge1 | User Guide
IMPORTERS

There can be as many <ColumnMapping> tags as it is necessary. These columns can be reused
in any way. <ColumnName> may contain multiple string tags only if the <MessagePropertyName>
allows for multiple entries (see below). If multiple entries are present, the contents are sequenced in
order with spaces.

Valid <MessagePropertyName> values are not case sensitive and are as follows:

• Sender: One value, must be a valid SMTP email address.


• To: One or more values, each must be a valid SMTP email address.
• CC: One or more values, each must be a valid SMTP email address.
• BCC: One or more values, each must be a valid SMTP email address.
• Title: One or more values.
• ActivityDateTime: One value, must be a valid DateTime value.
• Content: One or more values.

Custom fields may be used with multiple values and are added to each message as custom properties.
<DataType> and <Nullable> tags are semantic and are not mandatory.

Merge1 DB Collectorsupports the following data type values that can be collected from the database:
varchar, nvarchar, ntext, int, tinyint, longint, and datetime.

Sender, To, CC, and BCC fields are set to SMTP addresses only, thus imported messages will show up
with empty fields.
Select the Set Display Name to SMTP address when empty option in Importer Settings under
Processing to avoid this.

Example Output Message:

Figure 185: Output Message

Next Steps
After setting up the collector, follow the links below to continue with the configuration of:
• Monitored Users (N/A)
• Filters
• Targets
• Importer Settings

123
Merge1 | User Guide
IMPORTERS

DROPBOX BUSINESS
Dropbox Business is a cloud-based file storage system. It is a secure storage for all your tools, content,
and collaborators. This platform keeps your teams productive and your content safe by driving
transformation across industries.

Activities Captured
• Files and file operations - added/copied/deleted/downloaded/edited/moved/
permanently deleted/renamed/restored/reverted/rolled back
• Comments - added/deleted/edited
• Sharing:
o Shared content - add invitees/add members
o Shared content - copy, view, unshare
o Shared folder - create/mount/unmount
o Shared link - copy/create/download/view

There are some cases, such as events generated by external (anonymous) users, which are not
captured.

Creating a Dropbox Application


The owner of your organization's Dropbox folder must perform these steps to create a Dropbox
application for use in Merge1.
1. Log in to Dropbox and navigate to https://www.dropbox.com/developers.
2. At the top right corner, click App console.

Figure 186: Navigating to App Console

3. Click Create app.

124
Merge1 | User Guide
IMPORTERS

Figure 187: Creating an Application

4. Enable Choose an API: Scoped access and the type of access you need: Full Dropbox - Access
to all files and folders in a user's Dropbox.

Figure 188: Configuring an Application

5. Name your app and click Create app.


6. On the opened Settings tab (1), copy and save the App key and App secret (2) and then in the
Redirect URIs field, enter
https://merge1_instance/Configuration/OAuthCallback.

125
Merge1 | User Guide
IMPORTERS

Figure 189: Settings Tab

Note that both the App key and App secret must be provided to Merge1 as part of Dropbox Business
configuration.
7. On the Permissions tab, select the following checkboxes and click Submit:
• account_info.read: View basic information about your Dropbox account such as
your username, email, and country.
• files.metadata.read: View information about your Dropbox files and folders.
• files.content.read: View content of your Dropbox files and folders.
• sharing.read: View your Dropbox sharing settings and collaborators.
• file_requests.read: View your Dropbox file requests.
• team_info.read: View basic information about your team including names, user
count, and team settings.
• team_data.member: View structure of your team's and members' folders.
• members.read: View your team membership.
• groups.read: View your team group membership.
• events.read: View your team's activity log.

126
Merge1 | User Guide
IMPORTERS

Figure 190: Granting Permissions

Collector Configuration
1. In the Application ID field, add the App Key copied previously, and in Application Secret/Key,
enter the copied Secret, click NEXT.

Figure 191: Dropbox Business Application Configuration

127
Merge1 | User Guide
IMPORTERS

2. Grant Access to Box in the opened pop-up window. Make sure that pop-ups are not blocked
by your browser.

Figure 192: Linking with Dropbox

Time Stamp Formatting


For more information, on how to configure this section, see Time Stamp Formatting.

Attachments Configuration
For more information on how to configure attachments, see Attachments Configuration.

Advanced Configuration Options


For more information on how to configure Advance Configuration Options, see Advanced
Configuration Options.

Next Steps
After setting up the collector, follow the links below to continue with the configuration of:
• Monitored Users
• Filters
• Targets
• Importer Settings

128
Merge1 | User Guide
IMPORTERS

EML
The EML collector is used to process EML type files from various sources. EML format is widely used
by various compliance and archiving solutions and may help the organization avoid the need to
develop a specific-source parser. The EML collector is used for importing EML data from Symphony.
Files with md5 extension should be excluded from the import, as content from Symphony is exported
in a single Zip file containing EML files for each active conversation.

There are some drawbacks in using EML instead of Symphony collector for processing files from
Symphony. They include:

• EML does not have a subject line to do conversation threading when searching.
• EML has poorer look (XML to HTML looks better than EML).
• EML misses information about room created, when joined, etc.

Advanced Configuration
This section allows constructing a message based on:
• From
• Cc
• Subject
• To
• BCC
• Date
You can also specify a custom header (comma delimited) in the corresponding field.

Figure 193: Advanced Configuration

Timestamp Formatting
For more information, on how to configure this section see Time Stamp Formatting.

Collector Configuration
For information on how to configure the following sections of the Source tab, see:
• File Source
• SSH Key Authentication
• PGP Configurations
• Folder Configurations
• Miscellaneous Settings

Example of Output Message:

129
Merge1 | User Guide
IMPORTERS

Figure 194: Output Message

Next Steps
After setting up the collector follow the appropriate links below to continue with configuration
of:
• Monitored Users (N/A)
• Filters
• Targets
• Importer Settings

130
Merge1 | User Guide
IMPORTERS

EWS
Exchange Web Services (EWS) is an application program interface (API) that allows programmers to
access Microsoft Exchange items such as calendars, contacts, and email. EWS, which first became
available in Exchange Server 2007, provides administrators with the flexibility to store, retrieve, move,
and modify email and related data for a single user, a group of users or an entire Exchange Server
organization on an Exchange server.

Merge1 retrieves data from Exchange servers via:


• EWS.
• Skype for Business Online. For more information see the Setting Up Security and Compliance
for Microsoft 365and Enable In-Place Hold sections of EWS Collectorset up to configure Skype
for Business Online.

Activities Captured
- From Exchange:
• Messages
• Meeting requests
• Meeting cancellations
• Appointments

- From Skype for Business Online:


• Conversations
• Conversation archives
• Missed conversations

When to Turn File Transfer Off


There is a situation where you would want to turn File Transfer off and leave it off - when you must
maintain a regulatory compliance standard.

In Skype for Business Online, file transfers within Instant Messaging are considered a “non-archived
feature.” That means the feature is not captured when you have an In-Place Hold set up in Exchange.
Thus, the data you would send via file transfer does not get recorded, which can jeopardize
compliance. (Shared OneNote pages and PowerPoint annotations are also non-archived features.)

This option is controlled at the user level. In the Skype for Business Admin Center, under Users, you
will find the option for turning off non-archived features. You are supposed to select this option if you
are legally required to preserve electronically stored information.

131
Merge1 | User Guide
IMPORTERS

Providing Necessary Permissions to the Account


To provide necessary permissions:
1. Go to https://portal.office.com/AdminPortal/Home.
2. Log into your account if you are not logged in yet.
3. Open Exchange admin center.

Figure 195: Navigating to Exchange Admin Center


4. Go to Roles >Admin Roles.

Figure 196: Navigating to Permissions

5. Click Discovery Management to open its settings.

132
Merge1 | User Guide
IMPORTERS

Figure 197: Navigating to Discovery Management

6. On the Assigned tab, to select the members to assign the Admin role.

Figure 198: Selecting a Member

7. Select from the list and click Add.

Figure 199: Adding Admins


8. On the Permissions tab, check the boxes to add roles.

9. Add Legal Hold, ApplicationImpersonation, Mailbox Import Export, and Mailbox Search to
select the administrator roles that correspond to the Exchange features and services that
members of this role group should have permissions to manage and click OK.

133
Merge1 | User Guide
IMPORTERS

Legal Hold and Mailbox Import Export do not need to be enabled if Retention Policy is going to be
used. They should be enabled only in case In-Place Hold is used.

Figure 200: Selecting a Role

Impersonator user must have Mailbox Search permission if on the Monitored users tab ALL is selected

10. Click Save in Discovery Management settings.

Setting Up Security and Compliance for Microsoft 365


To set up Microsoft 365 Security and Compliance:
1. Navigate to Information governance, in the Microsoft Compliance center.
2. Click +New retention policy to start the setup wizard.

Figure 201: Starting the Setup Wizard

3. Add a Name and a Description for the policy and click Next.

134
Merge1 | User Guide
IMPORTERS

Figure 202: Naming the Policy

4. In the next screen you will be offered to choose the applications to apply the retention policy
to. You can either select Apply policy only to content in Exchange email, public folders, Office
365 groups, OneDrive, and SharePoint documents.

Once you choose the locations where the retention policy applies, click Next.

Figure 203: Choosing Location

5. On the next screen, you can set the retention period of the messages along with other
options. Configure the settings so that they meet your compliance requirements and click
Next.

135
Merge1 | User Guide
IMPORTERS

Figure 204: Retention Settings

6. Review the settings that you have chosen. If everything is correct, click Submit.

Figure 205: Reviewing the Settings

Note that it would take up to 1 day to apply the retention policy to the locations you chose.

Enable In-Place Hold


Follow the steps of this section if you are using EWS Collector for Skype for Business Online:
1. Log in to the Microsoft Office 365 Admin Center (https://outlook.office365.com/ecp).
2. Go to compliance management.

136
Merge1 | User Guide
IMPORTERS

Figure 206: Navigating to Compliance Management

3. On the in-place eDiscovery & hold tab, click the + sign.

Figure 207: Creating New In-Place eDiscovery

Creation of In-Place Holds in Exchange Online will be discontinued later this year or early next
year. As an alternative to using In-Place hold, please, use Retention Policy as described in
Setting Up Security and Compliance for Microsoft 365.
4. Provide a suitable Name and Description, click Next.
5. In-place Hold will not be available if you select Search all mailboxes. Select Specify mailboxes
to search and click the + sign. Add specific mailboxes (or distribution groups), then click Next.

137
Merge1 | User Guide
IMPORTERS

Figure 208: Selecting and Adding Mailboxes

6. You can either choose to put all content In-Place Hold (not recommended) or define some
criteria (recommended).
• Select Filter based on criteria.
• Click select message types.
• Click Select the message types to search, check the Skype for Business items
checkbox and click Next.

Figure 209: Defining Criteria

7. Select Place content matching the search query in selected mailboxes on hold, and click Finish
after selecting either:
• Hold indefinitely
• Specify number of days to hold items relative to their received date.

138
Merge1 | User Guide
IMPORTERS

Figure 210: Place Content Matching the Search Query

Microsoft Azure App Creation


To authenticate via OAuth during the collector configuration, you need to create a Microsoft Azure
Application by following these steps:

1. Login to the Azure Portal using the same credentials as for O365 (Global Admin).
2. Click Azure Active Directory at the top of the page and select App Registration from the left-
side navigation pane.

Figure 211: Azure Active Directory

139
Merge1 | User Guide
IMPORTERS

Figure 212: Navigating to App Registration

3. Click the +New registration button.

Figure 213: New Registration

4. Enter a Name for the application and click the Register button.
5. Find and make a note your Application (client) ID and Directory(tenant) ID as this is needed
for configuring the collector in Merge1.
6. In the navigation pane to the left, go to Certificates & secrets.

140
Merge1 | User Guide
IMPORTERS

Figure 214: Navigating to Certificates

7. Click the Upload certificate button.

Figure 215: Upload Certificate

8. Select a certificate (public key) with one of the following file types: .cer,.pem, .crt, and click
Add. For more information on how to create a certificate, see Creating a Certificate (Private
and Public Keys).

Microsoft Azure Permissions


1. In the navigation pane to the left, click API permissions.

141
Merge1 | User Guide
IMPORTERS

Figure 216: API Permissions

2. Click Microsoft Graph, and in the opened pane select Application permissions.

Figure 217: Application Permissions

3. Add the following permissions:


• Application: Application.Read.All
• User: User.Read.All
4. Add the Office 365 Exchange Online permissions (previously Exchange) - full_access_as_app;
MailboxSettings: MailboxSettings.Read.

142
Merge1 | User Guide
IMPORTERS

Figure 218: Office 365 Exchange Online Permissions

5. Grant all the above-mentioned permissions.

Figure 219: Updating Permissions

Collector Configuration
To configure the EWS collector:
1. Specify the URL for the EWS collector.
2. Select the required Exchange version from the drop-down list.
3. Choose if the import should be done by last modification date (DateTimeModified) or by
creation date (OriginalDateTime). The cut-off date options change accordingly.
4. Fill in the Mailbox Folder from where the data should be imported. If you have more than one
Mailbox Folder, separate each name with a semicolon (“;”).
5. To process data within all the folder, check All folders.
6. To process data within the subfolders of the specified mailboxes, check Include subfolders.
7. To search for the mentioned mailbox folders in the recovery route folders, check Load
recoverable items if the Exchange Version is not Exchange2007 Sp1.

143
Merge1 | User Guide
IMPORTERS

8. Enable Personal archive to process only the archived information.

Figure 220: EWS Configuration

9. Provide Impersonator name and Password in case you select Basic Authentication.

Figure 221: Basic Authentication

Note that to use Basic authentication you should enable the Allow Basic authentication policy
by navigating to Computer Configuration> Administrative Templates > Windows Components
> Windows Remote Management (WinRM) > WinRM Client.

10. Provide Application ID and Tenant ID.


11. Provide X.509 Certificate Thumbprint in case you activate the Local machine radio button as
the X.509 Certificate source.

Figure 222: Providing Credentials

12. In case you activate Upload file (*.pfx), click the Select button to upload the certificate and
then provide X.509 Certificate Password.

144
Merge1 | User Guide
IMPORTERS

Figure 223: Uploading Certificate

For step-by-step instructions on how to get Application ID, Tenant ID, and Thumbprint, see
Microsoft Azure App Creation and Creating a Certificate (Private and Public Keys) accordingly.
13. For Advanced Configuration Options - Do Not Download Data Modified/Created Before and
Do Not Download Data Modified/Created After, allow cutting off data outside the set date
range. If the before date is set to 08/17/2022 and the after date is set to 08/25/2022, only
the data between these two dates will be downloaded. Data outside that timeframe will be
ignored. Note that both options can be used independently as well.

Figure 224: Advanced Configuration Options

14. Select the Message Class you would like Merge1 to import and then click Save.

A Message Class is an internal identifier that Microsoft Outlook and Microsoft Exchange utilize to
locate and activate forms.

There are the following Message Class types that Merge1 can import:

Figure 225: Message Classes

- Data captured from Exchange


• Message (IPM.Note)
• Meeting Request (IPM. Schedule.Meeting.Request)

145
Merge1 | User Guide
IMPORTERS

• Meeting Cancellation (IPM.Schedule.Meeting.Canceled)


• Appointment (IPM.Appointment)

- Data captured from Skype for Business


• Skype for Business (IPM.Note.Microsoft.Conversation)
• Skype for Business Archive (IPM.Note.Microsoft.Conversation.Archive)
• Skype for Business Missed (IPM.Note.Microsoft.Conversation.Missed)

To include messages irrespective of their Message Class, select all of them.

Message Classes can be edited in Merge1.Collectors.Base.dll.config in the Bin folder within the Merge1
7.01 installation directory. Default path: C:\Program Files\Globanet Consulting Services\Merge1
7.0\Bin\Merge1.Collectors.Base.dll.config.

Progress Counter
The Progress counter to the right of the Status bar shows the progress of the collector in three stages:

• Acquiring Monitored Users


• Scanning the Number of Users
• Processing the Users | Total Number of Messages Processed

Figure 226: Progress Counter

Using EWS for Skype for Business Online


If no retention policy is set, only Skype for Business and Skype for Business Missed message classes
are captured, as they are not compliant.

When In-place hold is activated, a compliant copy of each message is saved in the Purges folder (in
addition to a copy saved in the user’s mailbox) and cannot be deleted from there. If Skype for
Business Archived message class is selected, data is captured from Purges folder.

When all 3 Skype for Business message classes are selected, duplicates can be captured, as copies are
kept both in the user mailbox and in the Purges folder. The only use case to get compliant data from
Skype for Business Online without duplicates is checking Skype for Business Missed and Skype for
Business Archived.

1
In case of Merge1 version 6.0, the path will be C:\Program Files\Globanet Consulting Services\Merge1
6.0\Bin\Merge1.Collectors.Base.dll.config.

146
Merge1 | User Guide
IMPORTERS

History Tracking
Based on the provided information, there is a chance to monitor a certain timeframe but get a
message with a timestamp that is out of the specified frame. This case is applicable when import is
based on DateTimeModified.

Figure 227: A Sample Message

Next Steps
After setting up the collector, follow the links below to continue with configuration of:
• Monitored Users
• Filters
• Targets
• Importer Settings

147
Merge1 | User Guide
IMPORTERS

EXCHANGE GRAPH API


Microsoft Exchange is a business-class email app which gives you a focused inbox that prioritizes
important messages and adapts to your work style, so you can get more done–faster.

Merge1 retrieves data from Exchange servers via Graph API.

Activities Captured
• Messages
• Meeting requests
• Meeting cancellations

Microsoft Azure App Creation


To authenticate via OAuth during the collector configuration, you need to create a Microsoft Azure
Application by following these steps:

1. Login to the Azure Portal using the same credentials as for O365 (Global Admin).
2. Click Azure Active Directory at the top of the page and select App Registration from the left-
side navigation pane.

Figure 228: Azure Active Directory

148
Merge1 | User Guide
IMPORTERS

Figure 229: Navigating to App Registration

3. Click the +New registration button.

Figure 230: New Registration

4. Enter a Name for the application and click the Register button.
5. Find and make a note your Application (client) ID and Directory(tenant) ID as this is needed
for configuring the collector in Merge1.
6. In the navigation pane to the left, go to Certificates & secrets.

149
Merge1 | User Guide
IMPORTERS

Figure 231: Navigating to Certificates

7. Click the Upload certificate button.

Figure 232: Upload Certificate

8. Select a certificate (public key) with one of the following file types: .cer,.pem, .crt, and click
Add. For more information on how to create a certificate, see Creating a Certificate (Private
and Public Keys).

Microsoft Azure Permissions


1. In the navigation pane to the left, click API permissions.

150
Merge1 | User Guide
IMPORTERS

Figure 233: API Permissions

2. Click Microsoft Graph, and in the opened pane select Application permissions.

Figure 234: Application Permissions


3. Add the following permissions:
• Mail:
o Mail.Read
o Mail.ReadBasic.All
• User: User.Read.All

4. Grant all the above-mentioned permissions.

Figure 235: Updating Permissions

151
Merge1 | User Guide
IMPORTERS

Collector Configuration
After filling in the Name and Description on the Add Importer window and selecting the source on
Configuration Wizard:
1. In the new window opened, add Application ID, and Application Secret/Key.
2. Provide X.509 Certificate Thumbprint in case you activate the Local machine radio button as
the X.509 Certificate source.

Figure 236: Providing Credentials

3. In case you activate Upload file (*.pfx), click the Select button to upload the certificate and
then provide X.509 Certificate Password.

Figure 237: Uploading Certificate


5. You can copy the Application ID from the Azure Active Directory > App Registrations >
<your app name> section.
6. Choose whether the import should be done by the last modification date
(DateTimeModified) or by thecreation date (OriginalDateTime). The cut-off date options
change accordingly.
7. Fill in the Mailbox Folder from where the data should be imported. If you have more than
one Mailbox Folder, separate each name with a semicolon (“;”).
8. Check All folders to process data within all the folders.
9. To process data within the subfolders of the specified mailboxes, check Include subfolders.
10. To search for the mentioned mailbox folders in the recovery route folders, check Load
recoverable items.

Figure 238: EWS Configuration

152
Merge1 | User Guide
IMPORTERS

11. For Advanced Configuration Options - Do Not Download Data Modified/Created Before and
Do Not Download Data Modified/Created After, allow cutting off data outside the set date
range. If the before date is set to 08/17/2022 and the after date is set to 08/25/2022, only
the data between these two dates will be downloaded. Data outside that timeframe will be
ignored. Note that both options can be used independently as well.

Figure 239: Advanced Configuration Options

12. Select the Captured Activity type you would like Merge1 to import and then click Save.
There are the following activities that Merge1 can import:

Figure 240: Message Classes

13. To include messages irrespective of their type, select all of them.

Next Steps
After setting up the collector, follow the links below to continue with configuration of:
• Monitored Users
• Filters
• Targets
• Importer Settings

153
Merge1 | User Guide
IMPORTERS

FX CONNECT
FX Connect is a market-leading FX execution venue that helps firms efficiently manage multiple
portfolios, connect with brokers, and streamline global operations. It provides users with tools to
manage pre- and post-trade workflows electronically, while also offering tools designed to help clients
carry out their compliance obligations.

The data from FX Connect should be imported to Merge1 in CSV format. Merge1 maps the columns of
the CSV file with the fields in the output message. Please note, that message participants by default
are imported in FX Connect User ID format. If you want to map them to the users’ email addresses,
each email address and corresponding FX Connect User ID should be added in User Mappings section
of collector set up.

Merge1 collector automatically merges messages with the same session ID into one output message.

Activities Captured
• Session ID
• Trade participants
• Messages
• Time stamps

Collector Configuration
For information on how to configure the following sections of the Source tab, see:
• File Source
• SSH Key Authentication
• PGP Configurations
• Folder Configurations
• Miscellaneous Settings

FX Connect Collector Options


If you want to manually set up Source Time Zone, select the relevant one from the drop-down list.

Figure 241: FX Connect Options

Once you have selected the Collector Type, you can also provide the Source Time Zone
information. Merge1 assumes that the messages in the source file are of the set time zone and based
on that data the dates in the messages are processed to UTC time zone. By default, Merge1 sets the
Source Time Zone as UTC.

154
Merge1 | User Guide
IMPORTERS

FX Connect Options
The Merge messages by thread, if checked, combines messages by threads rather than sending them
one by one.

Figure 242: FX Connect Options

Define User Mappings List


Merge1 can match FXUserID with the user’s SMTP address via the feature called ‘’Match Email
Address’’ in Settings. This is normally used to switch an old SMTP address with a new one, however, it
can also be used to switch the FXID with an SMTP address. Create a CSV file with the following 5
columns per user:

• LastName
• FirstName
• CompanyName
• FXUserID
• SMTP address.

Select Change the SMTP address and point to the location of the CSV. You can click Preview to see
how it looks and click Save.

Figure 243: Adding Subject Prefix

Message Body
In the FX Connect collector you can choose between two message body options, which specify how
the imported message will be displayed in the target.

Figure 244: Message Body

When you select the Plain Mode option, you will see the interactions below each other.
If you enable the Grid Mode option, you will see the information in the following columns:

155
Merge1 | User Guide
IMPORTERS

• Message creator
• Message timestamp
• Message

It is possible to change the color scheme of the grid mode by clicking the Select Style link.

Figure 245: Selecting Grid Mode Style

Example of sample source file:

Figure 246: Source File Sample

Next Steps
After setting up the collector, follow the links below to continue with the configuration of:
• Monitored Users (N/A)
• Filters
• Targets
• Importer Settings

156
Merge1 | User Guide
IMPORTERS

GOOGLE DRIVE
G Suite’s Business and Enterprise editions provide flexible storage options so there will always be
enough space for the files. With centralized administration, data loss prevention, and Vault for Drive,
users and file-sharing can be easily managed to help meet data compliance needs. Drive is also
available as a standalone offering, with Drive Enterprise. Supported G Suite Plans are G Suite Business
and G Suite Enterprise.

In enterprise applications a user’s data might need to be accessed without any manual authorization
on their part. In G Suite domains, the domain administrator can grant third-party applications with
domain-wide access to its users' data — this is referred as domain-wide delegation of authority. To
delegate authority this way, domain administrators can use service accounts with OAuth 2.0.

Activities Captured
• Shared files
• Comments and replies of shared documents

Service Account Creation


First a service account and its credentials need to be created. During this procedure information that
will be used later for the G Suite domain-wide delegation of authority and in the code to authorize
with the service account needs to be gathered.

The three items that will be needed later are service account’s:
• Client ID
• Private key file
• Email address.

To create a Service Account:


1. Open the Service accounts page: https://console.developers.google.com/iam-
admin/serviceaccounts. If prompted, select a project.

Figure 247: Navigating to the Service Account

157
Merge1 | User Guide
IMPORTERS

2. Click Create service account.

Figure 248: Creating a Service Account

3. In the Create service account window, type a name for the service account. Note that the
next two steps are optional.

Figure 249: Filling in the Required Information

4. Once the service account is created, click it to open its settings. Open the Show Domain-wide
Delegation menu, check Enable Google Workspace Domain-Wide Delegation and click Save.

Figure 250: Service Account Details

158
Merge1 | User Guide
IMPORTERS

5. In the same window, copy the Email and the Unique ID of the service account.
6. Go to KEYS and click ADD KEY, then select Create new key, to create a private key for the
service account.

Figure 251: Creating a Key

7. Select the key type JSON and click Create.

Figure 252: Creating a Private Key

8. Your new public/private key pair is generated and downloaded to your machine; it serves as
the only copy of this key. Keep it in a secure location.

Domain-Wide Authority Delegation to the Service Account


The created service account needs to be granted access to the G Suite domain’s user data that should
be accessed. The following tasks must be performed by an administrator of the G Suite domain:
1. Go to your G Suite domain’s Admin console https://admin.google.com/, click Security > API
controls․

159
Merge1 | User Guide
IMPORTERS

Figure 253: Navigating to Security

2. Scroll down to Domain wide delegation section and click Manage Domain Wide Delegation.

Figure 254: Managing Domain Wide Delegation

3. Click Add New.

Figure 255: Adding New Scopes

4. Open the key file that you saved in the above section, copy the value of client_id, then
paste it in the Client ID field. Enter the list of scopes that your application should be granted
access to. For example, if you need domain-wide access to Users and Groups enter
https://www.googleapis.com/auth/admin.directory.user.readonly and

160
Merge1 | User Guide
IMPORTERS

https://www.googleapis.com/auth/drive.readonly in OAuth scopes fields and click


Authorize.

Figure 256: Adding a New Client ID

Your service account now has domain-wide access to the Google Admin SDK Directory API for all the
users of your domain. Now you can use Admin SDK Directory service object on behalf of your G Suite
domain's users.

Only users with access to the Admin APIs can access the Admin SDK Directory API, therefore
your service account needs to impersonate one of those users to access the Admin SDK
Directory API. Additionally, the user must have logged in at least once and accepted the G
Suite Terms of Service.

Creating Administrative Role for the User Manager Service


Account
To create the account:
1. Go to https://admin.google.com and click Account > Admin roles.

Figure 257: Accessing Admin Roles

2. Click CREATE A NEW ROLE.

161
Merge1 | User Guide
IMPORTERS

Figure 258: Creating a New Role

3. Name the new role and click CONTINUE.

Figure 259: Adding Role Info

4. Expand Users, select Read and click CONTINUE.

Figure 260: Selecting Privileges

5. Review the privileges and click CREATE ROLE.

162
Merge1 | User Guide
IMPORTERS

Figure 261: Reviewing Privileges

6. To assign the role to a user, go to https://admin.google.com and click Users, then click the
user that you want to assign the role to.

Figure 262: Selecting a User

7. Select Admin roles and privileges.

Figure 263: Selecting Admin Roles and Privileges

8. Click the Edit button, assign a role, and click Save.

163
Merge1 | User Guide
IMPORTERS

Figure 264: Assigning a Role

9. Go to https://console.developers.google.com/ and click ENABLE APIS AND SERVICES.

Figure 265: Enabling APIs and Services

10. API Library will be open.

Figure 266: Navigating to APIs & Services

11. Search and enable Admin SDK and Google Drive APIs.

164
Merge1 | User Guide
IMPORTERS

Figure 267: Enabling Admin SDK

Figure 268: Enabling Google Drive API

Collector Configuration
To authenticate the collector:
1. Upload the JSON of the public key saved to your device.
2. Enter the email address of the user created in the previous section.

Figure 269: Uploading the JSON

Note that the Download button is activated when there is a JSON file uploaded.

Timestamp Formatting
For more information, on how to configure this section, see Time Stamp Formatting.

Advanced Configuration Options


For more information on how to configure Advance Configuration Options, see Advanced
Configuration Options.

Example of output message:

165
Merge1 | User Guide
IMPORTERS

Figure 270: Output Message

Next Steps
After setting up the collector, follow the links below to continue with the configuration of:
• Monitored Users
• Filters
• Targets
• Importer Settings

166
Merge1 | User Guide
IMPORTERS

ICECHAT
ICE Chat robust messaging system offers collaboration with other market participants. It offers
diverse setup options that can be tailored to support user’s compliance requirements. With IceChat
users can react to trade opportunities in real-time with features including quote and trade recognition
logic, blast messages and a marketplace directory connecting over 80,000 market participants.

Activities Captured
• Room ID
• Start time
• Message content
• Participants
• Participants entered
• Message date

Collector Configuration
For information on how to configure the following sections of the Source tab, see:
• File Source
• SSH Key Authentication
• PGP Configurations
• Folder Configurations
• Miscellaneous Settings

Optional Settings
• When Bloomberg Vault Format is selected, the imported messages are displayed in
Bloomberg Vault format.

Figure 271: Optional Settings

Figure 272: Sample Message


Example of standard processed message from IceChat:

Next Steps
After setting up the collector, follow the links below to continue with the configuration of:
• Monitored Users (N/A)
• Filters
• Targets
• Importer Settings

167
Merge1 | User Guide
IMPORTERS

JABBER ENTERPRISE
Cisco Jabber is a suite of Unified Communications applications that allow seamless interaction with
your contacts from anywhere. Cisco Jabber offers IM, presence, audio and video calling, voicemail,
and conferencing. The applications in the Cisco Jabber family of products are:

• Cisco Jabber for Android


• Cisco Jabber for iOS
• Cisco Jabber for Mac
• Cisco Jabber for Windows.

Merge1 retrieves data from the selected database and processes it 1.

Activities Captured
• Messages between individuals
• Groups chats
• Persistent chats
• File shares2

Cisco Jabber database design does not support storing Unicode characters, so messages that include
Unicode characters are not stored in the database, hence, cannot be captured by Merge1.

Collector Configuration
Merge1 retrieves data directly from Jabber’s database. You can select from the following three types:

• PostgreSQL Server
• Microsoft SQL Server
• Oracle Database

PostgreSQL Connection
To connect to Jabber enterprise database through PostgreSQL:
1. Select the database that you want to connect by clicking the respective button.

1You need to add all databases, from where to retrieve the data. Use the + button to add the databases.
2This feature is only supported in the environments where the Managed File Transfer feature is used in the Cisco Unified Communications
Manager IM and Presence Node. For more information see
https://www.cisco.com/c/en/us/td/docs/voice_ip_comm/cucm/im_presence/configAdminGuide/10_5_2/CUP0_BK_CEB3E82E_00_config-
admin-guide-imp-1052/CUP0_BK_CEB3E82E_00_config-admin-guide-imp-1052_chapter_010110.html

168
Merge1 | User Guide
IMPORTERS

Figure 273: Selecting the Database

2. For PostgreSQL:
• Enter the Configuration name.
• Select the PostgreSQL Server.
• Enter the Port and the Database name.

Figure 274: PostgreSQL Configuration

3. Choose the authentication method to connect to the server. If Windows Authentication is


chosen, Merge1 will connect using the Windows credentials of the account. If Postgres Server
Authentication is chosen, it can be connected to with the Postgres server credentials.
4. Enter the Login Name and Password.
5. Advanced Connection Parameters allow specifying the following:
• Connection timeout - the time during which the query is not processed can be
specified to yield timeout.

169
Merge1 | User Guide
IMPORTERS

• Min Pool Size - the minimum number of requests the application may process
concurrently.
• Max Pool Size - the maximum number of requests the application may process
concurrently.
• Network Packet Size - the fixed-size chunk of data that transfers requests and results
between clients and servers. This field specifies in what file-size chunks the file data
should be transferred.
• Enlist - when enabled, checks whether the SQL Server connection pooler
automatically enlists the connection in the creation thread's current transaction
context.
• Pooling - if enabled keeps the database connection session active so that when a
connection is later requested, one of the active sessions is used in preference to have
to create another one.
6. File Processing -By activating Process Shared Files checkbox, which is disabled by default, you
allow the files shared, using Jabber, to be processed by the collector and the fields below
become mandatory.
7. Fail conversations with missing files - When enabled, conversations that have reference(s) to
file(s) in the database but do not exist in the file store will be marked as failed (Stored in
Merge1 database), the Merge1 admin then can export the messages or set the reprocessing
option by navigating to the REPORTS page of Merge1.
8. Connection. Enter the host name of the remote SFTP server that is connected to the CUCM
IM and Presence server's MFT service and the folder path in the Host and Path text boxes,
respectively.
9. Authentication - To authenticate an SFTP connection, enter the username of the MFT server
user and import the private key of the user. You can also generate a new key pair, then add
the public key to the authorized_keys file of MFT server user. For more information,
regarding SSH key authentication, contact your Jabber and Linux teams.
Important Note: For MFT records CUCM allows the assignment of a database different than
the compliance database, as we do not support this setup. The database used for compliance
and MFT must be the same.
10. For Other Options:
• The Do not download data modified before will ensure that old or irrelevant data is
excluded. For example, if the date selected is 8/1/2022, it will not retrieve any data
modified before August 1 of 2022. Only the data after 8/1/2022 will be retrieved,
archived, and imported.

Oracle Server
To connect through Oracle:
1. For Oracle Connection fields:
• Specify a Configuration Name.
• Specify Oracle Server IP address and Port.
• In the SID field, add your Oracle SID, the Unique name that uniquely identifies your
instance/database. Or choose to add a Service Name of the Oracle Database instead.
• Add the name of your database schema in the Schema field.
• Add the Login and Password.
2. For Advanced Connection Parameters:

170
Merge1 | User Guide
IMPORTERS

• Min Pool Size is the minimum number of requests the application may process
concurrently.
• Max Pool Size is the maximum number of requests the application may process
concurrently.
• Enlist, when enabled, checks whether the SQL Server connection pooler automatically
enlists the connection in the creation thread's current transaction context.
• Pooling, if enabled keeps the database connections active so that when a connection
is later requested, one of the active ones is used in preference to have to create
another one.
• In the Connection Timeout field, the time during which the query is not processed
can be specific to yield timeout.
3. File Processing - By activating Process Shared Files checkbox, which is disabled by default, you
allow the files shared, using Jabber, to be processed by the collector and the fields below
become mandatory.
4. Fail conversations with missing files - When enabled, conversations that have reference(s) to
file(s) in the database but do not exist in the file store will be marked as failed (Stored in
Merge1 database), the Merge1 admin then can export the messages or set the reprocessing
option by navigating to the Reports page of Merge1.
5. Connection. Enter the host name of the remote SFTP server that is connected to the CUCM
IM and Presence server's MFT service and the folder path in the Host and Path text boxes,
respectively.
6. Authentication - To authenticate an SFTP connection, enter the username of the MFT server
user and import the private key of the user. You can also generate a new key pair then add
the public key to the authorized_keys file of MFT server user. For more information,
regarding SSH key authentication, please contact your Jabber and Linux teams.
Important Note: For MFT records CUCM allows the assignment of a database different than
the compliance database, we do not support this setup. The database used for compliance
and MFT must be the same.
7. For Other Options:
• The Do not download data modified before check will ensure that old or irrelevant
data is excluded. For example, if the date selected is 8/1/2022, it will not retrieve any
data modified before August 1 of 2022. Only the data after 8/1/2022 will be
retrieved, archived, and imported.

171
Merge1 | User Guide
IMPORTERS

Figure 275: Oracle Database

Microsoft SQL Server


To connect through Microsoft SQL:
1. Select the SQL Server from the drop-down menu.
2. Select the database, where Jabber files are stored, from the drop-down menu after
connecting to the server.
3. Advanced Connection Parameters allow specifying the following:
• In the Connection Timeout field, the time during which the query is not processed
can be specified to yield timeout.
• In the Load Balance Timeout field, the time during which the inactive connections
should be kept open in a connection pool can be specified. An inactive connection is a
database session that is not in use by an application.
• Min Pool Size - the minimum number of requests the application may process
concurrently.
• Max Pool Size - the maximum number of requests the application may process
concurrently.
• Network Packet Size - the fixed-size chunk of data that transfers requests and results
between clients and servers. This field specifies in what file-size chunks the file data
should be transferred.
• Asynchronous Processing, when enabled, allows various workflows to run at the same
time.
• Enlist - when enabled, checks whether the SQL Server connection pooler
automatically enlists the connection in the creation thread's current transaction
context.

172
Merge1 | User Guide
IMPORTERS

• Pooling - if enabled keeps the database connection session active so that, when a
connection is later requested, one of the active sessions is used in preference to have
to create another one.
• Replication is a technique through which an instance of a database is exactly copied
to, transferred to, or integrated with another location. Database replication is done
to provide a consistent copy of data across all the database nodes. It also removes
any data redundancy, merging of two databases into one and updating secondary
databases with outdated or incomplete data.
4. File Processing - By activating Process Shared Files checkbox, which is disabled by default, you
allow the files shared, using Jabber, to be processed by the collector and the fields below
become mandatory.
5. Fail conversations with missing files - When enabled, conversations that have reference(s) to
file(s) in the database but do not exist in the file store will be marked as failed (Stored in
Merge1 database), the Merge1 admin then can export the messages or set the reprocessing
option by navigating to the REPORTS page of Merge1.
6. Connection. Enter the host name of the remote SFTP server that is connected to the CUCM
IM and Presence server's MFT service and the folder path in the Host and Path text boxes,
respectively.
7. Authentication - To authenticate an SFTP connection, enter the username of the MFT server
user and import the private key of the user. You can also generate a new key pair then add
the public key to the authorized_keys file of MFT server user. For more information,
regarding SSH key authentication, please contact your Jabber and Linux teams.
Important Note: For MFT records CUCM allows the assignment of a database different than
the compliance database, we do not support this setup. The database used for compliance
and MFT must be the same.
8. For Other Options:
• The Do not download data modified before check will ensure that old or irrelevant
data is excluded. For example, if the date selected is 8/1/2022, it will not retrieve any
data modified before August 1 of 2022. Only the data after 8/1/2022 will be
retrieved, archived, and imported.

173
Merge1 | User Guide
IMPORTERS

Figure 276: Microsoft SQL Server

Figure 277: Other Options

Example output message:

Figure 278: Output Message

174
Merge1 | User Guide
IMPORTERS

Next Steps
After setting up the collector, follow the links below to continue with the configuration of:
• Monitored Users
• Filters
• Targets
• Importer Settings

175
Merge1 | User Guide
IMPORTERS

JSON
JSON collector allows our customers to rapidly transform JSON files using JSON template files to a
predefined format. Once JSON is transformed, Merge1 processes the JSON file by generating the
required mapping fields and creating the configured output format (EML, JSON, etc.). The mapping
varies from source to source. Contact Veritas Technologies LLC Support for more details on the
mapping corresponding to the source you are going to use it for.

Activities Captured
• Participants: From, To, CC, and BCC
• Activity datetime
• Body message

Collector Configuration
For information on how to configure the following sections of the Source tab, see:
• File Source
• PGP Configurations
• Folder Configurations
• Miscellaneous Settings

JSON Collector Options


Upload the JSON template provided separately for each source which is used to rapidly transform
.JSON files to a predefined format.

Figure 279: JSON Collector Options

Sample of an output message:

176
Merge1 | User Guide
IMPORTERS

Figure 280: Sample of an Output Message

Next Steps
After setting up the collector, follow the links below to continue with the configuration of:
• Monitored Users (N/A)
• Filters
• Targets
• Importer Settings

177
Merge1 | User Guide
IMPORTERS

MICROSOFT TEAMS
Microsoft Teams is a chat-based workspace in Office 365 that integrates with the apps and services
teams use to get work done together. The Microsoft Teams developer platform makes it easy for you
to integrate your service, whether you develop custom apps for your enterprise or SaaS applications
for teams around the world.

Microsoft Teams provides the enterprise security and compliance features you expect from Office
365, including broad support for compliance standards, and eDiscovery and legal hold for channels,
chats, and files.

Activities Captured
• Chat messages
• Channel messages

Captured messages contain1:

• Chat/Channel info
• Mentions
• Attachments
• Emojis

Note that edits and deletes of messages in chats, private, and public channels are not captured.

Notes
We recommend you invite the external users you want to communicate with and contact them as a
guest user because Microsoft APIs does not allow capturing external users’ events through its APIs.

To be able to capture shared attachments, the user should be a global admin or have corresponding
permissions.

Note that in Microsoft Teams Chats and Private Channel Conversations2 chats of users who do not
have an Exchange Online mailbox also referred as On-Premises or Hybrid users, are captured only
when at least one of the chat participants has an Exchange Online mailbox and is a user monitored by
Merge1.

1 If the listed items exist in the original message.


2 Not to be confused with Public Channel Chats/Conversations.

178
Merge1 | User Guide
IMPORTERS

Important Information
Each team in Microsoft Teams has a team site in SharePoint Online, and each channel in a team gets a
folder within the default team site document library. Files shared within a conversation are
automatically added to the document library, and permissions and file security options set in
SharePoint are automatically reflected within Teams.

Private chat files are stored in the sender’s OneDrive for the Business folder, and permissions are
automatically granted to all participants as part of the file-sharing process.

If you do not have SharePoint Online enabled in your tenant, Microsoft Teams’ users cannot share
files in teams. Users in private chat also cannot share files because OneDrive for Business (which is
tied to the SharePoint license) is required for that functionality. By storing the files in the SharePoint
Online document library and OneDrive for Business, all compliance rules configured at the tenant
level will be followed.

You can use a retention policy to retain chats and channel messages in Teams. Teams’ chats are
stored in a hidden folder in the mailbox of each user included in the chat, and Teams’ channel
messages are stored in a similar hidden folder in the group mailbox for the team. However, it is
important to understand that Teams uses an Azure-powered chat service that also stores this data,
and by default, this service stores the data forever. For this reason, we strongly recommend that you
use the Teams location to retain and delete Teams data. Using the Teams location will permanently
delete data from both the Exchange mailboxes and the underlying Azure-powered chat service. For
more information, see more here: https://docs.microsoft.com/en-us/MicrosoftTeams/security-
compliance-overview.

Note that Teams’ chats and channel messages are not affected by retention policies applied to the
user or group mailboxes in the Exchange or Office 365 groups locations. Even though Microsoft
Teams chats, and channel messages are stored in Exchange, they are affected only by a retention
policy that has applied to the Teams location.

Please see more on retention policy here: https://docs.microsoft.com/en-


us/office365/securitycompliance/retention-policies.

If a message is deleted and then the deletion is undone, all the other actions done on that
message will not be captured because the message will be absent from the mailbox.

Microsoft Azure App Creation


To authenticate via OAuth during the collector configuration, you need to create a Microsoft Azure
Application by following these steps:

179
Merge1 | User Guide
IMPORTERS

1. Login to the Azure Portal using the same credentials as for O365 (Global Admin).
2. Click Azure Active Directory at the top of the page and select App Registration from the left-
side navigation pane.

Figure 281: Azure Active Directory

Figure 282: Navigating to App Registration

3. Click the +New registration button.

Figure 283: New Registration

180
Merge1 | User Guide
IMPORTERS

4. Enter a Name for the application and click the Register button.
5. Enter the enter the URL of your local Merge1 environment in the following format:
https://<your_merge1_domain>/Configuration/OAuthCallback. Click
Register.

Figure 284: Registering an Application

6. Find and make a note your Application (client) ID and Directory (tenant) ID as this is needed
for configuring the collector in Merge1.
7. In the navigation pane to the left, go to Certificates & secrets.

Figure 285: Navigating to Certificates

8. Click the Upload certificate button.

181
Merge1 | User Guide
IMPORTERS

Figure 286: Upload Certificate

9. Select a certificate (public key) with one of the following file types: .cer,.pem, .crt, and click
Add. For more information on how to create a certificate, see Creating a Certificate (Private
and Public Keys).

Microsoft Azure Permissions


1. In the navigation pane, click API permissions (Figure 287).

Figure 287: API Permissions

2. Click Microsoft Graph, and in the opened pane select Application permissions.

182
Merge1 | User Guide
IMPORTERS

Figure 288: Application Permissions

3. Grant the following permissions:


• Application: Application.Read.All
• Application: Application.ReadWrite.All1.
• Directory: Directory.Read.All
• Files: Files.Read.All
• User: User.Read.All

4. Once you have selected all the checkboxes, click Update permissions.

Figure 289: Updating Permissions

5. Get back to API permissions section, click + Add a permission, select SharePoint and then
Application permissions. These are the permissions you need to grant:

1 Only required if the certificate has not been already uploaded to the Azure App.

183
Merge1 | User Guide
IMPORTERS

• Sites: Sites.Read.All
• TermStore: TermStore.Read.All
• User: User.Read.All

Once you have selected all the checkboxes, click Add permissions.

Figure 290: Requesting SharePoint Permissions

6. Add the Office 365 Exchange Online permissions (previously Exchange) - full_access_as_app;
MailboxSettings: MailboxSettings.Read.

Figure 291: Office 365 Exchange Online Permissions

Setting Up Security and Compliance for Microsoft 365


To set up Microsoft 365 Security and Compliance:

184
Merge1 | User Guide
IMPORTERS

1. Navigate to Information governance, in the Microsoft Compliance center.


2. Click +New retention policy to start the setup wizard.

Figure 292: Starting the Setup Wizard

3. Add a Name and a Description for the policy and click Next.

Figure 293: Naming the Policy

4. In the next screen you will be offered to choose the applications to apply the retention policy
to. You can either select Apply policy only to content in Exchange email, public folders, Office
365 groups, OneDrive, and SharePoint documents. You should select the second option and
activate last two options - Teams channel messages and Teams chats. There is also an
opportunity to choose specific Teams/Users or Exclude them.

Once you choose the locations where the retention policy applies, click Next.

185
Merge1 | User Guide
IMPORTERS

Figure 294: Choosing Location

5. In the next screen you can set the retention period of the messages along with other options.
Configure the settings so that they meet your compliance requirements and click Next.

Figure 295: Retention Settings

6. Review the settings that you have chosen. If everything is correct click Submit.

186
Merge1 | User Guide
IMPORTERS

Figure 296: Reviewing the Settings

Note that it would take up to 1 day to apply the retention policy to the locations you chose.

Collector Configuration
After filling in the Name and Description on the Add Importer window and selecting the source on
Configuration Wizard:

1. In the new window opened, add Application ID, and Application Secret/Key.
2. Provide X.509 Certificate Thumbprint in case you activate the Local machine radio button as
the X.509 Certificate source.

Figure 297: Providing Credentials

3. In case you activate Upload file (*.pfx), click the Select button to upload the certificate and
then provide X.509 Certificate Password.

187
Merge1 | User Guide
IMPORTERS

Figure 298: Uploading Certificate

4. You can copy the Application ID from the Azure Active Directory > App Registrations > <your
app name> section (Figure 299).

Figure 299: Copying Application ID

5. Enter the Application Secret/Key that you have saved before.


6. After clicking Next, a pop-up window should appear where you should provide the O365
Global Admin user credentials (please note that usually the pop-up is being blocked by the
browser so pay attention to the top right corner of the browser if the popup is not
appearing). In the next window click Accept, to grant the permissions.

188
Merge1 | User Guide
IMPORTERS

Figure 300: Granting Permissions

Activities to Be Captured
You can specify activities to capture by the collector if no events are needed. Note that chats are
always captured.

Figure 301: Activities to Be Captured

Time Stamp Formatting


For more information, on how to configure this section, see Time Stamp Formatting.

Note
The message tracking (and cut-off date filtering) itself is being done by LastModifiedTime or
OriginalDateTime property (determined by the "Import Based On" setting of the collector ) of the

189
Merge1 | User Guide
IMPORTERS

message, as it is the most accurate way to ensure that no data (including edits) is missing, however,
the timestamp that is being printed in the headers of the message is the message creation timestamp
that we are retrieving from the ConversationXML (which becomes available only after filtering, thus, it
cannot be used before the message is retrieved).That timestamp is communicated by the source
vendor (Microsoft) as the only accurate timestamp.

Advanced Configuration Options


There are following advanced options when configuring the collector with Merge1.

• The Subject Prefix feature will add a prefix before the message subject to facilitate the search
in the target.
• Options Do not download data modified before and Do not download data modified after
allow cutting off data outside the set date range. If the before date is set to 08/17/2022 and
the after date is set to 08/25/2022, only the data between these two dates will be
downloaded. Data outside that timeframe will be ignored. Note that both options can be
used independently as well.
• The Merge Message by Thread if checked combines messages by threads rather than sending
them one by one.
• The message time zone by which the messages are split, can be selected from the drop-down
menu. When Process Incomplete Days option is enabled, the messages of the days that have
not yet ended will be imported in a separate email as well. This option can be selected only if
Merge Messages by Thread is selected.
• The feature Include detailed user information in the body of the message searches Azure AD
for user principal name and then add user display name and mail address from the Azure
Active Directory.

When you have completed the configuration, click Save.

Figure 302: Advanced Configuration Options

Attachments Configuration
For more information on how to configure attachments, see Attachments Configuration.

190
Merge1 | User Guide
IMPORTERS

Message Body
This specifies how the imported message will be displayed in the target. The Basic HTML mode
organizes the data in a simple way and data displayed in a Light Grid Mode is two-toned, easy to view
with limited metadata.

Figure 303: Message Body

Note that in case of using file filtering by size and by type we recommend using custom messages.

Output sample:

Figure 304: Sample Output

Next Steps
After setting up the collector, follow the links below to continue with the configuration of:
• Monitored Users
• Filters
• Targets
• Importer Settings

191
Merge1 | User Guide
IMPORTERS

MICROSOFT TEAMS MEETINGS


Microsoft Teams is a chat and meetings-based workspace in Office 365 that integrates with the apps
and services used to get work done together. It provides the enterprise security and compliance
features you expect from Office365, including broad support for compliance standards, and
eDiscovery and legal hold for channels, chats, and files. Microsoft Teams always encrypts data, at-
rest, and in-transit, and includes multi-factor authentication to enhance identity protection.

The Merge1 Microsoft Teams Meetings solution makes possible the collection of audio/video/screen-
sharing content generated during a Teams meeting.

The solution has two components:

• The first component is the Merge1 Microsoft Teams Meetings Bot, which makes possible for
a bot to automatically join and captures raw data from a meeting with every participant. This
component is deployed in the tenant Azure environment. The bot joins every type of
meeting, ad hoc or scheduled, accessing real-time audio and video streams, including desktop
and app sharing.

Note that this collector requires acquiring Microsoft Teams Meetings Bot to allow recording
and storing of audio/video content at the desired source. For more information, contact
Veritas Technologies LLC Support.

• The second component is the Microsoft Team Meetings Collector. The collector will obtain
the previously recorded calls and meetings by the bot, process the raw data, and send the
final version of the message to the desired location. (On-prem target; cloud target;
transcription tool)

Activities Captured
• Audio calls
• Video calls
• Screen share
• Meetings

Note

Audio is not synchronized with video and screenshare.

Microsoft Azure App Creation


To authenticate via OAuth during the collector configuration, you need to create a Microsoft Azure
Application by following these steps:

1. Login to the Azure Portal using the same credentials as for O365 (Global Admin).

192
Merge1 | User Guide
IMPORTERS

2. Click Azure Active Directory at the top of the page and select App Registration from the left-
side navigation pane.

Figure 305: Azure Active Directory

Figure 306: Navigating to App Registration

3. Click the +New registration button.

Figure 307: New Registration

193
Merge1 | User Guide
IMPORTERS

4. Enter a Name for the application and click the Register button.
5. Find and make a note your Application (client) ID and Directory(tenant) ID as this is needed
for configuring the collector in Merge1.
6. In the navigation pane to the left, go to Certificates & secrets.

Figure 308: Navigating to Certificates

7. Click the Upload certificate button.

Figure 309: Upload Certificate

8. Select a certificate (public key) with one of the following file types: .cer,.pem, .crt, and click
Add. For more information on how to create a certificate, see Creating a Certificate (Private
and Public Keys).

Microsoft Azure Permissions

1. In the navigation pane, click API permissions.

194
Merge1 | User Guide
IMPORTERS

Figure 310: API Permissions

2. Click Microsoft Graph, and in the opened pane select Application permissions.

Figure 311: Application Permissions


3. Select the following permissions:
• User: User.Read.All

Once you have selected all the checkboxes, click Grant Admin Consent.

Collector Configuration
After filling in the Name and Description on the Add Importer window and selecting the Source on
Configuration Wizard:
1. Add Directory (tenant) Id and Application Id.
2. Provide X.509 Certificate Thumbprint in case you activate the Local machine radio button as
the X.509 Certificate source.

195
Merge1 | User Guide
IMPORTERS

Figure 312: Providing Credentials

3. Enter the Certificate Thumbprint.


In case you activate Upload file (*.pfx), click Select to upload the certificate and then provide
X.509 Certificate Password.

Figure 313: Uploading Certificate

4. For configuring the next page, see:


• File Source
• SSH Key Authentication

• To use SSH key authentication method:
7. Enable Use SSH Key Authentication to open the configuration window. SSH Key
Authentication is used for connecting to the source SFTP Server.

196
Merge1 | User Guide
IMPORTERS

Figure 102: Enabling SSH Key Authentication


Make sure the connection settings match those of the SFTP server. Enter the Path to the
required folder.
8. For Authentication, enter the Username provided by the source.
9. Click the Import Private Key button and Import SSH Key will open.
10. Copy and paste the Private Key.

11.
12. Figure 103: Import SSH Key
Click Import and the Public Key field will be populated automatically.
• Execute Script Against Source Files
• PGP Configurations
• Folder Configurations
• Miscellaneous Settings

Areas to Capture
By enabling the corresponding checkbox, you can capture the following content:
• Audio
• Video1
• Screen Share2

1 If the content has been provided by the source.


2 If the content has been provided by the source.

197
Merge1 | User Guide
IMPORTERS

Figure 314: Areas to Capture

The Audio checkbox is enabled by default, and the audio file is always included in the captured
message as a separate file.

Target Audience
To configure the target audience:
1. Enable Internal and external calls to allow capturing calls with both external and internal
users. Note that this option is enabled by default.
2. Enable External calls to capture only calls with the external users.

Figure 315: Target Audience

Note that guest access allows you to invite people from outside your organization to join a team.
Invited people get a guest account in Azure Active Directory and are considered as internal.

Attachments Configuration
1. The Include original data as attachment feature allows including/excluding original data as
attachment by enabling/disabling the corresponding checkbox.
2. When the Ignore Attachments checkbox is checked, all the attachments are being excluded
from the message which will enhance the collector performance. Each message will contain
only information and the link of the excluded attachment.
3. For more information on how to configure attachments, see Attachments Configuration.

Timestamp Formatting
For more information, on how to configure this section, see Time Stamp Formatting.
Example output message:

198
Merge1 | User Guide
IMPORTERS

Figure 316: Output Message

Next Steps
After setting up the collector, follow the links below to continue with the configuration of:
• Monitored Users (N/A)
• Filters
• Targets
• Importer Settings

199
Merge1 | User Guide
IMPORTERS

MICROSOFT TEAMS VIA EXPORT API


Microsoft Teams is a chat-based workspace in Office 365 that integrates with the apps and services
teams use to get work done together. It provides the enterprise security and compliance features you
expect from Office365, including broad support for compliance standards, and eDiscovery and legal
hold for channels, chats, and files. Microsoft Teams always encrypts data, at-rest, and in-transit, and
includes multi-factor authentication to enhance identity protection.

Activities Captured
• Chat messages (created, deleted, edited (the latest version))
• Channel messages (created, deleted, edited (the latest version)) 1

Captured messages can contain:

• Chat/channel info
• Voice messages
• Mentions
• Attachments
• Modern attachments
• Reactions2
• Video clips

Important Notes
Due to the changes in the history tracking mechanism, it is required to set the date value for ‘Do not
download data modified after’ to the previous day of the upgrade and run the collector on the new
version only once.

For daily import processes, it is required to clone the collector after the upgrade and on the cloned
collector, set the date value for ‘Do not download data modified before’ to the day of the upgrade.

Ignoring this recommendation can possibly cause duplicates during the first processing after the
upgrade.

Notes
Due to the Microsoft API issues, we have the following limitations3:
1. Messages of deleted teams/channels are not captured.
2. Messages of deleted chats (in case all the chat participants deleted the chat) are not
captured. It is recommended to have the Delete chat feature disabled.
3. Hosted contents from external users are not captured.

1 To capture data from shared channels, the team owner should be included in the monitored users list.
2
Reactions of already captured messages are not captured.
3 The first three cases have been reported to Microsoft and may be resolved at a later time.

200
Merge1 | User Guide
IMPORTERS

4. Deleted messages are available for capture only 21 days from the time of deletion.
5. Hosted contents (including voice messages) of deleted messages are not captured.

Microsoft Azure App Creation


To authenticate via OAuth during the collector configuration, you need to create a Microsoft Azure
Application by following these steps:
1. Login to the Azure Portal using the same credentials as for O365 (Global Admin).
2. Click Azure Active Directory at the top of the page and select App Registration from the left-
side navigation pane.

Figure 317: Azure Active Directory

Figure 318: Navigating to App Registration

3. Click the +New registration button.

201
Merge1 | User Guide
IMPORTERS

Figure 319: New Registration

4. Enter a Name for the application and click the Register button.
5. Find and make a note your Application (client) ID and Directory(tenant) ID as this is needed
for configuring the collector in Merge1.
6. In the navigation pane to the left, go to Certificates & secrets.

Figure 320: Navigating to Certificates

7. Click the Upload certificate button.

202
Merge1 | User Guide
IMPORTERS

Figure 321: Upload Certificate

8. Select a certificate (public key) with one of the following file types: .cer,.pem, .crt, and click
Add. For more information on how to create a certificate, see Creating a Certificate (Private
and Public Keys).

Microsoft Azure Permissions


1. In the navigation pane, click API permissions.

Figure 322: API Permissions

2. Click Microsoft Graph, and in the opened pane select Application permissions.

203
Merge1 | User Guide
IMPORTERS

Figure 323: Application Permissions

3. Select the following permissions:


• Channel:Channel.ReadBasic.All

• ChannelMember: ChannelMember.Read.All
• ChannelMessage: ChannelMessage.Read.All
• Chat: Chat.Read.All
• Chat: Chat.ReadBasic.All
• ChatMember: ChatMember.Read.All
• ChatMessage: ChatMessage.Read.All
• Files: Files.Read.All
• Group: Group.Read.All
• Team: Team.ReadBasic.All
• User: User.Read.All

4. Once you have selected all the checkboxes, click Add permissions.

Figure 324: Adding Permissions

204
Merge1 | User Guide
IMPORTERS

5. Get back to API permissions section, click + Add a permission, select SharePoint and then
Application permissions. These are the permissions you need to grant:

• Sites: Sites.Read.All
• User: User.Read.All

6. Once you have selected all the checkboxes, click Add permissions.
7. Once you have selected all the checkboxes, click Grant Admin Consent.

Requesting Access to Protected APIs

After creating the application in Azure Portal request access to protected APIs. For more information
about Protected APIs in Microsoft Teams click https://aka.ms/teamsgraph/protectedAPIs.

To request access to protected APIs, follow the steps below:


1. Go to https://aka.ms/teamsgraph/requestaccess to request access.
2. Provide the required information in the data entry form that will open.

Figure 325:Requesting Access (part 1)

3. Click Next. The next form will open.

205
Merge1 | User Guide
IMPORTERS

Figure 326:Requesting Access (part 2)

4. Answer the question and click Submit.

Notes
Creating a subscription in Microsoft Graph requires one of the following licenses:
• Microsoft 365 E5/A5/G5
• Microsoft 365 E5/A5/G5 Compliance
• Microsoft 365 E5/A5/G5/F5 Security
• Microsoft 365 E5/A5/G5 Information Protection and Governance

For pricing and licensing different subscriptions are required:


• In evaluation mode, seeded capacity is shared across all APIs
• Model A is for E5 customers

In case of detecting a user with an improper licensing or other payment issues, the Microsoft Teams
API call fails to fetch the data. Hence, conversations will be captured when at least one of the
participants has the proper Microsoft 365 licensing and has no payment issues. For additional
information about Teams API Pricing and licensing models, see Licensing and payment requirements -
Microsoft Graph | Microsoft Docs.

Enabling Billing for Microsoft Teams APIs in Microsoft Graph


Existing applications that used these metered APIs must now set up an active Azure billing
subscription by June 30th, 2023, to avoid service disruptions. All other applications, including new
applications since March 1st, 2023, are already subject to these requirements. (GCC tenants are
currently exempt from these requirements.)

Applications without an active Azure subscription will get error “HTTP 402 Payment required” when
trying to access the metered APIs using model=A. Applications using Evaluation Mode will also get
error “HTTP 402 Payment required” when the seeded capacity limit is exceeded.

206
Merge1 | User Guide
IMPORTERS

To avoid service disruptions to your application(s), take the following actions if you have not done so
yet:
1. Set up an Azure billing subscription for each application.
2. Set up a payment model (model=A) for each API request of a metered API.
3. If your app is using model=A, ensure that your users have the proper E5 licenses and that DLP
is enabled.

Please note that even if you have previously provided a subscription ID in the Protected API form, for
the subscription to be properly configured, you still need to follow the instructions above to finish the
setup.

Collector Configuration
After filling in the Name and Description on the Add Importer window and selecting the Source on
Configuration Wizard:
1. Add Directory (tenant) Id and Application Id.
2. Provide X.509 Certificate Thumbprint in case you activate the Local machine radio button as
the X.509 Certificate source.

Figure 327: Providing Credentials

3. Enter the Certificate Thumbprint.

In case you activate Upload file (*.pfx), click the Select button to upload the certificate and
then provide X.509 Certificate Password.

207
Merge1 | User Guide
IMPORTERS

Figure 328: Uploading Certificate

Model Selection

Here the user can make a Model Selection which allows selecting licensing and payment options for
Microsoft Teams APIs:
• Evaluation mode – enables access to APIs with limited usage per requesting an application
for evaluation purposes.
• A – is restricted to applications performing a security or compliance function and requires a
supported license.

Figure 329: Model Selection

Conversation Areas to Capture


You can specify the activities to be capture by the collector.

Figure 330: Conversation Areas to Capture

1. Enable All areas to capture data from chats and channels.

208
Merge1 | User Guide
IMPORTERS

2. Enable Certain areas in case either Chats or Channels1 data needs to be collected.

Threading and Formatting

For Threading and Formatting:


• If No threading is activated, a single message is generated for a message in the Chats and
Channels.
• If Per conversation is enabled and Contextual collection of channels is disabled, messages
that were created before the last capture date and edited/deleted after that, are captured
separately, i.e., the already captured messages from the post are not included in the output
message.
• If both Per conversation and Contextual collection of channels are enabled, messages that
were created before the last capture date and edited/deleted after that, are captured with
their post messages in the same output message.

Note that for chats we have the same output message with both Contextual collection of
channels enabled and disabled as this feature relates only to channels.

• If Per room is enabled and Contextual collection of channels is disabled, messages that were
created before the last capture date and edited/deleted after that, are captured separately,
i.e., the already captured messages in the post are not included in the output message.
• If both Per room and Contextual collection of channels are enabled, messages that were
created before the last capture date and edited/deleted after that are captured with their
post messages in the same output message.
• With the Use formatting radio button, the message in the output will be shown formatted.
• With Use light grid formatting, the message will be shown in a light grid mode.
• If Keep only body is activated, the messages will be shown without any formatting.

Figure 331: Threading and Formatting

1 The shared channels' membership type is printed in the output message as "UnknownFutureValue" due to API limitation.

209
Merge1 | User Guide
IMPORTERS

Note that when font-family Segoe UI is present in the output message (HTML tags), and Heading
1,2,3, etc., Bold, and Italic formatting styles are applied, the Segoe UI font is not respected by
Outlook. However, it is respected in HTML online editor.
Also, when Monospaced formatting style is applied, the HTML editor does not respect the given font-
family, and so does the Outlook.

Timestamp Formatting
For more information, on how to configure this section, see Time Stamp Formatting.

Note
The message tracking (and cut-off date filtering) itself is being done by LastModifiedTime or
OriginalDateTime property (determined by the "Import Based On" setting of the collector ) of the
message, as it is the most accurate way to ensure that no data (including edits) is missing, however,
the timestamp that is being printed in the headers of the message is the message creation timestamp
that we are retrieving from the ConversationXML (which becomes available only after filtering, thus, it
cannot be used before the message is retrieved).That timestamp is communicated by the source
vendor (Microsoft) as the only accurate timestamp.

Advanced Configuration Options


There are following advanced options when configuring the collector with Merge1.
• The Subject Prefix feature will add a prefix before the message subject to facilitate the search
in the target.
• Options Do not download data modified before and Do not download data modified after
allow cutting off data outside the set date range. If the before date is set to 08/17/2022 and
the after date is set to 08/25/2022, only the data between these two dates will be
downloaded. Data outside that timeframe will be ignored. Note that both options can be
used independently as well.
• The Include detailed user information in the body of the message feature searches Azure AD
for user principal name and then adds user display name and mail address from the Azure
Active Directory.
• Include mentioned channel/team members information allows getting the information of the
mentioned members in channels/teams by enabling/disabling the corresponding checkbox.

Figure 332: Advanced Configuration Options

210
Merge1 | User Guide
IMPORTERS

Attachments Configuration
1. The Include original data as attachment feature allows including/excluding original data as
attachment by enabling/disabling the corresponding checkbox.
2. The Ignore Attachments checkbox is checked, all the attachments are being excluded from
the message which will enhance the collector performance. Each message will contain only
information and the link of the excluded attachment.1
3. For Captured Modern Attachments, by selecting:
• Latest version - the latest saved version of shared document available at collector
runtime will be captured with the message.
• Shared version - the saved version of the document at the time of sharing in
Microsoft Teams will be captured with the message.

Note that to respect the fidelity of the shared document timestamp, it is


recommended to disable the Edit feature in Microsoft Teams.

Figure 333: Captured Modern Attachments

4. For more information on how to configure attachments, see Attachments Configuration.

Splitting Messages
This option allows splitting large files. In the field the size of a split part of the message can be
specified so that each part does not exceed the set size. For example, if the Max Size for each part of
split message is set to 25MB, and the original message is 65 MB, it will be split into 3 messages, each
not exceeding 25MB.

Figure 334: Splitting Messages

Sample output:

1
In case 'Ignore attachments' is checked and user generates a message in a chat with attachments and then replies to it, the
parent message will not be rendered to the reply in the output message.

211
Merge1 | User Guide
IMPORTERS

Figure 335: Sample Output

Next Steps
After setting up the collector, follow the links below to continue with the configuration of:
• Monitored Users
• Filters
• Targets
• Importer Settings

212
Merge1 | User Guide
IMPORTERS

MICROSOFT TEAMS VIA WEBHOOKS


Webhooks (also called a web callback or HTTP push API) is a way for an app to provide other
applications with real-time information. Webhooks delivers data to other applications. This makes
Webhooks much more efficient for both the provider and the consumers. Webhooks is a method
for an application to provide other applications with real-time information. It delivers data to
other applications in real or near real time. Therefore, Webhooks is sometimes referred to as
“Reverse API,” as it gives the consumer/subscriber what amounts to an API spec, which the
consumer must design as an endpoint where the subscribed events are delivered to. When an
event is detected by the source system that meets the definition of the subscription, Webhooks
makes an HTTP request to the subscriber’s endpoint, and can be reasonably said to be using the
customer’s API. Typically, a POST over Transport Layer Security (TLS), which will then require the
customer to take some action to persist the event on its own systems. Therefore, the Webhooks
model of information exchanges requires more engineering work on the subscriber’s side than
that of a traditional “pull API”, such as MS Graph API or EWS.

We use this technology to capture real-time data from Microsoft Teams.

Activities Captured
• Chat messages (created, edited (previous versions), deleted (the latest version))
• Channel messages (created, edited (previous versions), deleted (the latest version))

Captured messages can contain:


• Chat/Channel info
• System-generated events (call started/ended, members added/deleted/joined/left)
• Attachments
• Modern attachments
• Archived attachments in OneDrive or SharePoint (deleted posts)
• Reactions

Warning
For users that need to use the Merge1 Microsoft Teams via Webhooks importer for reactive
(targeted) discovery:
• Items are available for reactive discovery in the Webhooks portal according to the retention
period set when configuring the subscription in the Working in the Globanet Portal.
• The maximum amount of time is 90 days.
• When running a targeted discovery search, please allow an end-date greater than the
message date to accommodate for latency in delivery of items to the portal by Microsoft.
Even though Webhooks technology is usually instantaneous, Microsoft Support has confirmed
that there are sometimes delays in data processing which affects their webhooks delivery.
Allowing for a larger period for cut-off, ensures that data is not missed during discovery.

213
Merge1 | User Guide
IMPORTERS

Microsoft Azure App Creation


To authenticate via OAuth during the collector configuration:
1. Login to the Azure Portal using the same credentials as for O365 (Global Admin).
2. Click Azure Active Directory at the top of the page and select App Registration from the left-
side navigation pane.

Figure 336: Azure Active Directory

Figure 337: Navigating to App Registration

3. Click the +New registration button.

214
Merge1 | User Guide
IMPORTERS

Figure 338: New Registration

4. Enter a Name for the application and click the Register button.
5. Find and make a note your Application (client) ID and Directory(tenant) ID as this is needed
for configuring the collector in Merge1.
6. In the navigation pane to the left, go to Certificates & secrets.

Figure 339: Navigating to Certificates

7. Click the Upload certificate button.

215
Merge1 | User Guide
IMPORTERS

Figure 340: Upload Certificate

8. Select a certificate (public key) with one of the following file types: .cer,.pem, .crt, and click
Add. For more information on how to create a certificate, see Creating a Certificate (Private
and Public Keys).

Microsoft Azure Permissions


To add permissions for the application:
1. Go to the API permissions in the left side pane and click the Add a permission button.

Figure 341: Adding a Permission

2. Click Microsoft Graph.

216
Merge1 | User Guide
IMPORTERS

Figure 342:Selecting an API

3. Click Application permissions.

Figure 343: Microsoft Graph Permissions

4. Select the following permissions:


• ChannelMessage.Read.All
• ChatMember.Read.All
• ChannelMember.Read.All
• Chat.Read.All
• Group.Read.All
• User.Read.All.

5. Click Add permissions button.

217
Merge1 | User Guide
IMPORTERS

Figure 344: Selecting and Adding Permissions

6. Confirm the permissions by clicking Grant admin consent.

Figure 345: Granting Consent

The permission User.Read can be removed as this is added by Azure by default and is not
required for Merge1.

7. Click the Yes button to grant consent, or No to discard changes.

Figure 346: Confirming the Permissions

Please make sure that the consent has been successfully granted.

8. Click SharePoint.

218
Merge1 | User Guide
IMPORTERS

Figure 347: Selecting SharePoint

9. Click Application permissions.

Figure 348: Selecting Application Permissions

10. Select the Sites.Read.All permission:

219
Merge1 | User Guide
IMPORTERS

Figure 349: Selecting Permissions

11. Click the Add permissions button.

Figure 350: Successful Grant Consent

12. Navigate to the Certificates & secrets page.

Figure 351: The Certificates and Secretes Page

13. Click the + New client secret button.

220
Merge1 | User Guide
IMPORTERS

Figure 352: Adding New Client Secret

14. Copy the Secret and save it in a secure location.

Figure 353: Copying to Clipboard

Requesting Access to Protected APIs


See Requesting Access to Protected APIs.

Managing Encryption Keys


To create a Webhooks Platform subscription, you will need to generate an asymmetric key pair and
upload the public key to the Webhooks website during subscription creation.

Note that this public key will be sent to Microsoft Graph during subscription creation and the key will
be used to encrypt the data before it is sent to Veritas cloud infrastructure, i.e., only Private Key
holders will be able to decrypt the notifications sent by Microsoft Graph. Veritas does not have access
to the private key.

For managing Encryption keys:


1. Obtain a certificate with a pair of asymmetric keys:

221
Merge1 | User Guide
IMPORTERS

• You can self-sign the certificate, since Microsoft Graph does not verify the certificate
issuer, and uses the public key for only encryption
• The key must be of type RSA
• The key size must be between 2048 and 4096 bits.
2. Export the certificate in base64-encoded X.509 format and upload it to the Veritas Webhooks
site during subscription creation.
3. Export the private key and install it on the Merge1 server that will be used to capture data
gathered by the Webhooks Platform.

Note
Creating a Webhooks subscription in Microsoft Graph, requires one of the following licenses:
• Microsoft 365 E5/A5/G5
• Microsoft 365 E5/A5/G5 Compliance
• Microsoft 365 E5/A5/G5/F5 Security
• Microsoft 365 E5/A5/G5 Information Protection and Governance

All participants in the conversation should have the required Microsoft 365 licenses to ensure
complete data collection. For additional information about Teams API Pricing and licensing models,
see Licensing and payment requirements - Microsoft Graph | Microsoft Docs.

Enabling Billing for Microsoft Teams APIs in Microsoft Graph


Existing applications that used these metered APIs must now set up an active Azure billing
subscription by June 30th, 2023, to avoid service disruptions. All other applications, including new
applications since March 1st, 2023, are already subject to these requirements. (GCC tenants are
currently exempt from these requirements.)

Applications without an active Azure subscription will get error “HTTP 402 Payment required” when
trying to access the metered APIs using model=A. Applications using Evaluation Mode will also get
error “HTTP 402 Payment required” when the seeded capacity limit is exceeded.

To avoid service disruptions to your application(s), take the following actions if you have not done so
yet:
1. Set up an Azure billing subscription for each application.
2. Set up a payment model (model=A) for each API request of a metered API.
3. If your app is using model=A, ensure that your users have the proper E5 licenses and that DLP
is enabled.

Please note that even if you have previously provided a subscription ID in the Protected API form, for
the subscription to be properly configured, you still need to follow the instructions above to finish the
setup.

Working in the Globanet Portal


Contact Veritas Technologies LLC Support to get access to Globanet Portal. For more information on
how to manage Globanet Portal Applications and subscriptions, see Working in the Globanet Portal
document listed in the References.

222
Merge1 | User Guide
IMPORTERS

Collector Configuration
After filling in the Name and Description on the Add Importer window and selecting the Source on
Configuration Wizard:
1. Enter the Client ID and Client Secret (See Working in the Globanet Portal), in the
Application ID and the Secret fields correspondingly and click NEXT.

Figure 354: Providing Application Credentials

2. Enter the Subscription ID (See Working in the Globanet Portal), MS Azure Application ID,
and MS Azure Directory ID in the Authentication section.
3. Provide X.509 Certificate Thumbprint in case you activate the Local machine radio button
as the X.509 Certificate source.

Figure 355: Providing Credentials


5. In case you activate Upload file (*.pfx), click the Select button to upload the certificate and
then provide X.509 Certificate Password.

223
Merge1 | User Guide
IMPORTERS

Figure 356: Uploading Certificate

Message Decryption Options


Microsoft Graph does not verify the certificate issuer and uses the public key for only encryption. To
receive the notifications decrypted, enable one of the following options:
• Local machine (default) - the collector gets decryption certificates from the local machine.
• Upload files (*.pfx)

For Upload certificates *(.pfx):


1. Enable Upload certificates *(.pfx).
2. Click +ADD CERTIFICATE.
3. Select the X.509 Certificate file.
4. Provide the X.509 certificate password.

Figure 357: Message Decryption Options

Advanced Configuration Options


There are the following advanced options when configuring the collector with Merge1:
• The Subject Prefix feature will add a prefix before the message subject to facilitate the search
in the target.
• The Merge message by thread if checked combines messages by threads rather than sending
them one by one.
• Select the Message time zone by which the messages the drop-down menu.
• When Process incomplete days option is enabled, the messages of the days that have not yet
ended will be imported in a separate email as well. This option can be selected only if Merge
messages by thread is selected.

224
Merge1 | User Guide
IMPORTERS

Figure 358: Advanced Configuration Options

• Options Do not download data modified before and Do not download data modified after
allow cutting off data outside the set date range. If the before date is set to 08/17/2022 and
the after date is set to 08/25/2022, only the data between these two dates will be
downloaded. Data outside that timeframe will be ignored. Note that both options can be
used independently as well.

Figure 359: Advanced Configuration Options

Attachments Configuration
For more information on how to configure attachments, see Attachments Configuration.

Note that in case of using file filtering by size and by type we recommend using custom messages.

Message Body
This specifies how the imported message will be displayed in the target. The Basic HTML mode
organizes the data in a simple way and data displayed in a Light Grid Mode is two-toned, easy to be
viewed with limited metadata.

Figure 360: Message Body

Output sample:

225
Merge1 | User Guide
IMPORTERS

Figure 361: Output Sample

Next Steps
After setting up the collector, follow the links below to continue with the configuration of:
• Monitored Users
• Filters
• Targets
• Importer Settings

226
Merge1 | User Guide
IMPORTERS

ONEDRIVE FOR BUSINESS


OneDrive is a file-hosting service operated by Microsoft as part of its suite of online services. The
OneDrive collector ’s features include Monitored Users management, i.e., it is possible to specify
which users accounts of Microsoft OneDrive should be captured.

OneDrive metadata is used to create Merge1 email file. The metadata includes document creator
(author in the Merge1 email file), the file name (subject), Modified date (sent date), item id, name,
CreatedBy, CreatedDateTime, LastModifiedBy, LastModifiedDateTime, webUrl, size, parentReference,
folderId and any other tags listed in the message body are added to the email file body.

Activities Captured
• Uploaded files
• Renamed files
• ‘Delete’ event without the file1 2
• New created documents via browser with the file

Notes
• Microsoft OneNote files (where users' notes, drawings, screen clippings, and audio
commentaries are gathered) are captured.
• Only the latest activity is captured in case there are performed more than one activity in the
same file.

Activities Not Captured


• ‘Move to’ events with the file
• Download
• Preview
• Preview in the browser
• All folder activities (create, delete, rename, move, or copy)
• Flow activities

Microsoft Azure App Creation


To authenticate via OAuth during the collector configuration, you need to create a Microsoft Azure
Application by following these steps:
1. Login to the Azure Portal using the same credentials as for O365 (Global Admin).
2. Click Azure Active Directory at the top of the page and select App Registration from the left-
side navigation pane.

1 Delete events are not captured during the first run and immediately after the deletion.
2
Hard deleted items, i.e., items that have been deleted from Recycle bin as well, are not captured.

227
Merge1 | User Guide
IMPORTERS

Figure 362: Azure Active Directory

Figure 363: Navigating to App Registration

3. Click the +New registration button.

Figure 364: New Registration

4. Enter a Name for the application and click the Register button.
5. Enter the enter the URL of your local Merge1 environment in the following format:
https://<your_merge1_domain>/Configuration/OAuthCallback. Click
Register.

228
Merge1 | User Guide
IMPORTERS

Figure 365: Registering an Application

6. Find and make a note your Application (client) ID and Directory(tenant) ID as this is needed
for configuring the collector in Merge1.
7. In the navigation pane to the left, go to Certificates & secrets.

Figure 366: Navigating to Certificates

8. Click the Upload certificate button.

229
Merge1 | User Guide
IMPORTERS

Figure 367: Upload Certificate

9. Select a certificate (public key) with one of the following file types: .cer,.pem, .crt, and click
Add. For more information on how to create a certificate, see Creating a Certificate (Private
and Public Keys).

Microsoft Azure Permissions


1. In the navigation pane to the left, click API permissions.

Figure 368: API Permissions

2. Click Microsoft Graph, and in the opened pane, select Application permissions.

Figure 369: Application Permissions

3. Grant the following permissions:

230
Merge1 | User Guide
IMPORTERS

• Files: Files.Read.All
• Directory: Directory.Read.All
• User: User.Read.All
• Applications: Applications.Read.All
• Applications: Applications.ReadWrite.All1

4. Once you have selected all checkboxes, click Update Permissions.

Figure 370: Updating Permissions

5. Get back to API permissions section, click + Add a permission and select SharePoint API with
Application permissions. These are the permissions you need to grant:
• Sites: Sites.Read.All
• User: User.Read.All
• TermStore: TermStore.Read.All

Once you have selected all three checkboxes, click Add permissions.

Figure 371: Requesting SharePoint Permissions

1 Only required if the certificate has not been already uploaded to the Azure App.

231
Merge1 | User Guide
IMPORTERS

Collector Configuration
After filling in the Name and Description on the Add Importer window and selecting the source on
Configuration Wizard:

To set up the collector:


1. In the new window you need to add Application ID and Application Secret/Key.
2. Provide X.509 Certificate Thumbprint in case you activate the Local machine radio button as
the X.509 Certificate source.

Figure 372: Providing Credentials

3. In case you activate Upload file (*.pfx), click the Select button to upload the certificate and
then provide X.509 Certificate Password.

Figure 373: Uploading Certificate

4. You can copy the Application ID from the Azure Active Directory > App Registrations > <your
app name> section.

232
Merge1 | User Guide
IMPORTERS

5. Enter the Application Secret/Key that you have saved before.


6. After clicking Next, a pop-up window should appear where you can provide the O365 Global
Admin user credentials (usually the pop-up is being blocked by the browser, so pay attention
to the top right corner of the browser if the popup is not appearing). In the next window, click
Accept to grant the permissions.

Figure 374: Granting Permissions

Attachments Configuration
1. The Include original data as attachment feature allows including/excluding original data as
attachment by enabling/disabling the corresponding checkbox.
2. When the Ignore Attachments checkbox is checked, all the attachments are being excluded
from the message which will enhance the collector performance. Each message will contain
only information and the link of the excluded attachment.
3. For more information on how to configure attachments, see Attachments Configuration.

Timestamp Formatting
For more information, on how to configure this section, see Time Stamp Formatting.

Advanced Configuration Options


For Advanced Configuration Options:
1. The Subject Prefix feature will add a prefix before the message subject to facilitate the search
in the target.

233
Merge1 | User Guide
IMPORTERS

2. Options Do not download data modified before and Do not download data modified after
allow cutting off data outside the set date range. If the before date is set to 08/17/2022 and
the after date is set to 08/25/2022, only the data between these two dates will be
downloaded. Data outside that timeframe will be ignored. Note that both options can be
used independently as well.

Figure 375: Advanced Configuration Options


Example output message:

Figure 376: Output Message

Next Steps
After setting up the collector, follow the links below to continue with the configuration of:
• Monitored Users
• Filters
• Targets
• Importer Settings

234
Merge1 | User Guide
IMPORTERS

PIVOT
Pivot is an instant messaging platform that allows collaboration with financial market participants
over its secure and fast network.

Activities Captured
• Participant entered:
o Date time
o Internal flag
o Corporate email ID
• Message:
o Date time
o Content
• Participant left:
o Date time
o Corporate email ID

Collector Configuration
For information on how to configure the following sections of the Source tab, see:
• File Source
• PGP Configurations
• Folder Configurations
• Miscellaneous Settings

Primary Address to Use


Choose the email address type you would like Merge1 to prioritize when processing data from users
that have both the Pivot email address and the Corporate email address.

Figure 377: Primary Address to Use

Example of an output message:

235
Merge1 | User Guide
IMPORTERS

Figure 378: Output Message

Next Steps
After setting up the collector, follow the links below to continue with the configuration of:
• Monitored Users (N/A)
• Filters
• Targets
• Importer Settings

236
Merge1 | User Guide
IMPORTERS

REDTAIL SPEAK
Redtail is a CRM system that focuses on financial advisor/client relationships. The Speak feature is an
add-on model that allows advisors to communicate with their clients, team members, and the
company overall. Through its Speak platform, Redtail can send text messages to communicate with
the clients and recognizes the need for compliance.

Merge1 collects Redtail Speak messages from the Redtail Speak SMTP server. For setting up an SMTP
server, contact Veritas Support | Veritas™.

Activities Captured
• One-on-one chats with team members
• Public/private group conversations

Collector Configuration
For information on how to configure the following sections of the Source tab, see:
• File Source
• SSH Key Authentication
• PGP Configurations
• Folder Configurations
• Miscellaneous Settings

Next Steps
After setting up the collector, follow the links below to continue with the configuration of:
• Monitored Users (N/A)
• Filters
• Targets
• Importer Settings

237
Merge1 | User Guide
IMPORTERS

REFINITIV
Refinitiv brings a user the latest news from around the world, covering breaking news in markets, the
business, politics, entertainment, technology, video. Merge1 Refinitiv collector processes data from
Eikon Messenger and SI Dealing.

Eikon Messenger is captured and delivered to clients either via a daily XML posted to FTP (External
Feed) or hosted archiving (Global Relay). The Eikon Messenger instant messaging network is based on
an individual’s user ID + firm name and is captured/recognized as such.

Contact Veritas Technologies Support for more details on the mapping corresponding to the source,
you are going to use for Refinitiv collector.

Activities Captured
• Person to person messages
• Group chats
• Attachments
• Disclaimers

Notes
• To process current schema files, the file filter should be configured with the following
extensions: messages\.zip, attachments\.zip,(^.+?)\.csv.
• Quarantine sources column on the Dashboard shows the number of the files moved to the
quarantine folder while processing source files with the below listed configured formats. All
other files have initially been considered unwanted files and have been moved to the
quarantine folder.

Collector Configuration
For information on how to configure the following sections of the Source tab, see:
• File Source
• PGP Configurations
• Attachment Validation
• Folder Configurations
• Miscellaneous Settings

Refinitiv Options
The option Split by Day merges the messages from the same day into one email message. The time
zone by which the messages are split can be selected from the drop-down menu. This option can be
selected only if Merge Messages by Thread is selected.

238
Merge1 | User Guide
IMPORTERS

Figure 379: Refinitiv Options

Message Body
In the Refinitiv collector you can choose between three IB message body options, which specify how
the imported message will be displayed in the target.

Figure 380: Message Body

When you select the Plain Mode option, you will see the interactions below each other.
If you enable the Grid Mode option, you will see the information in the five following columns:
• UTC Time Stamp, which includes the date of the sent message
• Content
• Event Type, what kind of an event the activity is (joining the chat, sending a message, etc.)
• Message ID
• Attachment.

It is possible to change the color scheme of the grid mode by clicking the Select Style link.

Figure 381: Selecting Grid Mode Style

When you select the Light Grid Mode, the data is two-toned, easy to be viewed with limited
metadata.

Examples of Output Messages:

Plain Mode:

239
Merge1 | User Guide
IMPORTERS

Figure 382: Plain Mode

Next Steps
After setting up the collector, follow the links below to continue with the configuration of:
• Monitored Users (N/A)
• Filters
• Targets
• Importer Settings

240
Merge1 | User Guide
IMPORTERS

RINGCENTRAL
RingCentral Team Messaging is a team collaboration solution that helps organize and centralize team
communication. RingCentral provides a compliance API that will be used to download messages and
meeting-based content.

Activities Captured
• Chats
• Tasks
• Notes
• Events

Compliance Exports
Compliance Exports is a special capability specifically built for companies and regulated industries,
such as financial services, with compliance requirements for using electronic communication in the
workplace. This feature is also a fail-safe way of preserving business communications for legal
discovery or internal review.

https://developers.ringcentral.com/guide/team-messaging/manual/compliance-export-structure

When you download a compliance export, you will receive a .zip file that contains a number of files
and folders that contain all of the data associated with your data export.

Note
Only the content and items that fall within the specified period for the archive are included in the
downloaded/compliance export file. Therefore, data outside that time range is not captured.

Creating a RingCentral Application


To create the application:
1. Sign in to the RingCentral Developer Console.

Figure 383: Signing In

241
Merge1 | User Guide
IMPORTERS

2. You will be navigated to the Apps console were all your apps are listed and can be managed.
Click Create App at the upper right corner of All applications.

Figure 384: Navigating to the Applications

Note that if you see the Create App button, but it is disabled, then your account lacks the
permission required to create an app. Contact your account administrator to request this
permission.
3. Select your app type and click Next.

Figure 385: Selecting App Type and Permission

4. In the next opened window, enter App Name and Description.

Figure 386: Creating an App

242
Merge1 | User Guide
IMPORTERS

5. Select No for Do you intend to promote this app in the RingCentral App Gallery? (for internal-
use only)
6. In the Auth section, make sure 3-legged OAuth flow authorization code is enabled and select
Server-side web app (most common).
7. In the OAuth Redirect URI field, enter the URL of your local Merge1 environment in the OAuth
Redirect URI field with the following format:
https://<merge1_instance>/Configuration/OAuthCallback 1.

Figure 387: Creating an App

8. In the Security section, select Read Accounts and Team Messaging from the App Permissions
drop-down list. Click Create.

In the opened window, you will find your application details, including Client ID, Client Secret, and
RingCentral Server URL.

Figure 388: Copying the Credentials

1
You can find it in the 5th point of the click information.

243
Merge1 | User Guide
IMPORTERS

Collector Configuration
To set up the collector:
1. Click Add Importer, specify Name and a Description(optional), and select the collector from
the list. The RingCentral Application Configuration window will open.
2. In the Application ID field enter Client ID copied previously, in Application secret/key, enter
the copied Client Secret, enter the API server URL in the RingCentral server URL field, and
then click Next.

Figure 389: RingCentral Application Configuration

Time Stamp Formatting


For more information, on how to configure this section see Time Stamp Formatting.

Advanced Configuration Options


There are following advanced options when configuring the collector with Merge1.
• The Subject Prefix feature will add a prefix before the message subject to facilitate the search
in the target.
• The Merge message by thread if checked combines messages by threads rather than sending
them one by one.
• Select the Message time zone from the drop-down menu. When Process incomplete days
option is enabled, the messages of the days that have not yet ended will be imported in a
separate email as well. This option can be selected only if Merge messages by thread is
selected.
• Options Do not download data modified before and Do not download data modified after
allow cutting off data outside the set date range. If the before date is set to 08/17/2022 and
the after date is set to 08/25/2022, only the data between these two dates will be
downloaded. Data outside that timeframe will be ignored. Note that both options can be
used independently as well.

244
Merge1 | User Guide
IMPORTERS

Figure 390: Advanced Configuration Options

Attachments Configuration
For more information on how to configure attachments, see Attachments Configuration.

Note when the Ignore Attachments checkbox is checked, all the attachments are being excluded from
the message which will enhance the collector performance. Each message will contain only
information and the link of the excluded attachment.
Note that in case of using file filtering by size and by type, we recommend using custom messages.
Sample message:

Figure 391: Sample Message

Next Steps
After setting up the collector, follow the links below to continue with the configuration of:
• Monitored Users
• Filters
• Targets
• Importer Settings

245
Merge1 | User Guide
IMPORTERS

SERVICENOW
ServiceNow is a customizable service management platform that facilitates requests for support items
such as hardware, software requests. The platform has ability for partners to develop solutions and
add to the ServiceNow app library.

Activities Captured
• Live messages with comments and attachments created in My Feed
• Live messages with comments and attachments created in Company Feed
• Live messages with comments and attachments created in Group feed (Public/Private)
• Conversations with comments and attachments (one-on-one, group)
• Deletes
• Polls with choices and votes
• Like counts
• Links
• Mentions
• Emojis

Note that when the group is deleted, the messages are not captured.

Activities not Captured


• Record feed
• Tasks with comments
• Incidents with comments
• Requests with comments
• Requested items with comments
• Problem with comments
• Change request
• Change task

Creating a ServiceNow Application


The administrator of your organization must perform the following steps:
1. Log in to ServiceNow instance and navigate to System OAuth > Application Registry.

Figure 392: Navigating to the Application Registry

246
Merge1 | User Guide
IMPORTERS

2. Click the Application Registry and the applications list will open. Click New.

Figure 393: Creating New Application

3. Select the Create an OAuth API endpoint for external clients option.

Figure 394: Selecting the OAuth Application

4. Enter a name for the application.


5. Unlock the Redirect_URI field and enter the URL of your local Merge1 environment with the
following format: https://merge1_instance/Configuration/OAuthCallback and
click the Submit button.

Figure 395: Registring an Application

6. After executing the provided steps, on the Application Registry page you will find the
application you have just created. Click your application, and in the opened window, you will
find your application details, including Client ID and Client Secret.

247
Merge1 | User Guide
IMPORTERS

Figure 396: Copying the Client ID and Secret

7. Copy and save the Client ID and Secret to later provide them to Merge1 as part of ServiceNow
configuration.

Collector Configuration
To set up the collector:
1. Click Add Importer, specify Name and a Description (optional), and select the collector from
the list. The ServiceNow Application Configuration window will open.
2. Add your ServiceNow Instance URL, the App Key copied previously in the Application ID field,
and in Application Secret/Key, enter copied Secret, and then click NEXT.

Figure 397: ServiceNow Application Configuration

Timestamp Formatting
In addition to the primary stamp, a second timestamp can be enabled with its time zone. From the
drop-down list you can choose the time zone of the timestamp. The format of the timestamp in the
output message can also be specified from the six options in the Date time format drop-down list. You
should also select ServiceNow API Time zone which shows system default time zone on ServiceNow
instance1.

1 This is a mandatory field.

248
Merge1 | User Guide
IMPORTERS

Figure 398: Timestamp Formatting

Note that if selected time zone is not matching with your ServiceNow instance default time zone
there might be some unwanted consequences.

Advanced Configuration Options


For more information on how to configure Advanced Configuration Options, see Advanced
Configuration Options.

Attachment Configuration
For more information on how to configure attachments, see Attachments Configuration.

Message Body
This specifies how the imported message will be displayed in the target. The Basic HTML mode
organizes the data in a simple way and data displayed in a Light Grid Mode is two-toned, easy to be
viewed with limited metadata.

Figure 399: Message Body

Note that in case of using file filtering by size and by type we recommend using custom messages.

Next Steps
After setting up the collector, follow the links below to continue with the configuration of:
• Monitored Users
• Filters
• Targets
• Importer Settings

249
Merge1 | User Guide
IMPORTERS

SHAREPOINT
SharePoint is a web-based collaborative platform that integrates with Microsoft Office. Launched in
2001, SharePoint is primarily sold as a document management and storage system, but the product is
highly configurable, and the usage varies substantially among organizations.

SharePoint can refer to one or more SharePoint products or technologies, including:


• SharePoint Online
• SharePoint Server
• SharePoint Foundation
• SharePoint Designer 2013
• OneDrive for Business sync.

The Merge1 SharePoint collector captures data from SharePoint Online.

Activities Captured
• Newsfeed/Document library/ Picture library posts
• Newsfeed /Document library/ Picture library comments
• Custom lists items
• Custom lists comments
• Site page comments

Note
The SharePoint CSOM API provides two identical versions of the same data with a different version
numbering and for the storage and visibility sack, only one version is kept.

Microsoft Azure App Creation


To authenticate via OAuth during the collector configuration, you need to create a Microsoft Azure
Application by following these steps:
1. Login to the Azure Portal using the same credentials as for O365 (Global Admin).
2. Click Azure Active Directory at the top of the page and select App Registration from the left-
side navigation pane.

Figure 400: Azure Active Directory

250
Merge1 | User Guide
IMPORTERS

Figure 401: Navigating to App Registration

3. Click the +New registration button.

Figure 402: New Registration

4. Enter a Name for the application and click the Register button.
5. Enter the enter the URL of your local Merge1 environment in the following format:
https://<your_merge1_domain>/Configuration/OAuthCallback. Click
Register.

251
Merge1 | User Guide
IMPORTERS

Figure 403: Registering an Application

6. Find and make a note your Application (client) ID and Directory(tenant) ID as this is needed
for configuring the collector in Merge1.
7. In the navigation pane to the left, go to Certificates & secrets.

Figure 404: Navigating to Certificates

8. Click the Upload certificate button.

252
Merge1 | User Guide
IMPORTERS

Figure 405: Upload Certificate

9. Select a certificate (public key) with one of the following file types: .cer,.pem, .crt, and click
Add. For more information on how to create a certificate, see Creating a Certificate (Private
and Public Keys).

Microsoft Azure Permissions


For permissions:
1. In the navigation pane to the left, click API permissions.

Figure 406: API Permissions

2. Click Microsoft Graph, in the opened pane select Application permissions.

253
Merge1 | User Guide
IMPORTERS

Figure 407: Application Permissions

3. Grant the following permissions:


• Applications: Applications.Read.All
• Applications: Applications.ReadWrite.All1
• Files: Files.Read.All
• Directory: Directory.Read.All
• User: User.Read.All

4. Once you have selected all three checkboxes, click Update permissions.

Figure 408: Updating Permissions

5. Get back to API permissions section, click + Add a permission and select SharePoint API with
Application permissions (Figure 409). These are the permissions you need to grant:
• Sites: Sites.FullControl.All; Sites.Read.All

1 Only required if the certificate has not been already uploaded to the Azure App.

254
Merge1 | User Guide
IMPORTERS

• User: User.Read.All
• TermStore: TermStore.Read.All

Once you have selected all three checkboxes, click Add Permissions.

Figure 409: Requesting SharePoint Permissions

Collector Configuration
To set up the collector:
1. After you click Add Importer, and specify Name and a Description(optional), in the opened
window you need to provide Application ID, and Application Secret/Key.

You can copy the Application ID from the Azure Active Directory > App Registrations > <your
app name> section.

Figure 410: Copying an Application ID

2. Enter the Application Secret/Key that you have saved before.


3. Provide X.509 Certificate Thumbprint in case you activate the Local machine radio button as
the X.509 Certificate Source.

255
Merge1 | User Guide
IMPORTERS

Figure 411: Providing Credentials (Thumbprint)

4. In case you activate Upload file (*.pfx), click the Select button to upload the certificate and
then provide X.509 Certificate Password.

Figure 412: Uploading Certificate

5. After clicking Next, a pop-up window should appear where you should provide the O365
Global Admin user credentials (please note that usually the pop-up is being blocked by the
browser so pay attention to the top right corner of the browser if the popup is not
appearing). In the next window, click Accept to grant the permissions.

256
Merge1 | User Guide
IMPORTERS

Figure 413: Granting Permissions

SharePoint Activities
For SharePoint activities:
1. Activate Monitor all sites in case all SharePoint sites should be monitored. In this case, file
upload and download options will be inactive.
2. Activate Monitor certain sites in case only certain SharePoint sites/sub-sites should be
monitored.
3. Upload the CSV file that includes:
• The site/sub-site URL which can be found by clicking the Copy button from the right-
side opened Page Details window.
• TRUE or FALSE options which will specify whether the sub-sites should or should not
be monitored accordingly. If not specified, the default value will be FALSE, i.e., sub-
sites will not be monitored.

4. In case you need to make changes in the CSV, download the already uploaded file, make the
necessary changes, and upload it again.

Figure 414: SharePoint Activities

The following activities can be captured:

257
Merge1 | User Guide
IMPORTERS

• Microfeed
• Site page
• Document library
• Picture library
• Custom list

If the file names contain the “#” and “%” symbols, they will not be downloaded.

Timestamp Formatting
For more information on how to configure this section, see Time Stamp Formatting.

Advanced Configuration Options


For more information on how to configure Advance Configuration Options, see Advanced
Configuration Options.

For Processing Mode, here are the following options:

• The Single message per event captures each event (post, comment, reply) in one message.
• The Single message per comment and its replies/sub-comments captures a message and all
replies and comments related to it in one output message.
• The Single message per site captures all messages and their replies and comments in one
combined message.

Figure 415: Advanced Configuration Options

If any event has been changed after single Merge1 run, when it is run the next time, the updated
version of the event will be imported. The processing modes apply both to the Newsfeed and to the
Site Page comments.

Attachment Configuration
1. When the Ignore Attachments checkbox is checked, all the attachments are being excluded
from the message enhancing the collector performance. Each message will contain only
information and the link of the excluded attachment.
2. For more information on how to configure attachments, see Attachments Configuration.

Note that in case of using file filtering by size and by type, we recommend using custom messages.
Example of output message:

258
Merge1 | User Guide
IMPORTERS

Figure 416: Output Message

Next Steps
After setting up the collector, follow the links below to continue with the configuration of:
• Monitored Users
• Filters
• Targets
• Importer Settings

259
Merge1 | User Guide
IMPORTERS

SKYPE FOR BUSINESS


Skype for Business is an instant messaging client used with Skype for Business Server or with Skype for
Business Online. Skype for Business is an enterprise software.

Merge1 captures OCS/Lync/Skype for Business chats from SQL databases. Attachments are not
captured, so they should be disabled for the compliance.

The configuration page consists of three database configurations:


• Archive database usually named LCSLogs contains all the communications between the users.
• Persistent Chat database is MGC contain persistent chats.
• Compliance database is only used to capture participant entered, participant left, room
deleted events, it must be configured along with the Persistent Chat database, otherwise,
the information will not be captured.

To capture messages from persistent chat rooms, Enable Chat History option should be selected from
Persistent Chat category section.

Activities Captured
• Messages between users
• Persistent chats
• Message deletes not allowed by the system
• Message edits not allowed by the system

DB Configuration
Merge1 retrieves data from Lync/Skype for Business directly from its database(s).

Select the Source System Type from the drop-down list. (Merge1 supports Lync/Skype for Business
versions 2007 through 2013) Persistent Chat and Compliance databases are configurable for version
2013 only.

Note
Your Merge1 service account must have read access to your Skype for Business Compliance
Databases (the default database names for Skype for Business are: LCSlogs, mgc, mgccomp).

260
Merge1 | User Guide
IMPORTERS

Figure 417: DB Configuration

In the Merge1 Configuration for Skype for Business, we have three types of databases: Archive,
Persistent Chat, and Compliance, which are configured individually by providing database server
addresses and authentication credentials.

To change the configurations of individual database types, click Configure next to the Archive
Database.

All three types of databases are configured as follows:

1. Select the SQL Server from the drop-down menu.


2. Choose the authentication method to connect to the server. If Windows Authentication is
chosen Merge1 will connect to it using the Windows credentials of the account, it is set upon.
If SQL Server Authentication is chosen it can be connected to with the SQL Server credentials.
3. Select the database, where Skype files are stored, from the drop-down list after connecting to
the server.
4. Advanced Connection Parameters allow specifying the following:
• In the Connection timeout field, the time during which the query is not processed can
be specified to yield timeout.
• In the Load balance timeout field, the time during which the inactive connections
should be kept open in a connection pool can be specified. An inactive connection is a
database session that is not in use by an application.
• Min pool size is the minimum number of requests the application may process
concurrently.
• Max pool size is the maximum number of requests the application may process
concurrently.
• Network packet size is the fixed-size chunk of data that transfers requests and results
between clients and servers. This field specifies in what file-size chunks the file data
should be transferred.
• Asynchronous Processing, when enabled, allows various workflows to run at the same
time.
• Encrypt should be checked, when SQL Server uses SSL encryption for all data sent
between the client and server if the server has a certificate installed.
• Enlist when enabled, checks whether the SQL Server connection pooler automatically
enlists the connection in the creation thread's current transaction context.
• Pooling, if enabled keeps the database connections active so that, when a connection
is later requested, one of the active ones is used in preference to have to create
another one.
• Replication is a technique through which an instance of a database is exactly copied
to, transferred to, or integrated with another location. Database replication is done

261
Merge1 | User Guide
IMPORTERS

to provide a consistent copy of data across all the database nodes. It also removes
any data redundancy, merging of two databases into one and updating the secondary
databases with outdated or incomplete data.

Figure 418: Selecting Database

Other Options
For other options:
• The Subject Prefix is added to the subject line of imported emails. This is useful for organizing
imported data, i.e., when multiple sources share a common target.
• When Single Message per Conversation is selected, a single message is archived for each
conversation.
• When Single Message per Conversation Contributor is selected, a single message is archived
for each conversation with one version of the conversation per participant. This allows for the
data to be searched for based on the participant’s name. You can enable Bloomberg Vault
Format to enable Bloomberg archive formatting.
• If Single Message per IM is enabled, each IM in the conversation is imported as a separate
message.
• If Single Message per User (Combine all conversations) is enabled, a separate archive is
created for each User and includes all conversation of that participant. The From field will
contain the user's email address, the To field will contain all the email addresses of those with
whom that user has chatted, and the Body will contain all the user's conversations.
• Options Do not download data modified before and Do not download data modified after
allow cutting off data outside the set date range. If the before date is set to 08/17/2022 and
the after date is set to 08/25/2022, only the data between these two dates will be
downloaded. Data outside that timeframe will be ignored. Note that both options can be
used independently as well.
• Enable Message Chunking if you want to break down the data segments into chunks
containing the specified number of messages.

262
Merge1 | User Guide
IMPORTERS

• If you want to exclude messages that were sent within the past X number of hours, you can
enable Archiving Delay Check.
• For persistent chats use _ as user identifier option allows specifying the values from which
columns of the source DB should be assigned to the monitored users. The options are:
prinUri, prinEmail, prinADUserPrincipalName.
• Enabling Bloomberg Vault Format checkbox output message will be as shown.

Figure 419: Other Options

Archiving Delay Check Warning


The Delayed Archive feature is meant to mitigate a problem caused by a perceived deficiency in Skype
for Business whereby messages may enter the Compliance database later than anticipated. Merge1
can be configured to not only address current (daily) messages but also re-examine messages up to
72 hours in the past (look back period) to determine if there were late arriving messages and process
those as well. The bigger the look back period, the more processing Merge1 will have to do. We
recommend choosing a minimal look back period only when necessary and to never exceed 72 hours.

Recommended Use Case


The Skype for Business database, where the messages are stored, is not updated synchronously with
the application. It takes some time for the messages to be synchronized into the Skype for Business
database. Therefore, we recommend running the Skype for Business collector only one time a day on
a non-working hour.

263
Merge1 | User Guide
IMPORTERS

Example of Single Message per Conversation:

Figure 420: Output Message

Next Steps
After setting up the collector, follow the links below to continue with the configuration of:
• Monitored Users
• Filters
• Targets
• Importer Settings

264
Merge1 | User Guide
IMPORTERS

SLACK eDISCOVERY
The Slack eDiscovery collector allows retrieving data from Slack Enterprise account workspaces,
consolidate it into one archive or mail for eDiscovery. Enterprise Grid is a "network" of two or more
Slack workspace instances. Each Slack workspace has its team ID, its directory of members, its
channels, conversations, files, and zeitgeist.

To set up the Slack eDiscovery collector, open the C:\Program Files\Globanet Consulting Services\Merge1
7.0\UserSettings.config folder1 and replace the last four lines with the following:

<add key="SiteUrl" value="https://localhost/" />


<add key="ResourcesUrl" value="https://localhost/" />
<add key="OAuthCallbackUrl" value="https://localhost/" />
</UserSettings>

In addition, you should contact Slack at [email protected] and ask to enable Discovery API for your
organization before finishing the collector set up.

You should use https://localhost to access Merge1 portal for passing the OAuth for eDiscovery.

Note that after setting up you can change it back to your IP address.

Activities Captured
• Activities from all workspaces
• Direct messages
• Multi participant direct messages
• Channel conversations/messages
• Attachments (the attachment itself is included in the message generated by Merge1 as an
attachment)
• Attachments shared using third-party integrations such as OneDrive (only the link is included
in the body of the message generated by Merge1)
• Emojis (as texts)
• Deletes (including the deleted message and the event itself)
• Edits (including the message before and after it is edited)
• Guest conversations
• Message reactions2
• Shared channel events (channels shared with external organizations3)
• Channel join event
• Set channel purpose event

1 For Merge1 version 6.0, the path will be C:\Program Files\Globanet Consulting Services\Merge1
6.0\UserSettings.config.
2 Reactions for deleted messages are not captured.
3 Including the external users’ names.

265
Merge1 | User Guide
IMPORTERS

• Files delete event

Note that capturing the edit and delete activities depend on the retention policy of your Slack
Enterprise account. You can set message retention to "Keep all messages and keep edit and deletion
logs" from https://my.slack.com/admin/settings#data_retention. This will work for public channels. If
you need to capture all edit and deletion logs for private channels and direct messages as well, please
check the Retention Policy of your Slack Enterprise account.

Collector Configuration
To set up the Slack eDiscovery collector:
1. Log into your Slack Enterprise workspace using the organization URL. You should stay logged
into your account when adding a Merge1 collector.

Figure 421: Signing In

2. Click Manage Organization on the upper right corner.

Figure 422: Navigating to Manage Organizations

3. Enter the necessary workspace.


4. Confirm that the account used for configuring Merge1 has the necessary permissions, i.e., is
either an Org. Owner or a Primary Org. Owner.

266
Merge1 | User Guide
IMPORTERS

Figure 423: Organizational Members

5. Leave the window open.


6. Go to Merge1 Collector and add click Add Importer.
7. Add a Name to the importer and a Description and select the collector from the collectors list.
8. After receiving a confirmation from us, contact [email protected] and ask to enable
Discovery API for your organization.
9. Add your Slack eDiscovery Organization URL in the Organization Domain field. If the
organization domain has enterprise subdomain in it, it should be omitted from the field. For
example, the domain veritas.enterprise.slack.com should be filled in as veritas.slack.com
(Figure 424).
10. Click NEXT, to initialize the connection after the Discovery API is enabled. Discovery API allows
using approved third-party apps (in this case Merge1) to export, archive, or meet other
security and compliance obligations for any organization content.

Figure 424: Providing an Organizational Domain

11. Authorize the connection between Slack eDiscovery and Merge1.

267
Merge1 | User Guide
IMPORTERS

Figure 425: Authorizing the Connection

12. Go to the next step to set up the Timestamp Formatting.

Time Stamp Formatting


For more information, on how to configure this section, see Time Stamp Formatting.

Advanced Configuration Options


There are the following advanced options when configuring the collector with Merge1:
• If the option Single Message per Channel is enabled, Merge1 retrieves the data from a
channel and archives it as one message.
• Select the Message time zone from the dropdown list.
• Process Incomplete Days –when this option is enabled, the messages of the days that have
not yet ended will be imported in a separate email as well. This option can be selected only if
Single Message per Channel is selected.
• Import Archived Channel – when this option is selected, Merge1 imports the data from
archive channels in Slack.
• The Subject Prefix is added to the subject line of imported emails. For example, if entered
subject prefix is “Slack”. This is useful for organizing imported data, i.e., when multiple
sources share a common target.
• Do not download data modified before and Do not download data modified after – these
options allow cutting off data outside the set date range. If the before date is set to
08/17/2022 and the after date is set to 08/25/2022, only the data between these two dates
will be downloaded. Data outside that timeframe will be ignored. Note that both options can
be used independently as well.

268
Merge1 | User Guide
IMPORTERS

Figure 426: Advanced Configuration Options

Exclude File Types


When Do not download files greater than X megabyte(s) is selected, the files that are bigger than the
filled-in number of megabytes are not downloaded.

Figure 427: Exclude File Types

Message Body
This specifies how the imported message will be displayed in the target. The Plain Text mode
organizes the data in a simple way and data displayed in a Light Grid Mode is two-toned, easy to be
viewed with limited metadata.

Figure 428: Message Body

Next Steps
After setting up the collector, follow the links below to continue with the configuration of:
• Monitored Users
• Filters
• Targets
• Importer Settings

269
Merge1 | User Guide
IMPORTERS

SYMPHONY
Symphony provides secure enterprise collaboration. Users can communicate with internal and
external teams, securely share documents and content, conduct meetings with conferencing and
screen-sharing, leverage open APIs in the growing app ecosystem to streamline and automate
workflows.

The Symphony collector works with XML format only. Make sure that the files are in the correct
format. There are following mappings of XML tags to emails:

• <initiator> = From
• <sentTo> = To
• <readBy> = CC

Note that the Symphony collector can process only unzipped XML files.

Activities Captured
• Post date
• From
• Message content
• Record type
• Message ID
• Attachment
• Downloaded by
• Event action
• Read by

Collector Configuration
For information on how to configure the following sections of the Source tab, see:
• File Source
• SSH Key Authentication
• PGP Configurations
• Folder Configurations

Miscellaneous Settings
The Subject prefix is added to the subject line of imported emails. This is useful for organizing
imported data especially when multiple sources share a common target.

Figure 429: Misc Settings

270
Merge1 | User Guide
IMPORTERS

Attachment Validation
Merge1 enables you to develop customized notes for attachment validation. The default setting is
Fail Messages with missing Attachments, so the messages that do not have attachments are failed
and can be viewed under the Reports.
If you select the Replace all the attachments with the following note and input your custom note, all
the attachments to the messages will not be processed and in their place under the Reports you will
see only the custom message that you have entered.

If you select the Replace missing attachments with the following note and input your custom note, all
the missing attachments of the messages will not be processed, and you will see only the custom
message that you have entered (Figure 430).

Figure 430: Attachment Validation

• Merge Messages by Thread - when selected, messages with identical thread IDs are grouped
into individual emails (as opposed to receiving a separate email per message). It is possible to
select additional fields (Downloaded By and Read By) to be added to the merged message.
• Use the timestamp of the first record as message timestamp - selected only when Merge
Messages by Thread is selected. When enabled, it uses the timestamp of the first Symphony
message as a message timestamp, instead of the one of the last messages.
• Grid Mode - activated only when Merge Messages by Thread is selected. It allows viewing the
email content in a compact grid format. When Grid Mode is selected additional checkboxes
will appear that can activate extra columns in the gridded message. The Grid mode color
scheme can also be customized by clicking Select Style.
Note that limited information will be included in the output message:

271
Merge1 | User Guide
IMPORTERS

o Postdate
o From
o MessageContent
o RecordType
o MessageID
o Attachment
o DownloadedBy
o EventAction
o ReadBy

• When Process messages with ‘’IsArchived’’ tag is checked, messages that have the IsArchived
tag are processed as well.
• When Ignore readby messages is checked, messages with ReadBy field in them will be
ignored.

Split Message
Splitting Messages option allows splitting big files. In the field the size of a split part of the message
can be specified so that each part does not exceed the set size (Figure 431). For example, if the Max
Size for each part of split message is set to 25MB, and the original message is 65 MB, it will be split
into 3 messages, each not exceeding 25MB.

Figure 431: Splitting Messages

In case you have a limitation of 25 MB on your server, you must split your message max to 17MB as
the server also must have space for some encryption and decryption tasks that are being carried out
by Merge1.

Include Record Type


In this section the types of records that should be processed from Symphony can be specified. At least
one type should be selected. There are three types of records from Symphony that can be selected:

• Social Message
• Event
• Email Notification.

272
Merge1 | User Guide
IMPORTERS

Figure 432: Include Record Type

Sample output message:

Example of a part of the message from email when Merge Messages by Thread is selected. On the
right the message is shown when additional options to show DownloadedBy and ReadBy are selected.

Figure 433: Sample Message

Example of email with Grid Mode enabled.

Figure 434: Sample Message

Example of an email with Grid Mode enabled with additional options checked (DownloadedBy,
ReadBy, Attachment, Event Action).

273
Merge1 | User Guide
IMPORTERS

Figure 435: Sample Message

Example of email with Grid Mode enabled:

Figure 436: Selecting Grid Mode Style

Next Steps
After setting up the collector, follow the links below to continue with the configuration of:
• Monitored Users (N/A)
• Filters
• Targets
• Importer Settings

274
Merge1 | User Guide
IMPORTERS

TEXT-DELIMITED
Merge1 Text- Delimited is designed to allow rapidly developing text- delimited file processing. The
objective of the collector is to map the text- delimited fields to email required format. The mapping is
done based on the uploaded XML template. It varies from source to source; it must be written
separately. For more details on the mapping, corresponding to the source, you are going to use it for,
contact our support at https://www.veritas.com/support.

Activities Captured
• Participants: From, To, CC, and BCC
• Start time
• End time
• Body message
• Custom mappings
• Attachments

Notes
• To process the attachments, add the full path to the attachment in the CSV document. To
prevent files with similar names, we recommend creating attachments with folder structure
to avoid clash of files with similar names shared on different days and in different
conversations.
• To process the files properly, the files, that are going to be processed, and attachments
should have the same name.

Collector Configuration
For information on how to configure the following sections of the Source tab, see:
• File Source
• PGP Configurations
• Folder Configurations
• Miscellaneous Settings

Text-Based Collector Options


Upload an XML template and select the relevant time zone. Merge1 will attempt to retrieve the
correct time zone from the source automatically.

275
Merge1 | User Guide
IMPORTERS

Figure 437: Text Based Collector Options

The XML file should contain the information about the file itself. It should specify if the file contains
headers, the number of columns, delimiter type and the text qualifier. Next part of the XML file
should assign column names, identify data types, and indicate if the columns are optional. Lastly, it
should map the columns to the expected data fields: From/Sender, To, Subject/Title,
Date/ActivityDateTime, and Body/Content (Figure 439; Figure 440).

If you want to manually set up the Source Time Zone, select the relevant one from the drop-down list.

The Source Time zone setting will attempt to retrieve the time zone from the data itself automatically.

Message Body
This specifies how the imported message will be displayed in the target. The Plain Text mode
organizes the data in a simple way and data displayed in a Light Grid Mode is two-toned, easy to be
viewed with limited metadata (Figure 438).

Figure 438: Message Body

XML Template Configuration Guideline


To configure XML Template sample:
1. Configure the information about the file itself: if the file contains headers, number of
columns, delimiter type, text qualifier and attachment method 1.

<version>TD_3.0</version>
<options>
<containsHeader>Yes</containsHeader>

1 Note that if you want attachments to be processed properly, they should be in the same zipped folder and have attachments.zip format.

276
Merge1 | User Guide
IMPORTERS

<maxCols>6</maxCols>
<delimiter>","</delimiter>
<text_qualifier>"</text_qualifier>
<attachmentMethod>Archive</attachmentMethod>
<content_type>Html</content_type>
</options>

2. Assign column names, identify data type, and indicate if columns are optional.

<columns>
<column>
<order>1</order>
<name>Date</name>
<datatype>DateTime</datatype>
<datatype_options>
<format>XX/DD/YYYY HH:MM</format>
</datatype_options>
</column>
<column>
<order>2</order>
<name>From Email</name>
<datatype>String</datatype>
</column>
<column>
<order>3</order>
<name>To Email</name>
<datatype>String</datatype>
</column>
<column>
<order>4</order>
<name>Subject</name>
<datatype>String</datatype>
</column>
<column>
<order>5</order>
<name></Body</name>
<datatype>String</datatype>
</column>
<column>
<order>6</order>
<name>FILE_NAME</name>
<datatype>StringList</datatype>
<datatype_options>
<delimiter>";"</delimiter>
</datatype_options>
</column>
</columns>

277
Merge1 | User Guide
IMPORTERS

3. The last part of the XML file maps the columns to the expected data fields: Sender,
Participants, Title, ActivityDateTime, Body and Threading 1:

<mappings>
<mapping can_be_empty = "Yes">
<property>Sender</property>
<items>
<item>From Email</item>
</items>
</mapping>
<mapping can_be_empty = "Yes">
<property>Participants</property>
<items>
<string Role="Cc">"[email protected]"</string>
</items>
</mapping>
<mapping can_be_empty = "Yes">
<property>Title</property>
<items>
<item>Subject</item>
</items>
</mapping>
<mapping can_be_empty = "Yes">
<property>Content</property>
<items>
<item>Body</item>
</items>
</mapping>
<mapping can_be_empty = "Yes">
<property>ActivityDateTime</property>
<items>
<item>Date</item>
</items>
</mapping>
<mapping can_be_empty = "Yes">
<property>Attachments</property>
<items>
<item>FILE_NAME</item>
</items>
</mapping>
<mapping can_be_empty = "Yes">
<property>X-KVS-MessageType</property>
<items>
<string>"Telemessage"</string>
</items>
</mapping>
</mappings>
<threading disabled = "No">
<case_sensitive>No</case_sensitive>
<date_sort_direction>Ascending</date_sort_direction>

1 Only if threading is required.

278
Merge1 | User Guide
IMPORTERS

<items>
<item>From Email</item>
<item>To Email</item>
</items>
</threading>
</configuration>

Example of source .txt file:

Figure 439: Source .txt File

Parsed output:

Figure 440: Parsed Sample

Next Steps
After setting up the collector, follow the links below to continue with the configuration of:
• Monitored Users (N/A)
• Filters
• Targets
• Importer Settings

279
Merge1 | User Guide
IMPORTERS

TWITTER
Twitter is an online news and social networking site where people communicate in short messages
called tweets. The Twitter collector does not work with a proxy server.

Activities Captured
• GIFs are captured as links
• GIF post texts
• Attachments are captured as links
• Comments
• Retweets
• Quote tweets
• Emojis
• Tweets to timelines
• Poll post note (poll options are not captured)

Note that follows and direct messages are not captured.

Creating a Twitter Application


If you do not have an application created for Twitter:
1. Log in to https://developer.twitter.com/.
2. Click Create New App.
3. Complete the form by:
• Providing a name for the application, i.e.,” Merge1 Twitter App”.
• Entering the URL of your organization's website.
• Entering the URL of your local Merge1 environment with the following format:
/merge1_instance/Configuration/OAuthCallback.
• Agreeing to the terms of service.
4. Click Create.
5. Open the Keys and Tokens tab, to view the API Key and API Secret Key.

Collector Configuration
To activate Twitter Importer, fill in the following information in the Configuration Wizard of the
Source tab:
1. Provide your Twitter Application ID.
2. Enter the Application Secret/Key.
3. Click Save.

280
Merge1 | User Guide
IMPORTERS

Figure 441: Twitter Application Configuration

Time Stamp Formatting


For more information, on how to configure this section see Time Stamp Formatting.

Advanced Configuration Options


The Subject Prefix feature will add a prefix before the message subject to facilitate the search in the
target.

Figure 442: Advanced Configuration Options

Next Steps
After setting up the collector, follow the links below to continue with the configuration of:
• Monitored Users
• Filters
• Targets
• Importer Settings

281
Merge1 | User Guide
IMPORTERS

UBS
UBS provides financial advice and solutions to private, institutional, and corporate clients worldwide.

Activities Captured
• Datetime
• First name
• Last name
• Company name
• Says
• Content
• Participant’s full name
• Email
• User ID

Collector Configuration
For information on how to configure the following sections of the Source tab, see:
• File Source
• PGP Configurations
• Folder Configurations
• Miscellaneous Settings

UBS Options
Merge1 enables you to validate the UBS attachments. You can either group all messages based on
participants or you can group messages by date.

Figure 443: UBS Options

You can also set grouping interval. The time is calculated in hours.

Example Output Message:

282
Merge1 | User Guide
IMPORTERS

Figure 444: Output Message

Next Steps
After setting up the collector, follow the links below to continue with the configuration of:
• Monitored Users (N/A)
• Filters
• Targets
• Importer Settings

283
Merge1 | User Guide
IMPORTERS

WEB PAGE CAPTURE


The Merge1 Web Page Capture collector captures the web pages. It captures a specific web page and
the links on the page at a configurable through the collector UI level by the provided URL, retrieves its
appearance and imports it in PDF, PNG, and custom formats, that can be specified in a JSON file.

Activities Captured
• Web page in PDF
• Web page in PNG
• Web page in custom formats

Heavy pages with the depth of capture more than 1 may be captured not fully, as all the pages may
not be loaded completely by the time of the capture.

Collector Configuration
To configure URLs:
1. Click +Add Configuration Group.
2. Enter the Group Name for the output files of the captured URL.
3. Select the Output Format. It can be a PDF, PNG, or custom format file. For the custom format,
please contact our support at https://www.veritas.com/support.
4. Enter the website URL from which the capture should start.
5. Choose the capture mode: Full Domain or One Page. One Page captures only the entered
URL. Full Domain captures the mentioned URL and the pages that open from it with the same
domain on the mentioned depth.
6. The depth is the level of the pages on the site map that should be captured. It includes the
main website URL given in the configuration and the site pages below it on the site map. For
Example, if the depth is 1, the Web Capture collector captures the filled in website URL and all
the pages that open from that URL and have the same URL in their URLs.

284
Merge1 | User Guide
IMPORTERS

Figure 445: URLs Configuration

Time Stamp Formatting


For more information, on how to configure this section see Time Stamp Formatting.

Message Construction
As the messages generated by the Web Page Capture collector do not have senders or recipients,
from and to email addresses need to be entered manually for the output email files to be generated.
It is recommended to use existing email address in the From Email Address field, to avoid it being sent
to the SPAM folder if the target of the collector is a mailbox.

Figure 446: Message Construction

Advanced Configuration Options


The Subject Prefix feature will add a prefix before the message subject to facilitate the search in the
target.

285
Merge1 | User Guide
IMPORTERS

Figure 447: Advanced Configuration Options

Example of output message:

Figure 448: Output message

Next Steps
After setting up the collector, follow the links below to continue with the configuration of:
• Monitored Users (N/A)
• Filters
• Targets
• Importer Settings

286
Merge1 | User Guide
IMPORTERS

WORKPLACE FROM FACEBOOK


Workplace is an enterprise connectivity platform developed by Facebook, Inc. and featuring tools like
groups, instant messaging, and News Feed. Workplace allows third parties to fetch data from its APIs
for Compliance and eDiscovery purposes - this is achieved by using Custom Integrations.

Custom Integrations are not available in the free Workplace plans, customers who need to meet
Compliance and eDiscovery must have a Premium plan.

Activities Captured
Chats:
• One-on-one chats
• Group chats
• Attachments in chats
• Deleted messages and attachments in chats (if only one chat participant has deleted the
message)1
• “Add” events in group chats

Posts:
• Group posts (except multi-company groups, and main posts of buy & sell groups)
• Attachments2
• Polls (without attachments)
• GIFs
• Emojis
• GIF posts (mp4 format only)
• Likes & reactions to posts
• Comments and replies (without attachments)
• Photos
• Posts in MD format (without formatting)
• “Create” events (only images)
• Create doc posts in TXT format (without image)
• Live videos
• Latest versions of posts (except attachments)

Activities Not Captured


Group chats:
• Polls
• Sticker

1 If there is only one participant in the group chat, the deleted message/attachment is not captured.
2 Workplace side internal server error occurs in case of having 80+ attachments.

287
Merge1 | User Guide
IMPORTERS

• Reply to
• Reactions.

Group posts:
• Timeline activities
• Deleted group posts
• Name of the group
• Tagging coworkers
• Check-ins
• Feeling/Activity
• Comments deleted
• Created events
• Hidden chats
• Posts created on someone’s timeline
• Previous versions of posts

Custom Integration Creation in Workplace from Facebook


Workplace from Facebook allows third parties to fetch data from its APIs for Compliance and
eDiscovery purposes - this is achieved by using Custom Integrations.

Custom Integrations are not available in free Workplace plans, so customers who need to meet
Compliance and eDiscovery must have a Premium plan.

To create a custom integration:


1. Login to workplace using a System Administrator account.
2. Navigate to https://my.workplace.com/work/admin/apps/.
3. Sign in if prompted to.
4. Click Create Custom Integration (Figure 449).

Figure 449: Creating a Custom Integration

5. Enter a name for the Integration and click Create.

288
Merge1 | User Guide
IMPORTERS

Figure 450: Creating an Integration

6. Copy App ID and App Secret. Click Create Access Token and copy the generated token.

Figure 451: Getting the Token

7. If Discoverable is set to Yes, change it to No (Figure 452). This is not required but it is best
practice to make sure the users are not aware of existence of the application.

Figure 452: Integration Details

8. Under Integration Permissions, enable the following permissions:


• Read group content
• Read user timeline
• Read all messages
• Read user email
• Read group membership
• Message any member
o Allow this integration to work in group chats.

289
Merge1 | User Guide
IMPORTERS

Figure 453: Integration Permissions

9. To make sure the permissions remain available for Merge1, disable Automatically remove
unused permissions. This is not required; you can leave it on for better security, but you
might need to come back to this page and re-add the permissions.

Note that Facebook allows you to scope the App's permissions to specific groups.
This is recommended if you only need to monitor users of the certain groups.

Figure 454: Removing Unused Permissions

10. Following best security practices, enable Require App Secret Proof and allow list the public IP
addresses of your Merge1 server(s), gateways and/or proxy server(s).

Figure 455: Security Settings

290
Merge1 | User Guide
IMPORTERS

Collector Configuration
To configure the collector:
1. Enter the App ID copied in the Step 6 of the previous section in the Application ID field, the
App Secret in the Application Secret/Key field, and the Access Token in the Access Token field
(Figure 456).

Figure 456: Configuring the Collector

Time Stamp Formatting


For more information, on how to configure this section, see Time Stamp Formatting.

Attachment Configuration
For more information on how to configure attachments, see Attachments Configuration.

Advanced Configuration Options


For more information on how to configure Advance Configuration Options, see Advanced
Configuration Options.

Example output message:

291
Merge1 | User Guide
IMPORTERS

Figure 457: Output Message

Next Steps
After setting up the collector, follow the links below to continue with the configuration of:
• Monitored Users
• Filters
• Targets
• Importer Settings

292
Merge1 | User Guide
IMPORTERS

XIP
Greenwich Associates is the leading global provider of market intelligence and advisory services to the
financial services industry. They specialize in providing fact-based insights and practical
recommendations to improve business results.

Collector Configuration
For information on how to configure the following sections of the Source tab, see:
• File Source
• PGP Configurations
• Folder Configurations
• Miscellaneous Settings

Example Output Message:

Figure 458: Output Message

XIP Collector Options


If you want to manually set up the Source Time Zone, select the relevant one from the drop-down list.

Figure 459: XIP Collector Options

Once you have selected the Collector Type, you can also provide the Source Time Zone information.
Merge1 assumes that the messages in the source file are of the set time zone and based on that data
the dates in the messages are processed to UTC time zone. By default, Merge1 sets the Source Time
Zone as the Local Time Zone.

293
Merge1 | User Guide
IMPORTERS

Example Output Message:

Figure 460: Output Message

Next Steps
After setting up the collector, follow the links below to continue with the configuration of:
• Monitored Users (N/A)
• Filters
• Targets
• Importer Settings

294
Merge1 | User Guide
IMPORTERS

XSLT/XML
Merge1 XSLT/XML collector allows our customers to rapidly transform XML file using XSLT to a
predefined format. Once XML is transformed, Merge1 can process the XML by generating the
required mapping "From" "To" "Subject" "Date" "body" fields to appropriate elements of the XML file.
The mapping varies from source to source, and it must be written separately. Contact Veritas
Technologies LLC Support for more details on the mapping corresponding to the source you are going
to use it for.

Activities Captured
• Participants: From, To, CC, and BCC
• Start time
• End time
• Body message
• Device used
• Attachments

Collector Configuration
For information on how to configure the following sections of the Source tab, see:
• File Source
• SSH Key Authentication
• PGP Configurations
• Folder Configurations
• Miscellaneous Settings

XSLT/XML Collector Options


Upload the XSLT template from Merge1 7.01 folder. You can find the template in the Templates folder
of the Merge1 Installation file.

Figure 461: XSLT Collector Options

Next Steps
After setting up the collector, follow the links below to continue with the configuration of:

1 For Merge1 version 6.0, the folder will be Merge1 6.0.

295
Merge1 | User Guide
IMPORTERS

• Monitored Users (N/A)


• Filters
• Targets
• Importer Settings

296
Merge1 | User Guide
IMPORTERS

YAMMER
Yammer is a collaboration tool that helps users and their teams to stay on top of it all. They can start
conversations, work together on files, and organize around projects. The Yammer app allows Merge1
to hook in and collect data.

Activities Captured
• Posts in public and private groups
• Comments and replies of posts in public and private groups
• Private messages1
• Attachments (including SharePoint files)
• Edit activities of posts/comments/replies/private messages
• Polls2
• Praise (the text of the praise and the replies)
• Announcements (the text of the announcement and replies)
• Deleted private messages, posts, and comments (including attachments)3

Notes

• If messages are GDPR hard deleted, the attachments (if it has any) cannot be captured due to
the source limitation.
• A dummy SMTP address is created for a deleted message which is missing the deleted_by_id
field.
• GDPR hard deleted and soft deleted messages are captured as deleted.
• Legal Hold should be enabled so the attachments are not deleted from the SharePoint site.
For more details on how to enable Legal Hold, see Enable In-Place Hold.
• When sharing an already existing file from SharePoint, the attachment will not be captured -
only the URL of that attachment will be retrieved.
• The created message does not say it was deleted from Yammer. To capture the deletes, the
data retention setting needs to be set to Delete. See instructions at
https://learn.microsoft.com/en-us/yammer/manage-security-and-compliance/manage-data-
compliance#data-retention.
• Events of former members are not captured due to limited permissions of admin-generated
token.
• For files larger than 2 GB, a link for that attachment will be created and included in the body
of the output message with a warning in the log that the file is larger than 2 GB.
• A separate Import folder path should be provisioned on the Source Configuration tab for each
Yammer collector when running 2 or more collectors simultaneously.

1Unlessthe conversation has been started by an external user.


2 Choicesand votes of deleted polls are not captured.
3The delete event of the message/post will be captured in case there is a create/edit activity before the Merge1 run.

297
Merge1 | User Guide
IMPORTERS

• Currently, enabling the Merge messages by thread feature may impact the performance of
the collector processing.

Microsoft Azure App Creation


To authenticate via OAuth during the collector configuration:
1. Login to the Azure Portal using the same credentials as for O365 (Global Admin).
2. Click Azure Active Directory at the top of the page and select App Registration from the left-
side navigation pane.

Figure 462: Azure Active Directory

Figure 463: Navigating to App Registration

3. Click the +New registration button.

298
Merge1 | User Guide
IMPORTERS

Figure 464: New Registration

4. Enter a Name for the application and click the Register button.
5. Enter the enter the URL of your local Merge1 environment in the following format:
https://<your_merge1_domain>/Configuration/OAuthCallback. Click
Register.

Figure 465: Registering an Application

6. Find and make a note your Application (client) ID and Directory(tenant) ID as this is needed
for configuring the collector in Merge1.
7. In the navigation pane to the left, go to Certificates & secrets.

299
Merge1 | User Guide
IMPORTERS

Figure 466: Navigating to Certificates

8. Click the Upload certificate button.

Figure 467: Upload Certificate

9. Select a certificate (public key) with one of the following file types: .cer,.pem, .crt, and click
Add. For more information on how to create a certificate, see Creating a Certificate (Private
and Public Keys).

Microsoft Azure Permissions


For permissions:
1. In the navigation pane to the left, click API permissions.

300
Merge1 | User Guide
IMPORTERS

Figure 468: Navigating to API Permissions

2. Click Microsoft Graph, and in the opened pane select Application permissions. Grant the
following permission:
• Application.Read.All
• Sites.Read.All

Figure 469: Granting Permission

Once you have selected the checkbox, click Add permissions.

3. Get back to API permissions section, click + Add a permission and select SharePoint API with
Application permissions. This is the permission you need to grant:
• Sites:Sites.Read.All

301
Merge1 | User Guide
IMPORTERS

Figure 470: SharePoint Permissions

Once you have selected the checkbox, click Add permissions.

Setting Up Yammer
To set up the Yammer collector:
1. Log into your Yammer account at https://www.yammer.com/client_applications.
Please note that the user needs to have an Admin access.
2. Click Register New App.

Figure 471: Registering New Application

3. Provide an Application Name, the Organization, the Support e-mail, and add a Website link
and a Redirect URI in the following format: https://
merge1_instance/Configuration/OAuthCallback. Note that the IP address should be used.

302
Merge1 | User Guide
IMPORTERS

Figure 472: Register New App Form

4. Click the Continue button and copy the Client ID and Client secret from the opened page.

Figure 473: Copying Client ID and Secret

5. Go to Merge1 and add the Yammer collector by entering Name and Description and then
selecting the collector from the list.
6. In the Application ID field, add the Client ID copied in the 4 steps, and in the Application
Secret/Key add the copied Client Secret.
7. Click NEXT.
8. Allow logging in to the Yammer account, to finalize the collector set up. Make sure that the
pop-ups are not blocked by the browser. You can check that from the top right corner of the
browser address field.

303
Merge1 | User Guide
IMPORTERS

Figure 474: Configuring Yammer Application

Figure 475: Allowing Login

Collector Configuration
Merge1 needs an import folder to download, store and process data from Yammer. This is because
Yammer's APIs are limited in their abilities to send and receive data. The import folder used for
Yammer configuration must be empty for the importer to function properly.
1. To capture SharePoint files, enable the Process files stored in SharePoint checkbox. The
following Azure application credentials are required to capture the content:
• Application (Client) ID
• Directory (Tenant) ID
2. Provide X.509 Certificate Thumbprint in case you activate the Local machine radio button as
the X.509 Certificate source.

Figure 476: Providing Credentials

304
Merge1 | User Guide
IMPORTERS

3. In case you activate Upload file (*.pfx), click the Select button to upload the certificate and
then provide X.509 Certificate Password.

Figure 477: Uploading Certificate

Advanced Configuration Options and Content Capturing


There are the following advanced options when configuring the Yammer collector with Merge1:

Figure 478: Advanced Configuration Options

• Merge messages by thread - this combines all messages in a thread into a single message.
• Select the Message time zone from the drop-down menu. When Process Incomplete Days
option is enabled, the messages of the days that have not yet ended will be imported in a
separate email as well.
• Options Do not download data modified before and Do not download data modified after
allow cutting off data outside the set date range. If the before date is set to 08/17/2022 and
the after date is set to 08/25/2022, only the data between these two dates will be
downloaded. Data outside that timeframe will be ignored. Note that both options can be
used independently as well.
• Subject Prefix - this is added to the subject line of imported emails and is useful for organizing
imported data, i.e., when multiple sources share a common target.
• In the Content capturing section, you can choose either capturing all content or only private
content by enabling the corresponding option.

305
Merge1 | User Guide
IMPORTERS

Figure 479: Content Capturing

Message Body Type


This specifies how the imported message will be displayed in the target. The Plain mode displays the
message as simple text, the HTML mode organizes the data in a simple way, and with the Light grid
mode the output is two-colored with limited metadata.

Figure 480: Message body Type

Note that Light Grid becomes active if the Merge messages by thread is activated.

Attachment Validation
Merge1 enables you to develop customized notes for attachment validation. The default setting is Fail
Messages with missing data set, as a result of which the messages with a specific data chunk that do
not have attachments are failed and can be viewed under the REPORTS.

If you select the Replace missing attachments with the following note and input your custom note, all
the missing attachments of the messages will not be processed, and you will see only the custom
message that you have entered.

Figure 481: Attachment Validation

Time Stamp Formatting


For more information, on how to configure this section, see Time Stamp Formatting.

306
Merge1 | User Guide
IMPORTERS

Attachments Configuration
For more information on how to configure attachments, see Attachments Configuration.

Splitting Messages
This option allows splitting large files. In the field the size of a split part of the message can be
specified so that each part does not exceed the set size. For example, if the Max Size for each part of
split message is set to 25MB, and the original message is 65 MB, it will be split into 3 messages, each
not exceeding 25MB.

Figure 482: Splitting Messages


Sample Outputs

Figure 483: Plain Mode

Figure 484: HTML Mode

Next Steps
After setting up the collector, follow the links below to continue with the configuration of:
• Monitored Users
• Filters
• Targets
• Importer Settings

307
Merge1 | User Guide
IMPORTERS

YIELDBROKER
Yieldbroker is the leading Tier 1 licensed electronic trading platform for Australian and New Zealand
debt securities and derivatives. It is a dynamic collector that brings Banks, Portfolio Managers,
Treasuries and Risk Managers together in a trusted trading environment with unrivalled liquidity and
coverage of the AUD and NZD debt capital markets. Merge1 Yieldbroker collector processes data from
Yieldbroker messages.

Activities Captured
• Participant names and email addresses in the To, From, CC, and BCC fields
• Messages in the body of the output message
• Sender and Recipient company names in the body along with messages
• Thread ID in the message subject

Collector Configuration
For information on how to configure the following sections of the Source tab, see:
• File Source
• SSH Key Authentication
• PGP Configurations
• Folder Configurations
• Miscellaneous Settings

Advanced Configuration Options


There is the following advanced option when configuring the Yieldbroker collector with Merge1
(Figure 485):
• Merge1 messages by thread - this combines all messages in a thread into a single message.

Figure 485: Advanced Configuration Option

Message Body
This specifies how the imported message will be displayed in the target. The Plain Text mode
organizes the data in a simple way and data displayed in a Light Grid Mode is two-toned, easy to be
viewed with limited metadata.

308
Merge1 | User Guide
IMPORTERS

Figure 486: Message Body

Example of source file:

Figure 487: Source File

Parsed output:

Figure 488: Parsed Sample

Next Steps
After setting up the collector, follow the links below to continue with the configuration of:
• Monitored Users (N/A)
• Filters
• Targets
• Importer Settings

309
Merge1 | User Guide
IMPORTERS

YOUTUBE
YouTube is an online video sharing and social media platform owned by Google. It acts as a social
network by allowing users with a Google account to watch and upload their videos, comment on
videos, rate and respond to comments, like or dislike videos, etc.

Activities Captured
• Comments/replies of channel discussions
• Comments/replies of videos on channel playlists
• Comments/replies of uploaded videos
• Edits of comments/replies (only the latest version)
• Likes count
• Video view counts

Note that the deleted comments and replies are not captured due to the YouTube API limitations.

Creating a YouTube Application


To create a YouTube application, the user should create a new project, create credentials, and
manage domain-wide authority delegations.

Creating a New Project


To create a new project:
1. Sign in to Google Cloud Platform.

Figure 489: Signing In

2. Click Select a project, then NEW PROJECT.

310
Merge1 | User Guide
IMPORTERS

Figure 490: Creating a New Project

3. Enter a name for the project and click CREATE.

Figure 491: Specifying a Name for the Project

4. Once the project is created, click SELECT PROJECT from the Notifications and you are
navigated to the Project page.

Figure 492: Navigating to the Project Page

311
Merge1 | User Guide
IMPORTERS

Figure 493: Project

5. From the left side navigation menu, select APIs & Services > Dashboard.

Figure 494: Dashboard

6. Click ENABLE APIS AND SERVICES.

Figure 495: Enable APIs and Services

7. In the Search for APIs & Services search box, type YouTube Data API v3.

Figure 496: API Library

312
Merge1 | User Guide
IMPORTERS

8. Click YouTube Data API v3.

Figure 497: YouTube Data API V3

9. Once you are in the Gmail API page, click ENABLE.

Figure 498: Enabling YouTube API

Creating Credentials

To create the credentials:


1. From the left side navigation menu, select APIs & Services > Credentials.

Figure 499: Navigating to Credentials

2. Click CREATE CREDENTIALS and select OAuth client ID.

313
Merge1 | User Guide
IMPORTERS

Figure 500: OAuth Client ID

3. From the Application type drop-down menu, select Web application.

Figure 501: Selecting the Application Type

4. Enter the name for the application.

Figure 502: OAuth Client ID Name

5. In the Authorized redirect URIs section, click ADD URI and add the URL of your local Merge1
environment in the following format: https://<
merge1_domain>/Configuration/OAuthCallback and click CREATE, which you can find in the
10 point of the Click information.

314
Merge1 | User Guide
IMPORTERS

Figure 503: Authorized Redirect URIs

6. Copy and save the Client ID and Client ID from the created OAuth client pop-up window.

Figure 504: OAuth Client

Managing Domain-Wide Authority Delegation

1. Sign in to Google Admin Console.


2. On the left side menu, click Security > API controls.

315
Merge1 | User Guide
IMPORTERS

Figure 505: Navigating to API Controls

3. Scroll down to Domain wide delegation section and click MANAGE DOMAIN WIDE
DELEGATION.

Figure 506: Manage Domain-Wide Delegation

4. Click Add new.

Figure 507: Adding a New Delegation

316
Merge1 | User Guide
IMPORTERS

5. Enter the above saved Client ID in the Client ID field, add the following scopes in the OAuth
scopes fields:
• https://www.googleapis.com/auth/youtube
• https://www.googleapis.com/auth/youtube.force-ssl
• https://www.googleapis.com/auth/youtube.readonly
• https://www.googleapis.com/auth/youtubepartner

Figure 508: Adding Scopes

6. Click AUTHORIZE.

Note: By using this importer, you are agreeing to the YouTube terms:
https://www.youtube.com/t/terms, https://policies.google.com/privacy.

317
Merge1 | User Guide
IMPORTERS

Collector Configuration
To set up the collector:
1. Click Add Importer, specify Name and a Description(optional), and select the collector from
the list. The YouTube Application Configuration window will open.
2. In the Application ID field, enter Client ID copied previously, in Application secret/key, enter
the copied Client Secret and click Next.

Figure 509: YouTube Application Configuration

3. Select the account the content of which you want to capture and click Allow.

Time Stamp Formatting

For more information, on how to configure this section, see Time Stamp Formatting.

Threading

For Threading:
• If the No threading radio button is activated, only a single message is generated for a
comment or reply.
• If One parent comment with replies is activated, then a threaded message is generated for
comments and replies.
o The Message time zone by which the messages are split based on the selected time
zone from the drop-down menu. When Process Incomplete Days option is enabled,
the messages of the days that have not yet ended will be imported in a separate
email as well. This option can be selected only if One parent comment with replies is
activated.

318
Merge1 | User Guide
IMPORTERS

Figure 510: Threading

Message Body

This specifies how the imported message will be displayed in the target. The Basic HTML mode
organizes the data in a simple way and data displayed in a Light Grid Mode is two-toned, easy to be
viewed with limited metadata.

Figure 511: Message Body

Advanced Configuration Options


There are following advanced options when configuring the collector with Merge1 (Figure 512).
• The Subject Prefix feature adds a prefix before the message subject to facilitate the search in
the target.
• Options Do not download data modified before and Do not download data modified after
allow cutting off data outside the set date range. If the before date is set to 08/17/2022 and
the after date is set to 08/25/2022, only the data between these two dates will be
downloaded. Data outside that timeframe will be ignored. Note that both options can be
used independently as well.

Figure 512: Advanced Configuration Options

Sample message:

319
Merge1 | User Guide
IMPORTERS

Figure 513: Threaded Message Sample

Next Steps
After setting up the collector, follow the links below to continue with the configuration of:
• Monitored Users (N/A)
• Filters
• Targets
• Importer Settings

320
Merge1 | User Guide
IMPORTERS

ZOOM CHAT
Zoom is the leader in modern enterprise video communications, with an easy, reliable cloud platform
for video and audio conferencing, chat, and webinars.

Zoom Team Chat is a messenger which allows users with free and paid accounts to facilitate
communications between Zoom users. With Zoom Team Chat, you can send texts, audio, and video
messages, as well as share files, emojis, screenshots, and so on.

Activities Captured
• Chat messages
• Group chat messages
• Channel messages

Captured messages can contain:

• Edits
• Deletes1
• Emojis
• Attachments
• Video messages
• GIFs

Notes
• Chats from the last 6 months only can be captured.
• If the group chat/channel is deleted, the captured output file does not contain a "TO" field.
Thus, no recipients are mentioned.

Creating an oAuth App


To create an OAuth application, see Creating an OAuth App.

For Zoom Chat, add the following scopes to the application and click Done:
• User > View all user information
• Team Chat > View all users' team chat channels
• Report > View your team chat history report

Collector Configuration
To configure the collector:

1 The message creation metadata is not captured.

321
Merge1 | User Guide
IMPORTERS

1. Enter Client ID in the Application ID field.


2. Enter Client Secret in the Application Secret/Key field. Click NEXT.

Figure 514: Providing Credentials

3. In the opened pop-up, confirm the application connection. Make sure that the pop-ups are
not disabled in the browser window.

Timestamp Formatting
For more information, on how to configure this section, see Time Stamp Formatting.

Advanced Configuration Options


To configure advanced options:
1. Specify the Subject Prefix in the subject line of imported emails. This feature allows organizing
imported data when multiple sources share a common target.
2. Specify Do not download data modified before and Do not download data modified after to
allow cutting off data outside the set date range. If the before date is set to 08/17/2022 and
the after date is set to 08/25/2022, only the data between these two dates will be
downloaded. Data outside that timeframe will be ignored. Note that both options can be
used independently as well.
3. Specify the number of previous days for which Merge1 should scan for edits and deletes.

Figure 515: Advanced Configuration Options

322
Merge1 | User Guide
IMPORTERS

Threading Options
Enable one of the following options:
• No threading - If selected, only a single message will be generated for a message in the
chat/channel.
• Message with replies - If selected, chat/channel messages with all their replies will be
generated.
• Per conversation - If selected, chat/channel messages per conversation will be generated.

Figure 516: Threading Options

Attachments Configuration
For more information on how to configure attachments, see Attachments Configuration.

Next Steps
After setting up the collector, follow the links below to continue with the configuration of:
• Monitored Users
• Filters
• Targets
• Importer Settings

323
Merge1 | User Guide
IMPORTERS

ZOOM MEETINGS
Zoom is the leader in modern enterprise video communications, with an easy, reliable cloud platform
for video and audio conferencing, chat, and webinars. The Zoom account used for the Merge1 Zoom
collector needs to be on Business or Enterprise plan to gain access to the API. Note that Pro plan is
not supported.

Activities Captured
• Meeting metadata
• Meeting recording files:
o Audio and video
o Audio
o Audio transcripts
• Meeting chats

Figure 517: Enabling Automatic Recordings

Notes
• Only meetings from the last 6 months can be captured. The option to select a longer cut-off
date in the Merge1 UI, has also been disabled.
• Zoom does not support IP addresses as call back URLs.
• To capture the content, the meetings should be recorded. This applies to chats during
meetings too. To enable automatic recording, go to https://zoom.us/profile/setting >
Recording.
• If a message was sent privately to one of the meeting participants, it is not added to the
recording file, as the Zoom API does not provide that option. We recommend disabling the
private messages to be SEC compliant by following this link: https://zoom.us/account/setting.

Figure 518: Disabling Private Chats

• Attachments sent during a meeting are not captured. To prevent data loss, the option to
send files via meeting chat should be disabled from the Zoom Meetings UI.

324
Merge1 | User Guide
IMPORTERS

Figure 519: Disabling File Sending

Creating an OAuth App


To create an oAuth application:
1. Go to Zoom Marketplace: https://marketplace.zoom.us/.
2. Select Develop > Build App.

Figure 520: Navigating to Build App

3. Sign in if prompted to.


4. Choose OAuth application type.

Figure 521: Choosing an Application Type

5. Give an app name, choose Account-level app, disable publishing to Marketplace and click
Create.

325
Merge1 | User Guide
IMPORTERS

Figure 522: Creating an OAuth App

6. Copy the Client ID and the Client Secret. They will be used later to configure the Merge1
Zoom collector.
7. Under Redirect URL for OAuth and Allow List URL, enter the URL of your local Merge1
environment with the following format: "merge1_instance/Configuration/OAuthCallback". Click
Continue.

Figure 523: Providing Credentials

8. In the Information section, fill in:


• Short Description
• Long Description
• Developer Name
• Developer Email Address.

9. Go to Scopes and click Add Scopes.

326
Merge1 | User Guide
IMPORTERS

Figure 524: Navigating to Scopes

10. Add the following scopes to the application and click Done:
• Meeting > View all user meetings
• Recording > View all user recordings
• User > View all user information
• Dashboard > View all users' meetings information on Dashboard.

Figure 525: Adding Scopes

11. Go to the Activation section and click Install.

327
Merge1 | User Guide
IMPORTERS

Figure 526: Installing Application

12. To enable Merge1 to download meeting recordings, the admin must enable Cloud recording
downloads and disable Only the host can download cloud. To do that, go to Account
Management > Account Settings > Recording:

Figure 527: Enabling Cloud Recording Downloads

Collector Configuration
To configure the collector:
1. Enter Client ID in the Application ID field.
2. Enter Client Secret in the Application Secret/Key field from Figure 523. Click NEXT.

Figure 528: Providing Credentials

3. In the opened pop-up, confirm the application connection. Make sure that the pop-ups are
not disabled in the browser window.

Timestamp Formatting
For more information, on how to configure this section, see Time Stamp Formatting.

328
Merge1 | User Guide
IMPORTERS

Meeting File Download Options


This section includes:
• When Do not download files greater than X megabyte(s) is selected, the files, that are bigger
than the filled-in number of megabytes, are not downloaded.
• Include Chat File specifies how the chat file is added to the imported message: in the body of
the message or attached to the message as a separate file.
• Include Transcript File specifies how the transcript file is added to the imported message in
the body of the message or attached to the message as a separate file.
• Meeting Recordings specifies whether video with audio or only audio is included in the
imported message.

Figure 529: Meeting File Download Options

Advanced Configuration Options


For more information on how to configure Advance Configuration Options, see Advanced
Configuration Options.

Example output message:

Figure 530: Output Message

Next Steps
After setting up the collector, follow the links below to continue with the configuration of:
• Monitored Users
• Filters
• Targets
• Importer Settings

329
Merge1 | User Guide
IMPORTERS

ZOOM MEETINGS CHATS


Zoom is the leader in modern enterprise video communications, with an easy, reliable cloud platform
for video and audio conferencing, chat, and webinars.

Zoom’s Meeting and Webinar Archiving solution allows account administrators to set up an
automated mechanism to collect and archive meeting data to a 3rd party platform of their choice and
hence, satisfy FINRA and/ or other compliance requirements. Only account administrators can
manage what data is archived, what is displayed in the disclaimer, and enable archiving for specific
groups as well. Merge1 uses this API to retrieve archived meeting or webinar chats.

Note that the Meeting Archiving feature is enabled for your account by Zoom Support.

Activities Captured
• Webinar/Meeting metadata
• Webinar/Meeting chats

Notes
• The maximum number of days of archiving is up to 30 days. The number of days can be
specified from the https://zoom.us/account/setting.

Figure 531: Setting the Retention for Archiving Content

• Attachments sent during a meeting are not captured. To prevent data loss, the option to
send files via meeting chat should be disabled from the Zoom Meetings UI.

330
Merge1 | User Guide
IMPORTERS

Figure 532: Disabling File Sending

Creating an oAuth App


To create an OAuth application, see Creating an OAuth App.

For Zoom Meetings via Archiving API, add the following scopes to the application and click Done:
• Meeting > View all user meetings
• Webinar > View all user Webinars
• Recording > View all user recordings
• User > View all user information
• Dashboard > View all users' meetings information on Dashboard.

Collector Configuration
To configure the collector:
1. Enter Client ID in the Application ID field.
2. Enter Client Secret in the Application Secret/Key field from Figure 537. Click NEXT.

Figure 533: Providing Credentials

3. In the opened pop-up, confirm the application connection. Make sure that the pop-ups are
not disabled in the browser window.

331
Merge1 | User Guide
IMPORTERS

Timestamp Formatting
For more information, on how to configure this section see Time Stamp Formatting.

Advanced Configuration Options


For more information on how to configure Advance Configuration Options, see Advanced
Configuration Options.

Example output message:

Figure 534: Output Message

Next Steps
After setting up the collector, follow the links below to continue with the configuration of:
• Monitored Users
• Filters
• Targets
• Importer Settings

332
Merge1 | User Guide
IMPORTERS

ZOOM MEETINGS VIA ARCHIVING API


Zoom is the leader in modern enterprise video communications, with an easy, reliable cloud platform
for video and audio conferencing, chat, and webinars.

Zoom’s Meeting and Webinar Archiving solution allows account administrators to set up an
automated mechanism to collect and archive meeting data to a 3rd party platform of their choice and
hence, satisfy FINRA and/ or other compliance requirements. Only account administrators can
manage what data is archived, what is displayed in the disclaimer, and enable archiving for specific
groups as well.

Merge1 uses this API to retrieve archived meeting or webinar files of an account.

Note that the Meeting Archiving feature is enabled for your account by Zoom Support.

Activities Captured
• Webinar/Meeting metadata
• Webinar/Meeting recording files:
o Audio and video
o Audio
o Closed captions (only if the option is enabled by the user from the Zoom Settings)
• Webinar/Meeting chats
• Recording files as attachments1

Notes
• The maximum number of days of archiving is up to 30 days. The number of days can be
specified from the https://zoom.us/account/setting.

Figure 535: Setting the Retention for Archiving Content

1
A token should be added to download files with the download URLs.

333
Merge1 | User Guide
IMPORTERS

• Attachments sent during a meeting are not captured. To prevent data loss, the option to
send files via meeting chat should be disabled from the Zoom Meetings UI.

Figure 536: Disabling File Sending

Creating an oAuth App


To create an OAuth application, see Creating an OAuth App.

For Zoom Meetings via Archiving API, add the following scopes to the application and click Done:
• Meeting > View all user meetings
• Webinar > View all user Webinars
• Recording > View all user recordings
• User > View all user information
• Dashboard > View all users' meetings information on Dashboard.

Collector Configuration
To configure the collector:
1. Enter Client ID in the Application ID field.
2. Enter Client Secret in the Application Secret/Key field from Figure 537. Click NEXT.

334
Merge1 | User Guide
IMPORTERS

Figure 537: Providing Credentials

3. In the opened pop-up, confirm the application connection. Make sure that the pop-ups are
not disabled in the browser window.

Timestamp Formatting
For more information, on how to configure this section see Time Stamp Formatting.

Meeting File Download Options


This section includes:
• When Do not download files greater than X megabyte(s) is selected, the files, that are bigger
than the filled-in number of megabytes, are not downloaded. In this Custom Message field, a
text for those excluded files can be specified. For example: “Files {0} are not imported,
because they are greater than {1) megabytes”. {0} is used to add the name of the file and {1}
is used to add the number of megabytes specified above.
• The Include Chat File option specifies how the chat file is added to the imported message - in
the body of the message or attached to the message as a separate file.
• The Include Closed Captions File option specifies how the closed captions are added to the
imported message in the body of the message or attached to the message as a separate file.
• The Meeting Recordings option specifies whether video with audio or only audio is included
in the imported message.

335
Merge1 | User Guide
IMPORTERS

Figure 538: Meeting File Download Options

Advanced Configuration Options


For more information on how to configure Advance Configuration Options, see Advanced
Configuration Options.

Example output message:

Figure 539: Output Message

Next Steps
After setting up the collector, follow the links below to continue with the configuration of:
• Monitored Users
• Filters
• Targets
• Importer Settings

336
Merge1 | User Guide
IMPORTERS

MONITORED USERS
Monitored Users are individuals whose data is collected by Merge1.

There are the following User Sources from where Monitored Users can be added to the collector.
• All (based on native API)
• Active Directory
• CSV File
• Manually maintain the list
• Azure Active Directory

All (Based on Native API)


This option automatically imports the users of the collector using its API. This works for sources that
are connected to Merge1 by the API, like Slack eDiscovery, Zoom Meetings and Microsoft Teams, etc.

Figure 540: All (Based on Native API)

1. Include is used for providing a path to a CSV file or uploading a CSV file with a list of users that
have not been retrieved via API should be included in the Monitored Users.
2. Exclude is used for providing a path CSV file or uploading a CSV file with the users that should
not be monitored as opposed to Include.

Figure 541: Filter Type Configuration

337
Merge1 | User Guide
IMPORTERS

When the monitored users' source type is set to All (Based on native API), the Sync button is available
for the following collectors:
• Yammer
• Slack eDiscovery
• Chatter
• Chatter Cipher Cloud
• Microsoft Teams
• Microsoft Teams via Export API
• SharePoint
• Workplace from Facebook
• Dropbox Business
• OneDrive for Business
• Exchange Graph API

To display the SYNC button,the Delete data action is required for the following collectors:
• Citrix Workspace & ShareFile
• Dropbox Business
• Google Drive
• Jabber
• RingCentral
• Skype for Business
• ServiceNow
• Yammer
• Zoom Meetings Chats
• Zoom Chat

Active Directory
Active Directory (AD) is a directory service that Microsoft developed for the Windows domain
networks. Active Directory option allows retrieving a user list using LDAP. Expand Active Directory
Configuration to open it up.

338
Merge1 | User Guide
IMPORTERS

Figure 542: Active Directory LDAP Properties

Here are the steps for setting up Active Directory Configuration to import the users:
1. In the Server Name field, fill in the name of the LDAP Server.
2. In the Base Domain field, add the section of the directory where the search should begin,
e.g., ou=finance, dc=example, dc=com.
3. In the Port field, define the Port of the LDAP Server.
4. In the Username field, add the username of the LDAP account.
5. In the Password field, fill in the corresponding password to the LDAP account for signing in.
6. Search Scope defines the scope of the search starting from the Base Domain.
a. Base - only the specified Base Domain should be considered for search.
b. OneLevel - only the immediate children of the specified Base Domain should be
considered.
c. Subtree - the specified entry as Base Domain, as well as all its subordinates should be
considered.
7. In Search Filter, add filters that can be used to restrict the number of users or groups that are
permitted to access an application.
Users who do not have the selected attribute or a Display Name will not be returned by the LDAP
query.

1. Include is used for providing a path to a CSV file or uploading a CSV file with a list of users that
have not been retrieved via API should be included in the Monitored Users.
2. Exclude is used for providing a path CSV file or uploading a CSV file with the users that should
not be monitored as opposed to Include.

339
Merge1 | User Guide
IMPORTERS

Figure 543: Filter Type Configuration

CSV File
The CSV file option allows adding our own CSV file based on which the monitored users will be added.

Figure 544: CSV File

The CSV file should include two columns: email address of the user and display name of the user, both
required. The rest of the columns will be ignored. If the display name is not available, it can be filled
instead with the email address.

1. Include is used for providing a path to a CSV file or uploading a CSV file with a list of users that
have not been retrieved via API should be included in the Monitored Users.
2. Exclude is used for providing a path CSV file or uploading a CSV file with the users that should
not be monitored as opposed to Include.

Figure 545: Filter Type Configuration

Manually Maintain the List


This option allows manually managing users.

340
Merge1 | User Guide
IMPORTERS

Figure 546: Manually Maintain the List

After selecting Manually maintain the list from User Source Configuration, the below list of monitored
list will become active, where you can make the following changes.

Figure 547: Manually Maintain the List

1. Add Monitored User opens a window where you can add details of a user to be monitored.
2. Upload CSV allows uploading a Monitored users’ list as a CSV.
3. Update MU list allows updating the already selected list of monitored users.
4. Delete Selected removes selected users from the monitored list.
5. Sync allows synchronizing with the current data.
6. Search in the list of existing users.
7. Select the user and click Delete Selected. This will remove selected Monitored Users’ list.
8. Edit the information about an existing user.
9. Monitor. If checked, monitors the user, if not, the user is not monitored.

To add a monitored user, click Add Monitored User and fill in the necessary information. The same
information can later be edited by clicking Edit Monitored User as described in point 8.

341
Merge1 | User Guide
IMPORTERS

Figure 548: Adding Monitored User

• Corp Email Address is a required field for the corporate email address of the user.
• Display Name is the name that will be displayed in the Monitored Users list.
• Collector Email/ID is for the email or id of the user’s Collector account.
• Monitor this user option if checked monitors the user and vice versa.

Adding Monitored Users for Twitter


Here the user can add, edit, and delete the listed monitored users or browse among them by
searching the users.

Figure 549: Manually Adding Monitored Users

The following activities can be performed:


1. When + (Add Monitored User Manually) is chosen, the following pop-up opens, where
Corporate email address (email address of the Monitored User), Display name and the Screen
name of the user should be entered.

342
Merge1 | User Guide
IMPORTERS

Figure 550: Add Monitored User

2. Click Upload CSV for uploading the Monitored users’ list as a CSV.
3. Click Delete selected for deleting the below selected list of monitored users.
4. Click the SAVE CHANGES or CLOSE.

Azure Active Directory


This option automatically imports the users from the Microsoft Azure Directory. By expanding
Configure Azure Active Directory, Azure Active Directory Configuration screen opens.

Figure 551: Azure Active Directory Configuration

To configure the section:

343
Merge1 | User Guide
IMPORTERS

1. Specify Application ID and Directory ID. For more details on how to create an app in Microsoft
Azure and grant the permissions, see Microsoft Azure App Creation and Microsoft Azure App
Permissions accordingly.
2. Provide X.509 Certificate Thumbprint in case you activate the Local machine radio button as
the X.509 Certificate source.
3. In case you activate Upload file (*.pfx), click the Select button to upload the certificate and
then provide X.509 Certificate Password.

Figure 552: Upload File (*.pfx)

4. Select User Mapping Property form the dropdown list. Note that User Principal Name always
exists.
5. Enable Get all users checkbox.

Microsoft Azure App Permissions


To add permissions for the application:
1. Go to the API permissions in the left side pane and click the Add a permission button.

Figure 553: Adding a Permission

2. Click Microsoft Graph.

344
Merge1 | User Guide
IMPORTERS

Figure 554:Selecting an API

3. Click Application permissions.

Figure 555: Microsoft Graph Permissions

4. Select the following permissions:

• GroupMember.Read.All
• User.Read.All.

5. Click Add permissions button.

Figure 556: Selecting and Adding Permissions

6. Confirm the permissions by clicking Grant admin consent.

345
Merge1 | User Guide
IMPORTERS

Figure 557: Granting Consent

7. Click the Yes button to grant consent.

Skip Monitored Users


Some of the collectors do not have users, therefore instead of seeing the user configuration options
under the Monitored Users tab, you will the following screen:

Figure 558: Monitored Users Not Applicable

If you click SKIP, you will be redirected to the Filters tab.

Here is the list of collectors for which Monitored Users is not applicable:
• Amazon S3
• Bloomberg
• BlackBerry
• DB
• EML
• FX Connect
• JSON
• Microsoft Teams Meetings
• Redtail Speak
• Symphony
• Text-Delimited
• Refinitiv
• Yieldbroker

346
Merge1 | User Guide
IMPORTERS

• Pivot
• UBS
• XSLT/XML
• XIP
• YouTube.

347
Merge1 | User Guide
IMPORTERS

FILTERS
Filters are used to filter or separate data according to content. They can be configured to match
specific email addresses, XML tags with specific values, or other information using LDAP queries.

To configure the filters:

1. Click Add Filter.

Figure 559: Adding Filter

2. Enter a Filter Name and select Filter Type. Merge1 has the following filter types:
• Active Directory Filter
• Keyword Filter
• Mail Filter
• XML Filter
• Message Size Filter
• Time Stamp Filter
• Participants Count Filter.

Figure 560: Editing Filters

Active Directory Filter


Note
The installation of the following filter requires proficiency in LDAP.

348
Merge1 | User Guide
IMPORTERS

The Active Directory filter matches segments that contain values specified with an LDAP expression.
Values are retrieved each time the importer is run.

Figure 561: Active Directory Filter

1. Search Base sets the starting point for the search in the directory tree. For example, you
might need to query the entire directory, in which case the search base must specify the root
of the directory service. Or you might need to query a specific organizational unit (OU) in the
directory. For example: ou=finance, dc=example, dc=com.
2. Search Scope sets the scope of the search starting from the search base:
• All - all levels inside Active Directory are searched.
• Sub Level - only levels under selected Search Base are searched.
• This Level - only searches the specified by the Search Base level.

349
Merge1 | User Guide
IMPORTERS

3. Search Filter defines search criteria and provides more efficient and effective searches. A
filter specifies the conditions that must be met for a record to be included in the record set
(or collection) that results from a query.
4. When User Address Search Pattern is enabled, the placeholder in the Search Filter field is
replaced with each address that is returned by the Regular Expression (5). The default
expression retrieves values from all objects returned by the Regular Expression and classified
as a User. For example, the following line if input in Regular Expression field, will return all
users with the relevant domain: Z^_a-z{|}~])*@[b | B]loomberg.net$^[-!#$%&’*+/0-9=?A-
Z^_a-z{|}~](\.?[-!#$%&’*+/0-9=?A-
5. In the Regular Expression field, the default expression is input for retrieving values when User
Address Search Pattern is enabled (see pt. 4).
6. If Replace User Address with LDAP Attribute is checked and Replacement Attribute is added
below, it replaces each user’s address with their respective AD attributes as specified.
7. Write the Mail address in this field, that is activated when Replace User Address with LDAP
Attribute is checked (see pt. 6).
8. In the LDAP Server field, fill in the name of the LDAP Server.
9. In the Port field, define the Port of the LDAP Server.
10. In the User Name field, add the username of the LDAP account.
11. In the Password field, fill in the corresponding password to the LDAP account for signing in.
12. Check Enable Caching option if you want to enable saving the query result for future imports.
This will allow skipping searching in the AD during the next Import and will automatically fetch
the cached results.
13. In the Cached Query Count field, specify the number of queries that should be cached.
14. In the Cache Update Interval field, specify the time after which the cached queries should be
updated.

Users who do not have the selected attribute or a Display Name will not be returned by the LDAP
query.

Keyword Filter
Keyword filter allows you to retrieve and refine the data by mentioned keywords and collect it in the
specified target.

350
Merge1 | User Guide
IMPORTERS
Figure 562: Keyword Filter

1. In the Keywords (Comma separated) field, the keywords, by which the data will be filtered,
should be added. The keywords need to be separated by commas for the filtering to work.
Keywords are searched for in the body of the message, as well as in its subject.
2. If Case Sensitive option is checked, only the words with the same case sensitivity as the input
keyword will be filtered. E.g., if you input Direct, it will filter only messages with Direct in their
subjects and/or bodies, the results with direct or DIRECT will not be filtered.
3. Filter can be done being based on the following field(s):
• From
• CC
• Body
• To
• BCC
• Subject
• Custom Header

Mail Filter
Using Mail Filter, you can send the imported data to different targets based on the email addresses in
the TO, FROM, CC, and BCC fields of the imported messages, depending on the fields you specify in
the filter settings. The mail filtering in Merge1 can be static and dynamic.

Static Filter allows uploading a CSV file with email addresses that will be used for filtering. Click Add
from CSV to browse for the necessary list for filtering. The CSV file should include only email
addresses that should be used for filtering.

Figure 563: Mail Filter

Dynamic Filter is used to specify email addresses dynamically from an LDAP server or from a CSV file.
This means, that if any changes are applied to the user list in the server or in the CSV file, the filter
settings are refreshed, and values are retrieved newly each time the Importer is run.

351
Merge1 | User Guide
IMPORTERS

Figure 564: Setting up Dynamic Filter Type

Here are the steps for setting up LDAP Server to set up Dynamic Filter:
1. In the Server Name field, fill in the name of the LDAP Server.
2. Enter the Base Domain.
3. In the Port field, define the Port of the LDAP Server.
4. In the User Name field, add the username of the LDAP account.
5. In the Password field, fill in the corresponding password to the LDAP account for signing in.
6. Mark the Use Default Mailbox checkbox to activate/deactivate the Custom Attribute field.
7. Use the Custom Attribute field to extend the search of an asset.
8. Search Scope defines the scope of the search starting from the Base Domain.
• Base - only the specified Base Domain should be considered for search.
• OneLevel - only the immediate children of the specified Base Domain should be
considered.
• Subtree - the specified entry as Base Domain, as well as all its subordinates should be
considered.
9. In Search Filter field, add filters that can be used to restrict the number of users or groups
that are permitted to access an application.

352
Merge1 | User Guide
IMPORTERS

For using a CSV file as a dynamic filter, add the path to the CSV file in the field. If something is
updated in the CSV file, it will be applied the next time the Importer is run.

Figure 565: Using CSV Filter as a Dynamic Filter

Message Size Filter


This allows filtering messages to a different target based on their size.

Figure 566: Message Size Filter

In the Filter messages larger than/smaller than _ MB, larger than or smaller than should be selected
and the size of messages should be entered:
• If larger than is selected and the size of messages is entered, the messages that exceed that
size will be filtered.
• If smaller than is selected and the size of messages is entered, the messages that are smaller
than that size will be filtered.

Participants Count Filter


This allows filtering messages based on the number of participants.

353
Merge1 | User Guide
IMPORTERS

Figure 567: Participants Count Filter

The filter is configured based on the FROM, TO, CC, and BCC checkboxes.

The FROM field is always marked as checked and is not editable.

Match messages that have _ than X participant(s) is used to filter messages that have more/less than
the specified quantity of participants by choosing less or more from the drop-down list and inputting
the needed quantity of participants.

Time Stamp Filter


Time Stamp Filter allows filtering messages that are already constructed and ready to be sent based
on the timestamp.

354
Merge1 | User Guide
IMPORTERS

Figure 568: Time Stamp Filter

Here are the steps for configuring the filter:


1. The Match messages that fall inside/outside the range below drop-down list allows you to
include or exclude the specified period depending on the following cases:
• In case both the Range start date and the Range end date are specified, and the
inside option is selected from the drop-down list, the content between that cut-off
dates is filtered.
• In case both the Range start date and the Range end date are specified, and the
outside option is selected from the drop-down list, then the content before and after
the specified dates, is filtered.
• In case only the Range start date is specified, and the inside option is selected from
the drop-down list, the content after that specified start date is filtered.
• In case only the Range start date is specified, and the outside option is selected from
the drop-down list, the content before that specified start date is filtered.
• In case only the Range end date is specified, and the inside option is selected from
the drop-down list, the content before that specified end date is filtered.
• In case only the Range end date is specified, and the outside option is selected from
the drop-down list, then the content after that specified end date is filtered.
2. The Range start date checkbox allows specifying a start date.
3. The Range end date checkbox allows specifying an end date.

XML Filter
XML filter allows filtering through XML source data with tags and their specific values.

355
Merge1 | User Guide
IMPORTERS

Figure 569: XML Filter

1. In the Add Tag and Value field, an XML tag and corresponding to it value should be added.
They will be searched for in the body of the message from XML Source and when matched,
will be sent to the assigned target. You can add more than one XML tag and value. After
adding one, click the activated Plus button.
2. If you do not want to input each tag and its value manually, upload a CSV file that includes
tags and their values. Click Add from CSV, browse for the necessary file and upload it.
3. If the added tag and value are matched with a message, that message is sent to the
corresponding target. In the Header section you can add a specific text to be added in the
message header for facilitating future filtering. For example, you can add tags that match by
country and if the tag is matched, the header can be “MessageOriginCountry – USA”. See
example in Figure 570:

Figure 570: Header Matched

Note that only one header can be added to a single filter, so for each country, in this case, a separate
filter needs to be created.

This filter works only with XML sources:


• Bloomberg
• CellTrust
• Symphony
• XSLT/XML
• IceChat
• Pivot
• UBS

356
Merge1 | User Guide
IMPORTERS

TARGETS
After filling in all the information related to the Filters, click Next and you will be redirected to Targets
tab. You can either fill in the Targets or skip it and fill out later, from the Importer panel under the
Configurations.

Please note that files and attachments, greater than 2 GB are not being processed.

Figure 571: Targets


To set up Targets:
1. Click Add Default Target. You will be redirected to the Targets screen.

Figure 572: New Target

2. Fill in the Target Name and select Target Type from the drop-down menu. Note that these are
mandatory fields.

When you have selected the exact target, click Next.

Merge1 offers the following types of targets:


1. Azure Blob – Delivers data directly to the Azure Blob target.
2. Direct SMTP - Delivers data to an SMTP server address directly from the server.
3. EV Server - Archives data in an Enterprise Vault archive in EML or MSG formats.
4. EWS Server - Delivers data to an Exchange Web Services server.
5. Failed - Lists all imports as failed delivery attempts.
6. Folder - Delivers data in EML, MSG or JSON formats to specified folder.
7. Ignored - Ignored target is used to mark all items sent to it as Ignored.
8. Office 365 EWS - Delivers data to an Exchange Web Services server.
9. Report - Prints the output of the data inside the log file, usually used for diagnostics.
10. SMTP - Delivers data to an SMTP server address using a relay.
11. Google Vault - Delivers data to Google Vault.

357
Merge1 | User Guide
IMPORTERS

Azure Blob Target


To deliver data collected from different sources to the Azure Blob storage, Azure storage should be
configured accordingly. For more information on how to configure Azure Storage, see the section.

To configure Azure Storage:


1. Enable Connection String and enter the Connection String copied in step 9.
Or,
2. Enable Service SAS URL and enter the Service SAS URL copied in step 9.
3. Enter Blob Container Name from step 10.

Figure 573: Azure Storage

Output Folder
1. Create New Folder Per Session if enabled will create a separate folder for each time the
Importer is run, named after the date and time of the run.
2. If the Generate manifest file box is enabled, a CSV file is generated that will contain the list of
generated message files.

Figure 574: Output Folder

3. Specify the format of the exported message, EML, MSG or JSON. See the difference between
the file types in the table below.

358
Merge1 | User Guide
IMPORTERS

EML MSG JSON

EML is the extension MSG is the extension JSON is a lightweight


supported by multiple e- supported by Microsoft data-interchange format.
mail clients like Outlook Outlook.
Express, Thunderbird,
Windows Live Mail.
.eml file can be read by .msg file can only be saved It is easy to read and
its E-mail client along for e-mails and messages. write.
with other. Like Outlook
can read .eml files.

.eml files can be opened .msg files can only be It is easy for machines to
in a text editor as are opened by MAPI based parse and generate.
like text files. applications.

You can easily convert your .msg file into an .EML file as there could be possibilities where
you want to view an .MSG file but you do not have MS Outlook to open it. .MSG files are
client dependent because they are a proprietary message for Outlook, whereas .EML is a text
- based file representing a message. Therefore, having single messages stored in .EML rather
than an .MSG file proves more beneficial for the users, due to its flexibility.

4. The Remove invalid characters from message headers checkbox is activated by default.
5. Enter the SMTP address in case you want to Replace the empty “To” with an SMTP address in
the corresponding field.

Note that JSON file format is available in all the collectors’ folder target but currently is supported
only for the below listed collectors. For other collectors an error will be thrown.

• Amazon S3
• Box
• Chatter / Chatter Cipher Cloud
• DB (only newly created ones, not upgraded)
• Dropbox Business
• FX Connect
• Jabber Enterprise
• JSON
• Microsoft Teams Meetings
• Microsoft Teams via Export API
• OneDrive for Business
• Pivot
• Redtail Speak
• Refinitiv
• RingCentral
• ServiceNow

359
Merge1 | User Guide
IMPORTERS

• Slack eDiscovery
• Skype for Business
• Symphony
• Text- Delimited (newly created ones, not upgraded)
• Twitter
• Web Page Capture
• Workplace from Facebook
• XIP
• XSLT/XML (newly created ones, not upgraded)
• Yieldbroker
• YouTube
• Zoom Chat
• Zoom Meetings
• Zoom Meetings Chats
• Zoom Meetings via Archiving API

Envelope
The Construct Envelope messages option when enabled envelopes the original output message in a
new message with the From and To email addresses set in the corresponding fields.
The Use a preset FROM and TO in the outer envelope headers option adds the From and To email
addresses of the original output message in the header of the envelope.
The Place BCC users in the TO field option adds the email addresses from the BCC field of the original
output message to the TO field.

Figure 575: Envelope

The service account that runs the service should have read/write permission for the specified folder.

Webhooks Client Configuration


1. Enable Send Webhook Notifications.

Figure 576: Webhook Client Configuration

2. Specify Endpoint URL.


3. Specify Batch Size. The default size is 100.

360
Merge1 | User Guide
IMPORTERS

The default value for Request Method is POST.

Status Update Configuration


1. Enable Send Status Update.

Figure 577: Status Update Configuration

2. Specify Endpoint URL.

The default value for Request Method is POST.

Configuring Azure Storage

For Azure Blob storage:


1. Login to your Azure portal account.
2. Navigate to Storage Accounts.

Figure 578: Navigating to Storage Accounts

3. Click the account Name.

Figure 579: Storage Accounts

4. On the left side navigation pane, navigate to Shared Access Signature.


5. For Allowed services, enable Blob.

361
Merge1 | User Guide
IMPORTERS

6. For Allowed resource types, enable Service, Container, and Object.


7. For Allowed permissions, enable:
• Read
• Write
• Add
• Create
• List
8. Specify the Expiration start and end date and click Generate SAS and connection string.
9. Copy Connection string or Blob service URL for Connection configuration.

Figure 580: Shared Access Signature

10. On the left side navigation pane, select Containers (1) and click the name of the container you
want (2).

Figure 581: Containers

Direct SMTP Target


Direct SMTP Target allows Merge1 to deliver the processed messages directly to the recipients’ SMTP
server without requiring relaying through a secondary SMTP server like in the SMTP Target.

362
Merge1 | User Guide
IMPORTERS

Below you can find information on how to setup the Direct SMTP Target for your collector.

Figure 582: Direct SMTP Target

1. Specify the sender SMTP address that you want to use in the From field. We recommend
using an existing email address so the emails will not be spammed.
2. Specify a destination email address in the To field.
3. When you have filled in all the fields, click Next.
4. When the Place BCC users in the TO field is selected, the BCC emails of the message will be
added to the TO field.

Enterprise Vault Server Target


The EV Target requires the Enterprise Vault API Runtime (12 or above) installed on the machine
hosting Merge1 Agent.

363
Merge1 | User Guide
IMPORTERS

Figure 583: EV Target

1. To set up an EV target, enter the instance name or IP address of the server that hosts your EV
Directory SQL Server and click Connect to populate the other form fields.
2. After successfully connecting to the database, provide the relevant information from the
drop-down fields click Next:
• Site
• Destination Server
• Vault Store
• Archive
• Retention Category
3. Fill in the fields of the Index Properties section:
• Set
• Name
• Value
Index Properties are used to assign search parameters to data stored in the archive. These
parameters will appear in the Other Attribute Name and corresponding Value fields in Enterprise
Vault Shopping Service.

For Advanced Configuration Options:


1. Select the message format by activating the MSG or EML radio buttons from Message
format option.
2. Fill in the replace empty “To” field with SMTP address and validate the SMTP address by
enabling the corresponding checkbox.

364
Merge1 | User Guide
IMPORTERS

Figure 584: Advanced Configuration Options

Note
Merge1 officially supports Domino Journal, Journal Archive and SMTP archives, however, most other
archive types are usually compatible as well.

Note that by default, the value for Vault.MsgType is set to EXCH by Merge1. To change this, add a
new index property with Vault in the Set field, MsgType in the Name field, and the value of your
choice in the Value field.

To include the x-KVSMessageType header, find and enable the option on the SETTING page.

Exchange Web Server Target


If you choose EWS Target, Merge1 will deliver the data to the Exchange Web Services server, you
have chosen. Below you can find information on how to setup the EWS Target for your collector. Note
that the EWS target can be used to connect to the on-prem exchange server.

Figure 585: EWS Target

To set up the target:

365
Merge1 | User Guide
IMPORTERS

1. Enter the SMTP address in the relevant field.


2. If you activate Basic Authentication, provide the Impersonator information and Password of
the target Exchange Web Services account.
Or,
3. If you activate OAuth, provide Application ID, Tenant ID, and Thumbprint in case you select
OAuth Authentication type (Figure 586).

For step-by-step instructions on how to get Application ID, Tenant ID, and Thumbprint, see
Microsoft Azure App Creation and Creating a Certificate (Private and Public Keys) accordingly.

Figure 586: OAuth Credential Flow

4. Specify a Default Sender address for emails with empty FROM fields (EWS rejects such
emails).
5. Click Connect, to get the folder list.
6. Specify a Target folder for imported data.
7. When you have filled in all the fields, click Next.

Notes
• When checking the Use Exchange Personal Archive checkbox, you will enable Merge1 to
import data to the Personal Archive folder of the Target folder.
• When checking the Construct Envelope Message checkbox, you will enable Merge1 to import
data in MS Exchange journal report format (the X-MS-journal-report header is also added).

Microsoft Azure App Creation

To authenticate via OAuth during the collector configuration, you need to create a Microsoft Azure
Application:
1. Login to the Azure Portal using the same credentials as for O365 (Global Admin).
2. Click Azure Active Directory at the top of the page and select App Registration from the left-
side navigation pane.

366
Merge1 | User Guide
IMPORTERS

Figure 587: Azure Active Directory

Figure 588: Navigating to App Registration

3. Click the +New registration button.

Figure 589: New Registration

4. Enter a Name for the application and click the Register button.
5. Enter the enter the URL of your local Merge1 environment in the following format:
https://<your_merge1_domain>/Configuration/OAuthCallback. Click
Register.

367
Merge1 | User Guide
IMPORTERS

Figure 590: Registering an Application

6. Find and make a note your Application (client) ID and Directory(tenant) ID as this is needed
for configuring the collector in Merge1.
7. In the navigation pane to the left, go to Certificates & secrets.

Figure 591: Navigating to Certificates

8. Click the Upload certificate button.

Figure 592: Upload Certificate

368
Merge1 | User Guide
IMPORTERS

9. Select a certificate (public key) with one of the following file types: .cer,.pem, .crt, and click
Add. For more information on how to create a certificate, see Creating a Certificate (Private
and Public Keys).

Microsoft Office 365 EWS Target


If you choose Office 365 EWS Target, Merge1 will deliver the data to EWS in Microsoft Office 365 (in
the cloud). Below you can find information on how to setup the Office 365 EWS Target for your
collector.

Figure 593: MS Office 365 EWS Target

1. Enter the Username and Password of the target Exchange Web Services account.
2. Specify a Default Sender address for emails with empty FROM fields (EWS rejects such
emails).
3. When you have filled in all the fields, click the Next button.

Info
O365 EWS Target delivers the messages to O365 using the
https://office365ingestionsvc.gble1.protection.outlook.com/service/ThirdPartyIngestionService.svc
endpoint.
When messages are delivered to O365, they're stored in the user's (the user in the FROM field)
Purges folder. This folder is under the Recoverable Items folder and is not accessible by Outlook.
Therefore, all users that are in the FROM or SENDER fields, must have a mailbox in O365, otherwise
the messages will fail to be delivered.

Required permissions for Merge1:


1. Create a service account and provision Exchange Administrator permissions. For more
information see https://go.microsoft.com/fwlink/p/?LinkId=532393.The credentials of this
account will later be used in the Merge1 target configuration.
2. When using a Global Admin account, consent to the Office 365 third-party data connector
app (Creating a service principal using PowerShell will not work).

Note that this app is owned by Microsoft and Veritas does not have any control over the permissions
that this app requires.

To consent, navigate to the following page and click Accept:


https://login.microsoftonline.com/common/oauth2/authorize?client_id=8dfbc50b-2111-4d03-9b4d-
dd0d00aae7a2&response_type=code&redirect_uri=https://portal.azure.com/&nonce=1234&prompt
=admin_consent

369
Merge1 | User Guide
IMPORTERS

Notes
• When checking the Use Exchange Personal Archive checkbox, you will enable Merge1 to
import data to the Personal Archive folder of the Target folder.
• Make sure the DNS is properly configured for Autodiscover.

SMTP Target
If you choose an SMTP Target, Merge1 will deliver the data to an SMTP server address you provide.
Below you can find information on how to setup the SMTP Target for your Collector.

To configure Main Settings:


1. Specify the SMTP Server and Port fields. Note that the default is 25.
2. Enter an SMTP address for the Replace empty “To” field with SMTP address field.

Figure 594: Main Settings

To configure the Envelope section:

Figure 595: Envelope

1. Specify a destination email address in the To field and a return address in the From field.
2. Enable the Construct Envelope messages checkbox to envelope the original output message
in a new message with the From and To email addresses set in the corresponding fields. The
Use a preset FROM and TO in the outer envelope headers option adds the From and To email
addresses of the original output message in the header of the envelope.
3. Enable Place BCC users in the TO field to add the email addresses from the BCC field of the
original output message to the TO field.

Note: SMTP Target is not recommended for delivering messages to Exchange Online Mailboxes, due
to various throttling policies set by Microsoft. Also, Exchange Online does not accept Journal Envelope
messages which can result in loss of original message time stamps and other metadata.

Notes

370
Merge1 | User Guide
IMPORTERS

• When enabling the Construct Envelope Messages checkbox, Merge1 will import data in MS
Exchange journal report format (the X-MS-journal header also be added).
• When enabling the Place BCC users in the TO field checkbox, Merge1 will move all BCC
recipients to the TO field.

To configure Authentication Encryption:


1. Enable Use SSL encryption if you want to use SSL encryption. When enabled you can also
check the Implicit checkbox to encrypt the entire FTP connection from the start of the
session.
2. Enable Use TLS Encryption if you want to encrypt using TLS.
3. Enable Supply Username and password to enter username and password.

Figure 596: Authentication Encryption

Encryption: SSL and TLS encryption settings should match those of the target SMTP server. Click Test
Connection to check the connection and to ensure that your settings are accurate.

Report Target
The Report Target is used to check whether data can be analyzed successfully. The Importer will list
certain details for viewing in its activity logs. The complete header option includes subject lines, and
everything includes complete headers as well as the messages themselves (Figure 597).

Figure 597: Report Target


1. Select the relevant level.
2. Click Next.

371
Merge1 | User Guide
IMPORTERS

Folder Target
If you choose Folder Target, Merge1 delivers the data to the specified folder in EML, MSG or JSON
formats. Below you can find information on how to setup the Folder Target for your collector.

Output Folder

Figure 598: Output Folder

6. Select the output folder, to where the exported messages will be sent.
7. Specify the format of the exported message, EML, MSG or JSON. See the difference between
the file types in the table below.

EML MSG JSON


EML is the extension MSG is the extension supported JSON is a lightweight data-
supported by multiple e-mail by Microsoft Outlook. interchange format.
clients like Outlook Express,
Thunderbird, Windows Live
Mail.
.eml file can be read by its E- .msg file can only be saved for e- It is easy to read and write.
mail client along with other. mails and messages.
Like Outlook can read .eml
files.
.eml files can be opened in a .msg files can only be opened by It is easy for machines to
text editor as are like text MAPI based applications. parse and generate.
files.

You can easily convert your .msg file into an .eml file as there could be possibilities where you want to
view an .msg file but you do not have MS Outlook to open it. .msg files are client dependent because
they are a proprietary message for Outlook whereas, .eml is a text - based file representing a
message. Therefore, having single messages stored in .eml rather than an .msg file proves more
beneficial for the users, due to its flexibility.

372
Merge1 | User Guide
IMPORTERS

8. If the Generate manifest file box is enabled, a CSV file is generated that will contain the list of
generated message files.
9. Create New Folder Per Session if enabled will create a separate folder for each time the
Importer is run, named after the date and time of the run (Figure 599).

Figure 599: Create Folder per Session

10. The Remove invalid characters from message headers checkbox is activated by default.
11. Enter the SMTP address in case you want to Replace the empty “To” with an SMTP address in
the corresponding field.

Note that JSON file format is available in all the collectors’ folder target but currently is supported
only for the following below listed collectors. For other collectors an error will be thrown.

• Amazon S3
• Box
• Chatter / Chatter Cipher Cloud
• DB (only newly created ones, not upgraded)
• Dropbox Business
• FX Connect
• Jabber Enterprise
• JSON
• Microsoft Teams Meetings
• Microsoft Teams via Export API
• OneDrive for Business
• Pivot
• Redtail Speak
• Refinitiv
• RingCentral
• ServiceNow
• Slack eDiscovery
• Skype for Business
• Symphony
• Text- Delimited (newly created ones, not upgraded)
• Twitter
• Web Page Capture
• Workplace from Facebook
• XIP
• XSLT/XML (newly created ones, not upgraded)
• Yieldbroker
• YouTube
• Zoom Chat
• Zoom Meetings
• Zoom Meetings Chats
• Zoom Meetings via Archiving API

373
Merge1 | User Guide
IMPORTERS


Envelope
The Construct Envelope messages option when enabled envelopes the original output message in a
new message with the From and To email addresses set in the corresponding fields.
The Use a preset FROM and TO in the outer envelope headers option adds the From and To email
addresses of the original output message in the header of the envelope.
The Place BCC users in the TO field option adds the email addresses from the BCC field of the original
output message to the TO field.

Figure 600: Envelope

The service account that runs the service should have read/write permission for the specified folder.

Google Vault Target


Before configuring the Google Vault Target in the Merge1 UI, the following configurations should be
done in Google Admin Console.
Google Vault Configuration
1. Login to https://console.cloud.google.com/ using an Administrator account, click Select a
project, then NEW PROJECT.

Figure 601: Selecting a New Project

2. Enter a name for the project (example: Merge1) and click CREATE.

374
Merge1 | User Guide
IMPORTERS

Figure 602: Creating a New Project

3. Once the project is created, and there are multiple projects, click SELECT PROJECT from the
Notifications. You will be navigated to the created project dashboard.

Figure 603: Selecting a Project from the List

Note that if this is the first project created, you will automatically be navigated to the project
dashboard.

Figure 604: Getting Started – Dashboard

4. Hover APIs & Services, then select Library.

375
Merge1 | User Guide
IMPORTERS

Figure 605: Navigating to Library

5. In the Search for APIs & Services search, box type Gmail.

Figure 606: Searching Gmail


6. Click Gmail API.

Figure 607: Accessing Gmail API

7. Once you are in the Gmail API page, click ENABLE.

376
Merge1 | User Guide
IMPORTERS

Figure 608: Enabling Gmail API

8. Click Credentials.

Figure 609: Selecting Credentials

9. Click Manage service accounts.

Figure 610: Managing Service Accounts

10. Click + CREATE SERVICE ACCOUNT.

377
Merge1 | User Guide
IMPORTERS

Figure 611: Creating Service Account

11. Enter a name and a description for the service account and click CREATE AND CONTINUE.

Figure 612: Service Account Details

12. Select Owner as a role and click CONTINUE, then click DONE.

Figure 613: Grant Service Account Access to Project

13. You will be redirected to the page in Figure 614. Click the button and select Manage keys.

378
Merge1 | User Guide
IMPORTERS

Figure 614: Creating Key

14. Select ADD KEY > Create new key.

Figure 615: Creating New Key

15. Select JSON as a key type and click CREATE.

Figure 616: Selecting JSON

16. Once the key is created, you should get prompted to save the file on your computer, save it
somewhere secure, you will need it when configuring Merge1.

379
Merge1 | User Guide
IMPORTERS

Figure 617: Saving the Key

17. To grant permissions to the application, go to https://admin.google.com then Security > API
controls.

Figure 618: Accessing Security

18. Scroll down to Domain wide delegation section and click MANAGE DOMAIN WIDE
DELEGATION.

Figure 619: Managing Domain Wide Delegation


19. Click Add new.

380
Merge1 | User Guide
IMPORTERS

Figure 620: Adding a New Client ID

20. Open the key file that you saved as JSON above, copy the value of client_id, then paste it in
the Client ID field. Enter https://www.googleapis.com/auth/gmail.insert in OAuth scopes field
and click AUTHORIZE.

Figure 621: Adding a New Client ID

Now you can start configuring Merge1's Google Vault target.

Google Vault Target


1. Upload JSON file saved in the step 15 of the previous section by clicking SELECT.
2. Specify the mailbox, to which the imported messages should be delivered, in the Destination
mailbox field.
3. When Mark messages as deleted option is checked, the imported messages are not visible in
the "All Mail" section but are still available for compliance search.
4. Click SEND TEST EMAIL to test the connection to the target.

381
Merge1 | User Guide
IMPORTERS

Figure 622: Service Account Key

Note that you can download the uploaded JSON file by clicking Download. It is active only when there
is a JSON file to download.

In Merge1 you can have one default target and a number of Alternative Targets.

In case you want to make an Alternative target as the Default one next to the X button, you will see
the Default button. Click it and your Alternative Target will become your default and it will be listed
under the Alternative Targets.

Figure 623: Default Target

382
Merge1 | User Guide
IMPORTERS

IMPORTER SETTINGS
The final step for the Importer Configuration Wizard is the Importer Settings. Under this tab, you will
have the opportunity to configure the following:

• Reporting
• Message Header
• Logging
• Alerting
• Importer Schedule
• Filtering
• Processing
• Advanced Configuration Options.

Reporting & Message Tracking


The following section of the Importer Settings refers to email reports, which may be used to deliver
statistical information (also viewable on the Dashboard) via email.

Figure 624 : Reporting & Message Tracking

Enable Message Reconciliations


Merge1 imported messages have headers that can be found in message properties. When this option
is enabled, two following message headers are added to the generated message:

X-Merge1-Reconciliation-Id. This header is provided by the collectors and corresponds to the id of the
message in the source. In case of EWS collector it is the ID retrieved from Exchange server mailboxes.
Currently, only EWS collectorsets this header. If the Reconciliation Id is not set by the collector, this
header clones the Message-ID header value, which, in turn is generated by Merge1 for each unique
message.

X-MessageSource. Each collectorsets its own value for this header. For example, EWS collectorsets
the value of mentioned header using the user mailbox and mailbox folder name in the following
format: Mailbox:Foldername.

These headers are both in an embedded message and in an enveloped message. Enveloped message
has a different Message-ID from the embedded message. The Reconciliation Id remains the same for
both an embedded message and an enveloped message.

383
Merge1 | User Guide
IMPORTERS

The Enable Message Reconciliation can be enabled only when Audit DB is configured. Otherwise, the
following pop-up will appear:

Figure 625: Warning

Report Level
1. Report Level: In Merge1 you will find three types of Report Level, which set the level of
details. You can:
• Generate Summary Report Only. Summary reports include Source Statistics and
Message Statistics. Source Statistics includes the number of unprocessed,
quarantined, failed, and imported sources. Message Statistics includes the number of
unprocessed, failed, successful, excluded, and ignored messages.
• Generate Per-Source and Summary Report. This report type in addition to the
Summary Report includes statistics for each source. For each source there is statistics
for unprocessed, processed, imported, failed, monitored users (if applicable).
• Generate Per-Message, Per-Source and Summary Report. This report is useful only
for file collectors, such as Bloomberg, Symphony, IceChat, Text-Delimited, and others.
The per message report in addition to the reports described above is generated only
in case a message has failed.

Detailed reports are longer and take more time to read. Reports exceeding 5 MB are
shortened.

Reports are different from collector to collector, based on the activities that can be captured
from them.

2. MISC: By enabling the Delete Reported and Archived Sources and Sessions from Database
option, information will be deleted from the database when reports are sent. Deleted figures
will no longer appear in the REPORTS section of the Dashboard.

Figure 626: Report Settings

384
Merge1 | User Guide
IMPORTERS

3. Email Report Settings: Enable reporting by providing an SMTP server address.


4. Message Subject: Enter the subject for the report message.
5. Sender Name/Email: This information will appear in the FROM field when viewing emailed
reports.
6. Recipient Email: Enter an email address for delivering reports.

Message Headers
Message headers are custom headers that are used for labeling and sorting messages.

Note
Filters are not applied to headers generated by these settings.
These settings do not apply to the EML and Exchange Graph API sources.

Figure 627: Message Headers

1. Fill in the Header name and Value fields and click +.


2. Include the full header information either in the message body (with metadata separators in
between) or as HTML attachment (as Metadata.HTML attachment).

Logging
Enter a file path in file log folder field. File logs are typically used for troubleshooting purposes. This
field is required.

With File Log Priority the logs are saved in a separate log file and with Event Log Priority the event
Logs are stored in the Windows Event Viewer and is used to avoid third-party tools in Windows. Also,
the latter helps to customize logging process and facilitate monitoring based on requirements.

Figure 628: Logging

1. File Log Priority:


• Error. Only errors are recorded in the log file. Example: ERROR
Merge1.Core.SenderThread - <1> Failed to send message #4, TargetError. Error:

385
Merge1 | User Guide
IMPORTERS

Failed to save message C:\Users\Desktop\Bloomberg Target\4.eml: Header name


contains invalid characters.
• Warning. In addition to error logs, warning logs are also added. Example: WARN
Merge1.Core.Importer - The report won't be sent as no Email Address is provided.
• Info. This logging level gives information on performed actions. Example: INFO
Merge1.Core.Importer -Creating default Target.
• Debug. This logging level provides information on how an action was accomplished. It
gives more detailed overview than the previous three levels. DEBUG
Merge1.Core.Importer - Creating new session for Importer: 1
• Trace. The trace level is the lowest logging level, e.g., is the most detailed one. TRACE
Merge1.Core.SenderThread - <31> Preparing message #820 for sending.

When choosing logging level Trace, a warning message will appear notifying about possible security
risks with this level of logging. Some sensitive data can be stored in the log as plain text.

Figure 629: Warning

Log File Size Configuration

The log files do not have a size limit, which means they can grow up to couple of GBs. Files that large
cannot be opened. Therefore, a log file size limit needs to be set. The log file size cannot be
configured through Merge1 UI. However, it is possible to do by adding appropriate appender to the
log config file in the Merge1 installation folder. It is done the following way:

1. Go to C:\Program Files\Globanet Consulting Services\Merge1 7.0\Bin path1 in the Merge1


installation folder.
2. Open Merge1.Logging.config.
3. Add the following appender to the file before the root element at the end:

<appender name="RollingFile" type="log4net.Appender.RollingFileAppender">


<file value="" />
<datePattern value="'.'yyyy-MM-dd'.log'" />

1
In case of Merge1 version 6.0, the path will be C:\Program Files\Globanet Consulting Services\Merge1 6.0\Bin.

386
Merge1 | User Guide
IMPORTERS

<appendToFile value="true" />


<rollingStyle value="Composite" />
<maxSizeRollBackups value="-1" />
<maximumFileSize value="1KB" />
<staticLogFileName value="false" />
<countDirection value="0"></countDirection>
<layout type="log4net.Layout.PatternLayout">
<conversionPattern value="%date
[%thread] %-5level %logger - %message%newline" />
</layout>
</appender> -->

4. Specify the size of the log file in the <maximumFileSize value="1KB" /> field. For example,
10MB limit should be specified as <maximumFileSize value="10MB" />
5. Save the file.

As Merge1 is multi-threaded, always allow a +30% threshold between size you set in config file and
actual file size you will see.

Importer Schedule
Here you have the option to choose the Selected Times importer schedule option. This enables you to
set a weekly automated option. Increments are at 15-minute intervals (Figure 630).

Figure 630: Selected Times Importer Schedule

Even if the scheduler is enabled, but a time is not selected through Importer Schedule, the job will not
be queued.

Note

The Importer schedules must be re-configured after upgrading Merge1 from 6.0 to 7.0.

387
Merge1 | User Guide
IMPORTERS

Alerting
In this section the option to alert on errors the collector encounters during importing.
There are two levels of alerting:
• Error. Alert is sent when an Error is registered in the logs.
• Warning. Alert is sent when an Error or a Warning is registered in the logs.

To configure the alerting, enter the following information (Figure 631):


• Add the SMTP Server.
• Fill in the SMTP Port.
• Enable Server Authentication if required.
• Fill in Username and Password to authenticate to the server.
• Specify the buffer size.

Figure 631: Alerting

You can test the connection by entering Sender Name, Sender Email (preferably and existing one to
avoid the alert being sent to the Spam folder), and the Recipient Email. Click Send Test Email.

Filtering
Filters will not be applied unless filtering is enabled. To enable the filter, enable the Enable filtering
checkbox to configure their behavior (Figure 632).

• Unconditional hit default target: If selected, all data will be delivered to the default target,
even if an alternative target is set.
• Process all filters: When checked, applies filters to the relevant target. In case Match any is
selected, even if one filter matches to a message, the latter is sent to the set Target. If Match
all is checked, all filters must match the message to be sent to the specified Target. For
example, there are two Keyword Filters set with the following names: “Date – February”, “No
Attachment”. If Match any is selected, a message that has only “Date-February” keyword will

388
Merge1 | User Guide
IMPORTERS

be filtered and sent to the target. If Match all is selected, only “Date-February” keyword will
not suffice, the message should correspond to the second filter,” No Attachment”, as well.

Figure 632: Filtering

In the bottom fields, select the filter name and choose the target from the drop-down menu where
the corresponding messages should be sent. Make sure to click the activated + button to add the
filtering setting, otherwise it will not be saved.

Processing
Processing Options - This option is mostly used for the troubleshooting purpose.
It is advised to use Process Failed Messages Only when there is a big number of failed messages.

Figure 633: Processing

If there are problems with connection which lead to failed messages, Process All Messages is the
preferred choice.
If necessary, change this setting to process new segments or failed segments exclusively.
• Attachment is missing - This line is added to the first line of the reprocessed segments with
references to missing attachments.
• Disclaimer is missing - This line is added to the first line of the reprocessed segments with
references to missing disclaimers.

389
Merge1 | User Guide
IMPORTERS

• Strip Group Address Info - This option is selected by default and applies to the EML collector.
With this option, recipients in the header (To, CC and BCC) in an EML file will be removed
upon conversion.
• Set Content-Disposition to inline if missing - This option applies only to the EML source. When
processing EML files that have image attachments, Merge1 will insert any missing Content
Disposition header fields and set their disposition type to inline so that images will appear in
the message body when they are viewed in applications such as Microsoft Outlook.
• Set display name to SMTP address when empty – Enter the SMTP address in the Display
Name fields.
• Match Email Address - The Match Email Address option can match the existing ID or SMTP
Address and replace:
a. SMTP Address
b. Display Name
c. Display Name and SMTP Address

The CSV file should contain the following columns:


• Last Name (A)
• First Name (B)
• Company Name (C)
• Old Email (D)
• New Email (E).

Advanced Configuration Options


With the help of Enable Import Throttling you can reduce bandwidth consumption by breaking down
the data transfer into chunks with delays in between.

To adjust the Importer's thread pool and optimize it for performance on certain systems you can use
the files Queues and Threads. Additionally, you can set the number of Max target errors, which
indicates how many delivery attempts should fail before the Importer stops (Figure 634).

Figure 634: Advanced Configuration Options

After you have filled in all the fields in the five tabs you will have to click Save & Finish.

In case you want to make changes in the Wizard, click back and you will be redirected to the last
screen (Importer Settings).

390
USERS & GROUPS

CHAPTER 6

Users & Groups


This chapter represents:
• Creating a Merge1 User
• Selecting an AD User Account
Merge1 | User Guide
USERS&GROUPS

Users and Groups


To manage Merge1 user accounts, click User Profile on the navigation pane located on the left side.

Figure 635: Users & Groups

Users can be added to Merge1 in three ways:

Create a Merge1 User


With this option a user can be created directly in the Merge1 environment.
• Click Create Merge1 User to add a new account.
• You can edit user information and passwords if you click the pencil icon next to the
username.
• You can easily delete the user account by clicking the trash can.

To create a user:

Figure 636: Creating User

1. Provide Merge1 the following information:


• First name (required)
• Last name (required)
• Email address (required)
• Phone number
• Mobile number

392
Merge1 | User Guide
USERS&GROUPS

2. Assign the user type: Administrator (has full access) or Reviewer (can view only Reports and
Dashboard). Once you select the user type, click SAVE CHANGES.
3. Enable Send Password Email. Note The password should be changed after entering the
temporary password.

Note
To search for a particular user, enter the value of one of the following Active Directory user attributes:
"cn", "samaccountname", "givenname", "sn", or "mail".

Select an AD User Account (Recommended per industry best practice)


This option allows picking a user directly from the Active Directory of the Windows server the device
is part of (Figure 637).

Figure 637: Selecting AD Users and Groups

1. Click Select AD Users and Groups to add a new account.


2. Search for Active Directory users by a keyword. If no keyword is added, all Active Directory
users will be shown.
3. Select the user(s) you want to add and click Add Users.
4. Select the type of the user (Administrator or Reviewer).

Select Local Server User Account

This option allows picking a user directly from the users on the device Merge1 is installed on (Figure
638).

393
Merge1 | User Guide
USERS&GROUPS

Figure 638: Creating Local Server User Account

1. Click Select Local Server User Account to add a new account.


2. Search for Active Directory users by a keyword. If no keyword is added, all local users will be
shown.
3. Select the user(s) you want to add and click ADD USERS.
4. Select the type of the user (Administrator or Reviewer).

394
REPORTS

CHAPTER 7

Reports
This chapter represents how to manage the
Reports section.
Merge1 | User Guide
REPORTS

Overview
To view and extract detailed information about the Merge1 user activity and delivery failures, click
Reports in the Navigation pane.
• Audit: View Merge1 user activity.
• Monitored Users: View monitored users by Merge1.
• Unprocessed Messages: View unprocessed messages.
• Target Delivery Failure: View all failed attempts to deliver data.
• Missing Attachment Failure: View all failed messages with missing attachments.
• Missing Disclaimer Failure: View all failed messages with missing disclaimers.
• Data Acquisition Failure: View all failed messages with failed data acquisitions.

Managing The Reports


After selecting the report type choose the collector type and which reports you would like to review.
Finally, you can export the report information either in a PDF or CSV format.

Figure 639: Reports

For Audit and Monitored Users reports data can be exported as a PDF or CSV file when clicking the
corresponding button on the right side.

Figure 640: Exporting Reports

The Target Delivery Failure, Missing Attachment Failure, Missing Disclaimer Failure, and Data
Acquisition Failure reports have some of the following functionalities as not all actions are active for
the given report types:

1. Actions
The Reprocessing Options are the following:
• Retry processing. Retries failed messages processing when the importer is run.

396
Merge1 | User Guide
REPORTS

• Force processing - Processes the failed messages when the importer is run and delivers
them to the target without missing data.
• Delete failed messages - Deletes failed messages from DB.
• Skip - Does not process failed messages when the importer is running.

Figure 641: Reprocessing Options

After selecting the reprocessing option, click Apply. The configuration will be applied to the
data stored in DB. Click OK to close the pop-up window.

Important
The Reprocessing Options are applied in pairs with the Importer Settings > Processing >
Processing Options, i.e., Processing Options should also be configured, so the Reprocessing
Options configuration is applied properly.

By default, the Reprocessing option is Retry processing: if not configured by the user, there
will be retries with each session to process the failed messages until data reprocessing is
succeeded.
2. Export Messages
By clicking Export Messages, the report messages will be downloaded as a ZIP file containing
EML, JSON, or TXT files. The files contain all the generated data. Above the message body, the
failure reason is specified with an ERROR status. This functionality is useful in cases when
target delivery failure occurs: the messages can be downloaded here and manually sent to
the archive.

Audit
Many important actions that users make such as logging in or configuring importers, are listed in
Audit (Figure 642).

397
Merge1 | User Guide
REPORTS

Figure 642: Audit


The following event types are captured:

• LicenseChanged
• SqlConfigurationUpdate
• TargetAdded
• ConnectorAdded
• FilterAdded
• ImporterAdded
• ComponentSettingsModified
• ImporterServiceStart
• ImporterServiceStop
• TargetRemoved
• ConnectorRemoved
• FilterRemoved
• ImporterRemoved
• NetworkSettingsChanged
• AuditSettingsUpdated
• MessageHeadersSettingsUpdated
• ComponentRenamed
• ComponentDataDeleted
• ImporterDataDeleted
• ManualImportStart
• ScheduledImportStart
• ImporterCloned
• FilterCloned
• ConnectorCloned
• TargetCloned
• UserLoggedIn
• UserLoggedOff
• UserIsCreated
• UserIsDeleted

398
Merge1 | User Guide
REPORTS

• UserUpdatedProfileInfo
• UserTypeUpdated
• ImporterSchedulerEnable
• ImporterSchedulerDisable
• AgentEnabled
• AgentDisabled
• AgentCreated
• AgentDeleted
• AgentUpdated
• MonitoredUserSourceUpdated
• APIClientApplicationAdded
• APIClientApplicationRemoved
• APIClientApplicationChanged
• SmtpServerSettingsChanged
• ImportJobQueued
• ImportJobCanceled
• ImporterSchedulerEnabled
• ImporterSchedulerDisabled
• JITUserIsProvisioned
• JITUserRoleIsUpdated

Unprocessed Messages
The Unprocessed Messages report generates information on messages which have been constructed
and stored in the database, but there hasn't been an attempt to be sent to the target.
Unprocessed messages are reported when:
• A running importer is stopped.
• An importer is force killed before the messages are sent to the target.

Note that to process the unprocessed messages, the Processing Options of Importer Settings should
be configured.

Figure 643: Unprocessed Messages

399
Merge1 | User Guide
REPORTS

Target Delivery Failure


This report type generates information on messages which are constructed and stored in the
database - there is an attempt to send them to the target, but the attempt is failed.
Target delivery failures are reported when:

• The target is configured with invalid credentials.


• The selected target has size limits and there has been an attempt to send larger sizes of
messages. Specifically, the SMTP target has size limits and if the messages' size limits exceed
the target specified limit, the delivery of the messages to the target will fail.
• A target has insufficient storage (this case can apply to the Folder target).
• A target is overloaded.
• A network connectivity issue occurs.
• A target delivery has failed for some other reasons.

Figure 644: Target Delivery Failure

Missing Attachment Failure


For collectors, such as Bloomberg or Symphony, there is an option to fail messages with missing
attachments in the Attachment Validation sub-section when configuring Source.

Information on failed messages with missing attachments is reflected in the Missing Attachment
Failure report.

Figure 645: Missing Attachment Failure

400
Merge1 | User Guide
REPORTS

Missing Disclaimer Failure


For collectors, such as Bloomberg, there is an option to fail messages with missing disclaimers in the
Disclaimer Validation sub-section when configuring Source.

Information on failed messages with missing disclaimers is reflected in the Missing Disclaimer Failure
report.

Figure 646: Missing Disclaimer Failure

Data Acquisition Failure


When Merge1 captures data that is incomplete or damaged, information on the data will be reflected
in the Data Acquisition Failure report in case a report is generated.

Initially, this report has been constructed for the Yammer collector. According to the configuration,
the Yammer collector gets a date range, which is divided into chunks (a chunk is one hour) and starts
exporting the chunks separately in ZIP files. The ZIP file may or may not contain data depending on
the activity that occurred in the Yammer communication for the specific hour. Data processing in a
chunk (the whole ZIP file export) are reported when:

• The download fails, and data processing remains incomplete.


• The download is successful but there has been a column added in the CSV file while no
updates have been made on our side.
• An attachment has been added to a file while it is not included in the ZIP file.

When the data processing failure occurs, an output message is constructed. The body of the message
contains the start and end dates (separated with ":") of the processing data (chunk), and the failure
type is mentioned as Data Acquisition Failure.

When Merge1 starts running next time is set up to process the failed messages, the messages
(chunks) will be queued to be partially processed (DoPartialProcess for the Yammer collector). The
body is split into 2 parts - start and end date, by which a range (chunk) is created to reprocess.

The log file reflects information on generated data in the form of messages, while those messages are
the chunks, which may or may not contain messages.

401
Merge1 | User Guide
REPORTS

Notes

• In the case of the RingCentral collector data processing also occurs in ranges, however, when
a range (chunk) is failed, it is not considered a Data Acquisition Failure։ the information is only
logged.
• In the case of the Workplace from Facebook and Microsoft Teams via Webhooks collectors,
the Data Acquisition Failure report information is generated differently. Specifically, Merge1
messages are generated from the data stream. When a message is not processed for some
reasons (e.g., the message contains a new body type, the attachment is missing, or the
participant list is absent) the data is stored in the Merge1 DB as a message with the available
data (such as from, time, body, subject and more) and the status is specified as Data
Acquisition Failure. In this case, the quantity of Data Acquisition Failure messages is
equivalent to the number of Unprocessed Messages.
• Only the Yammer collector has a reprocessing functionality. Before reprocessing occurs, the
failed range (chunk) is deleted from DB. When the range fails again, the record is created
again and stored in DB.

Figure 647: Data Acquisition Failure

402
SETTINGS

CHAPTER 8

Settings
This chapter represents:
• Overview
• Merge1 Settings
• SMTP Server Settings
Merge1 | User Guide
SETTINGS

Overview
To view or configure Settings, navigate to the Settings section of the navigation pane. Settings and
SMTP Server Settings sections show up.

Figure 648: Settings

Settings
Database Configuration
1. Click Connect to Database to view the database configuration menu.

404
Merge1 | User Guide
SETTINGS

Figure 649: Database Configuration

2. Select an SQL server from the drop-down list or enter one in the same field.
3. Click Connect. The Select Database drop-down becomes active.
4. . When picking Create New from the drop-down list, a prompt appears (Figure 650).

Figure 650: Creating a New Database

3. Specify a name for the database and click Create. Select the database from the drop-down
menu.
4. Choose between Windows or SQL Server Authentication and enter the Login Name and
Password.

Note
When Windows Authentication is selected, Login Name and Password fields will be disabled
because the credentials entered in Figure 12 during installation will be used.

5. Configure Advanced Connection Parameters by specifying:


a. Connection timeout
b. Load balance timeout
c. Min pool size

405
Merge1 | User Guide
SETTINGS

d. Max pool size


e. Network packet size
f. Asynchronous processing
g. Encrypt
h. Enlist
i. Pooling
j. Replication
k. Enable always encrypted (column encryption)
6. Once you have carried out all the required steps, click OK. A Success pop-up window with
Database successfully selected info will show up.
7. Click Save Settings, then Yes to re-login Merge1.

Audit Configuration
Audit Database is used to log the activity performed in Merge1 UI, such as logging in, setting up a
collector, running an importer, etc.

To set up the Audit Database:


1. Click Connect to Audit Database and fill in the database information as shown in the Database
Configuration steps.

Note that the Enable option should be checked to record the audit logs in the database.

2. To check the Audit logs in the Reports section, select Audits in the Report Type drop-down
list.

Proxy and Authentication Configuration


A proxy server allows the traffic to flow through the proxy server to the address you requested.

To configure the proxy:


1. Enable Use a proxy server.
2. Specify Address and Port.
3. Select Proxy type:
a. None
b. Socks 4
c. Socks 5
d. HTTP
4. If you want to use credentials of a different user, enable the corresponding checkbox, and
enter the Account and Password.

406
Merge1 | User Guide
SETTINGS

Figure 651: Proxy and Authentication Configuration

Note
If your organization uses a proxy server, make sure the address and port information match those of
your browser's proxy settings.

Message Settings
The x-KVSMessageType header is used for e-discovery tasks associated with Veritas™ Compliance
Accelerator and Discovery Accelerator.

Figure 652: Message Settings

Click SAVE SETTINGS to save the settings for the Merge1 Settings.

SMTP Server Settings


The SMTP is an internet standard communication protocol for electronic mail transmission. When an
email is sent, the SMTP server processes the email, decides which server to send the message to, and
relays the message to that server.

To set up the SMTP Server settings, enter the required information in the following fields:
• SMTP Server
• Server Email
• Server Port
• Username
• Password

407
Merge1 | User Guide
SETTINGS

If you want to ensure privacy between communicating applications, check TLS required 1.

Figure 653: SMTP Server Settings

Click SAVE SETTINGS to save the settings for the SMTP Server.

1Transport Layer Security (TLS) is a cryptographic protocol designed to provide communications security over a computer network. Merge1
supports TLS version 1.3.

408
BRANDING SETTINGS

CHAPTER 9

Branding Settings
Merge1 | User Guide
BRANDING SETTINGS

Managing Branding Settings


The Merge1 interface look can be changed to make it closer to the corporate colors. The color
palette, as well as the logo, can be changed by clicking Branding Settings in the navigation pane.

Figure 654: Branding Settings

410
LICENSING

CHAPTER 10

Licensing
This chapter represents:
• Overview
• License Details
• Activating License
• Exporting to PDF
Merge1 | User Guide
LICENSING

Overview
Licenses are distributed for Collector and Target types individually. To activate a component or
components, send the Activation Request Code to Veritas Technologies LLC Support.

When installing Merge1 V7 for the first time, a trial version of Merge1 will be installed offering the
fully functional version of the product for 30 days.

Figure 655: License Trial Version

When upgrading Merge1 V6 to Merge1 V7, License Activation Key will be required. To see the
licensing info, navigate to the Licensing section of the navigation pane.

Figure 656: Licensing Section

License Details
All license information can be found under License Details:
1. The License Status can be marked as Valid, or the following status will show up:

Figure 657: License Inactive Status

2. Merge1 Version. The currently used Merge1 version.


3. Client ID. The ID generated for you as a client.
4. Expiration date/time. The expiration date/time will be specified: it can be permanent or for a
specific date.
5. Activation Request Code. The code that is sent to the support team for getting the activation
code.

412
Merge1 | User Guide
LICENSING

6. Enter Activation Code. The field to enter the requested activation code. Click UPDATE to
activate the license.

Figure 658: License Details

The following information is included in the license report:


• Name
• License Count
• User Count
• License End Date.

Activating License
Licenses are distributed for Sources and Target types individually. To activate a component or
components, send the Activation Request Code to Veritas Technologies LLC Support.

In case you fail to see License Status marked as Valid contact the Veritas Technologies LLC Support
team to activate the license.

Note
If you go over the limit of the license of the API-based collectors, Bloomberg, Refinitiv, a warning
message will be generated in the logs. Contact the support team for a new license.

Exporting to PDF
To have the details of the license page in a PDF file click EXPORT TO PDF and Merge1 license info will
be downloaded to your local PC.

413
Merge1 | User Guide
LICENSING

Figure 659: Exporting to PDF

414
API CLIENTS

CHAPTER 11

API Clients
This chapter represents:
• Overview
• Managing API Clients
Merge1 | User Guide
API CLIENTS

Managing API Clients


The sub-section represents how the apps can be added, edited, and deleted.

Figure 660: Client Applications

Adding a New Application


1. Go to the API Clients section of the navigation pane.
2. Click Add Application and a pop-up window will open (Figure 661)

Figure 661: Adding an Application

3. Specify a name (maximum 64 characters in length).


4. Select the Agent Manager role.
5. Click Add and a new card will be added to the page (Figure 662).

Figure 662: Client Application Added

416
Merge1 | User Guide
API CLIENTS

The application consists of the following fields:


• Name. The application name is specified.
• Role. The level of accessibility is specified.
• Application ID. Application ID is presented. The user can copy the ID by clicking the copy
button.

Editing an Application
1. Click Edit on the card and a popup will open to edit the application info (Figure 663).

Figure 663: Editing an Application

2. Modify the Name and click Save (Figure 664).

Figure 664: Editing an Application

Deleting an Application
1. Click Delete at the top right corner of the application (Figure 665).

Figure 665: Deleting an Application

2. Click Yes if you want to proceed or No to cancel the deletion.

417
Merge1 | User Guide
API CLIENTS

Managing Secrets
1. Click Go to Secrets located on the bottom corner of the application card.

Figure 666: Managing Secrets

2. Add a Secret or a JSON web key (Figure 667) to pass an OAuth authentication (see Registering
an Agent for using the Secret).

Figure 667: Managing Secrets

Adding a Secret
To add a secret:
1. Click New Secret.

Figure 668: Adding a New Secret

418
Merge1 | User Guide
API CLIENTS

2. In the opened pop-up window, enter a Description (maximum 500 characters in length) for
the secret.

Figure 669: Adding a New Secret


3. Select an expiration period from the drop-down list. Available periods:
a. Recommended: 6 months
b. 3 months
c. 12 months
d. 18 months
e. 24 months
f. Custom
Note
The specified expiration period is used to invalidate the secret.

Figure 670: Selecting an Expiration period


4. If Custom is selected, the Expiration Date picker will be shown below with the current system
date. Select a date.

419
Merge1 | User Guide
API CLIENTS

Figure 671: Selecting Expiration Date

5. After filling in the required fields, click Add and a new card will be added to the page.

The secret card consists of the following fields:


• Description. The description of the secret is specified.
• Client secret. The client secret is specified.
The Client secret will be shown only when creating the secret. It should be copied
using the Copy button and saved in a secure location for later usage.
• Expires. The expiration date will be specified. And if Custom is selected, the user can
manually set the date using Calendar.

Notes
• All secrets are immutable (not editable). Once generated, it will be active until the expiration
date.
• Shared Secrets are stored in the database in a hashed format; hence the system can/will
show it in a plain text mode only at the generation time.

Deleting a Secret
1. Click Delete at the top right corner of the secret card (Figure 672).

Figure 672: Deleting a Secret

2. Click Yes if you want to proceed or No to cancel the deletion.

420
Merge1 | User Guide
API CLIENTS

Managing JSON Web Keys


Adding a JSON Web Key
To add a JWK public key:
1. Click JSON Web Key.

Figure 673: Adding a JSON Web Key

2. In the opened pop-up window, enter a Display Name (maximum 500 characters in length) for
the public key and provide a JWK Public Key (maximum 4000 characters in length).

Figure 674: Adding a JSON Web Key

3. After filling in the required fields click Add and a new card will be added to the page.

The JWK public key card consists of the following fields:


• Name. The JWK public key name is specified.
• Expires. The expiration date will be specified.

Note
JWK public keys do not have an expiration period. They are valid until they are deleted from the
system.

421
Merge1 | User Guide
API CLIENTS

Deleting a JSON Web Key


1. Click Delete at the top right corner of the JSON web key card.

Figure 675: Deleting JSON Web Key

2. Click Yes if you want to proceed or No to cancel the deletion.

Note
JWK Public Keys do not have an expiration period. They are valid until the User deletes them from the
system.

422
JOB MONITORING

CHAPTER 13

Job Monitoring
This chapter represents:
• Overview
• Managing Job Monitoring
Merge1 | User Guide
JOB MONITORING

Overview
This section allows Merge1 root tenant admins to monitor import jobs with their job executions.

Figure 676: Job Monitoring

When expanded, the page provides two-level information.

Figure 677: Job Monitoring Details

The first level:

Field Description
ID Here the job ID is displayed. Note that you
can use the Copy button next to it to copy
and use it for later purposes.
Scheduler Here the scheduler status (On/Off) is
displayed. The scheduler status can be
changed by enabling/disabling the toggle.
Confirm or discard the status change.

424
Merge1 | User Guide
JOB MONITORING

Status Here the importer status


(Idle/Queued/Running/Stopping) is
displayed.
Last Status Change Date Here the last status change date is
displayed.
Last Run Date Here the last run date is displayed.

Importer ID Here the Importer ID is displayed. Note


that you can use the Copy button next to
it to copy and use it for later purposes.

The second level provides:

Field Description
Status Here the job execution status
(Pending/Sent to Agent/Agent
Accepted/Finished) is displayed.
Start Date Here the start date is displayed.

Last Heartbeat Date Here the last heartbeat date is displayed.

End Date Here the end date is displayed.

Error Message Here the error message is displayed if


there are any.
Run Attempts Here the run attempts are displayed.

Trigger Here the trigger type is displayed. It can


either be trigged by scheduler or
manually.
Agent Here the agent name/ID is displayed. If
there is no agent assigned, the field
remains blank.

425
Merge1 | User Guide
JOB MONITORING

Managing Job Monitoring


Filtering Importer Jobs
The Filtering option allows filtering out the list of records from the sub-section.

Figure 678: Filtering Importer Jobs

By selecting the Importer from the drop-down list, only the importer with its job executions will be
displayed.

Figure 679: The Filtered List

Browsing Importer Jobs


This sub-section is enhanced with the pagination option. This means that it is enabled with the
possibility of splitting the list of records in the sub-section into pages for paged navigation.

426
Merge1 | User Guide
JOB MONITORING

Figure 680: Browsing Importer Jobs

Setting the Number of Entries per Page


By default, each sub-section is set to display 20 entries per page to ensure fast page loading.
However, you can define to view a lower/greater number of entries per page.

Figure 681: Setting the Number of Entries per Pag

427
APPENDIX

CHAPTER 14

Appendix
This chapter represents:
• Creating a Certificate (Private and Public Keys)
• Known Issues
Merge1 | User Guide
APPENDIX

Creating a Certificate (Private and Public Keys)


For private key:
1. Go to the Start menu & click Administrative Tools > Internet Information Services (IIS)
Manager and click the server’s name in the Connections column on the left and
double click Server Certificates.

Figure 682: Navigating to server Certificates

2. Click Create Self-Signed Certificate in the Actions column on the right.

Figure 683: Creating Self-Signed Certificate

3. Type any meaningful name and then click OK to proceed.

Figure 684: Specifying a Name

4. Click OK. Once that is complete, you should now see the SSL in the list of Self-Signed
certificates. Now, you have IIS Self-Signed Certificate with 1 year validation.

429
Merge1 | User Guide
APPENDIX

Figure 685: Server Certificates

5. Right-click on that certificate and click Export

Figure 686: Exporting the certificate

6. Specify the path, type the password, confirm the password, and click OK. Now, you
have exported the Private key.

Figure 687: Entering the Details for the Certificate

For private key:

1. Launch Microsoft Management Console. Press Win+R, type mmc.exe and click OK.
2. Click File and select the Add/Remove Snap-in option.

430
Merge1 | User Guide
APPENDIX

Figure 688: Navigating to Certificates

3. Click Certificates in the list of Available snap-ins and then click Add.

Figure 689: Certificates

4. Select Computer account and click Next.

Figure 690: Selecting the Certificate Snap-in

5. Choose Local Computer and click Finish.

Figure 691: Selecting the Computer

6. Click OK to add the certificate snap-in and get back to console.

431
Merge1 | User Guide
APPENDIX

Figure 692: Adding the Certificate Snap-in

7. Expand the Personal folder in the left-side menu and choose Certificates.

Figure 693: Selecting the Certificates

8. Right-click the certificate you want to export - All Tasks > Export.

Figure 694: Navigating to Export Screen

9. On the prompt menu, click Next.

Figure 695: Welcome Screen of Certificate Export Wizard

10. Click No. Do not export the private key!

432
Merge1 | User Guide
APPENDIX

Figure 696: Exporting Private Key

11. Choose Base-64 encoded X.509 (.CER) and click Next.

Figure 697: Selecting the Certificate Type

12. Fill in the file path and click Next.

Figure 698: Specifying the File Path

13. Click Finish and now you have the Public key.

433
Merge1 | User Guide
APPENDIX

Figure 699: Completing the Certificate Export Wizard

Note
CNG certificates are not supported.

434
Merge1 | User Guide
APPENDIX

Known Issues
• In the Citrix Workspace & ShareFile collector, duplicate messages are captured for shared and
then deleted files in case Archive all activities in ShareFile (1) or from the Archive only certain
selection of activities in ShareFile, File share and Text-only messages (2) are enabled.

• In the Microsoft Teams via Export collector, in case of having an error with ‘404 not found’
message for a user when processing messages from Microsoft Teams, the collector will skip
that user and a warning will be logged for later troubleshooting.

References
Please, refer to the following related documents to obtain more information about the system and
how it functions, which can be found in the Documents folder of the downloaded Merge1 7.0 file:

• Microsoft SQL Always Encrypted Configuration Guide


• Installation Instructions
• Working in the Globanet Portal

435

You might also like