Importing data through Integration Points

Integration Points provides you with the ability to import data directly into your workspace through the same functionality that the Relativity Desktop Client (RDC) provides for importing the document object. This includes importing a CSV file, LDAP, or load file directly into your workspace, and scheduling future or recurrent import jobs..

Note: All Integration Points jobs are fully editable after run.

To see web import functionality in action, watch the following Web Import and Export video.

This page contains the following information:

Importing a CSV file

Importing LDAP

Importing a document load file

Importing an image load file

Importing a production load file

Previewing the import file

If you're importing a load file, you have the option of previewing that file before you run the import job. You can find the preview options listed with the Back and Save buttons.

Clicking File, Errors, or Choices & Folders displays the load file preview.

The Load File Summary section provides the following information:

  • Preparing Preview - a visual display of the progress of the load file preview.
  • Progress Summary
    • Status - the status of the load file preview preparation.
    • Time Elapsed - the amount of time it's taken Relativity to prepare the load file preview.
  • Load File Breakdown
    • Total Records - the total number of documents included in the load file.
    • Total Bytes Read - the number of bytes read for the load file preview.
    • Total Bytes - the total number of bytes contained in the load file.
    • Errors - the number of errors contained in the load file.

The Records section displays the number of the record in the load file, as well as all of the source fields that you mapped when creating the integration point. Note that you can't preview a load file if you haven't at least mapped the control number field.

Running the import job

  • Once Relativity stops the job, the Job Status field on the Status view reflects this.
  • Downloading the error file

    If your integration point encounters any errors during its run, the Download Error File link on the Transfer Options console is activated. This gives you the option of downloading an Excel file containing all the errors found in the integration point. Note that this option is available for load file imports only and isn't visible for other providers.

    To download this file, click the Download Error File link.

    (Click to expand)

    Then open the downloaded file in the bottom left corner of your screen.

    (Click to expand)

    You now have the option of manually fixing the errors, saving the modified file in your DataTransfer\Import folder, and creating a new integration point to import those fixed files, seeing that they didn't make it in with the original import. When doing this, simply ensure that the Import Source field of the new integration point refers to the file you just added.

    Integration point agent considerations

    When you have one agent enabled, a scheduled integration points job is always queued and is always run. When you have more than one agent, however, the scheduled job may get queued or it may result in an error, after which that job is rescheduled. In other words, there is mixed behavior when you have enabled more than one agent.

    The following table provides a breakdown of this behavior:

    If Then
    1. You enable a single agent called Agent 1.
    2. You schedule a job called IP1 to run at 10:00 AM daily.
    3. You click Run or Retry Errors on IP1 at 9:59:59 AM.
    1. Agent 1 picks up the Run or Retry Errors job for IP1 and completes it in one hour.
    2. Agent 1 picks up the scheduled job for IP1, creates an error, removes the job history from IP1, and reschedules IP1 to run at the next interval.
    1. You enable Agent 1 and Agent 2.
    2. You schedule IP1 to run at 10:00 AM daily.
    3. You click Run or Retry Errors on IP1 at 9:59:59 AM.
    1. Agent 1 picks up the Run or Retry Errors job for IP1 and begins working on it.
    2. Agent 2 picks up the scheduled job for IP1, creates an error, removes the job history from IP1, and reschedules IP1 to run at the next interval.
    1. You enable Agent 1 and Agent 2.
    2. You schedule IP1 to run at 10:00 AM daily.
    3. You click Run or Retry Errors on IP1 at 9:59:59 AM.
    4. All other agents are busy, including Agent 2.
    1. Agent 1 picks up the Run or Retry Errors job for IP1 and begins working on it.
    2. Agent 1 completes the Run or Retry Errors job for IP1.
    3. Agent 1 picks up the scheduled job for IP1 and completes it.
    1. You enable Agent 1 and Agent 2.
    2. You click Run or Retry Errors on IP1.
    3. You click Run or Retry Errors on IP2.
    1. Agent 1 picks up the Run or Retry Errors job for IP1 and begins working on it.
    2. Agent 2 picks up the Run or Retry Errors job for IP2 and begins working on it.

    Disabling an Integration Point sync

    To disable an integration point sync, simply turn off the scheduler.

    1. From the Integration Points landing page, click the Integration Point Name that you wish to disable.
    2. Click Edit.
    3. From the Import Scheduling section under Enable Scheduler, select No.This disables the scheduling mechanism for that integration point.

    Scheduler date format considerations

    The integration points scheduler accepts non-U.S. date formats to further accommodate, for example, users in Australia.

    In this case, the default language in your browser settings is set to English (Australian) or any other language that would display a non-U.S. date format of day/month/year instead of /month/day/year.

    Relativity then properly displays the date when you select it for the Start and End Date fields in the Scheduling category.

    This date format will also appear anywhere else in Relativity where a date is displayed, such as on the saved Integration Point Details layout and the Date Last Modified field on the Document list.