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

Accessing Integration Points

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