Overview
Connectors, in general, serve as the mechanism through which documents from the Venio application are transmitted to third-party applications. For example, Relativity Connector is specifically designed to facilitate the transfer of Venio documents to Relativity workspaces. The API provided by Relativity is employed for the importation of these documents. It is essential to establish the Relativity environment and field mapping. The environment determines the destination workspace for these documents, while field mapping assigns Venio field values to the corresponding Relativity fields.
The Relativity connector is compatible with either Relativity Server or Relativity One, which are two distinct Relativity applications designed for different purposes. The Venio application is capable of pushing documents to both of these platforms. The configuration required to define these Relativity platforms is identical, and document importation occurs in the same manner. Document imports take place concurrently with Venio production. As Venio production completes a chunk of full-text native or image documents, that chunk is also uploaded to the Relativity workspaces.
Prerequisites:
Permission and Control Settings: The user must be granted permission to manage the connector, and the control setting value for Enable_Connector should be set to 1.
Relativity Environment: This environment is created within the admin module by providing Relativity credentials (username/password) and the base URL.
Relativity Workspaces: These are analogous to Venio projects on the Relativity side, where we intend to push documents. They will be listed based on the provided Relativity credentials.
Relativity Field Mapping: This is used to specify how Venio field values correspond to Relativity fields. Field mapping can be done on-the-fly or through pre-defined mappings, so it is not an absolute prerequisite.
Workflow Block Diagram
Diagram Details
The production process in Relativity is closely linked to regular Venio production. The only additional steps required by the user are to choose whether they want to perform Relativity import alongside regular production. If they opt for this, they must select the appropriate environment and Relativity workspace from the Destination page in the production module. (Assuming these have been configured as part of the prerequisites mentioned earlier). Another optional step is field mapping, which involves defining how Venio field values should be mapped to corresponding Relativity fields.
Notifications for Relativity Status (From UI)
Once the production is completed, notifications are received through both in-app notifications and email alerts. The Status page in the production module also allows users to check the number of full-text, image, and native files imported into the production. In the case of any errors, users can download the error log file exclusively from the Status page in the production module.
Tables and details
- If a production is created, with relativity production check tbl_ep_exports for details on export created
Within this exports table, there is a filed called 'ExportOptions' which is of xml data type. You will find following kind of node that allows you to determine if it has a corresponding relativity import or not:
<ExportTemplateSettings>
<TemplateVersion />
<ConnectorOption>
<Connectors>
<Connector>
<Platform>LOCAL_REPOSITORY</Platform>
</Connector>
<Connector>
<Platform>RELATIVITY</Platform>
<Id>2</Id>
<Name>Rel Dui with Dev API</Name>
</Connector>
</Connectors>
<FieldMappingTemplate>
<RelativityTemplateId>87</RelativityTemplateId>
</FieldMappingTemplate>
</ConnectorOption>
The ConnectorOption node indicates that both the RELATIVITY platform and the regular LOCAL_REPOSITORY platform have been chosen.
Production Settings:
To review the export settings and their details, please check field "export_options" in tbl_ep_exports to see the export settings . The details are stored in XML format.
Queued Files:
All documents queued for production, based on their source (tag/media), will be stored in tbl_ep_ExportPrimaryTable. These are the documents that will be prepared for production.
Jobs Created by Production:
Production creates the following five jobs:
-
Prepare Data Job:
- Prepares data for production, including queued files.
- Imports metadata into each record created in the selected relativity workspace.
-
Native Job:
- Exports native files.
- Imports native files into the selected relativity workspace.
-
Fulltext Job:
- Exports full-text data.
- Imports full-text data into the selected relativity workspace.
-
Image Job:
- Exports images.
- Imports images into the selected relativity workspace.
-
Copy Job:
- Creates load files like CSV and DAT.
- Copies exported records. To see the details, use "select * from tbl_ep_ExportDetails."
These jobs have dependencies, for example, the Copy Job will not start unless the Native, Fulltext, and Image jobs are completed.
Production Status:
The status of the above five production jobs can be viewed through the user interface (UI) or by querying the following tables:
-
To see the status of full text produced, check the "status" field in tbl_Ep_FulltextDetails for regular production jobs.
-
To see the ConnectorStatus, check the "ConnectorStatus," field in tbl_Ep_FulltextDetails for relativity production jobs.
-
To see the status of images produced, check the "status" field in Tbl_Ep_TiffDetails.
-
To see the ConnectorStatus, check the "ConnectorStatus," field in Tbl_Ep_TiffDetails for relativity production jobs.
-
To see the status of natives produced, check the "status" field in Tbl_Ep_NativeDetails.
-
To see the ConnectorStatus, check the "ConnectorStatus," field in Tbl_Ep_NativeDetails for relativity production jobs.
-
To check the status of load files created and the final produced data, examine the "copyStatus" in tbl_ep_ExportDetails.
P.S. Status/ConnectorStatus fields will have one of the values in -2,-1,0,1,2.
- -2 means 'failed'
- -1 means 'postponed'
- 0 means 'not started'
- 1 means 'in progress'
- 2 means 'completed'
Comments
0 comments
Please sign in to leave a comment.