Exporting data through Integration Points

To create an integration point specifically for exporting a folder, perform the following steps:

1. Navigate to the Integration Points tab.
2. Click New Integration Point.
3. Complete the following fields in the Setup category of the Create Integration Point layout:
   
• Name—the name of your integration for reference purposes.
• Type—select Export to designate this as an export job. Selecting this sets the Source field to be Relativity.
• Source—this is automatically set to Relativity since you are exporting data out of a Relativity workspace.
• Destination—select Load File.
• Transferred Object—select Document.
• Profile—use this to complete the remaining Integration Points settings based on the settings of a saved profile. This includes all of the fields in the Connect to Source layout, as well as field mappings. If no profiles exist in the workspace, you do not have the option of selecting them. To apply a profile that you previously created, select it from the drop-down list. For more information on profiles, see Integration Points profiles.
• Email Notification Recipients—enter the email addresses of those who should receive notifications of whether the integration point export succeeded or failed. Use semi colons between addresses.
• Log Errors—select Yes or No to denote whether Relativity tracks item level errors.
  • If you select Yes, each job also logs any item level errors.
  • If you select No, Relativity does not log these item level errors.
  • Regardless of your selection, job-level errors are always recorded in Relativity.
• Enable Scheduler—gives you the option of scheduling additional exports. Selecting Yes makes the following fields available:
  • Frequency—the interval at which Relativity promotes data using this integration point.
    • Daily—select this option to promote data once every day.
    • Weekly—select this option to promote data on a weekly basis. You can specify how often in the Reoccur field, in which you will provide a number value in the Every # week(s) choice. You can then specify on which day of the week the data promotion will take place by checking any of the days of the week listed.

    • Monthly—select the day of the month that you want this integration point to promote data once every month.

    • Reoccur—enter the number of month(s) in which this integration point recurrently promotes data.
    • Send On
      • Day __ the month—select the day of the month that you want this integration point to promote data.
      • The __ of the Month—select this option for this integration point to promote dataon the chosen day of every month. For example, "The Second Friday of the month."
  • Start Date—the date that you want Integration Points to start promoting the data.
  • End Date—(Optional) the date that you want Integration Points to stop promoting the data. Leaving the End Date blank causes the Integration Point to run indefinitely at the scheduled interval.
  • Scheduled Time—the time at which this integration point promotes date. This time is local to your PC, not to the server.
4. Click Next to advance to the Source Information layout.
5. Complete the following fields on the Source Information layout:
   
• Source—select Folder from the drop-down list. Specify that you want to select a folder, from which you want export the data in your load file. You will select this folder below from the folder structure in the Folder field. You will also need to select a View from the Views field.
• Folder—click on the down arrow and expand the folder structure, locate the folder from which you want to export the data, and select it. This field is only available if you selected Folder + Subfolders as the source above.

Note: When creating an integration point based on a profile, if you change the saved search, folder, or production set on the Setup layout, the fields listed in the Selected Fields window below are not updated to reflect the new source that you selected. If you're not using a profile to creating the integration point, these fields are updated to reflect the newly selected source.

• Views—click on the down arrow and select a view for the data that you want to export. This is only available if you selected Folder or Folder + Subfolders as the source above.
• Start Export at Record—select a record number that identifies the initial document for export. Integration Points exports the document with this record number and continues exporting documents with subsequent record numbers.
• Source Fields | Selected Fields| Renamed Fields—choose the fields that you want to export by moving them to the Selected Fields box. The box on the left displays all available source fields. The fields listed in the Selected Fields column are determined by what you select for the Source field above, as well by the folder, production set, or saved search that you select. Only the fields in the Selected Fields box on the right will be exported when you run the integration point. If you wish to rename the fields in your load file before exporting them, you can do so through the Rename option described below. The fields whose names you change are displayed in the Renamed Fields column.
• Rename—gives you the option of renaming the fields in your load file before exporting them. When you click this button, you are presented with the following settings and buttons in the Rename Fields window:
  
  
  • Selected Field—displays the current name of the field that you selected from the Source Fields column. To change its name, use the Renamed Field below.
  • Renamed Field—enter the new name for the Selected Field. This name will appear in the Renamed Fields column of the layout once you click the Update or Update and Next button below. If you do not change the original name of the selected field, then the Renamed Fields column contains an empty row for that field.
  • Update button—click this button to update the selected field to the name you entered in the Renamed Field setting. When you do this, the renamed field appears in the Renamed Field column.
  • Update and Next button—click this button to update the selected field to the name you entered in the Renamed Field setting and then move to the next field in the Selected Field column. When you do this, the renamed field appears in the Renamed Field column and the next field appears in the Selected Field setting.
  • Cancel button—click this to exit the Rename Fields window without applying any changes to current field names.
    
6. Click Next to advance to the Destination Information layout.
7. Complete the following fields on the Destination Information layout:
   

Load File Options

• Export Type—this field reflects the type of export job you are running, which you specified on the Setup layout. By default, Load File is selected as the base configuration for your export job. You also have the option of enhancing the load file by selecting Images, Natives, and Text Fields as Files, depending on the makeup of your data. Selecting any of these options makes additional corresponding output settings available, which are described below.
  • The Text Fields as Files option determines the export of the extracted text or OCR. Select this option if you want to export files as individual document-level text files, with one file per document. Integration Points includes text as part of your load file if you deselect this option and if a long text field is included in the selected fields that you mapped in the Source Information layout.
• Destination Folder—specify the folder into which you want to export the data from the load file. This reads the Default File Repository and lets you select a subfolder of that location.
• Create Export Folder—check this box to create an export folder named after the existing Relativity Integration Point job and the timestamp in your export folder. This will prevent the overwriting of any previous Relativity Integration Point exports to your export folder. When you check this box, the value displayed in the Destination Folder field is updated to reflect the [JobName]_[RunTimeStampUTC] information.
• Image File Format—select one of these formats for image-level load file:
  • Opticon
  • IPRO
  • IPRO (Full Text)
• Data File Format—select the format for the document-level load file you are exporting:
  • Relativity (.dat)—load file exports with the standard Concordance delimiters.
  • HTML (.html)—load file is in HTML and contains hyperlinks to launch any exported files.
  • Comma-separated (.csv)—load file exports as delimited text file that uses a comma to separate values.
  • promote data—load file exports with the custom delimiters that you select.
• Data File Encoding—select an encoding for the document-level load file from the drop-down box.
• File Path—controls how the export path for the files is referenced. Select one of the following options:
  • Use absolute paths—paths to exported files are represented as absolute paths. For example, C:\ Desktop\VOL001\NATIVE001\AS000001.msg
  • Use relative paths—paths to exported files are represented as relative paths. For example, .\VOL001\NATIVE001\AS000001.msg
  • Use prefix—a prefix is added to the relative path, such as a CD drive letter. For example, D:\VOL001\NATIVE001\AS000001.msg
• Include Native Files Path—check this box if you want to include the native file path in your data once you export it. Note that in the load file, for example a Relativity.dat file, there will be file path information added for every record you are exporting.
• Export Multiple Choice Fields as Nested—select this option to maintain the hierarchy of Relativity multiple-choice lists, when applicable. The nested value delimiter, a backslash, separates child choices.
• Name Output Files After—select one of the following naming convention for exported files:
  • Identifier—select this option to name the files after the identifier for your workspace.
  • Begin production number—select this option to name the files after the production number. (This number may be the Bates number for a production.) Relativity names files after the production number only if you select Produced Images as the Production Precedence below.
• Append Original File Name—select this option to append the original name of the file to the end of the exported file name.

Image—the following fields are only available if you selected Images for the Export Type field above.

• File Type—select one of these file types:
  • Single-page TIF/JPG
  • Multi-page TIF
  • PDF
• Production Precedence—select one of the following groups of produced documents for export instead of the original images:
  • Original Images—exports only the original, non-produced images.
  • Produced Images—exports a produced version of the images. When you select this, the following fields become available:
    
    
    • Image Productions—select the produced images that you want to act as the precedence.
    • Include Original Images If Not Produced—exports only the original images in the event that they have not been produced.
• Subdirectory Prefix—enter the alpha prefix for the subdirectory that stores exported images. By default, this is set to IMG.

Native

• Subdirectory Prefix—enter the alpha prefix for the subdirectory that stores exported native files. By default, this is set to NATIVE. This field is only available if you selected Natives for the Export Type field above.

Text—the following fields are only available if you selected text Fields As Files for the Export Type field above.

• Text File Encoding—select the encoding for the document-level text files
• Text Precedence—select and assign an order to long text fields that Relativity checks for text when performing an export. You must select one or more long text fields to use this functionality. Click the ellipsis to display the Pick Text Precedence pop-up. To move fields between columns, highlight them and click the Right or Left single or double arrows. Use the Up and Down arrows to order the precedence of the fields.



• Subdirectory Prefix—enter the alpha prefix for the subdirectory that stores exported text files. By default, this is set to TEXT.

Volume

• Prefix—enter the alpha prefix for the volume identifier. By default, this is set to VOL.
• Start Number—select the first number used for the numeric section of the volume identifier. Multiple volumes increment numbers during export creating unique volume identifiers.
• Number of Digits—select the number of digits attached to the prefix. (For example, if you select 3, the output is VOL001, VOL002, and so on.)
• Max Size (MB)—select the maximum size allowed for each volume in MBs.

Subdirectory

• Start Number—select the starting number for the subdirectories.
• Number of Digits—select the number of digits of the subdirectory prefix (For example, if you select 3, the output is IMG001, IMG002, and so on.)
• Max Files—select the number of files to store in each subdirectory.

8. Click Save to save this integration point with these export settings.

Once Relativity saves the integration point, you will be able to run it and export the data based on the settings you specified. See Running the export job for details.

To create an integration point specifically for exporting a folder and subfolders, perform the following steps:

1. Navigate to the Integration Points tab.
2. Click New Integration Point.
3. Complete the following fields in the Setup category of the Create Integration Point layout:
   
   
• Name—the name of your integration for reference purposes.
• Type—select Export to designate this as an export job. Selecting this sets the Source field to be Relativity.
• Source—this is automatically set to Relativity since you are exporting data out of a Relativity workspace.
• Destination—select Load File.
• Transferred Object—select Document.
• Profile—use this to complete the remaining Integration Points settings based on the settings of a saved profile. This includes all of the fields in the Connect to Source layout, as well as field mappings. If no profiles exist in the workspace, you do not have the option of selecting them. To apply an existing profile, select it from the drop-down list. For more information on profiles, see Integration Points profiles.
• Email Notification Recipients—enter the email addresses of those who should receive notifications of whether the integration point export succeeded or failed. Use semicolons between addresses.
• Log Errors—select Yes or No to denote whether Relativity tracks item level errors. Regardless of your selection, job-level errors are always recorded in Relativity.
  • If you select Yes, each job also logs any item level errors.
  • If you select No, Relativity does not log these item level errors.
• Enable Scheduler—gives you the option of scheduling additional exports. Selecting Yes makes the following fields available:
  • Frequency—the interval at which Relativity promotes data using this integration point.
    • Daily—select this option to promote data once every day.
    • Weekly—select this option to promote data on a weekly basis. You can specify how often in the Reoccur field, in which you will provide a number value in the Every # week(s) choice. You can then specify on which day of the week the data promotion will take place by checking any of the days of the week listed.

    • Monthly—select the day of the month that you want this integration point to promote data once every month.

    • Reoccur—enter the number of month(s) in which this integration point recurrently promote data.
    • Send On
      • Day __ the month—select the day of the month that you want this integration point to promote data.
      • The __ of the Month—select this option for this integration point to promote data on the chosen day of every month. For example, "The Second Friday of the month."
  • Start Date—the date that you want Integration Points to start promoting the data.
  • End Date—(Optional) the date that you want Integration Points to stop promoting the data. Leaving the End Date blank causes the Integration Point to run indefinitely at the scheduled interval.
  • Scheduled Time—the time at which this integration point promotes data. This time is local to your PC, not to the server.
4. Click Next to advance to the Source Information layout.
5. Complete the following fields on the Source Information layout:
   

   

   • Source—select Folder + Subfolders from the drop-down list and specify that you want to select a folder and subfolders from which you want export the data in your load file. You will select this folder below from the folder structure in the Folder + Subfolders field. You will also need to select a View from the Views field.
   • Folder + Subfolders—click on the down arrow and expand the folder structure, locate the folder and subfolders from which you want to export the data, and select it. This field is only available if you selected Folder + Subfolders as the source above.

   Note: When creating an integration point based on a profile, if you change the saved search, folder, or production set on the Setup layout, the fields listed in the Selected Fields window below are not updated to reflect the new source that you selected. If you're not using a profile to creating the integration point, these fields are updated to reflect the newly selected source.

   • Views—click on the down arrow and select a view for the data that you want to export. This is only available if you selected Folder or Folder + Subfolders as the source above.
   • Start Export at Record—select a record number that identifies the initial document for export. Integration Points exports the document with this record number and continues exporting documents with subsequent record numbers.
   • Source Fields | Selected Fields | Renamed Fields—choose the fields that you want to export by moving them to the Selected Fields box. The box on the left displays all available source fields. The fields listed in the Selected Fields column are determined by what you select for the Source field above, as well by the folder, production set, or saved search that you select. Only the fields in the Selected Fields box on the right will be exported when you run the integration point. If you wish to rename the fields in your load file before exporting them, you can do so through the Rename option described below. The fields whose names you change are displayed in the Renamed Fields column.
   • Rename—gives you the option of renaming the fields in your load file before exporting them. When you click this button, you are presented with the following settings in the Rename Fields window:
     
     
     • Selected Field—displays the field that you have selected from the Source Fields column, the name of which you can change in the Renamed Field below.
     • Renamed Field—enter the desired new name for the field. This name will appear in the Renamed Fields column of the layout once you click the Update or Update and Next button below. If you do not change the original name of the selected field, then the Renamed Fields column contains an empty row for that field.
     • Update button—click this button to update the selected field to the name you entered in the Renamed Field setting. When you do this, the renamed field appears in the Renamed Field column.
     • Update and Next button—click this button to update the selected field to the name you entered in the Renamed Field setting and then move to the next field in the Selected Field column. When you do this, the renamed field appears in the Renamed Field column and the next field appears in the Selected Field setting.
     • Cancel button—click this button to exit the Rename Fields window without applying any changes to current field names.
       
6. Click Next to advance to the Destination Information layout.
7. Complete the following fields on the Destination Information layout:
   

Load File Options

• Export Type—this field reflects the type of export job you are running, which you specified on the Setup layout. By default, Load File is selected as the base configuration for your export job. You also have the option of enhancing the load file by selecting Images, Natives, and Text Fields as Files, depending on the makeup of your data. Selecting any of these makes additional corresponding output settings available, which are described below.
  • The Text Fields as Files option determines the export of the extracted text or OCR. Select this option if you want to export files as individual document-level text files, with one file per document. Integration Points includes text as part of your load file if you deselect this option and if a long text field is included in the selected fields that you mapped in the Source Information layout.
• Destination Folder—specify the folder into which you want to export the data from the load file. This reads the Default File Repository and lets you select a subfolder of that location.
• Create Export Folder—check this box to create an export folder named after the existing Relativity Integration Point job and the timestamp in your export folder. This will prevent the overwriting of any previous Relativity Integration Point exports to your export folder. When you check this box, the value displayed in the Destination Folder field is updated to reflect the [JobName]_[RunTimeStampUTC] information.
• Image File Format—select one of these formats for image-level load file:
  • Opticon
  • IPRO
  • IPRO (Full Text)
• Data File Format—select a the format for the document-level load file you are exporting:
  • Relativity (.dat)—load file exports with the standard Concordance delimiters.
  • HTML (.html)—load file is in HTML and contains hyperlinks to launch any exported files.
  • Comma-separated (.csv)—load file exports as delimited text file that uses a comma to separate values.
  • Custom (.txt)—load file exports with the custom delimiters that you select.
• Data File Encoding—select an encoding for the document-level load file from the drop-down box.
• File Path—controls how the export path for the files is referenced. Select one of the following options:
  • Use absolute paths—paths to exported files are represented as absolute paths. For example, C:\ Desktop\VOL001\NATIVE001\AS000001.msg
  • Use relative paths—paths to exported files are represented as relative paths. For example, .\VOL001\NATIVE001\AS000001.msg
  • Use prefix—a prefix is added to the relative path, such as a CD drive letter. For example, D:\VOL001\NATIVE001\AS000001.msg
• Include Native Files Path—check this box if you want to include the native file path in your data once you export it. Note that in the load file, for example a Relativity.dat file, there will be file path information added for every record you are exporting.
• Export Multiple Choice Fields as Nested—select this option to maintain the hierarchy of Relativity multiple-choice lists, when applicable. The nested value delimiter, a backslash, separates child choices.
• Name Output Files After—select one of the following naming convention for exported files:
  • Identifier—select this option to name the files after the identifier for your workspace.
  • Begin production number—select this option to name the files after the production number. (This number may be the Bates number for a production.) Relativity names files after the production number only if you select Produced Images as the Production Precedence below.
• Append Original File Name—select this option to append the original name of the file to the end of the exported file name.

Image—the following fields are only available if you selected Images for the Export Type field above.

• File Type—select one of these file types:
  • Single-page TIF/JPG
  • Multi-page TIF
  • PDF
• Production Precedence—select one of the following groups of produced documents for export instead of the original images:
  • Original Images—exports only the original, non-produced images.
  • Produced Images—exports a produced version of the images. When you select this, the following fields become available:
    
    
    • Image Productions—select the produced images that you want to act as the precedence.
    • Include Original Images If Not Produced—exports only the original images in the event that they have not been produced.
• Subdirectory Prefix—enter the alpha prefix for the subdirectory that stores exported images. By default, this is set to IMG.

Native

• Subdirectory Prefix—enter the alpha prefix for the subdirectory that stores exported native files. By default, this is set to NATIVE. This field is only available if you selected Natives for the Export Type field above.

Text—the following fields are only available if you selected text Fields As Files for the Export Type field above.

• Text File Encoding—select the encoding for the document-level text files
• Text Precedence—select and assign an order to long text fields that Relativity checks for text when performing an export. You must select one or more long text fields to use this functionality. Click the ellipsis to display the Pick Text Precedence pop-up. To move fields between columns, highlight them and click the Right or Left single or double arrows. Use the Up and Down arrows to order the precedence of the fields.



• Subdirectory Prefix—enter the alpha prefix for the subdirectory that stores exported text files. By default, this is set to TEXT.

Volume

• Prefix—enter the alpha prefix for the volume identifier. By default, this is set to VOL.
• Start Number—select the first number used for the numeric section of the volume identifier. Multiple volumes increment numbers during export creating unique volume identifiers.
• Number of Digits—select the number of digits attached to the prefix. (For example, if you select 2, the output is VOL001, VOL002, and so on.)
• Max Size (MB)—select the maximum size allowed for each volume in MBs.

Subdirectory

• Start Number—select the starting number for the subdirectories.
• Number of Digits—select the number of digits of the subdirectory prefix (For example, if you select 3, the output is IMG001, IMG002, and so on.)
• Max Files—select the number of files to store in each subdirectory.

8. Click Save to save this integration point with these export settings.

Once Relativity saves the integration point, you will be able to run it and export the data based on the settings you specified. See Running the export job for details.

To create an integration point specifically for exporting a production set, perform the following steps:

1. Navigate to the Integration Points tab.
2. Click New Integration Point.
3. Complete the following fields in the Setup category of the Create Integration Point layout:
   
   
• Name—the name of your integration for reference purposes.
• Type—select Export to designate this as an export job. Selecting this sets the Source field to be Relativity.
• Source—this is automatically set to Relativity since you are exporting data out of a Relativity workspace.
• Destination—select Load File.
• Transferred Object—select Document.
• Profile—use this to complete the remaining Integration Points settings based on the settings of a saved profile. This includes all of the fields in the Connect to Source layout, as well as field mappings. If no profiles exist in the workspace, you do not have the option of selecting them. To apply an existing profile, select it from the drop-down list. For more information on profiles, see Integration Points profiles.
• Email Notification Recipients—enter the email addresses of those who should receive notifications of whether the integration point export succeeded or failed. Use semi colons between addresses.
• Log Errors—select Yes or No to denote whether Relativity tracks item level errors. Regardless of your selection, job-level errors are always recorded in Relativity.
  • If you select Yes, each job also logs any item level errors.
  • If you select No, Relativity does not log these item level errors.
• Enable Scheduler—gives you the option of scheduling additional exports. Selecting Yes makes the following fields available:
  • Frequency—the interval at which Relativity promotes data using this integration point.
    • Daily—select this option to promote data once every day.
    • Weekly—select this option to promote data on a weekly basis. You can specify how often in the Reoccur field, in which you will provide a number value in the Every # week(s) choice. You can then specify on which day of the week the data promotion will take place by checking any of the days of the week listed.

    • Monthly—select the day of the month that you want this integration point to promote data once every month.

    • Reoccur—enter the number of month(s) in which this integration point recurrently promotes data.
    • Send On
      • Day __ the month—select the day of the month that you want this integration point to promote data.
      • The __ of the Month—select this option for this integration point to promote data on the chosen day of every month. For example, "The Second Friday of the month."
  • Start Date—the date that you want Integration Points to start promoting the data.
  • End Date—(Optional) the date that you want Integration Points to stop promoting the data. Leaving the End Date blank causes the Integration Point to run indefinitely at the scheduled interval.
  • Scheduled Time—the time at which this integration point promotes data. This time is local to your PC, not to the server.
4. Click Next to advance to the Source Information layout.

4. Complete the following fields on the Source Information layout:
   



• Source—select Production from the drop-down list. specify that you want to select a production set, from which you want export the data in your load file. You will select this folder below from the folder structure in the Folder + Subfolders field. You will also need to select a View from the Views field.
• Production Set—click on the down arrow and select the production set that you want to act as the source for the load file. This field is only available if you have selected Production as the source above.

Note: When creating an integration point based on a profile, if you change the saved search, folder, or production set on the Setup layout, the fields listed in the Selected Fields window below are not updated to reflect the new source that you selected. If you're not using a profile to creating the integration point, these fields are updated to reflect the newly selected source.

• Start Export at Record—select a record number that identifies the initial document for export. Integration Points exports the document with this record number and continues exporting documents with subsequent record numbers.
• Source Fields | Selected Fields| Renamed Fields—choose the fields that you want to export by moving them to the Selected Fields box. The box on the left displays all available source fields. The fields listed in the Selected Fields column are determined by what you select for the Source field above, as well by the folder, production set, or saved search that you select. Only the fields in the Selected Fields box on the right will be exported when you run the integration point. If you wish to rename the fields in your load file before exporting them, you can do so through the Rename option described below. The fields whose names you change are displayed in the Renamed Fields column.
• Rename—gives you the option of renaming the fields in your load file before exporting them. When you click this button, you are presented with the following settings in the Rename Fields window:
  
  
  • Selected Field—displays the field that you have selected from the Source Fields column, the name of which you can change in the Renamed Field below.
  • Renamed Field—enter the desired new name for the field. This name will appear in the Renamed Fields column of the layout once you click Update or Update and Next below. If you do not change the original name of the selected field, then the Renamed Fields column contains an empty row for that field.
  • Update button—click this button to update the selected field to the name you entered in the Renamed Field setting. When you do this, the renamed field appears in the Renamed Field column.
  • Update and Next button—click this button to update the selected field to the name you entered in the Renamed Field setting and then move to the next field in the Selected Field column. When you do this, the renamed field appears in the Renamed Field column and the next field appears in the Selected Field setting.
  • Cancel button—click this button to exit the Rename Fields window without applying any changes to current field names.
    

5. Click Next to advance to the Destination Information layout.
6. Complete the following fields on the Destination Information layout:
   

Load File Options

• Export Type—this field reflects the type of export job you are running, which you specified on the Setup layout. By default, Load File is selected as the base configuration for your export job. You also have the option of enhancing the load file by selecting Images, Natives, and Text Fields as Files, depending on the makeup of your data. Selecting any of these makes additional corresponding output settings available, which are described below.
  • The Text Fields as Files option determines the export of the extracted text or OCR. Select this option if you want to export files as individual document-level text files, with one file per document. Integration Points includes text as part of your load file if you deselect this option and if a long text field is included in the selected fields that you mapped in the Source Information layout.
• Destination Folder—specify the folder into which you want to export the data from the load file. This reads the Default File Repository and lets you select a subfolder of that location.
• Create Export Folder—check this box to create an export folder named after the existing Relativity Integration Point job and the timestamp in your export folder. This will prevent the overwriting of any previous Relativity Integration Point exports to your export folder. When you check this box, the value displayed in the Destination Folder field is updated to reflect the [JobName]_[RunTimeStampUTC] information.
• Image File Format—select one of these formats for image-level load file:
  • Opticon
  • IPRO
  • IPRO (Full Text)
• Data File Format—select a the format for the document-level load file you are exporting:
  • Relativity (.dat)—load file exports with the standard Concordance delimiters.
  • HTML (.html)—load file is in HTML and contains hyperlinks to launch any exported files.
  • Comma-separated (.csv)—load file exports as delimited text file that uses a comma to separate values.
  • Custom (.txt)—load file exports with the custom delimiters that you select.
• Data File Encoding—select an encoding for the document-level load file from the drop-down box.
• File Path—controls how the export path for the files is referenced. Select one of the following options:
  • Use absolute paths—paths to exported files are represented as absolute paths. For example, C:\ Desktop\VOL001\NATIVE001\AS000001.msg
  • Use relative paths—paths to exported files are represented as relative paths. For example, .\VOL001\NATIVE001\AS000001.msg
  • Use prefix—a prefix is added to the relative path, such as a CD drive letter. For example, D:\VOL001\NATIVE001\AS000001.msg
• Include Native Files Path—check this box if you want to include the native file path in your data once you export it. Note that in the load file, for example a Relativity.dat file, there will be file path information added for every record you are exporting.
• Export Multiple Choice Fields as Nested—select this option to maintain the hierarchy of Relativity multiple-choice lists, when applicable. The nested value delimiter, a backslash, separates child choices.
• Name Output Files After—select one of the following naming convention for exported files:
  • Identifier—select this option to name the files after the identifier for your workspace.
  • Begin production number—select this option to name the files after the production number. (This number may be the Bates number for a production.) Relativity names files after the production number only if you select Produced Images as the Production Precedence below.
• Append Original File Name—select this option to append the original name of the file to the end of the exported file name.

Image—the following fields are only available if you selected Images for the Export Type field above.

• File Type—select one of these file types:
  • Single-page TIF/JPG
  • Multi-page TIF
  • PDF
• Production Precedence—select one of the following groups of produced documents for export instead of the original images:
  • Original Images—exports only the original, non-produced images.
  • Produced Images—exports a produced version of the images. When you select this, the following fields become available:
    
    
    • Image Productions—select the produced images that you want to act as the precedence.
    • Include Original Images If Not Produced—exports only the original images in the event that they have not been produced.
• Subdirectory Prefix—enter the alpha prefix for the subdirectory that stores exported images. By default, this is set to IMG.

Native

• Subdirectory Prefix—enter the alpha prefix for the subdirectory that stores exported native files. By default, this is set to NATIVE. This field is only available if you selected Natives for the Export Type field above.

Text—the following fields are only available if you selected text Fields As Files for the Export Type field above.

• Text File Encoding—select the encoding for the document-level text files
• Text Precedence—select and assign an order to long text fields that Relativity checks for text when performing an export. You must select one or more long text fields to use this functionality. Click the ellipsis to display the Pick Text Precedence pop-up. To move fields between columns, highlight them and click the Right or Left single or double arrows. Use the Up and Down arrows to order the precedence of the fields.



• Subdirectory Prefix—enter the alpha prefix for the subdirectory that stores exported text files. By default, this is set to TEXT.

Volume

• Prefix—enter the alpha prefix for the volume identifier. By default, this is set to VOL.
• Start Number—select the first number used for the numeric section of the volume identifier. Multiple volumes increment numbers during export creating unique volume identifiers.
• Number of Digits—select the number of digits attached to the prefix. (For example, if you select 2, the output is VOL001, VOL002, and so on.)
• Max Size (MB)—select the maximum size allowed for each volume in MBs.

Subdirectory

• Start Number—select the starting number for the subdirectories.
• Number of Digits—select the number of digits of the subdirectory prefix (For example, if you select 3, the output is IMG001, IMG002, and so on.)
• Max Files—select the number of files to store in each subdirectory.

7. Click Save to save this integration point with these export settings.

Once Relativity saves the integration point, you will be able to run it and export the data based on the settings you specified. See Running the export job for details.

To create an integration point specifically for exporting a saved search, perform the following steps:

1. Navigate to the Integration Points tab.
2. Click New Integration Point.
3. Complete the following fields in the Setup category of the Create Integration Point layout:
   
   
• Name—the name of your integration for reference purposes.
• Type—select Export to designate this as an export job. Selecting this sets the Source field to be Relativity.
• Source—this is automatically set to Relativity since you are exporting data out of a Relativity workspace.
• Destination—select Load File.
• Transferred Object—select Document.
• Profile—use this to complete the remaining Integration Points settings based on the settings of a saved profile. This includes all of the fields in the Connect to Source layout, as well as field mappings. If no profiles exist in the workspace, you do not have the option of selecting them. To apply a profile that you previously created, select it from the drop-down list. For more information on profiles, see Integration Points profiles.
• Email Notification Recipients—enter the email addresses of those who should receive notifications of whether the integration point export succeeded or failed. Use semi colons between addresses.
• Log Errors—select Yes or No to denote whether Relativity tracks item level errors. Regardless of your selection, job-level errors are always recorded in Relativity.
  • If you select Yes, each job also logs any item level errors.
  • If you select No, Relativity does not log these item level errors.
• Enable Scheduler—gives you the option of scheduling additional exports. Selecting Yes makes the following fields available:
  • Frequency—the interval at which Relativity promotes data using this integration point.
    • Daily—select this option to promote data once every day.
    • Weekly—select this option to promote data on a weekly basis. You can specify how often in the Reoccur field, in which you will provide a number value in the Every # week(s) choice. You can then specify on which day of the week the data promotion will take place by checking any of the days of the week listed.

    • Monthly—select the day of the month that you want this integration point to promote data once every month.

    • Reoccur—enter the number of month(s) in which this integration point recurrently promote data.
    • Send On
      • Day __ the month—select the day of the month that you want this integration point to promote data.
      • The __ of the Month—select this option for this integration point to promote data on the chosen day of every month. For example, "The Second Friday of the month."
  • Start Date—the date that you want Integration Points to start promoting the data.
  • End Date—(Optional) the date that you want Integration Points to stop promoting the data. Leaving the End Date blank causes the Integration Point to run indefinitely at the scheduled interval.
  • Scheduled Time—the time at which this integration point promote data. This time is local to your PC, not to the server.
4. Click Next to advance to the Source Information layout.
5. Complete the following fields on the Source Information layout:

• Source—select Saved Search from the drop-down list. specify that you want to select a saved search, from which you want export the data in your load file. You will select this folder below from the folder structure in the Folder + Subfolders field. You will also need to select a View from the Views field.
• Saved Search—click on the down arrow and select the saved search that you want to act as the source for the load file. This field is only available if you selected Saved Search as the source above.

Note: When creating an integration point based on a profile, if you change the saved search, folder, or production set on the Setup layout, the fields listed in the Selected Fields window below are not updated to reflect the new source that you selected. If you're not using a profile to creating the integration point, these fields are updated to reflect the newly selected source.

• Start Export at Record—select a record number that identifies the initial document for export. Integration Points exports the document with this record number and continues exporting documents with subsequent record numbers.
• Source Fields | Selected Fields| Renamed Fields—choose the fields that you want to export by moving them to the Selected Fields box. The box on the left displays all available source fields. The fields listed in the Selected Fields column are determined by what you select for the Source field above, as well by the folder, production set, or saved search that you select. Only the fields in the Selected Fields box on the right will be exported when you run the integration point. If you wish to rename the fields in your load file before exporting them, you can do so through the Rename option described below. The fields whose names you change are displayed in the Renamed Fields column.
• Rename—gives you the option of renaming the fields in your load file before exporting them. When you click this button, you are presented with the following settings in the Rename Fields window:
  
  
  • Selected Field—displays the field that you selected from the Source Fields column, the name of which you can change in the Renamed Field below.
  • Renamed Field—enter the desired new name for the field. This name will appear in the Renamed Fields column of the layout once you click Update or Update and Next below. If you do not change the original name of the selected field, then the Renamed Fields column contains an empty row for that field.
  • Update button—click this button to update the selected field to the name you entered in the Renamed Field setting. When you do this, the renamed field appears in the Renamed Field column.
  • Update and Next button—click this button to update the selected field to the name you entered in the Renamed Field setting and then move to the next field in the Selected Field column. When you do this, the renamed field appears in the Renamed Field column and the next field appears in the Selected Field setting.
  • Cancel button—click this to exit the Rename Fields window without applying any changes to current field names.
    

4. Click Next to advance to the Destination Information layout.
5. Complete the following fields on the Destination Information layout:
   

Load File Options

• Export Type—this field reflects the type of export job you are running, which you specified on the Setup layout. By default, Load File is selected as the base configuration for your export job. You also have the option of enhancing the load file by selecting Images, Natives, and Text Fields as Files, depending on the makeup of your data. Selecting any of these makes additional corresponding output settings available, which are described below.
  • The Text Fields as Files option determines the export of the extracted text or OCR. Select this option if you want to export files as individual document-level text files, with one file per document. Integration Points includes text as part of your load file if you deselect this option and if a long text field is included in the selected fields that you mapped in the Source Information layout.
• Destination Folder—specify the folder into which you want to export the data from the load file. This reads the Default File Repository and lets you select a subfolder of that location.
• Create Export Folder—check this box to create an export folder named after the existing Relativity Integration Point job and the timestamp in your export folder. This will prevent the overwriting of any previous Relativity Integration Point exports to your export folder. When you check this box, the value displayed in the Destination Folder field is updated to reflect the [JobName]_[RunTimeStampUTC] information.
• Image File Format—select one of these formats for image-level load file:
  • Opticon
  • IPRO
  • IPRO (Full Text)
• Data File Format—select a the format for the document-level load file you are exporting:
  • Relativity (.dat)—load file exports with the standard Concordance delimiters.
  • HTML (.html)—load file is in HTML and contains hyperlinks to launch any exported files.
  • Comma-separated (.csv)—load file exports as delimited text file that uses a comma to separate values.
  • Custom (.txt)—load file exports with the custom delimiters that you select.
• Data File Encoding—select an encoding for the document-level load file from the drop-down box.
• File Path—controls how the export path for the files is referenced. Select one of the following options:
  • Use absolute paths—paths to exported files are represented as absolute paths. For example, C:\ Desktop\VOL001\NATIVE001\AS000001.msg
  • Use relative paths—paths to exported files are represented as relative paths. For example, .\VOL001\NATIVE001\AS000001.msg
  • Use prefix—a prefix is added to the relative path, such as a CD drive letter. For example, D:\VOL001\NATIVE001\AS000001.msg
• Include Native Files Path—check this box if you want to include the native file path in your data once you export it. Note that in the load file, for example a Relativity.dat file, there will be file path information added for every record you are exporting.
• Export Multiple Choice Fields as Nested—select this option to maintain the hierarchy of Relativity multiple-choice lists, when applicable. The nested value delimiter, a backslash, separates child choices.
• Name Output Files After—select one of the following naming convention for exported files:
  • Identifier—select this option to name the files after the identifier for your workspace.
  • Begin production number—select this option to name the files after the production number. (This number may be the Bates number for a production.) Relativity names files after the production number only if you select Produced Images as the Production Precedence below.
• Append Original File Name—select this option to append the original name of the file to the end of the exported file name.

Image—the following fields are only available if you selected Images for the Export Type field above.

• File Type—select one of these file types:
  • Single-page TIF/JPG
  • Multi-page TIF
  • PDF
• Production Precedence—select one of the following groups of produced documents for export instead of the original images:
  • Original Images—exports only the original, non-produced images.
  • Produced Images—exports a produced version of the images. When you select this, the following fields become available:
    
    
    • Image Productions—select the produced images that you want to act as the precedence.
    • Include Original Images If Not Produced—exports only the original images in the event that they have not been produced.
• Subdirectory Prefix—enter the alpha prefix for the subdirectory that stores exported images. By default, this is set to IMG.

Native

• Subdirectory Prefix—enter the alpha prefix for the subdirectory that stores exported native files. By default, this is set to NATIVE. This field is only available if you selected Natives for the Export Type field above.

Text—the following fields are only available if you selected text Fields As Files for the Export Type field above.

• Text File Encoding—select the encoding for the document-level text files
• Text Precedence—select and assign an order to long text fields that Relativity checks for text when performing an export. You must select one or more long text fields to use this functionality. Click the ellipsis to display the Pick Text Precedence pop-up. To move fields between columns, highlight them and click the Right or Left single or double arrows. Use the Up and Down arrows to order the precedence of the fields.



• Subdirectory Prefix—enter the alpha prefix for the subdirectory that stores exported text files. By default, this is set to TEXT.

Volume

• Prefix—enter the alpha prefix for the volume identifier. By default, this is set to VOL.
• Start Number—select the first number used for the numeric section of the volume identifier. Multiple volumes increment numbers during export creating unique volume identifiers.
• Number of Digits—select the number of digits attached to the prefix. (For example, if you select 2, the output is VOL001, VOL002, and so on.)
• Max Size (MB)—select the maximum size allowed for each volume in MBs.

Subdirectory

• Start Number—select the starting number for the subdirectories.
• Number of Digits—select the number of digits of the subdirectory prefix (For example, if you select 3, the output is IMG001, IMG002, and so on.)
• Max Files—select the number of files to store in each subdirectory.

6. Click Save to save this integration point with these export settings.

Once Relativity saves the integration point, you will be able to run it and export the data based on the settings you specified. See Running the export job for details.