Installing Integration Points

To successfully use Integration Points, you need to install the Integration Points application to at least one workspace. The first workspace the application is installed in should be your source workspace.

Use the following procedures to install Integration Points:

1. Install Integration Points from either the Application Library or an external file. See Installing Integration Points.
2. Add the Integration Points agent. See Adding Integration Points agents.
3. Access Integration Points. See Accessing Integration Points.

This page contains the following information:

System requirements and specifications

You must have the following in order to use Integration Points:

• Integration Points has the same system requirements as its compatible Relativity version. See the System requirements.
• The WebAPIPath instance setting in the kCura.IntegrationPoints section configured correctly. Note that this path is case sensitive.

Note: Relativity Processing is not required to use Integration Points.

Installing Integration Points

Since Integration Points uses the ADS framework, you have the following options available for installing Integration Points in your environment. See Relativity applications.

• Install Integration Points from the Application Library - If you add the Integration Points application to the Application Library, you can install it to the current workspace, or to multiple workspaces at once, from the Application Library.
• Install Integration Points from an external file - You can import the Integration Points application into your workspace from an external file if it hasn't been added to the Application Library.

Adding Integration Points agents

After you install Integration Points, add the Integration Points Agent and Integration Points Manager Agent through the following steps.

Note: We recommend only using the Integration Points Agent.

Add one of each of these agents per Resource Pool. See Agents.

1. Navigate to the Agents tab.
2. Click New Agent and complete the following required fields:
   • Agent Type - access the list of agents, filter for one of the Integration Points agents, select the agent, and click OK.
     
     
   • Number of agents - enter the number of agents you want to add.
   • Agent Server - select a server and click OK. Select the regular agent server here, not the processing worker or processing queue manager.
   • Run interval - enter the interval, in seconds, at which the agent should check for available jobs.
   • Logging level of event details - select Log critical errors only (recommended), Log warnings and errors, or Log all messages.
   • Enabled - select Yes.
3. Click Save.
4. Repeat the above steps for the Integration Points Manager agent.

Verify the Enable column displays Yes for the both the Integration Points and Integration Points Manager Agent. See Agents.

Note: Integration Points agents operate on a single agent per job basis. If you have 4 agents enabled and only 1 job running in your workspace, only 1 agent will be performing work while the other 3 agents will be idle until additional jobs are started. Likewise, if you have 4 agents enabled and 3 jobs running, 3 agents will be doing work - 1 for each job - and 1 will be idle waiting for an additional job to start.

Security permissions

See a detailed breakdown of required Integration Points permissions

The following tables provide detailed breakdowns of the security permissions required to use Integration Points.

To submit a job for a non-Relativity source provider (FTP, LDAP, or Load File) and display console errors for that job, you need the following permissions:

Workspace	Object/operation/tab	Permission type
Source	Workspace	View, Edit, Add
Source	Integration point	View
Source	Integration Point	Instance view
Source	Job History	View, Edit, Add
Source	Destination Provider	View
Source	Source Provider	View
Source	Integration Point Type	View
Destination	Destination RDO	View, Edit, Add
Destination	Allow Import	Admin operation

To submit a job with Relativity as the source provider and display console errors for that job, you need the following permissions:

Workspace	Object/operation/tab	Permission type
Source	Workspace	View, Edit, Add
Source	Integration point	View
Source	Integration Point	Instance view
Source	Job History	View, Edit, Add
Source	Destination Provider	View
Source	Source Provider	View
Source	Integration Point Type	View
Source	Document	View, Edit
Source	Search	View, Edit, Add
Source	Advanced & Saved Searches The saved search that you use for the integration point must have an owner of Public.	Browser
Destination	Destination Workspace	View, Edit, Add
Destination	Allow Export	Admin operation

If you're creating an integration point for a non-Relativity source provider (FTP, LDAP, or Load File), Relativity assumes you have the following system admin permissions:

Workspace	Object/operation/tab	Permission type
Source	Integration point	View, Edit Edit is required for adding Job History RDO’s.
Source	Job History	View, Edit, Add
Source	Job History Error	View, Edit, Add Edit is required to mark errors as new and expired

If you're creating an integration point with Relativity as the source provider, Relativity assumes you have the following system admin permissions:

Workspace	Object/operation/tab	Permission type
Source	Destination workspace	View, Edit, Add Edit is required to rename destination workspaces.
Destination	Manage Object Types This is required to create new object types.	Admin operation
Destination	Source workspace	Add, Edit Edit is required for situations when Relativity renames the destination workspace upon a source workspace name change.
Destination	Source job	Add

To view an integration point with any source provider, you need the following permissions:

Workspace	Object/operation/tab	Permission type
Source	Job History	View
Source	Integration point	View
Source	Integration point	Instance view
Source	Integration point type	View

To create and edit an integration point with any source provider, you need the following permissions:

Workspace	Object/operation/tab	Permission type
Source	Integration point	View, Edit, Add Edit is only required if you're editing the integration point. Add is only required if you're creating the integration point.
Source	Integration point type	View
Destination	Field	Instance view
Destination	Allow Import	Admin operation

To create an integration point with a Relativity source provider, you need the following permissions:

Workspace	Object/operation/tab	Permission type
Source	Field	Instance View
Source	Allow Import	Admin operation

To create an integration point with any source provider from an integration point profile, you need the following permissions:

Workspace	Object/operation/tab	Permission type
Source	Integration point profile	View

To view any integration point profile, you need the following permissions:

Workspace	Object/operation/tab	Permission type
Source	Integration point profile	View
Source	Integration point profile	Instance view
Source	Source provider	View
Source	Destination provider	View
Source	Integration point type	View

To create and edit an integration points profile with any source provider, you need the following permissions:

Workspace	Object/operation/tab	Permission type
Source	Integration Point Profile	View, Edit, Add Edit is only required if you're editing the integration point profile. Add is only required is you're creating the integration point profile.
Source	Integration Point Type	View
Source	Source Provider	View
Source	Destination Provider	View
Destination	Field	Instance view
Destination	Allow Import	Admin operation

To create and edit an integration points profile with a Relativity source provider, you need the following permissions:

Workspace	Object/operation/tab	Permission type
Source	Field	Instance view
Source	Allow Import	Admin operation

If you don’t have sufficient permissions and you attempt to perform either of the following actions, you’ll see an error message stating "You do not have sufficient permissions. Please contact your system administrator." In each case, Relativity creates an error listing all missing permissions.

• Loading the integration points console or clicking Run Now or Retry:
  • If the error occurs after a button click, the message is prefixed with, "Failed to submit integration job."
  • If the job is a retry job, the prefix reads, "Failed to submit the retry job."
• Saving an integration point after creating a new one or editing an existing one.

Note: Integration points is tenant-aware. This means that workspace admins within a tenancy receive an error if they attempt to push to a workspace they don't have permissions to. This error occurs when they click Run Now on the integration point they create to push documents to review.

Accessing Integration Points

Once you've installed Integration Points, the Integration Points application tab appears in your workspace.