Installing Integration Points

Note: As of September 1, 2024, we’ve streamlined our Staging boundaries to more effectively separate staging data from workspace and system data. With this change, you will no longer be able to write to or access data outside of the four defined staging area folders. The four folders that comprise the Staging area are ARM, ProcessingSource, StructuredData, and TenantVM. Folders that were removed include FTA, Temp, Export, and dtSearch, in addition to any other folders that you manually created. Refer to the Staging Area topic and Staging Area FAQ in Community for more details.

To successfully use Integration Points, you need to install the Integration Points application to at least one workspace.

Installing Integration Points

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

• 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 has not been added to the Application Library.

Once you install Integration Points application, the necessary Integration Points agents will be deployed automatically.

Security 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	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	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
Source	Tab Visibility	Workspace Details
Destination	Destination Workspace	View, Edit, Add
Destination	Allow Export	Admin operation
Destination	Tab Visibility	Workspace Details

If you are 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 are 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 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	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	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	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	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	Allow Import	Admin operation

If you do not have sufficient permissions and you attempt to perform either of the following actions, you will 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 do not have permissions to. This error occurs when they click Run Now on the integration point that they create to push documents to review.