Get started with integration points

Relativity Integration Points provides a robust framework that you can use to develop custom providers for importing data to Relativity Dynamic Objects (RDOs) or other types of objects. It supports the integration of custom providers that ingest data in XML, JSON, SQL databases, or other formats. This framework leverages the standard features available in the Application Deployment System (ADS), such as custom pages and event handlers. Because you use the ADS to build your custom integration points, you can easily deploy them to multiple workspaces and Relativity environments. You can also manipulate this data just like any other content because it lives in Relativity object types. Additionally, Relativity Integration Points includes a fully implemented UI that you extend by adding your own custom page, which contains only those fields requiring user input for your provider. For information about administrative tasks, see Relativity Integration Points.

This page contains the following information:

See these related pages:

Understand the Relativity Integration Points framework

The Relativity Integration Points framework streamlines the process of creating custom functionality for importing data. This framework lets you focus on how your code interacts with a data source and on the usability of your client interface. The following diagram illustrates the workflow for creating an integration point.

(Click to expand)

diagram showing how to create an integration point

This diagram includes the following steps:

  1. The user clicks the New Integration Point button to start the Create Integration Point wizard.
  2. The user selects a source provider and destination RDO and optionally schedules the import.
  3. The Integration Points framework invokes the custom page that you developed for your custom source provider. The custom page displays the required settings for the page, and the users enter input values as necessary.
  4. The user maps provider source fields to destination RDO fields and clicks Save.

The Integration Points framework provides these key features to facilitate this workflow and your development process:

Basic concepts for integration point development

Integration Points provides a framework for hosting your custom application, which contains or utilizes the following key components:

Workflow for importing data

The following workflow illustrates how the Integration Points framework uses an agent for importing data:

(Click to expand)

diagram showing workflow for importing data

This diagram includes the following steps:

  1. Your custom source provider ingests a specific type of data, such as XML, JSON, or others. It uses the settings selected by the user on the your custom page. The Create Integration Point wizard invokes your custom page. See Understand the Relativity Integration Points framework.
  2. The Integration Point agent batches data from your source provider and calls the Import API.
  3. The Relativity Import API programmatically adds your data to Relativity dynamic objects (RDOs).
  4. In Relativity, you use the RDOs to access the imported data.

Relativity Integration Points API

The Relativity Integration Points API includes the following namespaces with classes and interfaces that you can use to interact with components of this framework:

Integration Points SDK files

You can download the Integration Points SDK from the Relativity Community. For more information, see Download the SDKs.

After downloading the Integration Points SDK, extract its contents to a folder on your local machine. It contains the following folders:

For information about adding these files to a project, see Best practices for integration point development and Set up your Visual Studio solution.

Note: You must use Visual Studio 2015 to develop integration points for Relativity 9.4 or above.

Community Updates

Aero Developer FAQ Evolving the Platform Most recent release notes
Learn more Learn more Learn more

Additional Resources

Access Third-Party Tools with GitHub     Create .NET Apps Faster with NuGet
Visit github     visit nuget