Relativity Desktop Client Guide - v9.4

Relativity Desktop Client Guide - v9.4
Desktop Client Guide
July 25, 2017 - Version 9.4
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
For the most recent version of this document, visit our documentation website.
Table of Contents
1 Overview
4
1.1 RDC menu bar
6
1.2 Workspace folder options
7
1.3 Starting the RDC
8
1.4 Logging on to the RDC
8
1.5 Setting up direct mode
9
1.5.1 Requirements
2 Using the RDC installer
10
10
2.1 Software requirements
10
2.2 Installing the RDC
11
2.3 Changing, repairing, or removing RDC installation
11
3 Importing through the RDC
11
3.1 Importing multiple load files simultaneously
12
3.2 Handling errors
12
3.3 Saving import settings
13
3.3.1 Saving a field map
14
3.4 Viewing audit information for an import
14
3.5 Load file specifications
15
3.5.1 Metadata, extracted text, and native files
15
3.5.2 Image and extracted text files
19
3.5.3 Processed data
21
3.6 Importing document metadata, files, and extracted text
21
3.6.1 Importing documents
22
3.6.2 Importing Yes/No fields on documents
31
3.7 Importing an image file
Relativity | Desktop Client Guide - 2
31
3.8 Importing a production file
35
3.9 Import errors for Desktop Client
39
4 Exporting with the RDC
40
4.1 Technical considerations for .kwx files
41
4.2 Exporting a production set
41
4.2.1 Fields on the Destination Files tab
4.3 Exporting a saved search
4.3.1 Fields on the Destination Files tab
4.4 Exporting a folder
4.4.1 Fields on the Destination Files tab
4.5 Exporting a folder and its subfolders
4.5.1 Fields on the Destination Files tab
47
50
56
59
64
67
72
5 Configuring the RDC
75
5.1 Batch handling
75
5.2 Validation and auditing
76
5.3 Import and export
78
Relativity | Desktop Client Guide - 3
1 Overview
The Relativity Desktop Client (RDC) provides the functionality for importing document load, image,
and production files, as well as for exporting production sets, saved searches, and folders.
For information about importing applications into Relativity, see Installing an application.
Also see these related recipes:
Using the RDC
As a litigation support specialist, you need to export a production of email files for the opposing
counsel in the Salt vs. Pepper case. You created a production set named "Salt vs. Pepper - Email
Production" and ran your production, and now you need to export the production using the RDC.
So, you open the RelativityDesktop Client and log in to your Relativity environment.
You select and open the Salt vs. Pepper case and then click Production Set... on the Export menu
to open the production export options.
Since this production set consists only of email messages, you include your Bates numbering and
email metadata fields in the exported metadata.
Relativity | Desktop Client Guide - 4
The case production format requirements you need to comply with include PDF images with an
Opticon data file format and a .csv data file format with Unicode (UTF-8) encoding. On the
Destination Files tab, you select the required format options and also select to copy the files from
the repository to copy the exported emails to your export network directory.
Relativity | Desktop Client Guide - 5
After selecting your options, you're ready to click Run on the File menu to complete the production
export to be able to send the Salt vs. Pepper emails as PDF images with the required data files to
the opposing counsel.
1.1 RDC menu bar
The RDC menu bar appears above the workspace folder structure. It includes the following menu
options:
File:
n
n
n
Open - switches between different workspaces.
Exit - closes the RDC.
Refresh - updates the folder browser.
Tools - Import:
n
n
n
Image File - imports images from a page-level load file.
Document Load File - imports native files, document metadata, and extracted text from a documentlevel load file.
Production Load File - imports productions from a page-level load file.
Tools - Export:
n
n
Production Set - exports production sets.
Saved Search - exports from saved searches.
Relativity | Desktop Client Guide - 6
n
n
Folder - exports from a specific folders.
Folder and Subfolders - exports from a specific folder and its subfolders.
Options:
n
n
Settings - changes the default value for Force Folder Preview and enter a WebService URL.
Check Connectivity - assists with troubleshooting network and system configuration errors that
occurred while importing and exporting.
Help:
n
About - displays the version of the RDC.
1.2 Workspace folder options
The RDC provides right-click options on folders, which you can use to build the workspace folder
structure, or to import and/or export directly to and from a folder.
When you right-click on a workspace or folder, the following menu options display:
n
New Folder - create subfolders. In the Add New Folder pop-up, enter a folder name, and then click OK.
The maximum length for the folder name is 255 characters. Since the folder name is a system field, once
you create it, you can't edit it. The new folder is added to the workspace through the RDC.
n
Import - import an image file, document load file, or production file into a specific folder. Highlight the
folder, point to Import, and select a file type. If you have metadata, natives and images to load, run the
load file import first, then the image file import. See Importing through the RDC on page 11.
n
Export - export a specific folder, or a folder and its subfolders. .
Relativity | Desktop Client Guide - 7
1.3 Starting the RDC
To open the RDC:
1. Double-click on the shortcut installed on your desktop. The Settings dialog box appears when you open
the application for first time.
2. Select or enter settings for the following options:
n
Force Folder Preview Default - options to enable or disable this feature. When enabled, the RDC
checks the first 1000 records of the load file after you click Import. It then displays the number of
folders soon to be created. You can use this information to ensure that the load process is behaving as expected. If a large number of folders are listed, you can stop the load file, and verify that
the Folder Info field is set correctly. By default, this feature is Enabled. See Importing through
the RDC on page 11
n
WebService URL - enter the URL provided by your system admin. This URL is used to establish a
connection between the RDC and your server. If the URL path is entered incorrectly, you are
unable to connect the RDC to your database.
The WebService URL has the format http or https://<MyServiceName>/RelativityWebAPI/.
When you display a Relativity page, you see the web service name listed in the address bar on
the browser. For example, if the address bar displayed https://smith.com/Relativity, then your
web service URL would be https://smith.com/ RelativityWebAPI/. In addition, you can confirm
this URL with your system admin.
3. Click OK. These settings are stored in your machine registry and they are retained when you upgrade
the RDC.
1.4 Logging on to the RDC
To log in, enter your Login name and Password. These are the same credentials you use to log in to
Relativity. If the server certificate is untrusted, you can allow using untrusted certificate or close the
RDC.
Note: If your environment is configured to use RSA authentication, then you can enter your Relativity
account username, and RSA passcode when logging in to the RDC.
Relativity | Desktop Client Guide - 8
After you log in, the RDC displays a list of workspaces where you have access rights. Use the filter
bar to narrow the list.
Note: By default, a wildcard is used to filter workspaces in the RDC. For example, enter ELA to find
workspaces named ELAN and Relativity.
Highlight your workspace and click OK to open it in the RDC. The folder structure of your workspace
displays. A new workspace contains only a root folder, while an existing workspace may contain
subfolders that you can display by clicking the plus sign.
Note: In Relativity Desktop Client, Document is selected by default as the type of object for data import or
export. You can also select other object types, including Relativity Dynamic Objects.
1.5 Setting up direct mode
When importing or exporting through the Relativity Desktop client (RDC), you can load data through
two different modes: web mode or direct mode. Direct mode provides faster performance, but it
requires a connection to the network hosting the data, as well as specific Windows group
permissions. Direct mode has direct access to write to the file repository, which bypasses the need
to go through the web server in order to ingest the data, saving a significant amount of time.
Relativity | Desktop Client Guide - 9
1.5.1 Requirements
The following conditions must be met in order to load data using direct mode:
Note: For deployments that have multi-tenancy enabled, don't give tenants Direct Mode access in the
Relativity Desktop Client, as doing so will result in more than one tenant having access to the same BCP
path, which could then lead to interferences with load files during import.
n
n
n
n
The Active Directory account running the load must have direct access to the Relativity File Repository
and BCPPath folder.
The loaded data must be located on the Relativity system network/domain.
The computer running the Relativity Desktop Client must be located on the Relativity system network/domain.
The group of users responsible for uploading documents through the Win Relativity component
(Relativity Upload Users) must have Full Control in the Document Repository Share. This allows members of this group to import and export in Direct mode. Non-members can only import and export in
Web mode. For more information, see the Pre-installation guide.
2 Using the RDC installer
To use the RDC, you must download a copy of the RDC installer. To download the RDC installer:
1.
2.
3.
4.
Open your workspace in Relativity.
Select the Administration tab.
Click Workspace Details to display the Relativity Utilities Console.
Click Relativity Desktop Client (32-bit) or Relativity Desktop Client (64-bit) depending on your operating system configuration under the Relativity Downloads selection.
5. Complete the steps for installing the RDC. See Installing the RDC on the next page for more information.
2.1 Software requirements
The RDC 9.4 or higher requires that Microsoft .NET 4.5.1 and Microsoft Visual C++ 2005 and 2013
SP1 Redistributable is installed on the workstation. For additional information, see the System
Requirements guide.
Your operating system determines whether you need to download the 64-bit or 32-bit version of
these applications:
n
n
If you're running a 32-bit machine, you must install the RDC 32-bit and the Visual C++ 2005 and 2013
SP1 x86 Redistributable.
If you're running a 64-bit machine, you want to install the RDC 64-bit and the Visual C++ 2005 and 2013
SP1 x64 Redistributable. You may notice a significant improvement in the speed of the RDC with the 64bit version. However, a 64-bit machine can have both the x86 and x64 redistributables installed at the
same time, and it can run the 32-bit or 64-bit version of the RDC.
Relativity | Desktop Client Guide - 10
2.2 Installing the RDC
To install the RDC:
1. Click Run on the File Download dialog, and on any security messages.
2. Click Next on the RDC setup wizard to start the installation.
3. Select on one of the following options on the Choose Setup Type dialog:
n Typical installs the most common program features. There is no difference between typical and
complete setups.
n Custom provides options to choose application features and location where you want to install
them:
o You can click on the icons in the tree to select the features that you want to install. Click
Reset if you want to redisplay the default settings.
o You can also use the Disk Usage button to display the amount disk space available and
required for the installation. After you have selected your custom settings, click Next to
display the Ready to Install dialog.
n Complete installs all application features. There is no difference between typical and complete
setups.
4. Click Install on the Ready to Install dialog to run the installation wizard.
5. Click Finish when the setup is complete. Your desktop displays a shortcut icon for the RDC.
2.3 Changing, repairing, or removing RDC installation
You can also run the installer to modify, repair, or remove an existing installation of the RDC. Run
the installer on a machine where the application is installed. Select one of the following options:
n
n
n
Change - modify the features that are installed.
Repair - attempts to fix errors in the most recent installation.
Remove - uninstalls the RDC from your machine.
3 Importing through the RDC
You can import document load files, as well as image and production files, through the Relativity
Desktop Client (RDC). You need to install the RDC on your computer before you can perform an
import.
Relativity | Desktop Client Guide - 11
You can also use the Windows Command Line to import documents into Relativity. With the
Windows Command Line you can automate document importing along with other parts of your
processing and integration process. See the Command Line Import guide.
To import through the RDC, you must be part of a group that has the Allow Import admin operation
enabled in workspace permissions.
Note: You must be logged in to a Relativity environment in order to successfully import files.
3.1 Importing multiple load files simultaneously
You can safely import multiple load files into the same workspace simultaneously. For best results,
use multiple machines and one active instance of the RDC per machine.
We recommend limiting this to four concurrent imports at a time into one workspace.
3.2 Handling errors
Relativity skips any records with errors that it encounters during the load process. It warns you
about any errors that were encountered after all the correct records have loaded.
When you click OK in the error warning box, Relativity creates a new document-level load file with
only the erroneous records. This file lists all the errors that occurred during the load process. You
are prompted to save these records to prevent any loss of data. Choose a path to save your error file
and click OK.
Relativity | Desktop Client Guide - 12
After you have saved your error file, you can make any necessary corrections to those records, and
then perform an Append Load. A record of these errors is also available in the Errors tab,
referencing the workspace name and Artifact ID.
3.3 Saving import settings
You can save the settings used to import a load file. This option is helpful if you frequently work with
your own internal processing tools or with the same processing vendor. To save your import
settings, point to the File menu, and then click Save Import Settings. Choose a location for the
document load file (.kwe).
Note: .kwe stands for kCura Win Edds.
The settings for the selected destination path and for copying files to a repository aren't saved in the .kwe
file.
When you have an identically formatted load file, you can use your saved .kwe. In the RDC, open the
.kwe file, and select the file being loaded.
You can also update the path in the .kwe file. The following illustration displays the text of a .kwe
file. The fourth line contains an absolute path to the document-level load file to be loaded. Update
this section to point to your new load file. After you have updated your .kwe file, select File and
Load Import Settings. Test for any errors, and then load the file.
Relativity | Desktop Client Guide - 13
3.3.1 Saving a field map
You can save the field mapping used to import a load file. The field map is exported as a CSV file
that saves the mapping of the Relativity fields to those in the dat file being imported. You can save
or view your field map from the Field Map tab or from the File menu in the Import Document Load
File window. To save your field map:
1. From the Import Document Load File window, click View/Save Field Map. The Selected Field Map window opens.
2. Click Export to CSV.
3.4 Viewing audit information for an import
After you import your file, the RDC records and audits this instance in the History tab. Click Import
to display the settings used for the import. To view the transfer rate of the load file, add the
Relativity | Desktop Client Guide - 14
Execution Time field to the view, if necessary.
3.5 Load file specifications
Using load files, Relativity can load the following types of files:
n
n
n
Metadata, extracted text, and native files
Image and extracted text files
Processed data
These sections detail the load file requirements for the respective file types.
3.5.1 Metadata, extracted text, and native files
Relativity uses a flat, document-level load file to load metadata, document level extracted text, and
natives files. Each line should represent one document.
3.5.1.1 Encoding
The Relativity Desktop Client (RDC) attempts to determine the encoding of a file, by default, when a
load file is first selected. To do this, the RDC checks the byte order mark at the beginning of the file.
If there is no byte order mark, it cannot determine the encoding type. The types of byte order marks
include:
n
n
n
Unicode (UTF16)
Big-Endian Unicode
UTF8
Everything else is considered undetectable by the RDC and uses the default encoding chosen for the
load file or stand-alone extracted text file.
A variety of load file encoding options are supported, including:
n
n
n
n
n
n
Western European (Windows)
Unicode
Unicode (Big-Endian)
Unicode (UTF-7)
Unicode (UTF-8)
Other options, based on your SQL sever
3.5.1.2 Header row
Relativity doesn't require load file header rows. However, they are strongly recommended to ensure
accuracy.
The field names in your header don't need to match the field names in your workspace.
3.5.1.3 Fields
Relativity doesn't require any specific load file field order. You can create any number of workspace
fields to store metadata or coding. During the load process, you can match your load file fields to
the fields in your workspace.
Relativity | Desktop Client Guide - 15
The identifier field is required for each load.
When loading new records, this is your workspace identifier.
When performing an overlay, you can use the workspace identifier or select another field as the
identifier. This is useful when overlaying production data. For example, you could use the Bates
number field rather than the document identifier in the workspace.
All fields except Identifier are optional; however, you may find some of the following system fields
beneficial.
1. Identifier – the unique identifier of the record
2. Group Identifier – the identifier of a document’s family group
n
n
The group identifier repeats for all records in the group.
Usually, this is the document identifier of the group’s parent document. For example:
If an email with the document identifier of AS00001 has several attachments, the email
and its attachments have a group identifier of AS00001.
n If a group identifier for a record is not set, the document identifier populates the group identifier
field in the case. This effectively creates a “group” of one document.
3. MD5 Hash – the duplicate hash value of the record
o
You can enter any type of hash value (and rename the field in your case).
If documents share the same hash value, Relativity identifies the documents as a duplicate
group.
n If a hash field for a record is not set, the document identifier populates the hash field in the case.
This effectively creates a “group” of one document.
4. Extracted Text – The text of the document. Either the OCR or Full Text.
n
n
n
The extracted text appears in the viewer and is added to search indexes. This field can contain
either:
The actual OCR or Full Text
The path to a document level text file containing the OCR or Full Text.
5. Native File Path – the path to any native files you’d like to load.
o
o
Both relative and absolute paths are supported.
6. Folder Info – builds the folder browser structure for the documents.
n
n
n
n
n
This field is backslash “\” delimited.
If not set, the documents load to the root of the case.
Each entry between backslashes is a folder in the Relativity folder browser.
Each backslash indicates a new subfolder in the browser.
Note: For example, if the load file contained the following entry in the folder info field: “Slinger,
Ryan\Email\deleted_items”
Relativity would build the following folder structure:
Each document with the above entry would be stored in the “deleted_items” folder.
Relativity | Desktop Client Guide - 16
7. Relativity Native Time Zone Offset - Relativity’s native viewer technology displays all email header
dates and times in GMT. This numeric field offsets how email header dates and times appear in the
viewer.
n
n
If the value in this field is blank, or 0, for a document, then the email header date and time
appears in GMT.
You can enter a whole number in this field – positive or negative – to offset the time from GMT
to the local time zone of the document.
For example, if the document was collected from US CDT time, enter “-5” in the field,
because the CDT offset from GMT is -5.
This ONLY applies when viewing email header dates and times in the Relativity Native File Viewer.
Your metadata fields display as imported.
o
n
3.5.1.4 Accepted date formats
Relativity accepts date and time as one field. For example, Date Sent and Time Sent should be one
field. If date sent and time sent ship separately, you must create a new field for time. You can
format date fields to accept the date without the time, but not the time without the date. Dates
can't have a zero value. Format dates in a standard date format such as “6/30/2017 1:23 PM” or
“6/30/2017 13:23”..
Note: When you import data using a load file with a date format that differs from the format used on your
local machine, Relativity adjusts the format in the load file to match that set on your machine.
The table below lists the date formats recognized by the Relativity Desktop Client and the Import
API. It contains both valid and invalid date formats:
Entry in Load File
12/31/9999
Monday January 4 2010
5.08:40 PM
Object Type
12/31/9999 0:00
1/4/2010 0:00
6/30/2009 17:08
17:08:33
6/30/2009 17:08
17:08
6/30/2009 17:08
5:08 PM
6/30/2009 17:08
Relativity | Desktop Client Guide - 17
Definition
The current date will be entered if the
date is missing. For this example,
assume the import was done on
6/30/2009.
The current date will be entered if the
date is missing. For this example,
assume the import was done on
6/30/2009.
The current date will be entered if the
date is missing. For this example,
assume the import was done on
6/30/2009.
The current date will be entered if the
date is missing. For this example,
assume the import was done on
6/30/2009.
Entry in Load File
14-Apr
Object Type
4/14/2009 0:00
9-Apr
4/9/2009 0:00
14-Mar
3/14/2009 0:00
1-Mar
3/1/2009 0:00
22-Feb
2/22/2009 0:00
20080420
20080420 2:22:00 AM
4/9/2008 16:13
4/9/2008 8:49
9-Apr-08
Apr. 9, 08
4.9.2008
4.9.08
4/9/2008
4;9;2008
Wednesday, 09 April 2008
12-31-1753
2014-11-28T17:45:39.744-08:00
4/9/08 13:30 PM
2008-044-09
4/9/2008 10:22:00 a.m.
00/00/0000
4/20/2008 0:00
4/20/2008 0:00
4/9/2008 16:13
4/9/2008 8:49
4/9/2008 0:00
4/9/2008 0:00
4/9/2008 0:00
4/9/2008 0:00
4/9/2008 0:00
4/9/2008 0:00
4/9/2008 0:00
12/31/1753 12:00 AM
11/28/2014 0:00
Definition
The current year will be entered if the
year is missing.
The current year will be entered if the
year is missing.
The current year will be entered if the
year is missing.
The current year will be entered if the
year is missing.
The current year will be entered if the
year is missing.
Results in an error
Results in an error
Results in an error
Results in an error unless the
CreateErrorForInvalidDate instance
setting is set to False.
In addition, Relativity takes into account the regional settings of the SQL Server where the database
resides. For example, you may have an SQL Server residing in the UK that uses the date format
DD/MM/YYYY, such as 4/9/2011. When you access a workspace on a PC with UK regional settings,
the date appears as 4/9/2011. When you access the same workspace on a PC with US regional
settings, the date appears as 9/4/2011.
3.5.1.5 Delimiters
During import, you can designate which delimiters are used in your load file. You can select each
delimiter from the ASCII characters, 001 – 255.
The delimiter characters have the following functions:
Relativity | Desktop Client Guide - 18
n
n
n
n
n
Column – separates load file columns
Quote – marks the beginning and end of each load file field (also known as a text qualifier)
Newline – marks the end of a line in any extracted or long text field
Multi-value – separates distinct values in a column. This delimiter is only used when importing into a
Relativity multi-choice field.
Nested-values – denotes the hierarchy of a choice. This delimiter is only used when importing into a
Relativity multi-choice field.
Note: For example, say a load file contained the following entry, and was being imported into a multi-choice
field: “Hot\Really Hot\Super Hot; Look at Later”
With the multi-value delimiter set as “;” and the nested value delimiter set as “\"”, the choices would appear
in Relativity as:
3.5.1.6 Default delimiters
If you generate your own load files, you may choose to use Relativity’s defaults:
n
n
n
n
n
Column - ASCII 020
Quote - ASCII 254
Newline - ASCII 174
Multi-Value - ASCII 059
Nested Values - ASCII 092
3.5.2 Image and extracted text files
For image imports, Relativity requires Opticon load files with ANSI/Western European encoding.
This .opt text file references the Control ID on a page level. The first page should match up to any
data you intend to load. You can use this same process for importing page-level extracted text.
Relativity does not support Unicode .opt files for image imports. When you have a Unicode .opt file,
you must resave this file in ANSI/Western European encoding.
You must convert images in unsupported formats using a third-party conversion tool before
Relativity can successfully upload them.
3.5.2.1 Image file formats
Relativity accepts only the following file types for image loads:
Relativity | Desktop Client Guide - 19
n
n
Single page, Group IV TIFs (1 bit, B&W)
Single page JPGs
Multi page TIFs and PDFs can be imported into the system, but you must load them as native files.
3.5.2.2 Load file format
The Opticon load file is a page level load file, with each line representing one image.
Below is a sample:
REL00001,REL01,D:\IMAGES\001\REL00001.TIF,Y,,,3
REL00002,REL01,D:\IMAGES\001\REL00002.TIF,,,,
REL00003,REL01,D:\IMAGES\001\REL00003.TIF,,,,
REL00004,REL01,D:\IMAGES\001\REL00004.TIF,Y,,,2
REL00005,REL01,D:\IMAGES\001\REL00005.TIF,,,,
The fields are, from left to right:
n
n
Field One – (REL00001) – the page identifier
Field Two – (REL01) – the volume identifier is not required. However, you must include a space in each
line of the load file for this field as illustrated below:
REL00001, ,D:\IMAGES\001\REL00001.TIF,Y,,,3
REL00002, ,D:\IMAGES\001\REL00002.TIF,,,,
n
n
n
n
n
Field Three – (D:\IMAGES\001\REL00001.TIF) – a path to the image to be loaded
Field Four – (Y) – Document marker – a “Y” indicates the start of a unique document.
Field Five – (blank) – can be used to indicate box
Field Six – (blank) – can be used to indicate folder
Field Seven – (3) – often used to store page count, but unused in Relativity
3.5.2.3 Importing extracted text during an image load
You can also import extracted text during the image import process by setting an option in the
Relativity Desktop Client. For more information about importing extracted text during an image
load, see the Relativity Admin Guide.
No changes are needed in the Opticon load file. If the aforementioned setting is active, Relativity
looks for page level txt files named identical to their corresponding TIFs. For example:
Relativity | Desktop Client Guide - 20
3.5.3 Processed data
Some data originates from client files and needs processing to extract the metadata. The following
table shows the delimiters that your internal processing software must use to present data as fields.
Value
Column
Quote
Newline
Multi-Value
Nested Value
Character
¶
þ
®
;
\
ASCII Number
020
254
174
059
092
You can provide this list to your vendor to help communicate the required delivery format for load
files. The fielded data should be delivered as delimited files with column or field names located in
the first line.
3.6 Importing document metadata, files, and extracted text
You can use a document-level load file to import document metadata, native files, and extracted
text. For large data sets, consider breaking the load file into smaller document counts. Use multiple
Relativity | Desktop Client Guide - 21
computers and instances to load the individual load files. It may be helpful to break up the types of
information into distinct subgroups; such as load metadata, natives, text, and images. Loading data
in smaller amounts can assist with quality assurance. We recommend having no more than four
concurrent RDC imports running on the same server or in the same workspace.
In addition, you may see warning or errors during an import under the following conditions:
n
n
Native file with 0 KB - The RDC imports only metadata for native files with the size of 0 KB. In the RDC,
the Warnings tab displays a message indicating that the file is empty and only metadata has been
loaded for the record. In the viewer, users see extracted text when it exists for the file. If the file has no
extracted text, users see a blank placeholder, and no image or viewer options are available. See Configuring the RDC on page 75.
Long file path names - If the load file contains a field used to set the folder path on the folders browser,
and the field is longer than 255 characters for a document, the RDC displays an error message for that
document on the Errors tab. The RDC doesn't import the document into Relativity. The RDC continues
to import any other documents in the load file with fields shorter than 255 characters.
3.6.1 Importing documents
To import through the RDC, you must be part of a group that has the Allow Import admin operation
enabled in workspace permissions.
Use the following steps to import documents:
1. Open the RDC and select a workspace.
2. On the Tools menu, point to Import and then click Document Load File. (In the RDC browser, you can
right-click on a specific folder, point to Import and click Load File.) The Load File tab in the Import Document Load File window appears.
3. (Optional) To use settings in from an existing import file, use these steps:
a. On the Import Document Load File dialog, click the File menu, and select Load Import Settings.
b. Browse for your load field map file (.kwe) in the Open Saved Field Map dialog, and then click
Open.
c. Click OK on the kCura.EDDS.WinForm dialog. Click Open on Choose Load File dialog. Settings
from the file are used to populate fields in the Load File and Field Map tabs. (You can also modify
any settings on these tabs as necessary.)
d. Continue with step 7.
4. Click
to browse for a document load file on the Load File tab. Set the other options as necessary.
On the Load File tab, set the following options to indicate how your load file is configured:
Relativity | Desktop Client Guide - 22
n
First line contains column names — select this option if your load file has a header.
n
Start Line - select the line number in the load file where you want the import process to begin.
The default value is 0, which results in loading the entire file.
File Encoding - select an encoding for the document load file. (Consult your processing vendor
or department to determine the correct encoding option, if necessary.) If your file contains a lan-
n
guage other than English, choose a Unicode option. Click
for additional information about encoding.
Relativity | Desktop Client Guide - 23
for additional options or click
Review the following information about how the encoding of load files is handled:
Relativity uses auto-detection to determine the encoding of your text files. If it finds a different file type in your text files, it changes to the appropriate method.
o Relativity immediately applies any changes that you make to the encoding of a load file,
and displays these changes in the column header preview.
o Relativity provides you with the ability to audit the encoding of a load file.
o Relativity includes the functionality for previewing the import file as well as the encoding
of the extracted text files.
File Column Headers - Relativity automatically updates this section of the Load File tab when
you select the file encoding. This section may display the following message before you select an
encoding for the load file.
o
n
After you select the encoding, this section displays the fields in the load file. The column headers
in the file display as vertical list. The fields display in alphanumeric order. The numeric value in
parentheses indicates the position of the field within the file. For example, the control number is
the first column in this illustration, while the Application Name is second.
Relativity | Desktop Client Guide - 24
Since the load file is parsed based on the delimiter set, you may need to check delimiters used in
the load file if the column headers are not lined up correctly. Determine the delimiters used in
the file, and then select them in the Character section of this tab.
n
Characters - select the delimiters used by your load file:
o
Column delimiter - select the character used to separate columns.
o
Quote - select the character used as the text qualifier.
o
Newline - select the character used to indicate the end of a line in any extracted text or
long text field.
o
Multi-value delimiter - select the character used to separate choices within a field.
o
Nested value - select the character used to separate the different levels of a multi-choice
hierarchy.
For example, you might import a field with following values: “Hot\Really Hot\Super Hot;
Look at Later”. Using a semi-colon (;) as a multi-value delimiter, and a backslash (\) as a
nested value delimiter, Relativity displays the choices as illustrated below:
5. Click the Field Map tab. To automatically map fields, click Auto Map Fields below the lists of fields. The
fields from the load file are mapped to any existing fields of the same name in the workspace.
Relativity | Desktop Client Guide - 25
Only fields matched in the center columns are loaded into the workspace. Other fields in the
Workspace Fields and Load File Fields lists are ignored. You must always match the identifier field for
the load file.
Consider the following when auto-mapping fields:
n
n
n
Case isn't taken into account for the mapping. For example, a field named "email" in the load file
would map to a field named "Email" in the workspace.
Spacing is taken into account. For example, in a two-word field name, if there is one space
between words in the workspace field, and two spaces between words in the load file field, the
fields will not be mapped.
Characters are mapped only to themselves. For example, an underscore is only mapped to
another underscore, not to a space.
Note: You can also manually map fields in the load file to existing fields in the workspace.
To manually map fields, highlight a field from the Workspace Fields list and click the right arrow to move the
field into the center column. Then, highlight the corresponding field in the Load File Fields list and click the left
arrow to move the field into the center column. You can move all fields in a list into a new column by clicking
the double arrow buttons. Use the up and down arrow buttons to reorder the fields.
Review these additional guidelines when you map fields for a workspace and load file:
n
n
Before importing relational fields, review the Import Behavior option on the New or Edit Field
form. You can use this option to determine how blank values are handled in relational fields.
If you are importing a field that contains more than 200 choices, you will see these choices automatically displayed in a Popup Picker. You will see an error if duplicate choices exist for the field.
Overwrite and Overlay identifiers:
In the Overwrite section, select one of these options to indicate the type of load:
n
n
n
Append Only - loads only new records.
Overlay Only - updates existing records only. You must include a workspace identifier in an overlay load. This field acts as a link indicating to Relativity where to import the data.
Append/Overlay - adds new records and overlays data on existing records
Relativity | Desktop Client Guide - 26
If you are performing an overlay or append/overlay, select an Overlay Identifier to specify the field
that links your overlay load file to the workspace.
Note: The fields in the drop-down menu are fixed-length fields with a manually-applied SQL index. This is NOT
the same as adding the field to the full-text index. Contact your SQL database administrator to apply an index to
a field.
Multi-Select Field Overlay Behavior:
The following fields are only available if you select the Append / Overlay or Overlay only Overwrite
option:
n
n
n
Merge Values - merges all values for multi-choice and multi-object fields in the load file with corresponding multi-choice and multi-option fields in the workspace. The fields are merged regardless of the overlay behavior settings in the environment.
Replace Values - replaces all values for multi-choice and multi-object fields in the load file with
corresponding multi-choice and multi-option fields in the workspace. The fields are merged
regardless of the overlay behavior settings in the environment.
Use Field Settings - merges or replaces all values for multi-choice and multi-object fields in the
load file with corresponding multi-choice and multi-option fields in the workspace. The fields are
merged according to the overlay behavior settings in the environment.
Folder Info:
In the Folder Info section, select Folder Information Column if you want to use a metadata field to
build the folder structure for the workspace. In the drop-down box, choose the field that you want
Relativity to use for building the folder structure. This field is commonly a source or folder path field. All
folders are built under the Import Destination folder.
When building the folder structure, Relativity looks for backslashes to indicate a new sub-folder. The
following folder structure would result from a field containing field with the value UB
Impairment\Accounts\Bunk Accounts:
Before importing, you can use the Preview Choices and Folders option to check the number of choices
and folders created by importing the records to the workspace.
Note: The number of folders reported during preview is inaccurate if the folder name contains a backslash.
Avoid using backslashes in folder names.
Note: Do not select Folder Information Column if you do not want to build a folder structure based on
metadata. When this option is not selected, Relativity loads all documents directly into the folder indicated by
the import destination.
Native File Behavior:
Relativity | Desktop Client Guide - 27
In the Native File Behavior section, select Load Native Files if you want to load native files along with
database records. (Do not select this option if you do not have any native files to load.)
Note: You can ignore the Repository option if your files are on your desktop or laptop, or if you are a
consulting partner loading data into kCura's hosting environment.
In the Native file paths contained in column drop-down box, select a field from your load file that
contains a relative or absolute path to the native files. If the native files reside in a Relativity-accessible
location, click Repository, and select one of these options:
n
Copy files from current location to selected document repository - select this option to copy
files from the location in the selected load file field to the selected document repository.
Note: You can use the Default option to configure an environment level. See the
CopyFilesToRepository instance setting.
n
Do not copy files to a Relativity document repository - select this option if the native files have
already been copied to their final location, which is accessible by Relativity.
Extracted Text:
In the Extracted Text section, set the following options to control how the Full Text or OCR is loaded
into the database. You can import full text or OCR into any long-text field that has been mapped. These
options are only available for selection if you've already mapped a long-text field:
n
Cell contains file location- select this option if your extracted text is in document-level text files,
and your load file contains a path to those text files. You don't need to select this option if a field
in your load file contains extracted text.
n
Encoding for undetectable files- select an encoding for the text file. Click
guage options or click
o
o
o
o
o
for additional lan-
for additional information about encoding.
Western European (Windows)- indicates the Windows standard encoding for English.
Unicode - utilizes more than 107,000 characters covering 90 scripts.
Unicode (Big-Endian)- is the same as Unicode, except that the byte order is reversed.
Unicode (UTF-7)- represents Unicode text using a stream of ASCII characters to guarantee
that the high bit will always be zero.
Unicode (UTF-8)- represents all characters in the Unicode character set using 8-bit bytes.
Note: A warning message appears if you are missing information required to run the import.
Update the settings for the required options, and click Import File again.
Relativity | Desktop Client Guide - 28
6. (Optional) To preview information about the content you are importing to the workspace, select
Import, and click one of these options:
n
Preview File - displays the first 1000 documents in the load file. Only mapped fields appear.
Make sure that matched fields that appear in the preview are correct.
n
Preview Errors - checks all documents for potential loading errors, but displays only the first
1000 errors. If your file does not contain errors, a no errors message appears.
Note: You can use the error report to correct any errors, and then you can re-add the file to the RDC.
Relativity only loads valid records. Records with errors are skipped. You can export the records for
correction and reload. See Handling errors on page 12.
Preview Choices and Folders - displays the number of choices created in the browser and the
number of choices created by importing the records.
7. On the Import menu, click Import File.
n
Note: If Force folder preview is selected, a confirmation message appears, which contains information about
the number of folders that will be created. Click OK to continue with the import.
8. Review the progress of the import.
You can view the progress of an import or export through the RDC. Select the following tabs to display
specific information:
n
Summary - displays general information about the number of records, processing warnings, and
errors. The following screenshot displays file progress for an import job. You can also see a
similar dialog when exporting content.
Relativity | Desktop Client Guide - 29
Note: SQL Insert Mode always shows Bulk.
n
Errors - lists any errors encountered during the load. The Errors tab displays any errors that
occur when you import or export content with the RDC.
Note: When you run an import job, the RDC only imports only records with no errors into the
workspace.
n
n
n
n
Progress - displays a detailed view of the load progress.
Warnings - displays information about loading or connection issues.
Report - includes the following files that you can export:
o Export Error Report - exports a .csv file with a summary of errors.
o Export Error File - exports a .dat file, which is a document-level load file containing only
records with errors.
File Transfer Mode - displays the following information:
o Web mode - this mode uses the web server and it is the standard.
o Direct mode - this mode provides faster performance, but requires a connection to the
network hosting the data, as well as specific Windows group permissions. For more
information, see Setting up direct mode on page 9.
Note: For deployments that have multi-tenancy enabled, don't give tenants Direct Mode access in the
Relativity Desktop Client, as doing so will result in more than one tenant having access to the same BCP path,
which could then lead to interferences with load files during import.
Relativity | Desktop Client Guide - 30
9. (Optional) To save your import settings, point to the File menu, and then click Save Import Settings.
Choose a location for the document load file (.kwe). See Saving import settings on page 13.
3.6.2 Importing Yes/No fields on documents
To ensure that you get the correct results when importing into Yes/No fields, use these guidelines:
n
n
n
No values – Import Yes/No fields containing any values except those specified for Yes values.
Yes values – Import Yes/No fields containing only "Yes", "Y", "True", "T", and any non-zero integer.
(For example, if you import an "X", the RDC assigns a value of "No" to the documents.)
Null values – Leave the Yes/No field empty.
Note: You can change the display values on a Yes/No field, but your modification doesn’t affect how the
RDC handles these values during a document import.
3.7 Importing an image file
You can import image load files that are Opticon-formatted page-level files. Relativity only accepts
single page, Group IV TIFs, or JPGs.
To import through the RDC, you must be part of a group that has the Allow Import admin operation
enabled in workspace permissions.
To import an image load file:
1. Open the RDC and select a workspace.
2. On the Tools menu, point to Import and then click Image Load File. (In the RDC browser, you can rightclick on a specific folder, point to Import and click Image File.) The Import Production Load File dialog
appears.
3. (Optional) To use settings in an existing import file, complete these steps:
a. On the Import Image Load File dialog, click the Import menu, and then select Load Settings.
b. Browse for your load settings file (.kwi) in the Open dialog, and then click Open.
Note: The RDC denotes all image and production import settings with a .kwi file extension. However,
when you select these file types to filter on when you're choosing to save or load the settings file, the
RDC denotes these settings with a .kwx file extension.
c. Click OK on the kCura.EDDS.WinForm dialog. Click Open on Choose Load File dialog. Settings
from the file are used to populate fields in the Import Image Load File dialog. (You can also
Relativity | Desktop Client Guide - 31
modify the settings on this dialog as necessary.)
d. Continue with step 5.
4. On the Import Image Load File dialog, set the options as necessary. Select the following options:
n
n
n
Load File - click
to browse for your page-level load file. Relativity accepts Opticon format
image load files.
Start Line - select the line number in the load file where you want the import process to begin.
The default value is 0, which results in loading the entire file.
Numbering - select one of the following options:
o
o
Use load file page IDs - default setting.
Auto-number pages - select this option if page IDs in the production are not unique. For
example, you might import a set of TIFFs that share a page identifier for each record. The
page identifiers are shared per document and are not unique. The Auto-number pages
option appends the 01, .02, and so on to the page-level identifier, creating a unique number per page.
Note: Enable Auto-number pages if you are importing productions that use document level
numbering without page numbers, and include documents that contain multiple pages.
n
Select Mode - select one of the following options:
o
Append Only - load only new records.
Overlay Only - update existing records only. You must include a workspace identifier in an
overlay load. This field acts as a link indicating to Relativity where to import the data.
o
Append/Overlay - adds new records and overlays data on existing records.
o
Note: Select Append to import the extracted text and natives from a .dat file. Select overlay when
overlaying production images onto the existing documents.
n
n
(Available Only for Production Load Files) Production - select a Relativity production that you
want to upload images to. Only new production sets without a production source appear in this
list.
(Available Only for Production Load Files) Overlay Identifier - select a field that stores overlaid
document-level Bates information on the document.
Note: The fields in the drop-down menu are fixed-length fields with a manually-applied SQL index.
Note that this is NOT the same as adding the field to the full-text index. Contact your SQL database
administrator to apply an index to a field.
n
Repository - if the native files reside in a Relativity-accessible location, click Repository, and
select one of the following options. (You can ignore this option if your files are on your desktop
or laptop, or if you are a consulting partner loading data into kCura's hosting environment.)
Relativity | Desktop Client Guide - 32
o
Copy files from current location to selected document repository - select this option to
copy files from the location in the selected load file field to the selected document repository.
Note: You can use the Default option to configure an environment level. See the Instance
setting guide.
Do not copy files to a Relativity document repository - select this option if the native
files have already been copied to their final location, which is accessible by Relativity.
(Available Only for Image Load Files) Load Extracted Text - select this option to load new text for
Production documents that may be revised based on redactions. The text files must be meet
these requirements:
o
n
o
o
o
n
Have .txt extensions
Stored in the same directory as TIFF files,
Named in the same way as the TIFF files
(Available Only for Image Load Files) Encoding for undetectable files - select an encoding for the
text file. Click
encoding.
for additional language options or click
for additional information about
Western European (Windows) - indicates the Windows standard encoding for English.
Unicode - utilizes more than 107,000 characters covering 90 scripts.
o Unicode (Big-Endian) - is the same as Unicode, except that the byte order is reversed.
o Unicode (UTF-7) - represents Unicode text using a stream of ASCII characters to guarantee that the high bit will always be zero.
o Unicode (UTF-8) - represents all characters in the Unicode character set using 8-bit bytes.
5. (Optional) To view any errors, click Import, and then select Check Errors. The preview dialog lists several tabs that may contain information about any errors in your import. See Handling errors on
page 12.
6. Click Import File on the Import menu.
7. Review the progress of the import.
o
o
You can view the progress of an import or export through the RDC. Select the following tabs to display
specific information:
n
Summary - displays general information about the number of records, processing warnings, and
errors. The following screenshot displays file progress for an import job. You can also see a
similar dialog when exporting content.
Relativity | Desktop Client Guide - 33
Note: SQL Insert Mode always shows Bulk.
n
Errors - lists any errors encountered during the load. The Errors tab displays any errors that
occur when you import or export content with the RDC.
Note: When you run an import job, the RDC only imports only records with no errors into the
workspace.
n
n
n
n
Progress - displays a detailed view of the load progress.
Warnings - displays information about loading or connection issues.
Report - includes the following files that you can export:
o Export Error Report - exports a .csv file with a summary of errors.
o Export Error File - exports a .dat file, which is a document-level load file containing only
records with errors.
File Transfer Mode - displays the following information:
o Web mode - this mode uses the web server and it is the standard.
o Direct mode - this mode provides faster performance, but requires a connection to the
network hosting the data, as well as specific Windows group permissions. For more
information, see Setting up direct mode on page 9.
Note: For deployments that have multi-tenancy enabled, don't give tenants Direct Mode access in the
Relativity Desktop Client, as doing so will result in more than one tenant having access to the same BCP path,
which could then lead to interferences with load files during import.
Relativity | Desktop Client Guide - 34
8. (Optional) To save your import settings, point to the File menu, and then click Save Import Settings.
Choose a location for the production load file (.kwi). See Saving import settings on page 13.
3.8 Importing a production file
You can import productions from an external tool to a Relativity workspace. Follow these guidelines
when you want to work with externally created production:
n
n
Create a production set in Relativity. The numbering imported with the Opticon file functions as Bates
numbering. (The Bates label setting in the imported production is not used.)
Run the production with the external tool to generate the following files:
o
Document level control file - it should minimally contain an identifier field that is also present in
the workspace, and a new production or Bates number.
Note: When loading a production set into Relativity, you may map a production numbering field to the
identifier field, as long as it is unique.
Page level Opticon file - it should use the production or Bates numbering scheme.
Overlay document level load file in Relativity.
o
n
To import through the RDC, you must be part of a group that has the Allow Import admin operation
enabled in workspace permissions.
To import a production, use these steps:
1. Open the RDC and select a workspace.
2. On the Tools menu, point to Import, and then click Production Load File. (In the RDC browser, you can
right-click on a specific folder, point to Import and click Production File.) The Import Production Load
File dialog appears.
3. (Optional) To use settings in an existing import file, complete these steps:
a. On the Import Production Load File dialog, click the Import menu, and then select Load Settings.
b. Browse for your load settings file (.kwi) in the Open dialog, and then click Open.
Note: The RDC denotes all image and production import settings with a .kwi file extension. However,
when you select these file types to filter on when you're choosing to save or load the settings file, the
RDC denotes these settings with a .kwx file extension.
c. Click OK on the kCura.EDDS.WinForm dialog. Click Open on Choose Load File dialog. Settings
from the file are used to populate fields in the Import Production Load File dialog. (You can also
Relativity | Desktop Client Guide - 35
modify the settings on this dialog as necessary.)
d. Continue with step 5.
4. On the Import Production Load File dialog, set the options as necessary.
n
n
n
Load File - click
to browse for your page-level load file. Relativity accepts Opticon format
image load files.
Start Line - select the line number in the load file where you want the import process to begin.
The default value is 0, which results in loading the entire file.
Numbering - select one of the following options:
o
o
Use load file page IDs - default setting.
Auto-number pages - select this option if page IDs in the production are not unique. For
example, you might import a set of TIFFs that share a page identifier for each record. The
page identifiers are shared per document and are not unique. The Auto-number pages
option appends the 01, .02, and so on to the page-level identifier, creating a unique number per page.
Note: Enable Auto-number pages if you are importing productions that use document level
numbering without page numbers, and include documents that contain multiple pages.
n
Select Mode - select one of the following options:
o
Append Only - load only new records.
Overlay Only - update existing records only. You must include a workspace identifier in an
overlay load. This field acts as a link indicating to Relativity where to import the data.
o
Append/Overlay - adds new records and overlays data on existing records.
o
Note: Select Append to import the extracted text and natives from a .dat file. Select overlay when
overlaying production images onto the existing documents.
n
n
(Available Only for Production Load Files) Production - select a Relativity production that you
want to upload images to. Only new production sets without a production source appear in this
list.
(Available Only for Production Load Files) Overlay Identifier - select a field that stores overlaid
document-level Bates information on the document.
Note: The fields in the drop-down menu are fixed-length fields with a manually-applied SQL index.
Note that this is NOT the same as adding the field to the full-text index. Contact your SQL database
administrator to apply an index to a field.
n
Repository - if the native files reside in a Relativity-accessible location, click Repository, and
select one of the following options. (You can ignore this option if your files are on your desktop
or laptop, or if you are a consulting partner loading data into kCura's hosting environment.)
Relativity | Desktop Client Guide - 36
o
Copy files from current location to selected document repository - select this option to
copy files from the location in the selected load file field to the selected document repository.
Note: You can use the Default option to configure an environment level. See the Instance
setting guide.
Do not copy files to a Relativity document repository - select this option if the native
files have already been copied to their final location, which is accessible by Relativity.
(Available Only for Image Load Files) Load Extracted Text - select this option to load new text for
Production documents that may be revised based on redactions. The text files must be meet
these requirements:
o
n
o
o
o
n
Have .txt extensions
Stored in the same directory as TIFF files,
Named in the same way as the TIFF files
(Available Only for Image Load Files) Encoding for undetectable files - select an encoding for the
text file. Click
encoding.
for additional language options or click
for additional information about
Western European (Windows) - indicates the Windows standard encoding for English.
Unicode - utilizes more than 107,000 characters covering 90 scripts.
o Unicode (Big-Endian) - is the same as Unicode, except that the byte order is reversed.
o Unicode (UTF-7) - represents Unicode text using a stream of ASCII characters to guarantee that the high bit will always be zero.
o Unicode (UTF-8) - represents all characters in the Unicode character set using 8-bit bytes.
5. (Optional) To view any errors, click Import, and then select Check Errors. The preview dialog lists several tabs that may contain information about any errors in your import. See Handling errors on
page 12.
6. Click Import File on the Import menu.
7. Review the progress of the import.
o
o
You can view the progress of an import or export through the RDC. Select the following tabs to display
specific information:
n
Summary - displays general information about the number of records, processing warnings, and
errors. The following screenshot displays file progress for an import job. You can also see a
similar dialog when exporting content.
Relativity | Desktop Client Guide - 37
Note: SQL Insert Mode always shows Bulk.
n
Errors - lists any errors encountered during the load. The Errors tab displays any errors that
occur when you import or export content with the RDC.
Note: When you run an import job, the RDC only imports only records with no errors into the
workspace.
n
n
n
n
Progress - displays a detailed view of the load progress.
Warnings - displays information about loading or connection issues.
Report - includes the following files that you can export:
o Export Error Report - exports a .csv file with a summary of errors.
o Export Error File - exports a .dat file, which is a document-level load file containing only
records with errors.
File Transfer Mode - displays the following information:
o Web mode - this mode uses the web server and it is the standard.
o Direct mode - this mode provides faster performance, but requires a connection to the
network hosting the data, as well as specific Windows group permissions. For more
information, see Setting up direct mode on page 9.
Note: For deployments that have multi-tenancy enabled, don't give tenants Direct Mode access in the
Relativity Desktop Client, as doing so will result in more than one tenant having access to the same BCP path,
which could then lead to interferences with load files during import.
Relativity | Desktop Client Guide - 38
8. (Optional) To save your import settings, point to the File menu, and then click Save Import Settings.
Choose a location for the production load file (.kwi). See Saving import settings on page 13.
3.9 Import errors for Desktop Client
The following table lists the most common import errors found in the Relativity Desktop Client,
including their messages and fixes.
Message
Invalid date.
Invalid boolean.
Invalid decimal.
Invalid integer.
Input length exceeds maximum set length of <max
length> for this VarChar field.
Input length exceeds maximum set length of <max
length> for the associated object field <name>.
Error uploading file. Skipping line.
File upload failed. Either the access to the path is
denied or there is no disk space available.
File '<file name>' not found.
File '<file name>' contains 0 bytes.
Identity Value not set.
Fix
Change the date information to one of the standard
date formats.
Change data to a YES or NO format.
Change the data to a valid number.
Change the data to an integer.
Increase the character restriction on the field.
Increase the character size of associated object.
Verify and correct line information.
Verify disk space is available and check permissions on
data server.
Verify the file is available in path provided.
No data exists in the file.
The identity field has not been mapped. Map the identity field.
Choice name specified twice for this record.
Two choice name fields are titled identically. Each
choice name should be unique from all others in the
load file.
Proposed choice name exceeds 200 characters.
Rename the specified choice to something less than
200 characters.
User does not exist in the system or is not available Email used in the custodian file is not associated with
for assignment.
any custodian in the system.
Document has been previously processed in this file Same ID trying to load twice.
Error: full text file specified does not exist.
Verify the path of extracted text file.
There are an invalid number of cells in this row Remove the extra column delimiter from load file.
expecting:<expected>, actual:<actual>.
- This document identifier does not exist in the sys- Overlay unavailable. You must append the data.
tem - no document to overwrite
A document with identifier <document identifier>
The identifier field already exists in the system. You
already exists in the system
need to do an overlay to overwrite the existing data.
This file identifier exists attached to another docSame ID trying to load twice.
ument with selected key field {0}
Relativity | Desktop Client Guide - 39
Message
This file identifier exists attached to another document with selected ArtifactID {0}
This file identifier exists attached to another document
Document is already in the selected production
This document contains redactions or highlights
that can't be overwritten
There is no image specified on this line
One of the files specified for this document does not
exist
The image file specified is not a supported format in
Relativity
The file being uploaded is empty
The identifier field for this row is either empty or
unmapped
The identifier specified on this line has been previously specified in the file
The document specified has been secured for editing.
Your account does not have rights to add a document or object to this case
A non-unique associated object is specified for this
new object.
Fix
Same ID trying to load twice.
Duplicate page ID in a different document.
The Bates number is already loaded.
Because you can't overlay into an existing production,
you must create a new production or replace the
images manually on the back end.
Delete the markups.
Make sure image id is present in load file.
Make sure image files are present for represented
path.
This can't be loaded without conversion to an
approved format.
No data exists in the file so it can't be loaded.
Verify that an identifier exists.
Make sure the identifier field is unique or overlay data.
Change security permissions to allow document edit
rights.
Change security permissions to allow document add
rights.
Two objects with the same name exist in the workspace. Identify the duplicates and change one of their
names.
Change security permissions to allow updates to
object.
Add a child object.
Your account does not have rights to add an associated object to the current object.
An object field references a child object which does
not exist.
This record's Overlay Identifier is shared by multiple Use a unique ID to overlay the data
documents in the case, and cannot be imported.
4 Exporting with the RDC
You can use the Relativity Desktop Client (RDC) to export production sets, search results, and
folders. When you perform an export, the RDC automatically creates top-level folders for images,
Relativity | Desktop Client Guide - 40
text, and natives. The RDC exports all documents included in the production set, search result, or
folder.
To export through the RDC, you must have the Allow Export admin operation permission.
Note: You need to install the RDC on your computer before you can perform an export.
4.1 Technical considerations for .kwx files
Note the following:
n
n
n
n
n
n
.kwx stands for kCura Win edds eXport.
The .kwx file you call on when you load export settings is a SOAP-serialized file used to run the export.
SOAP is a protocol based on XML. It's designed specifically to transport or store procedure calls using
XML. It does this by converting fields and properties of an object into the serial format of an XML
stream.
When you run an export, the RDC collects all the inputs from the form into an object in memory. The
RDC also passes the object on to the export process.
When you save an export settings object, Relativity passes that object in memory to a SOAP serializer.
The SOAP serializer writes that object’s settings to XML.
When you load export settings, Relativity takes a serialized object and deserializes it to an in-memory
settings object. Then it loops over all the properties and sets the actual form values to reflect those settings.
4.2 Exporting a production set
You can export the contents of a production set created in Relativity through the RDC.
To export through the RDC, you must have the Allow Export admin operation permission.
To export a production set:
1. Open the RDC and select a workspace.
2. On the Tools menu, point to Export and then click Production Set.
The Data Source tab in the Export Production window appears.
Relativity | Desktop Client Guide - 41
3. (Optional) To use settings in an existing export file, use these steps:
1. Click the File menu, and select Load Export Settings.
2. Browse for your export settings file (.kwx) in the Open dialog.
3. Select a production set, and click OK. Your production set appears on the Data Source tab, and
the settings from the file populate the Destination Files tab. (You can also modify any settings on
the Data Source and Destination Files tab as necessary.)
Note: On the Destination Files tab, you may want to select Overwrite Files if you're re-exporting the
same group of files to the previously used location.
4. Continue with step 7.
4. On the Data Source, select a production set in the Productions box. Update the remaining options as
necessary.
The Data Source tab appears when you select the option to export production sets, saved
searches, folders, and subfolders. Each of these actions have similar actions, but you may
want to select different settings for them.
Relativity | Desktop Client Guide - 42
Note: The Production:: Begin Bates and Production:: End Bates reflective fields automatically
populate in the Selected Columns.
On the Data Source tab, you can set the following options for the data that you want to
export:
n
n
Views - select a view for the data that you want to export.
Selected Columns - choose the fields that you want to export by moving them to the Selected
Columns box. The box on the right displays all available fields, but the RDC only exports the
fields in the Selected Columns box.
Note: If you select any reflected fields the only value for the production you select displays.
n
n
Start Export at Record # select a record number that identifies the initial document for export.
The RDC begins by exporting the document with this record number and continues by exporting
documents with subsequent record numbers.
(Available only for Saved Searches, Folders, and Subfolders) Production Precedence - click
to
display the Pick Production Precedence dialog where you can select a group of produced documents for export instead of the original images.
Relativity | Desktop Client Guide - 43
n
Select the images that you want to export:
Original Images - only the original, non-produced images.
Produced Images - a produced version of the images.
o Include original images… - original images for the documents that are not in a specified
production.
Move the productions that you want to exported to the Selected Productions box. To move productions 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.
o
o
n
Note: The RDC only produces one version of each document. The version of the document in the
topmost production exports first. If the document doesn't exist in the topmost production,
Relativity checks for the document in the second production and so on. If the document is not a part
of any of the selected productions, and Include original images ... is enabled, then the original
document produces.
5. Select the Destination Files tab.
On the Destination tab, you can set options that control how the files in folders, searches, and
production sets are exported. The Export dialog displays this tab when you select an Export option
from the Tools menu, or when you right-click on a folder or workspace in the RDC. The Destination tab
displays the same options when you export files in folders, searches, or production sets.
Relativity | Desktop Client Guide - 44
Note: In the Text and Native File Name section, the Named after option is available only for Production Sets.
6. Complete the fields on the Destination Files tab. See Fields on the Destination Files tab on page 47.
7. After you select your export settings, select File and click Run.
Note: A warning message appears if you are missing information required to run the export. Update the
settings for the required options, and click Run again.
8. Review the progress of the export.
You can view the progress of an import or export through the RDC. Select the following tabs to display
specific information:
n
Summary - displays general information about the number of records, processing warnings, and
errors. The following screenshot displays file progress for an import job. You can also see a
similar dialog when exporting content.
Relativity | Desktop Client Guide - 45
Note: SQL Insert Mode always shows Bulk.
n
Errors - lists any errors encountered during the load. The Errors tab displays any errors that
occur when you import or export content with the RDC.
Note: When you run an import job, the RDC only imports only records with no errors into the
workspace.
n
n
n
n
Progress - displays a detailed view of the load progress.
Warnings - displays information about loading or connection issues.
Report - includes the following files that you can export:
o Export Error Report - exports a .csv file with a summary of errors.
o Export Error File - exports a .dat file, which is a document-level load file containing only
records with errors.
File Transfer Mode - displays the following information:
o Web mode - this mode uses the web server and it is the standard.
o Direct mode - this mode provides faster performance, but requires a connection to the
network hosting the data, as well as specific Windows group permissions. For more
information, see Setting up direct mode on page 9.
Note: For deployments that have multi-tenancy enabled, don't give tenants Direct Mode access in the
Relativity Desktop Client, as doing so will result in more than one tenant having access to the same BCP path,
which could then lead to interferences with load files during import.
Relativity | Desktop Client Guide - 46
9. (Optional) To save your export settings, point to the File menu, and click Save Export Settings. Choose
a location for the export settings file (.kwx).
4.2.1 Fields on the Destination Files tab
The Destination Files tab contains the following sections with their respective fields:
n
Export Location - select a target directory for exporting folders, searches, and production sets. Click
to browse for a location. Select Overwrite Files to overwrite any existing files of the same name in
the target export directory.
n
Physical File Export - select Copy Files From Repository option. This is the default option and copies
files from the file server to the specified export location. If you don't select Copy Files From Repository,
Relativity doesn't copy the files to the export location. Instead, the exported load files reference the
repository location of the files.
n
Volume Information - controls the naming and size of the volume identifier. Set the following options
in this section:
o
o
o
o
n
Subdirectory Information - controls the naming and size of volume subfolders. Set the following
options in this section:
o
o
o
o
o
o
n
Prefix - enter the alpha prefix for the volume identifier.
Start # - select the first number used for the numeric section of the volume identifier. Multiple
volumes increment numbers during export creating unique volume identifiers.
# 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 - select the maximum size allowed for each volume in MBs.
Image Prefix - enter the alpha prefix for the subdirectory that stores exported images.
Native Prefix - enter the alpha prefix for the subdirectory that stores exported native files.
Text Prefix - enter the alpha prefix for the subdirectory that stores exported extracted text files.
Start # - select the starting number for the subdirectories.
# 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.
File Path - controls how the export path for the files is referenced. Select one of the following options:
o
Use absolute paths - paths to exported files are represented as absolute paths.
C:\ Desktop\VOL001\NATIVE001\AS000001.msg
o
Use relative paths - paths to exported files are represented as relative paths.
.\VOL001\NATIVE001\AS000001.msg
o
Use prefix - a prefix is added to the relative path, such as a CD drive letter.
D:\VOL001\NATIVE001\AS000001.msg
n
Load File Characters - select the delimiters to use in a document-level load file when Data File Format
in the Metadata section is set to Custom. Select the following options as necessary:
o
o
o
Column - this delimiter separates columns in the load file.
Quote - this delimiter qualifies the text in each field of the load file.
Newline - this delimiter signifies the end of any extracted text or long text field in the load file.
Relativity | Desktop Client Guide - 47
o
o
n
Multi-Value - this delimiter separates different choices within a choice field.
Nested Value - this delimiter indicates the hierarchy of choices within a choice field.
Text and Native File Names - select the following options for naming exported native and extracted
text files:
o
(Available Only for Production Sets) Named 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.
l Beginning production number - select this option to name the files after the production
number. (This number may be the Bates number for a production.)
Append original file - select this option to append the original name of the file to the end of the
exported file name.
l
o
n
Image - determines whether to include images in an export and sets the format of the load file. Set the
following options:
o
Check Export Images - select this option to include images in the export. (You must set the Data
File Format and the File Type when you export images.)
Data File Format - select one of these formats for image-level load file:
o
Opticon
IPRO
File Type - select one of these file types:
o
l
l
l
l
l
Single-page TIF/JPG
Multi-page TIF
PDF
n
Native - select Export Native Files to export native files.
n
Metadata - use the following options to control the export of the document-level load file and extracted
text:
o
Data File Format - select a the format for the document-level load file you're exporting:
o
Comma separated (.csv)
Concordance (.dat) - load file exports with the standard Concordance delimiters.
l Custom (.txt) - load file exports with the custom delimiters that you select in the Load File
Characters section.
l HTML (.html) - load file is in HTML and contains hyperlinks to launch any exported files.
Data File Encoding - select an encoding for the document-level load file from the drop-down
l
l
o
o
o
box. Click
for additional options.
Export Text Field as Files - 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. The
RDC includes text as part of your load file if you deselect this option.
Text File Encoding - select the encoding for the document-level text files. Click
for additional
options.
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
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.
Relativity | Desktop Client Guide - 48
If you add more than one field to the Selected Long Text Fields column, Relativity adds the Text
Precedence column as the last column in the load file. During an export, Relativity checks the
topmost field in the Selected Long Text Fields column for text, and if the field is null, it checks
the next field in order of precedence for text. When it finds a field that contains text, Relativity
adds the contents of that field to the Text Precedence column in the document load file, and
then continues checking the fields for the next document.
For example, you want the Text Precedence column in the load file to contain the contents of the
OCR Text field when it is available for a document and the contents of the Extracted Text field
when the OCR Text for a document is null. In the Pick Text Precedence pop-up, you add the OCR
Text as the first field in the Selected Long Text Fields column followed by the Extracted Text field.
If you select only one field in the Selected Long Text Fields column, Relativity adds the text to a
column with the same name as the field, and does not create the Text Precedence column.
Note: If you want to improve export performance, you don't need to add all of the long text fields you
select in the Pick Text Precedence pop-up to the Selected Columns option on the Data Source tab.
When you don't select these fields on the Data Source tab, but you add them to Selected Long Text
Fields column, the RDC adds the content of these fields to the Text Precedence column as described
above. When you add the long text fields on the Data Source tab, Relativity adds these columns to the
document level load file.
The Precedence Text column displays the file path to the exported files if you select the Export
Text Field as Files checkbox.
o
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.
Relativity | Desktop Client Guide - 49
4.3 Exporting a saved search
You can export the current results of a saved search through the RDC. To export through the RDC,
you must have the Allow Export admin operation permission.
To export a saved search:
1. Open the RDC and select a workspace.
2. On the Tools menu, point to Export and click Saved Search.
The Data Source tab in the Export Production window appears.
3. (Optional) To use settings in an existing export file complete these steps:
1. Click theFile menu, and select Load Export Settings.
2. Browse for your export settings file (.kwx) in the Open dialog.
3. Select a saved search, and click OK. Your saved search is listed on the Data Source tab, and the
settings from the file are used to populate the Destination Files tab. (You can also modify any settings on the Data Source and Destination Files tab as necessary.)
Note: On the Destination Files tab, you may want to select Overwrite Files if you are re-exporting the
Relativity | Desktop Client Guide - 50
same group of files to the previously used location.
4. Continue with step 7.
4. On the Data Source, select a saved search in the Searches box. Update the remaining options as necessary.
The Data Source tab appears when you select the option to export production sets, saved searches,
folders, and subfolders. You will see similar options on the tab for each of these actions, but you may
want to select different settings for them. The following screenshot uses a production set as an
example, but the settings are the same when exporting production sets, saved searches, folders, and
subfolders.
Relativity | Desktop Client Guide - 51
On the Data Source tab, you can set the following options for the data that you want to export.
Depending on the type of data you want to export, the dropdown updates accordingly. Select from the
following:
n
n
n
n
Views - Folders and subfolders - select a view for the data that you want to export.
Searches - Saved Search - select a saved search you want to export.
Productions - Production set - select a production set you want to export
Selected Columns - choose the fields that you want to export by moving them to the Selected
Columns box. The box on the right displays all available fields. Only the fields in the Selected
Columns box are exported.
Note: If a reflected production field is selected for Selected Column, the RDC doesn't narrow down the
field to a specific production. The reflected field for all productions is included.
n
n
Start Export at Record # - select a record number that identifies the initial document for export.
The RDC exports the document with this record number and continues exporting documents
with subsequent record numbers.
(Available only for Saved Searches, Folders, and Subfolders) Production Precedence - click
to
display the Pick Production Precedence dialog where you can select a group of produced documents for export instead of the original images.
Relativity | Desktop Client Guide - 52
o
Select the images that you want to export:
Original Images - export only the original, non-produced images.
Produced Images - export a produced version of the images.
l Include original images… - export original images for the documents that are not
in a specified production.
Move the productions that you want to exported to the Selected Productions box. To
move productions between columns, highlight the production and click the Right or Left
single or double arrows. Use the Up and Down arrows to order the precedence of the
fields.
l
l
o
Note: Only one version of each document is produced. If the document is in the topmost
production, that version is exported. If not, Relativity checks for the document in the second
production and so on. If the document is not a part of any of the selected productions, and
Include original images ... is enabled, then the original document is produced.
5. Select the Destination Files tab.
On the Destination tab, you can set options that control how the files in folders, searches, and
production sets are exported. The Export dialog displays this tab when you select an Export option
from the Tools menu, or when you right-click on a folder or workspace in the RDC. The Destination tab
displays the same options when you export files in folders, searches, or production sets.
Relativity | Desktop Client Guide - 53
Note: In the Text and Native File Name section, the Named after option is available only for Production Sets.
6. Complete the fields on the Destination Files tab. See Fields on the Destination Files tab on page 56.
7. After you have selected your export settings, select File and click Run.
Note: A warning message is displayed if you are missing information required to run the export. Update the
settings for the required options, and run the export again.
8. Review the progress of the export.
You can view the progress of an import or export through the RDC. Select the following tabs to display
specific information:
n
Summary - displays general information about the number of records, processing warnings, and
errors. The following screenshot displays file progress for an import job. You can also see a
similar dialog when exporting content.
Relativity | Desktop Client Guide - 54
Note: SQL Insert Mode always shows Bulk.
n
Errors - lists any errors encountered during the load. The Errors tab displays any errors that
occur when you import or export content with the RDC.
Note: When you run an import job, the RDC only imports only records with no errors into the
workspace.
n
n
n
n
Progress - displays a detailed view of the load progress.
Warnings - displays information about loading or connection issues.
Report - includes the following files that you can export:
o Export Error Report - exports a .csv file with a summary of errors.
o Export Error File - exports a .dat file, which is a document-level load file containing only
records with errors.
File Transfer Mode - displays the following information:
o Web mode - this mode uses the web server and it is the standard.
o Direct mode - this mode provides faster performance, but requires a connection to the
network hosting the data, as well as specific Windows group permissions. For more
information, see Setting up direct mode on page 9.
Note: For deployments that have multi-tenancy enabled, don't give tenants Direct Mode access in the
Relativity Desktop Client, as doing so will result in more than one tenant having access to the same BCP path,
which could then lead to interferences with load files during import.
Relativity | Desktop Client Guide - 55
9. (Optional) To save your export settings for reuse, point to the File menu, and click Save Export
Settings. Choose a location for the export settings file (.kwx).
4.3.1 Fields on the Destination Files tab
The Destination Files tab contains the following sections with their respective fields:
n
Export Location - select a target directory for exporting folders, searches, and production sets. Click
to browse for a location. Select Overwrite Files to overwrite any existing files of the same name in
the target export directory.
n
Physical File Export - select Copy Files From Repository option. This is the default option and copies
files from the file server to the specified export location. If you don't select Copy Files From Repository,
Relativity doesn't copy the files to the export location. Instead, the exported load files reference the
repository location of the files.
n
Volume Information - controls the naming and size of the volume identifier. Set the following options
in this section:
o
o
o
o
n
Subdirectory Information - controls the naming and size of volume subfolders. Set the following
options in this section:
o
o
o
o
o
o
n
Prefix - enter the alpha prefix for the volume identifier.
Start # - select the first number used for the numeric section of the volume identifier. Multiple
volumes increment numbers during export creating unique volume identifiers.
# 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 - select the maximum size allowed for each volume in MBs.
Image Prefix - enter the alpha prefix for the subdirectory that stores exported images.
Native Prefix - enter the alpha prefix for the subdirectory that stores exported native files.
Text Prefix - enter the alpha prefix for the subdirectory that stores exported extracted text files.
Start # - select the starting number for the subdirectories.
# 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.
File Path - controls how the export path for the files is referenced. Select one of the following options:
o
Use absolute paths - paths to exported files are represented as absolute paths.
C:\ Desktop\VOL001\NATIVE001\AS000001.msg
o
Use relative paths - paths to exported files are represented as relative paths.
.\VOL001\NATIVE001\AS000001.msg
o
Use prefix - a prefix is added to the relative path, such as a CD drive letter.
D:\VOL001\NATIVE001\AS000001.msg
n
Load File Characters - select the delimiters to use in a document-level load file when Data File Format
in the Metadata section is set to Custom. Select the following options as necessary:
o
o
o
Column - this delimiter separates columns in the load file.
Quote - this delimiter qualifies the text in each field of the load file.
Newline - this delimiter signifies the end of any extracted text or long text field in the load file.
Relativity | Desktop Client Guide - 56
o
o
n
Multi-Value - this delimiter separates different choices within a choice field.
Nested Value - this delimiter indicates the hierarchy of choices within a choice field.
Text and Native File Names - select the following options for naming exported native and extracted
text files:
o
(Available Only for Production Sets) Named 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.
l Beginning production number - select this option to name the files after the production
number. (This number may be the Bates number for a production.)
Append original file - select this option to append the original name of the file to the end of the
exported file name.
l
o
n
Image - determines whether to include images in an export and sets the format of the load file. Set the
following options:
o
Check Export Images - select this option to include images in the export. (You must set the Data
File Format and the File Type when you export images.)
Data File Format - select one of these formats for image-level load file:
o
Opticon
IPRO
File Type - select one of these file types:
o
l
l
l
l
l
Single-page TIF/JPG
Multi-page TIF
PDF
n
Native - select Export Native Files to export native files.
n
Metadata - use the following options to control the export of the document-level load file and extracted
text:
o
Data File Format - select a the format for the document-level load file you're exporting:
o
Comma separated (.csv)
Concordance (.dat) - load file exports with the standard Concordance delimiters.
l Custom (.txt) - load file exports with the custom delimiters that you select in the Load File
Characters section.
l HTML (.html) - load file is in HTML and contains hyperlinks to launch any exported files.
Data File Encoding - select an encoding for the document-level load file from the drop-down
l
l
o
o
o
box. Click
for additional options.
Export Text Field as Files - 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. The
RDC includes text as part of your load file if you deselect this option.
Text File Encoding - select the encoding for the document-level text files. Click
for additional
options.
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
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.
Relativity | Desktop Client Guide - 57
If you add more than one field to the Selected Long Text Fields column, Relativity adds the Text
Precedence column as the last column in the load file. During an export, Relativity checks the
topmost field in the Selected Long Text Fields column for text, and if the field is null, it checks
the next field in order of precedence for text. When it finds a field that contains text, Relativity
adds the contents of that field to the Text Precedence column in the document load file, and
then continues checking the fields for the next document.
For example, you want the Text Precedence column in the load file to contain the contents of the
OCR Text field when it is available for a document and the contents of the Extracted Text field
when the OCR Text for a document is null. In the Pick Text Precedence pop-up, you add the OCR
Text as the first field in the Selected Long Text Fields column followed by the Extracted Text field.
If you select only one field in the Selected Long Text Fields column, Relativity adds the text to a
column with the same name as the field, and does not create the Text Precedence column.
Note: If you want to improve export performance, you don't need to add all of the long text fields you
select in the Pick Text Precedence pop-up to the Selected Columns option on the Data Source tab.
When you don't select these fields on the Data Source tab, but you add them to Selected Long Text
Fields column, the RDC adds the content of these fields to the Text Precedence column as described
above. When you add the long text fields on the Data Source tab, Relativity adds these columns to the
document level load file.
The Precedence Text column displays the file path to the exported files if you select the Export
Text Field as Files checkbox.
o
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.
Relativity | Desktop Client Guide - 58
4.4 Exporting a folder
You can export the contents of a specific workspace folder through the RDC.
Note: To preserve your current folder structure, you have the option of running the Set Relativity folder
path field script when you're exporting a folder through the RDC.
To export through the RDC, you must have the Allow Export admin operation permission.
Note: When you select the Folder option, only the contents of the current folder are exported. Use Folder
and Subfolders option to export the contents of both the folder and its subfolders, or the contents of an
entire workspace. See Exporting a folder and its subfolders on page 67.
To export a folder:
1. Open the RDC and then select a workspace.
2. In the RDC browser, right-click on a specific folder, point to Export and then click Folder.
You can also highlight a folder in the RDC browser. On the Tools menu, point to Export and
click Folder.) The Data Source tab in the Export Production window appears.
3. (Optional) To use settings in an existing export file, complete these steps:
1. Click theFile menu, and select Load Export Settings.
2. Browse for your export settings file (.kwx) in the Open dialog.
3. Select a view, and click OK. Your view is listed on the Data Source tab, and determines the fields
displayed in the Selected Columns box. Other settings from the file are used to populate the
Destination Files tab. (You can also modify any settings on the Data Source and Destination Files
tab as necessary.)
Note: On the Destination Files tab, you may want to select Overwrite Files if you are re-exporting the
same group of files to the previously used location.
4. Continue with step 7.
Relativity | Desktop Client Guide - 59
3. On the Data Source tab, select a view in the Views box. Update the remaining options as necessary.
The Data Source tab appears when you select the option to export production sets, saved searches,
folders, and subfolders. You will see similar options on the tab for each of these actions, but you may
want to select different settings for them. The following screenshot uses a production set as an
example, but the settings are the same when exporting production sets, saved searches, folders, and
subfolders.
On the Data Source tab, you can set the following options for the data that you want to export.
Depending on the type of data you want to export, the dropdown updates accordingly. Select from the
following:
n
n
n
n
Views - Folders and subfolders - select a view for the data that you want to export.
Searches - Saved Search - select a saved search you want to export.
Productions - Production set - select a production set you want to export
Selected Columns - choose the fields that you want to export by moving them to the Selected
Columns box. The box on the right displays all available fields. Only the fields in the Selected
Columns box are exported.
Note: If a reflected production field is selected for Selected Column, the RDC doesn't narrow down the
field to a specific production. The reflected field for all productions is included.
n
n
Start Export at Record # - select a record number that identifies the initial document for export.
The RDC exports the document with this record number and continues exporting documents
with subsequent record numbers.
(Available only for Saved Searches, Folders, and Subfolders) Production Precedence - click
to
display the Pick Production Precedence dialog where you can select a group of produced documents for export instead of the original images.
Relativity | Desktop Client Guide - 60
o
Select the images that you want to export:
Original Images - export only the original, non-produced images.
Produced Images - export a produced version of the images.
l Include original images… - export original images for the documents that are not
in a specified production.
Move the productions that you want to exported to the Selected Productions box. To
move productions between columns, highlight the production and click the Right or Left
single or double arrows. Use the Up and Down arrows to order the precedence of the
fields.
l
l
o
Note: Only one version of each document is produced. If the document is in the topmost
production, that version is exported. If not, Relativity checks for the document in the second
production and so on. If the document is not a part of any of the selected productions, and
Include original images ... is enabled, then the original document is produced.
4. Select the Destination Files tab.
On the Destination tab, you can set options that control how the files in folders, searches, and
production sets are exported. The Export dialog displays this tab when you select an Export option
from the Tools menu, or when you right-click on a folder or workspace in the RDC. The Destination tab
displays the same options when you export files in folders, searches, or production sets.
Relativity | Desktop Client Guide - 61
Note: In the Text and Native File Name section, the Named after option is available only for Production Sets.
5. Complete the fields on the Destination Files tab. See Fields on the Destination Files tab on page 64.
6. After you have selected your export settings, select File and click Run.
Note: A warning message appears if you are missing information required to run the export. Update the
settings for the required options, and run the export again.
7. Review the progress of the export.
You can view the progress of an import or export through the RDC. Select the following tabs to display
specific information:
n
Summary - displays general information about the number of records, processing warnings, and
errors. The following screenshot displays file progress for an import job. You can also see a
similar dialog when exporting content.
Relativity | Desktop Client Guide - 62
Note: SQL Insert Mode always shows Bulk.
n
Errors - lists any errors encountered during the load. The Errors tab displays any errors that
occur when you import or export content with the RDC.
Note: When you run an import job, the RDC only imports only records with no errors into the
workspace.
n
n
n
n
Progress - displays a detailed view of the load progress.
Warnings - displays information about loading or connection issues.
Report - includes the following files that you can export:
o Export Error Report - exports a .csv file with a summary of errors.
o Export Error File - exports a .dat file, which is a document-level load file containing only
records with errors.
File Transfer Mode - displays the following information:
o Web mode - this mode uses the web server and it is the standard.
o Direct mode - this mode provides faster performance, but requires a connection to the
network hosting the data, as well as specific Windows group permissions. For more
information, see Setting up direct mode on page 9.
Note: For deployments that have multi-tenancy enabled, don't give tenants Direct Mode access in the
Relativity Desktop Client, as doing so will result in more than one tenant having access to the same BCP path,
which could then lead to interferences with load files during import.
Relativity | Desktop Client Guide - 63
8. (Optional) To save your export settings, point to the File menu, and click Save Export Settings. Choose
a location for the export settings file (.kwx).
4.4.1 Fields on the Destination Files tab
The Destination Files tab contains the following sections with their respective fields:
n
Export Location - select a target directory for exporting folders, searches, and production sets. Click
to browse for a location. Select Overwrite Files to overwrite any existing files of the same name in
the target export directory.
n
Physical File Export - select Copy Files From Repository option. This is the default option and copies
files from the file server to the specified export location. If you don't select Copy Files From Repository,
Relativity doesn't copy the files to the export location. Instead, the exported load files reference the
repository location of the files.
n
Volume Information - controls the naming and size of the volume identifier. Set the following options
in this section:
o
o
o
o
n
Subdirectory Information - controls the naming and size of volume subfolders. Set the following
options in this section:
o
o
o
o
o
o
n
Prefix - enter the alpha prefix for the volume identifier.
Start # - select the first number used for the numeric section of the volume identifier. Multiple
volumes increment numbers during export creating unique volume identifiers.
# 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 - select the maximum size allowed for each volume in MBs.
Image Prefix - enter the alpha prefix for the subdirectory that stores exported images.
Native Prefix - enter the alpha prefix for the subdirectory that stores exported native files.
Text Prefix - enter the alpha prefix for the subdirectory that stores exported extracted text files.
Start # - select the starting number for the subdirectories.
# 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.
File Path - controls how the export path for the files is referenced. Select one of the following options:
o
Use absolute paths - paths to exported files are represented as absolute paths.
C:\ Desktop\VOL001\NATIVE001\AS000001.msg
o
Use relative paths - paths to exported files are represented as relative paths.
.\VOL001\NATIVE001\AS000001.msg
o
Use prefix - a prefix is added to the relative path, such as a CD drive letter.
D:\VOL001\NATIVE001\AS000001.msg
n
Load File Characters - select the delimiters to use in a document-level load file when Data File Format
in the Metadata section is set to Custom. Select the following options as necessary:
o
o
o
Column - this delimiter separates columns in the load file.
Quote - this delimiter qualifies the text in each field of the load file.
Newline - this delimiter signifies the end of any extracted text or long text field in the load file.
Relativity | Desktop Client Guide - 64
o
o
n
Multi-Value - this delimiter separates different choices within a choice field.
Nested Value - this delimiter indicates the hierarchy of choices within a choice field.
Text and Native File Names - select the following options for naming exported native and extracted
text files:
o
(Available Only for Production Sets) Named 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.
l Beginning production number - select this option to name the files after the production
number. (This number may be the Bates number for a production.)
Append original file - select this option to append the original name of the file to the end of the
exported file name.
l
o
n
Image - determines whether to include images in an export and sets the format of the load file. Set the
following options:
o
Check Export Images - select this option to include images in the export. (You must set the Data
File Format and the File Type when you export images.)
Data File Format - select one of these formats for image-level load file:
o
Opticon
IPRO
File Type - select one of these file types:
o
l
l
l
l
l
Single-page TIF/JPG
Multi-page TIF
PDF
n
Native - select Export Native Files to export native files.
n
Metadata - use the following options to control the export of the document-level load file and extracted
text:
o
Data File Format - select a the format for the document-level load file you're exporting:
o
Comma separated (.csv)
Concordance (.dat) - load file exports with the standard Concordance delimiters.
l Custom (.txt) - load file exports with the custom delimiters that you select in the Load File
Characters section.
l HTML (.html) - load file is in HTML and contains hyperlinks to launch any exported files.
Data File Encoding - select an encoding for the document-level load file from the drop-down
l
l
o
o
o
box. Click
for additional options.
Export Text Field as Files - 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. The
RDC includes text as part of your load file if you deselect this option.
Text File Encoding - select the encoding for the document-level text files. Click
for additional
options.
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
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.
Relativity | Desktop Client Guide - 65
If you add more than one field to the Selected Long Text Fields column, Relativity adds the Text
Precedence column as the last column in the load file. During an export, Relativity checks the
topmost field in the Selected Long Text Fields column for text, and if the field is null, it checks
the next field in order of precedence for text. When it finds a field that contains text, Relativity
adds the contents of that field to the Text Precedence column in the document load file, and
then continues checking the fields for the next document.
For example, you want the Text Precedence column in the load file to contain the contents of the
OCR Text field when it is available for a document and the contents of the Extracted Text field
when the OCR Text for a document is null. In the Pick Text Precedence pop-up, you add the OCR
Text as the first field in the Selected Long Text Fields column followed by the Extracted Text field.
If you select only one field in the Selected Long Text Fields column, Relativity adds the text to a
column with the same name as the field, and does not create the Text Precedence column.
Note: If you want to improve export performance, you don't need to add all of the long text fields you
select in the Pick Text Precedence pop-up to the Selected Columns option on the Data Source tab.
When you don't select these fields on the Data Source tab, but you add them to Selected Long Text
Fields column, the RDC adds the content of these fields to the Text Precedence column as described
above. When you add the long text fields on the Data Source tab, Relativity adds these columns to the
document level load file.
The Precedence Text column displays the file path to the exported files if you select the Export
Text Field as Files checkbox.
o
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.
Relativity | Desktop Client Guide - 66
4.5 Exporting a folder and its subfolders
You can export the contents of a folder and its subfolders, as well as an entire workspace, through
the RDC.
Note: To preserve your current folder structure, you have the option of running the Set Relativity folder
path field script when you're exporting a folder through the RDC.
To export through the RDC, you must have the Allow Export admin operation permission.
Note: You can also export only the content of the current folder using the Folder option. See Exporting a
folder on page 59.
To export a folder and its subfolders:
1. Open the RDC and select a workspace.
2. In the RDC browser, right-click on a specific folder, point to Export and then click Folder and
Subfolders.
You can also highlight a folder in the RDC browser. On the Tools menu, point to Export and
click Folder and Subfolders.
The Data Source tab in the Export Production window appears.
Note: To export an entire workspace, highlight the root folder.
3. (Optional) To use settings in an existing export file, complete these steps:
1. Click File and select Load Export Settings.
2. Browse for your export settings file (.kwx) in the Open dialog.
3. Select a view, and then click OK. Your view is lists on the Data Source tab. This determines the
fields listed in the Selected Columns box. Other settings from the file are used to populate the
Destination Files tab. You can also modify any settings on the Data Source and Destination Files
tab as necessary.
Note: On the Destination Files tab, you may want to select Overwrite Files if you are re-exporting the
Relativity | Desktop Client Guide - 67
same group of files to the previously used location.
4. Continue with step 7.
4. On the Data Source, select a view in the Views box. Update the remaining options as necessary.
The Data Source tab appears when you select the option to export production sets, saved searches,
folders, and subfolders. You will see similar options on the tab for each of these actions, but you may
want to select different settings for them. The following screenshot uses a production set as an
example, but the settings are the same when exporting production sets, saved searches, folders, and
subfolders.
On the Data Source tab, you can set the following options for the data that you want to export.
Depending on the type of data you want to export, the dropdown updates accordingly. Select from the
following:
Relativity | Desktop Client Guide - 68
n
n
n
n
Views - Folders and subfolders - select a view for the data that you want to export.
Searches - Saved Search - select a saved search you want to export.
Productions - Production set - select a production set you want to export
Selected Columns - choose the fields that you want to export by moving them to the Selected
Columns box. The box on the right displays all available fields. Only the fields in the Selected
Columns box are exported.
Note: If a reflected production field is selected for Selected Column, the RDC doesn't narrow down the
field to a specific production. The reflected field for all productions is included.
n
n
Start Export at Record # - select a record number that identifies the initial document for export.
The RDC exports the document with this record number and continues exporting documents
with subsequent record numbers.
(Available only for Saved Searches, Folders, and Subfolders) Production Precedence - click
to
display the Pick Production Precedence dialog where you can select a group of produced documents for export instead of the original images.
o
Select the images that you want to export:
Original Images - export only the original, non-produced images.
Produced Images - export a produced version of the images.
l Include original images… - export original images for the documents that are not
in a specified production.
Move the productions that you want to exported to the Selected Productions box. To
move productions between columns, highlight the production and click the Right or Left
single or double arrows. Use the Up and Down arrows to order the precedence of the
fields.
l
l
o
Relativity | Desktop Client Guide - 69
Note: Only one version of each document is produced. If the document is in the topmost
production, that version is exported. If not, Relativity checks for the document in the second
production and so on. If the document is not a part of any of the selected productions, and
Include original images ... is enabled, then the original document is produced.
5. Select the Destination Files tab.
On the Destination tab, you can set options that control how the files in folders, searches, and
production sets are exported. The Export dialog displays this tab when you select an Export option
from the Tools menu, or when you right-click on a folder or workspace in the RDC. The Destination tab
displays the same options when you export files in folders, searches, or production sets.
Note: In the Text and Native File Name section, the Named after option is available only for Production Sets.
6. Complete the fields on the Destination Files tab. See Fields on the Destination Files tab on page 72.
7. After you have selected your export settings, select File and then click Run.
Note: A warning message displays if you are missing information required to run the export. Update the
settings for the required options, and run the export again.
8. Review the progress of the export.
You can view the progress of an import or export through the RDC. Select the following tabs to display
specific information:
n
Summary - displays general information about the number of records, processing warnings, and
errors. The following screenshot displays file progress for an import job. You can also see a
Relativity | Desktop Client Guide - 70
similar dialog when exporting content.
Note: SQL Insert Mode always shows Bulk.
n
Errors - lists any errors encountered during the load. The Errors tab displays any errors that
occur when you import or export content with the RDC.
Note: When you run an import job, the RDC only imports only records with no errors into the
workspace.
n
n
n
n
Progress - displays a detailed view of the load progress.
Warnings - displays information about loading or connection issues.
Report - includes the following files that you can export:
o Export Error Report - exports a .csv file with a summary of errors.
o Export Error File - exports a .dat file, which is a document-level load file containing only
records with errors.
File Transfer Mode - displays the following information:
o Web mode - this mode uses the web server and it is the standard.
o Direct mode - this mode provides faster performance, but requires a connection to the
network hosting the data, as well as specific Windows group permissions. For more
information, see Setting up direct mode on page 9.
Relativity | Desktop Client Guide - 71
Note: For deployments that have multi-tenancy enabled, don't give tenants Direct Mode access in the
Relativity Desktop Client, as doing so will result in more than one tenant having access to the same BCP path,
which could then lead to interferences with load files during import.
9. (Optional) To save your export settings, click File > Save Export Settings. Choose a location for the
export settings file (.kwx).
4.5.1 Fields on the Destination Files tab
The Destination Files tab contains the following sections with their respective fields:
n
Export Location - select a target directory for exporting folders, searches, and production sets. Click
to browse for a location. Select Overwrite Files to overwrite any existing files of the same name in
the target export directory.
n
Physical File Export - select Copy Files From Repository option. This is the default option and copies
files from the file server to the specified export location. If you don't select Copy Files From Repository,
Relativity doesn't copy the files to the export location. Instead, the exported load files reference the
repository location of the files.
n
Volume Information - controls the naming and size of the volume identifier. Set the following options
in this section:
o Prefix - enter the alpha prefix for the volume identifier.
o Start # - select the first number used for the numeric section of the volume identifier. Multiple
volumes increment numbers during export creating unique volume identifiers.
o # 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.)
o Max size - select the maximum size allowed for each volume in MBs.
n
Subdirectory Information - controls the naming and size of volume subfolders. Set the following
options in this section:
o Image Prefix - enter the alpha prefix for the subdirectory that stores exported images.
o Native Prefix - enter the alpha prefix for the subdirectory that stores exported native files.
o Text Prefix - enter the alpha prefix for the subdirectory that stores exported extracted text files.
o Start # - select the starting number for the subdirectories.
o # 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.)
o Max Files - select the number of files to store in each subdirectory.
n
File Path - controls how the export path for the files is referenced. Select one of the following options:
o Use absolute paths - paths to exported files are represented as absolute paths.
C:\ Desktop\VOL001\NATIVE001\AS000001.msg
o Use relative paths - paths to exported files are represented as relative paths.
.\VOL001\NATIVE001\AS000001.msg
o Use prefix - a prefix is added to the relative path, such as a CD drive letter.
D:\VOL001\NATIVE001\AS000001.msg
Relativity | Desktop Client Guide - 72
n
Load File Characters - select the delimiters to use in a document-level load file when Data File Format
in the Metadata section is set to Custom. Select the following options as necessary:
o Column - this delimiter separates columns in the load file.
o Quote - this delimiter qualifies the text in each field of the load file.
o Newline - this delimiter signifies the end of any extracted text or long text field in the load file.
o Multi-Value - this delimiter separates different choices within a choice field.
o Nested Value - this delimiter indicates the hierarchy of choices within a choice field.
n
Text and Native File Names - select the following options for naming exported native and extracted
text files:
o (Available Only for Production Sets) Named after - select one of the following naming convention
for exported files:
l Identifier - select this option to name the files after the identifier for your workspace.
l Beginning production number - select this option to name the files after the production
number. (This number may be the Bates number for a production.)
o Append original file - select this option to append the original name of the file to the end of the
exported file name.
n
Image - determines whether to include images in an export and sets the format of the load file. Set the
following options:
o Check Export Images - select this option to include images in the export. (You must set the Data
File Format and the File Type when you export images.)
o Data File Format - select one of these formats for image-level load file:
l Opticon
l IPRO
o File Type - select one of these file types:
l Single-page TIF/JPG
l Multi-page TIF
l PDF
n
Native - select Export Native Files to export native files.
n
Metadata - use the following options to control the export of the document-level load file and extracted
text:
o Data File Format - select a the format for the document-level load file you're exporting:
l Comma separated (.csv)
l Concordance (.dat) - load file exports with the standard Concordance delimiters.
l Custom (.txt) - load file exports with the custom delimiters that you select in the Load File
Characters section.
l HTML (.html) - load file is in HTML and contains hyperlinks to launch any exported files.
o Data File Encoding - select an encoding for the document-level load file from the drop-down
box. Click
for additional options.
o Export Text Field as Files - 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. The
RDC includes text as part of your load file if you deselect this option.
o Text File Encoding - select the encoding for the document-level text files. Click
for additional
options.
o 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
Relativity | Desktop Client Guide - 73
functionality. Click
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.
If you add more than one field to the Selected Long Text Fields column, Relativity adds the Text
Precedence column as the last column in the load file. During an export, Relativity checks the
topmost field in the Selected Long Text Fields column for text, and if the field is null, it checks
the next field in order of precedence for text. When it finds a field that contains text, Relativity
adds the contents of that field to the Text Precedence column in the document load file, and
then continues checking the fields for the next document.
For example, you want the Text Precedence column in the load file to contain the contents of the
OCR Text field when it is available for a document and the contents of the Extracted Text field
when the OCR Text for a document is null. In the Pick Text Precedence pop-up, you add the OCR
Text as the first field in the Selected Long Text Fields column followed by the Extracted Text field.
If you select only one field in the Selected Long Text Fields column, Relativity adds the text to a
column with the same name as the field, and does not create the Text Precedence column.
Note: If you want to improve export performance, you don't need to add all of the long text fields you
select in the Pick Text Precedence pop-up to the Selected Columns option on the Data Source tab.
When you don't select these fields on the Data Source tab, but you add them to Selected Long Text
Fields column, the RDC adds the content of these fields to the Text Precedence column as described
above. When you add the long text fields on the Data Source tab, Relativity adds these columns to the
document level load file.
The Precedence Text column displays the file path to the exported files if you select the Export
Text Field as Files checkbox.
Relativity | Desktop Client Guide - 74
o
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.
5 Configuring the RDC
You can fine-tune the performance of the RDC in your environment by adjusting configuration
settings that control behavior related to the following:
n
n
n
Batch handling below
Validation and auditing on the next page
Import and export on page 78
5.1 Batch handling
You have the option to set several configuration settings that control how the RDC uses batches to
load records in the database. Large batch sizes may cause timeouts to occur during the loading
process, because Relativity initially attempts to load all documents or images in these batches.
By default, the RDC uses dynamic batch resizing when a timeout occurs. This dynamic bath resizing
automatically lowers the size of the batch and retries the import. The RDC reduces the batch size by
100 until it determines the optimum number of records for import. It can also reduce the number of
records when the data size (in bytes) for the batch approaches the value set for the
ImportBatchMaxVolume.
To set custom configuration setting for batch handling in your RDC configuration file:
1. Exit the RDC if it is currently open.
2. Navigate to the kCura.EDDS.Winform.exe.config file on the machine where the RDC is installed. By
default, this configuration file is located in the following directory:
[Installation_Directory]\kCura Corporation\Relativity Desktop Client
Note: Make a backup copy of this file in case you need to rollback any configuration changes made to it.
3. Open the kCura.EDDS.Winform.exe.config file in a text or XML editor.
4. Delete the opening comment tag <! -- displayed before the tag <kCura.WinEDDS>, and the closing tag -> displayed after the tag </kCura.WinEDDS>.
<kCura.WinEDDS><add key="WebAPIOperationTimeout" value="600000" />
<!--<add key="ImportBatchMaxVolume" value="10485760" />
<add key="ImportBatchSize" value="1000" />
<add key="ExportBatchSize" value="1000" />
<add key="DynamicBatchResizingOn" value="True" />
<add key="MinimumBatchSize" value="100" />
<add key="WaitTimeBetweenRetryAttempts" value="30" />
<add key="CreateErrorForEmptyNativeFile" value="False" />-->
</kCura.WinEDDS>
Relativity | Desktop Client Guide - 75
5. Edit the attribute values as necessary. Modify only the values in the previous code sample.
n
n
n
n
n
n
n
ImportBatchMaxVolume: This value represents the maximum data size (in bytes) for a batch.
When the data size approaches this value, the RDC reduces the batch size by 100 using dynamic
batch resizing. The default value is 10485760 bytes (or 10 MB).
ImportBatchSize: This value represents the initial number of records in an import batch. If
dynamic batch resizing is enabled, this value may be reset for a job to accommodate the number of records or the size of the data. The default value is 1000 records.
ExportBatchSize: This value represents the number of records in an export batch. The default
value is 1000 records.
DynamicBatchResizingOn: When default value of True is set, the RDC automatically uses
dynamic batch resizing to decrease the batch size by 100 records and retry the import job. When
the value is set to False, the RDC timeouts when the import job is too large to complete.
MinimumBatchSize: When DynamicBatchResizingOn is set to True, this value represents lower
bound on the batch size. Batch sizes cannot be smaller than this value. The default value is 100
records.
WaitTimeBetweenRetryAttempts: This value represents the time interval in seconds between
import attempts made by the RDC. The default value is 30 seconds.
CreateErrorForEmptyNativeFile: When the default value of False is set, the RDC imports only
the metadata for the record associated with an empty file (of 0 KB), and it displays a message on
the Warning tab. When this value is set to True, the RDC does not import the metadata for the
empty file, and the Error tab displays a message.
Note: The RDC does not import empty files. This instance setting controls only the import of metadata,
and where information about an empty file displays.
6. Save your changes to the file. You can now log in to the RDC.
5.2 Validation and auditing
You have the option to add configuration settings that control whether the RDC performs validation
for native and image file types. The configuration settings can also control the locations for all
import jobs. You can also set the level of detail you want the audit log to capture for all import jobs.
You must manually add these settings to the configuration file.
Use these instructions to customize the configuration settings for native and image validation, as
well as audit level.
Before disabling validation, you should confirm that your files are all of supported types and that the
native file paths in the load files are correct.
Note the following:
n
n
When you disable file type validation, you do not receive any warnings regarding unsupported file
types. It's therefore possible for files to be imaged and result in errors.
Disabling the file type validation also causes the application to set the Relativity Native Types field to
Unknown Format.
Relativity | Desktop Client Guide - 76
o
o
n
Setting a native type to unknown has no effect on productions or OCR.
Setting a native type to unknown has no effect on how the viewer or imaging engine handles the
file. This means that a native type of unknown can't be the sole cause of an error in the viewer or
the imaging engine. If a file is designated unknown and it actually has an unsupported file type,
the Viewer or imaging engine throws an error based on the fact that it has an unsupported file
type.
When you disable file location validation, the RDC may temporarily stop and then restart if the load file
lists paths that do not contain files. Similarly, the RDC will stop when the load file does not include a
path for a native file, but it will load any files prior to encountering this issue.
Complete these steps to configure file validation and auditing:
1. Exit the RDC if it is currently open.
2. Navigate to the kCura.EDDS.Winform.exe.config file on the machine where the RDC is installed. By
default, this configuration file is located in the following directory:
[Installation_Directory]\kCura Corporation\RelativityDesktop Client
Note: Make a backup copy of this file in case you need to rollback any configuration changes made to it.
3. Open the kCura.EDDS.Winform.exe.config file in a text or XML editor.
4. Delete the opening comment tag
<! -- displayed before the tag <kCura.WinEDDS>, and the closing tag --> displayed after the tag </kCura.WinEDDS>.
5. To disable the validation of native file types for all jobs, add the following setting between the <kCura.WinEDDS>…</kCura.WinEDDS> tags:
<add key="DisableNativeValidation" value="True" />
6. To disable the validation of the native file locations for all jobs, add the following setting between the
<kCura.WinEDDS>…</kCura.WinEDDS> tags:
<add key="DisableNativeLocationValidation" value="True" />
Note: Do not use the DisableNativeLocationValidation flag when copying files to a repository. File locations are
validated regardless of the flag before they are copied.
7. To disable the validation of image file types for all jobs, add the following setting between the <kCura.WinEDDS>…</kCura.WinEDDS> tags:
<add key="DisableImageTypeValidation" value="True" />
8. To disable the validation of the image file locations for all jobs, add the following setting between the
<kCura.WinEDDS>…</kCura.WinEDDS> tags:
<add key="DisableImageLocationValidation" value="True" />
Note: The options represented in steps 5-8 are controlled separately; however native type validation is
dependent upon native location validation. Image type validation is dependent upon image location validation.
To enable any of these functions, set the respective value to False.
9. To disable auditing, add the following setting between the <kCura.WinEDDS>…</kCura.WinEDDS> tags:
<add key="AuditLevel" value="NoAudit" />
You can set audit level to any of the following values:
n
FullAudit: Includes create, update, and delete messages. Snapshot is also enabled so all current
field values (Audit Details) are captured for updates. This is the default setting.
Relativity | Desktop Client Guide - 77
NoSnapshot: Includes create, update, and delete messages. Snapshot is disabled so current field
values (Audit Details) are not captured for updates.
n NoAudit: Auditing is disabled.
10. Save your changes to the file. You can now log in to the RDC.
n
5.3 Import and export
You can control and retry the behavior for importing and exporting using the importing and
exporting settings. You can also control how to bypass specific invalid date errors when importing
with the RDC.
Use the following instructions to set custom configuration settings in your RDC configuration file for
importing and exporting:
1. Exit the RDC if it is currently open.
2. Navigate to the kCura.EDDS.Winform.exe.config file on the machine where the RDC is installed. By
default, this configuration file is located in the following directory:
[Installation_Directory]\kCura Corporation\Relativity Desktop Client
Note: Make a backup copy of this file in case you need to rollback any configuration changes made to it.
3. Open the kCura.EDDS.Winform.exe.config file in a text or XML editor.
4. Edit any of the following attribute values:
n
n
n
CreateErrorForInvalidDate: You can suppress errors that occur as a result of importing dates
as"00/00/0000." The default value is True. This can result in an error when importing with an
invalid date.
IOErrorNumberOfRetries: This value controls the number of import and export attempts after
an error occurs. The default number of retries is 20.
IOErrorWaitTimeInSeconds: This value sets the number of seconds the RDC waits before retrying an import or export after an error occurs. The default value is 30 seconds.
<kCura.Utility>
<add key="CreateErrorForInvalidDate" value="True" />
<add key="IOErrorNumberOfRetries" value="20" />
<add key="IOErrorWaitTimeInSeconds" value="30" />-->
</kCura.Utility>
5. Save your changes to the file. You can now log in to the RDC.
Relativity | Desktop Client Guide - 78
Proprietary Rights
This documentation (“Documentation”) and the software to which it relates (“Software”) belongs
to kCura LLC and/or kCura’s third party software vendors. kCura grants written license agreements
which contain restrictions. All parties accessing the Documentation or Software must: respect
proprietary rights of kCura and third parties; comply with your organization’s license agreement,
including but not limited to license restrictions on use, copying, modifications, reverse engineering,
and derivative products; and refrain from any misuse or misappropriation of this Documentation or
Software in whole or in part. The Software and Documentation is protected by the Copyright Act of
1976, as amended, and the Software code is protected by the Illinois Trade Secrets Act. Violations
can involve substantial civil liabilities, exemplary damages, and criminal penalties, including fines
and possible imprisonment.
©2017. kCura LLC. All rights reserved. Relativity® and kCura® are registered trademarks of kCura
LLC.
Relativity | Desktop Client Guide - 79
Was this manual useful for you? yes no
Thank you for your participation!

* Your assessment is very important for improving the work of artificial intelligence, which forms the content of this project

Download PDF

advertising