Exporting data through Integration Points

Integration Points provides you with the ability to export data directly from your workspace. This includes exporting saved searches, case folders, and productions directly from your workspace, and scheduling future or recurrent export jobs.

  • Although importing and exporting a load file is possible in Integration Points, Import/Export is the main application recommended for a stable and efficient load file import and export.
  • When you export data to a load file through Integration Points, your files are saved to a file share. To access this file share, look at the AppID in the URL of your Relativity environment and locate the EDDS folder on the file share that has the same number.

Exporting a folder to load file

Exporting a folder and subfolders to a load file

Exporting a production to a load file

Exporting a saved search to a load file

Exporting to a Relativity workspace

In addition to exporting to a CSV and load file, you have the option of exporting data from one Relativity workspace to another Relativity workspace. For more information on this capability, see Promoting data between workspaces through Integration Points.

Running the export job

To export your load file based on the export settings you specified above, click Run on the Transfer Options console on the saved integration point.

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

Note that you also have the option of saving this integration point as a profile through the Save as Profile button on the Transfer Options console. For more information on profiles, see Integration Points profiles.

Click OK on the run confirmation message, which informs you of where your documents will be placed.

The Run button turns to red and gives you the option of stopping the job you just kicked off, as long as that job has a status of Pending or Processing.

If necessary, monitor the progress of the promote job by viewing the Status field in the Status view at the bottom of the layout. You will see any of the following status values:

  • Pending—the job has yet to be picked up by an agent.
  • Validation—an agent is validating the job to make sure it has the required settings, such as access to the source and destination objects (saved searches, workspaces, etc.). If validation fails, the status changes to "Validation failed," and Relativity logs an error. If the validation succeeds, the job moves on to a status of "Processing."
  • Validation failed—the job validation has failed, resulting in an error, the details of which are saved in the Job History Errors tab.
  • Processing—the agent has picked up the job and is in the process of completing it.
  • Completed—the job is complete, and no errors occurred.
  • Completed with errors—the job is complete and errors have occurred. You can view error details in the Job History Errors tab. See Monitoring job history and errors for details.
  • Error—job failed—a job-level error occurred and the job did not complete because it failed. You can view error details in the Job History Errors tab. See Monitoring job history and errors for details.
  • Stopping—you clicked the Stop button, and the stop job has yet to be picked up by an agent.
  • Stopped—the job has been stopped.

Stopping and restarting an export job

Relativity gives you the option of stopping an export job from proceeding in the event that you need to re-prioritize it or because you made a mistake when creating it. You can only do so when that job has a status of Pending or Processing.

Note the following about stopping an Integration Points job:

  • You can also stop a scheduled job if it has a status of Pending or Processing.
  • A job is cannot be stopped if it has any status other than Pending or Processing, or the point at which Relativity starts promoting documents with such as information as the user who tagged them and the source workspace.
  • When you click Stop, Relativity immediately stops creating new errors for that job.
  • When you click Stop on a run-now job, Relativity marks all errors associated with the current job history as Expired.
  • When you click Stop on a retry job, Relativity marks all errors associated with the current job history and the previous job as Expired.
  • You can start a scheduled job after you have already stopped it.
  • The item counts on the Integration Points layout reflect all items promoted before the agent received the signal to stop the job.

To stop an export job, follow the steps below.

  1. Click Stop on the console.

    Relativity then informs you that you will not be removing any data by stopping the transfer and that you should check to make sure that the overwrite setting you previously entered is still appropriate for the re-run.

  1. Click Stop Transfer to proceed.

  • Once Relativity stops the job, the Job Status field on the Status view reflects the stopped job.
  • To re-start a stopped job, click Run. When you do this, Relativity begins to transfer data again from the beginning but does not remove any data already transferred.

    Stopping (disabling) an Integration Point from promoting data

    To stop, or disable, an integration point from promoting data, simply disable, or turn off, the scheduler option.

    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.

    Automatically stopping a scheduled job that repeatedly fails

    In some cases, a scheduled job may fail each time it is executed, such as when a job needs reconfiguring, and it may take some time before you become aware of these failed attempts. To mitigate this situation, you can configure an instance setting which will specify the maximum number of consecutive failed attempts encountered before the job is automatically stopped. For example, you may want to stop the scheduled job after four consecutive failed attempts at running.

    1. Navigate to the Instance Settings page.

    2. Create a new instance setting with the following settings.

      • Name—enter MaxFailedScheduledJobsCount.
      • Section—enter kcura.IntegrationPoints.
      • Value Type—select Integer 32-bit.
      • Value—enter the number of consecutive failed attempts to be executed before the scheduled job is stopped.

    The integration point's Scheduling tab will display the failed jobs with a Job Type of "Scheduled Run," Job Status of "Error - job failed," Items Transferred of "0," and Total Items based on the number of items in that job. The system will attempt one more run after the configured maximum number of consecutive failed attempts before it stops the scheduled job and the Total Items column will be blank.

    The "Next Scheduled Runtime (UTC)" field on the Scheduling tab will be blank, letting you know that job is not scheduled to run again. You will need to correct the error(s) before it will run again as scheduled.

    When you go to the Job History page to view the job, you will see the system-generated error description explaining why the scheduled job was stopped.