### Download and Install Migrate.Server RAP File Source: https://help.relativity.com/RelativityOne/Content/index.htm/Data_migration/Migrate/Migrate_setup Instructions to download the latest Migrate.Server RAP file from the Community site and install it onto your Relativity Server instance as the initial setup step. ```Relativity Configuration 1. Download the latest RAP file located in the Relativity Applications folder from the Community site for Migrate.Server 2. Install the Migrate.Server RAP file to your Relativity Server instance. ``` -------------------------------- ### RelativityOne Analytics: Categorization Set Settings Source: https://help.relativity.com/RelativityOne/Content/index.htm/System_Guides/User_quick_reference/Analytics/Conceptual_analytics_setup_basics Outlines the essential settings for configuring an Analytics categorization set in RelativityOne. This includes specifying the categorization name, document source, associated Analytics index, and fields for categories and examples. ```APIDOC Name: [enter a name for the categorization set] Documents To Be Categorized: [select the saved search containing the documents to be categorized] Analytics Index: [select the index you created that defines the conceptual space] Minimum Coherence Score: [leave as default] Maximum Categories Per Document: [leave as default] Email notification recipients: [enter any email address for those who need to be contacted when categorization is complete] Categories and Examples Source: [select the Category Designation field] Example Indicator Field: [select the Category Indicator field] ``` -------------------------------- ### Install Case Metrics at Instance Level in Relativity Source: https://help.relativity.com/RelativityOne/Content/index.htm/Relativity/Case_Metrics/Case_Metrics Details the process of installing the Case Metrics .rap file into the Application Library at the instance level, including selecting initial workspaces for installation to ensure instance-wide functionality. ```Plain Text 1. Navigate to the Application Library tab. 2. Click New Library Application. 3. On the Application File field, click Select File. 4. Select the Case Metrics .rap file and click Open. 5. Click Save. 6. Once the application installation is complete, in the Workspaces Installed section, click Select. 7. Choose at least one workspace from the list to ensure Case Metrics works at the instance level. 8. Click the Move selected from left to right icon. 9. Click Apply. (The selected workspaces will have Case Metrics installed, and a list will display in the Workspaces Installed section.) ``` -------------------------------- ### APIDOC: Integration Point Setup - Scheduling Fields Source: https://help.relativity.com/RelativityOne/Content/index.htm/Relativity/Integration_Points/Importing_data_through_Integration_Points Outlines the scheduling options for an Integration Point, allowing users to enable a scheduler and configure frequency (daily, weekly, monthly), start date, end date, scheduled time, and time zone. ```APIDOC Scheduling: Enable Scheduler: Gives you the option of scheduling additional imports. Selecting Yes makes the following fields available: Frequency: The interval at which Relativity syncs this integration point. Select one of the options below: Daily: Select this option to sync once every day. Weekly: Select this option to sync on a weekly basis. Then, enter data in the following fields: Reoccur: Enter a numeric value in the "Every # week(s)" field for how often you want it to occur weekly. Send On: Specify on which day of the week (Monday through Sunday) the sync will take place by selecting any of the days of the week listed. Monthly: Select this option to sync on a monthly basis. Then, enter data in the following fields: Reoccur: Enter a numeric value in the "Every # month(s)" field for how often you want it to occur monthly. Send On: Select the "Day # of the month" that you want this integration point to sync. Start Date: The date that you want Integration Points to start syncing the data. End Date: (Optional) the date that you want Integration Points to stop syncing the data. Leaving the End Date blank causes the Integration Point to run indefinitely at the scheduled interval. Scheduled Time: The time at which this integration point syncs. This time is local to your PC, not to the server. Time Zone: Select the appropriate time zone. ``` -------------------------------- ### RelativityOne Analytics: Category Designations Layout Source: https://help.relativity.com/RelativityOne/Content/index.htm/System_Guides/User_quick_reference/Analytics/Conceptual_analytics_setup_basics Defines the required fields for a dedicated layout in RelativityOne, enabling reviewers to tag documents as examples for categorization. This layout ensures consistent application of category designations and indicators. ```APIDOC Layout name: [enter a name for the layout] Fields: - Category Designation - Category Indicator ``` -------------------------------- ### Install Case Metrics at Workspace Level in Relativity Source: https://help.relativity.com/RelativityOne/Content/index.htm/Relativity/Case_Metrics/Case_Metrics Describes the procedure for installing Case Metrics into specific workspaces from the Application Library after it has been added to the instance, enabling its use within those selected workspaces. ```Plain Text 1. Navigate to the Application Library tab. 2. Select Case Metrics from the list. 3. Choose at least one workspace from the list where you wish to install Case Metrics. 4. Click the Move selected from left to right icon. 5. Click Apply. (The selected workspaces will have Case Metrics installed, and a list will display in the Workspaces Installed section.) ``` -------------------------------- ### Resolving Other Application Installation Errors Source: https://help.relativity.com/RelativityOne/Content/index.htm/Relativity/Applications/Troubleshooting_application_installation_errors Guidance for resolving application installation errors that cannot be resolved directly through the Import Status page and require manual intervention in the target workspace. ```APIDOC Procedure: 1. On the Import Status page, identify errors where the 'Resolve Errors' column indicates manual resolution. 2. Manually resolve the underlying issue within the target workspace (e.g., modifying an artifact, adjusting settings). 3. After resolving the issue in the workspace, return to the Import Status page. 4. Click 'Retry Import' (button will be enabled once all errors are resolved). ``` -------------------------------- ### Common Application Installation Error List and Resolutions Source: https://help.relativity.com/RelativityOne/Content/index.htm/Relativity/Applications/Troubleshooting_application_installation_errors Identifies common causes of application installation errors and their possible resolutions, including issues with duplicate names, relational fields, locked applications, malformed files, and restricted external resources. ```APIDOC Error Sources: - Application contains duplicate Object Type or field names Possible Resolutions: * Rename the item in the target workspace * Rename the item in the application * Remove the item from the application * Remove the item from the target workspace * Map fields before installing - Application file contains a relational field that uses a friendly name that a relational field in the target workspace already uses Possible Resolutions: * Change the friendly name of the relational field in the target workspace * Change the friendly name of the relational field in the application * Map fields before installing - Application contains an Object Type that already exists in the target workspace inside a locked application Possible Resolutions: * Unlock the application in the target workspace * Remove the object type from the application - Application has a malformed file Possible Resolutions: * Re-export the application and try again - Application contains an external resource of a restricted file type Possible Resolutions: * Remove the external resource from the application and re-install ``` -------------------------------- ### Relativity Install Event Handler Definition and Permissions Source: https://help.relativity.com/RelativityOne/Content/index.htm/Relativity/Security_permissions/Workspace_security Defines an Install Event Handler in Relativity, an assembly that runs during installation to configure the environment for applications. Includes associated tab access requirements. ```APIDOC **Install Event Handler**—the name of the pre or post-install event handler, which is an assembly that runs when you install them to configure your Relativity environment to support your applications. + Viewing, adding, or deleting event handlers requires access to the **Object Type** tab. ``` -------------------------------- ### Example ARM Archive Share Path Configuration Source: https://help.relativity.com/RelativityOne/Content/index.htm/ARM/ARM_Configuration An example of a recommended UNC path for an ARM share, emphasizing that it should be located at the root level of any drive on the server for optimal configuration. Multiple ARM shares are allowed, but all should be at the root of their respective drives. ```Configuration \\SERVERNAME\\ARMShare ``` -------------------------------- ### Creating a User in Relativity Source: https://help.relativity.com/RelativityOne/Content/index.htm/Mobile/Mobile_Admin Step-by-step guide for administrators to create a new user account within the Relativity platform. ```APIDOC To create a user, follow the steps below. 1. In the User list, tap +. 2. Complete the fields on the form. 3. Tap Save. ``` -------------------------------- ### Relativity Library Applications Manager API (ILibraryApplicationsManager, IApplicationInstallManager) Source: https://help.relativity.com/RelativityOne/Content/index.htm/What_s_New/Release_notes Documentation for the new Library Applications Manager API, designed for programmatic interaction with Relativity applications. It supports CRUD operations on applications and includes asynchronous helper methods for managing application installations, checking status, retrying installs, retrieving installation details, results, errors, and canceling installs. This functionality is available via the ILibraryApplicationsManager and IApplicationInstallManager interfaces in the Relativity.Services.Interfaces.LibraryApplication namespace. ```APIDOC ILibraryApplicationsManager Interface: Namespace: Relativity.Services.Interfaces.LibraryApplication Operations: - Create Application - Read Application - Update Application - Delete Application IApplicationInstallManager Interface: Namespace: Relativity.Services.Interfaces.LibraryApplication Helper Methods: - Retrieve application install status (asynchronous) - Retry application installs (asynchronous) - Retrieve workspace installation details - Retrieve installation results - Retrieve installation errors - Cancel application installs Supporting Classes/Enumerations: Namespace: Relativity.Services.Interfaces.LibraryApplication ``` -------------------------------- ### RelativityOne PDF Markup: DtSearch Syntax Examples Source: https://help.relativity.com/RelativityOne/Content/index.htm/Relativity/Relativity_Redact/Automated_PDF_markup_project Explains how dtSearch syntax is used to apply markups in RelativityOne PDF projects. Provides examples for applying markups to all terms in a search and for applying markups to specific parts of a dtSearch syntax. ```DtSearch apple w/2 pear (?apple) w/2 pear ``` -------------------------------- ### Textual Near Duplicate Identification (TND) Setup Components Source: https://help.relativity.com/RelativityOne/Content/index.htm/System_Guides/User_quick_reference/Analytics/Email_threading_and_TND_setup_basics This section outlines the four main components required for setting up Textual Near Duplicate Identification (TND) in RelativityOne, providing a high-level overview of the necessary elements. ```APIDOC TND Setup Components: 1. Workspace fields 2. Saved search 3. Structured analytics set 4. Views ``` -------------------------------- ### Examples of Relativity Virtual Paths Source: https://help.relativity.com/RelativityOne/Content/index.htm/Relativity/Processing/Mapping_processing_fields Provides concrete examples of virtual paths generated based on different file and folder structures, including cases with PSTs, embedded messages, and notes on leading backslashes for directly selected containers/files. ```Text \\Maude Lebowski\\Loose Docs \\Walter Sobchak\\Walter.pst\\Inbox\\Unimportant\\Fest Junk\\Walter test.pst\\My Test Box In the case of a container or loose file being directly selected for processing, the virtual path does not have a leading backslash. test.pst\\My Test Box\\000000009B90A00DCC4229468A243C71810F71BC24002000.MSG Revisions.doc This is the virtual path of a file embedded in the Revisions.doc file. ``` -------------------------------- ### RelativityOne Export: Export_Extras Table Example Values Source: https://help.relativity.com/RelativityOne/Content/index.htm/Relativity/Import_Export/Access_DB__MDB__Load_file_specifications Provides concrete examples of how data might be structured and stored within the 'Export_Extras' table, illustrating common metadata types such as file names, MD5 hashes, and sent dates/times. ```APIDOC Table: Export_Extras (Example Values) Description: Exemplary values in Export_Extras table. Examples: - theLabel: File Name theCategory: TEXT theValue_or_memoValue: Monthly Reports.docx Explanation: For all electronic files, the original filename (including extension). - theLabel: MD5 theCategory: TEXT theValue_or_memoValue: 08a008a01d498c404b0c30852b39d3b8 Explanation: The MD5 (a message-digest algorithm) hash value of the file. - theLabel: Sent Date/Time theCategory: DATE theValue_or_memoValue: 26/05/1999 8:33 PM Explanation: The date and time the email was sent. ``` -------------------------------- ### RelativityOne: Saved Search Configuration for Email Threading Source: https://help.relativity.com/RelativityOne/Content/index.htm/System_Guides/User_quick_reference/Analytics/Email_threading_and_TND_setup_basics Details the setup for a saved search in RelativityOne to be used as a data source for email threading and textual near duplicate identification, emphasizing no conditions and recommended fields. ```APIDOC Search Name: No specific recommendation, follow team protocol. Conditions: None (to include all attachments and loose files). Fields (Recommended for QC): - Email From - Email To - Email CC - Email BCC - Email Subject - Email Date Sent - Parent Document ID - File Name field ``` -------------------------------- ### Configure Analytics Conceptual Index Settings Source: https://help.relativity.com/RelativityOne/Content/index.htm/System_Guides/User_quick_reference/Analytics/Conceptual_analytics_setup_basics Specifies the settings for creating a new Analytics conceptual index, including basic information, advanced options for training and filtering, and optional email notifications for index status. ```APIDOC Analytics Index Settings: Index Information: Name: Conceptual Analytics Index Index Type: Conceptual Data source: (select the saved search created previously) Order: (set order or leave as default) Advanced Settings: Training data source: (defaults to the same saved search as data source) Optimize training set: Yes Dimensions: (leave as default) Remove English signatures and footers: Yes Enable email header filter: Yes (Note: This setting cannot be altered if 'Remove English signatures and footers' is set to No) Stop words: (leave as default) Optional Settings: Email notification recipients: (enter any email addresses for notifications) ``` -------------------------------- ### RelativityOne TND Relation Items View Configuration Source: https://help.relativity.com/RelativityOne/Content/index.htm/System_Guides/User_quick_reference/Analytics/Email_threading_and_TND_setup_basics Describes the setup for the Relational Items View within the RelativityOne viewer, used for navigating documents within a Textual Near Duplicate (TND) thread. Details required fields and sort order. ```APIDOC View Association: Associated to the [SAS Prefix]::Textual Near Duplicate Group field Fields: - Control Number - [SAS Prefix]::Textual Near Duplicate Group - [SAS Prefix]::Textual Near Duplicate Similarity - [SAS Prefix]::Textual Near Duplicate Principal - Relativity Compare Conditions: Conditions cannot be set on a relational items view Sort: - [SAS Prefix]::Textual Near Duplicate Group – Ascending Order - [SAS Prefix]::Textual Near Duplicate Similarity – Descending Order - [SAS Prefix]::Textual Near Duplicate Principal – Descending Order ``` -------------------------------- ### RelativityOne Email Threading & TND Workspace Fields Setup Source: https://help.relativity.com/RelativityOne/Content/index.htm/System_Guides/User_quick_reference/Analytics/Email_threading_and_TND_setup_basics Defines the required relational fields for combined Email Threading and Textual Near Duplicate (TND) functionality within a RelativityOne workspace. These fields are typically pre-existing but must be created if using multiple structured analytics sets. ```APIDOC Field Name: Email Duplicate ID Field Type: Fixed-length text Relational?: Yes Field Name: Email Thread Group Field Type: Fixed-length text Relational?: Yes Field Name: Textual Near Duplicate Group Field Type: Fixed-length text Relational?: Yes ``` -------------------------------- ### RegEx Metacharacters Reference Source: https://help.relativity.com/RelativityOne/Content/index.htm/Relativity/Analytics/Using_regular_expressions_with_structured_analytics Reference guide for common regular expression metacharacters, detailing their meaning and usage with examples. ```APIDOC Metacharacter: \d Description: Whole number 0 - 9 Example: \d\d\d = 327, \d\d = 81, \d = 4 Note: \d\d\d ≠ 24631 because 24631 contains 5 digits. \d\d\d only matches for a 3-digit string. ``` ```APIDOC Metacharacter: \w Description: Alphanumeric character Example: \w\w\w = dog, \w\w\w\w = mule, \w\w = to, \w\w\w = 467, \w\w\w\w = 4673 Note: \w\w\w ≠ boat because boat contains 4 characters. \w ≠ ! because it is a non-alphanumeric character. ``` ```APIDOC Metacharacter: \W Description: Symbols Example: \W = %, \W = #, \W\W\W = @#% Note: \W\W\W\W ≠ dog8 because d, o, g, and 8 are alphanumeric characters. ``` ```APIDOC Metacharacter: \s Description: Whitespace character Example: dog\scat = dog cat Note: \s matches for a single space. \s only works in Analytics RegEx. In dtSearch RegEx, \s doesn't return results. ``` ```APIDOC Metacharacter: [a-z] [0-9] Description: Character set, at least one of which must be a match, but no more than one unless otherwise specified. The order of the characters doesn't matter. Example: pand[ora] = panda, pand[ora] = pando Note: pand[ora] ≠ pandora because it is implied in pand[ora] that only 1 character in [ora] can return. ``` -------------------------------- ### RelativityOne: Structured Analytics Set Configuration Source: https://help.relativity.com/RelativityOne/Content/index.htm/System_Guides/User_quick_reference/Analytics/Email_threading_and_TND_setup_basics Outlines the configuration steps and choices for creating a structured analytics set in RelativityOne, including general information, email headers, email threading, textual near duplication, and optional settings. ```APIDOC Structured Analytics Set Information: Name: Enter a name for the structured analytics set. Prefix: Keep the default prefix or add your own prefix. Shorter prefixes (even just two characters, such as “E1”) take up less space in your views. Operations to run: Email threading, Textual near duplicate identification. Data source: Select the saved search you created above. Email Headers: Analytics profile: Select the profile you created above. Use email header fields: Yes. Languages: Select any language used in email headers in your extracted text. We recommend that you always include English, even for data sets in other languages. Email Threading: Destination Email Thread Group: Select the default field or the custom field you created. Destination Email Duplicate ID: Select the default field or the custom field you created. Textual Near Duplication: Destination Textual Near Duplicate Group: Textual Near Duplicate Group Minimum similarity percentage: You can keep the default value or change it to a value between 80 and 100. Ignore numbers: No (unless you have a very large document set that will take a long time to run). Optional Settings: Choose the appropriate Analytics server ``` -------------------------------- ### Download and Add Relativity Application to Application Library Source: https://help.relativity.com/RelativityOne/Content/index.htm/Advice_Hub_Solutions/Propagate_coding_post-import This section provides step-by-step instructions to download the Propagate Coding Post-import .rap file from the Relativity Community and then upload it to the Relativity Application Library. It ensures the correct version is selected for compatibility. ```APIDOC Download Application: 1. Log in to Relativity Community (https://community.relativity.com/s/files) 2. Navigate to 'Relativity Applications' folder 3. Locate and select the newest compatible 'Propagate Coding Post-import .rap' file (higher version number preferred) 4. Click 'Download' Add Solution to Application Library: 1. Navigate to 'Application Library' tab 2. Click 'Upload Application' 3. Click 'Select File' 4. Navigate to and select the downloaded .rap file 5. Click 'Open' 6. Click 'Save' ``` -------------------------------- ### ChatGPT Enterprise Data Source Filter Criteria Source: https://help.relativity.com/RelativityOne/Content/index.htm/Collect/Data_sources/ChatGPT Details the supported filter criteria, operators, and examples for collecting ChatGPT Enterprise chat data within Relativity's Collect feature. This table specifies the 'Start Date' criterion. ```APIDOC Criteria: Start Date Operators: Greater Than or Equals Description: When you use the Start Date property in a query, the search returns prompts and responses that exist the day of and after the entered date. Example: When you search a Start Date of 1/1/2024, Relativity collects all prompts and responses from that date to today. ``` -------------------------------- ### Integration Point Profile Setup Configuration Source: https://help.relativity.com/RelativityOne/Content/index.htm/Relativity/Integration_Points/Integration_Points_profiles Describes the required fields and their values for setting up an Integration Point profile to enable copying functionality in RelativityOne. ```APIDOC Profile Setup: Name: string Description: Enter a profile name of your choice. Type: string Value: Export Description: This field must be set to Export for the profile to be copied. Source: string Value: Relativity Description: This field must be set to Relativity for the profile to be copied. Destination: string Value: Relativity Description: This field must be set to Relativity for the profile to be copied. Transferred Object: string Value: Document | non-document object meta data Description: Select the Document or non-document object meta data you want to sync to the destination workspace. The non-document object must already exist in the destination workspace. Profile: string Description: Select a profile of your choice. ``` -------------------------------- ### dtSearch Phonic Search Operator Source: https://help.relativity.com/RelativityOne/Content/index.htm/Relativity/dtSearch/Using_dtSearch_syntax_options The pound sign (#) enables phonic searching, returning words that sound similar to the search term and start with the same letter. For example, searching for '#pear' would find 'pair' and 'pare'. This functionality is available in standard and Dictionary searches. ```dtSearch #pear ``` -------------------------------- ### Prepare Workspace for Relativity Propagation Solution Source: https://help.relativity.com/RelativityOne/Content/index.htm/Advice_Hub_Solutions/Propagate_coding_post-import Overview of the initial tasks required to prepare a Relativity workspace after deploying the Propagate Coding Post-import solution. This includes creating and configuring a propagation processing job, with an option to define a schedule. ```APIDOC Workspace Preparation Tasks: 1. Create and configure a propagation processing job. 2. Optionally define a schedule for running the propagation processing job. ``` -------------------------------- ### RelativityOne: aiR for Review Field Naming Convention Source: https://help.relativity.com/RelativityOne/Content/index.htm/Relativity/aiR_for_Review/aiR_for_Review_results This snippet describes the standardized naming convention for aiR for Review results fields when adding them to document views and saved searches. It provides the general format and a concrete example to guide users in correctly referencing these fields. ```APIDOC Field Naming Convention: Format: `aiR Analysis::` Example: `aiR Relevance Analysis::Prediction` ``` -------------------------------- ### Configure Instance Level Security for Case Metrics Source: https://help.relativity.com/RelativityOne/Content/index.htm/Relativity/Case_Metrics/Case_Metrics Outlines the prerequisites and steps for configuring instance-level security for Case Metrics, including ensuring user group membership and granting specific instance permissions. It also references the new Feature Permissions model. ```Plain Text To configure instance security for Case Metrics, you need to: * Ensure that users whom you want to use Case Metrics at the instance level are members of every group and workspace that you want them to be able to view data from. * Grant instance permissions to each group that you want to be able to view Case Metrics at the instance level. To configure instance permissions for Case Metrics: 1. Navigate to the Instance Details tab. 2. Click Manage Permissions. 3. Click Edit Permissions for a group on the Group Management tab. 4. Grant access to the instance permissions listed in the table below. (Note: The Schedule (Add) permission as an object permission needs to be enabled for non-system admins to create scheduled reports. Non-system admins can access Case Metrics but only report on workspaces and groups they have access to.) ``` -------------------------------- ### Sample Opticon Load File for Image Imports Source: https://help.relativity.com/RelativityOne/Content/index.htm/Relativity/Import_Export/Import_Export_Load_file_specifications This snippet provides an example of an Opticon load file, a page-level file required for image imports in RelativityOne. Each line represents a single image, detailing its identifier, optional volume, full path, and a document start marker. ```Load File Format 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,,,, ``` -------------------------------- ### Download Case Metrics Application from Relativity Community Source: https://help.relativity.com/RelativityOne/Content/index.htm/Relativity/Case_Metrics/Case_Metrics Provides steps to download the Case Metrics .rap file from the Relativity Community portal, emphasizing selection of the newest compatible version for your Relativity instance. ```Plain Text 1. Log in to the Relativity Community and click on the Relativity Applications folder. 2. Locate the newest Case Metrics .rap file that is compatible with your version of Relativity and select it. (Note: Solutions are sorted from most recently modified to oldest; select the .rap file with the higher version number if multiple versions exist.) 3. Click Download. ``` -------------------------------- ### Relativity dtSearch Regex for NLRT-prefixed strings Source: https://help.relativity.com/RelativityOne/Content/index.htm/Relativity/Regular_expressions/Searching_with_regular_expressions Example of a regular expression used in Relativity's dtSearch to find strings starting with 'nlrt-' followed by four digits. The '##' prefix is specific to Relativity's dtSearch syntax for case-insensitive searches, and '\d' represents any digit. ```Relativity dtSearch ##nlrt-\d{4} ``` -------------------------------- ### Steps to create a new Structured Analytics Set in RelativityOne Source: https://help.relativity.com/RelativityOne/Content/index.htm/Relativity/Analytics/Running_structured_data_analytics Provides a step-by-step guide on how to create a new structured analytics set, including navigation, field completion, and operation-specific settings. It also advises on creating sets during off-hours for large workspaces. ```APIDOC 1. From the Indexing & Analytics tab, select Structured Analytics Set. 2. Click New Structured Analytics Set. 3. Complete or edit the Structured Analytics Set Information fields on the layout. See Structured analytics fields. 4. For each selected operation, fill in the additional required fields and adjust the settings as necessary. - Email threading fields - Name normalization fields - Textual near duplicate identification fields - Language identification fields - Repeated content identification fields 5. Click Save. The console appears, and you can now run your structured analytics set. See Structured Analytics Set console. When creating a new structured analytics set in a large workspace, the document table may become locked while the results fields are being created. We recommend creating new sets off-hours to prevent any disruption to review. ``` -------------------------------- ### Configure Analytics Index Data Source Source: https://help.relativity.com/RelativityOne/Content/index.htm/System_Guides/User_quick_reference/Analytics/Conceptual_analytics_setup_basics Details the conditions and fields required to set up a saved search that serves as the data source for an Analytics conceptual index in Relativity. This search defines the documents that will be included in the index. ```APIDOC Data Source Configuration: Name: (e.g., Conceptual Analytics Index Search) Conditions: - Extracted Text Size > 0 - Extracted Text Size < 30000 Fields: - Extracted Text Note: If Relativity Processing was not used, the 'Extracted Text Size' field must be manually populated. ``` -------------------------------- ### dtSearch Regular Expression for Case-Insensitive Search Source: https://help.relativity.com/RelativityOne/Content/index.htm/Relativity/Regular_expressions/Using_regular_expressions_with_dtSearch Illustrates a specific regular expression pattern for use within Relativity's dtSearch engine. This example demonstrates how to search for strings starting with 'NLRT-' followed by four digits, considering dtSearch's default case-insensitivity and its handling of whitespace. ```dtSearch "##nlrt-\d{4}" ``` -------------------------------- ### Relativity Document Family Rollover to New Level Source: https://help.relativity.com/RelativityOne/Content/index.htm/Relativity/Processing/Processing_profiles Illustrates how an entire document family rolls over to the next control number level when it does not fit on the current level, ensuring family integrity. The example shows a family starting on a new level because the previous level had insufficient remaining numbers. ```APIDOC | Number | Document | | --- | --- | | REL.001.0001.9999 | Excel document | | REL.001.0002.0001 | Word document | | REL.001.0002.0002 | Word document | 9,997 documents later | Number | Document | | --- | --- | | REL.001.0002.9997 | email with no attachments | | REL.001.0003.0001 | email with 4 attachments | | REL.001.0003.0002 | attachment 1 | | REL.001.0003.0003 | attachment 2 | | REL.001.0003.0004 | attachment 3 | | REL.001.0003.0005 | attachment 4 | ``` -------------------------------- ### Relativity Persistent Highlight Wildcard Syntax Source: https://help.relativity.com/RelativityOne/Content/index.htm/Relativity/Persistent_highlight_sets/Entering_highlight_terms Illustrates the use of wildcard characters (asterisk) in terms for persistent highlighting within Relativity, allowing for flexible matching of words based on prefixes, suffixes, or substrings. These examples show how to match words starting with, ending with, or containing a specific term. ```Relativity Search Syntax term* ``` ```Relativity Search Syntax *term ``` ```Relativity Search Syntax *term* ``` -------------------------------- ### Create OAuth2 Client for Primary Instance Authentication Source: https://help.relativity.com/RelativityOne/Content/index.htm/Relativity_Unified_Experience/Configuring_your_environments Outlines the steps to create an OAuth2 client in the duplicate Relativity instance to authenticate with the primary instance, including required fields like Name, Flow Grant Type, Context User, Enabled status, and Access Token Lifetime. ```APIDOC OAuth2 Client: HybridModelAuth Name: HybridModelAuth Flow Grant Type: Client Credentials Context User: Hybrid User Enabled: Yes Access Token Lifetime: 60 (minutes) ``` -------------------------------- ### APIDOC: Slack Collection Filter Criteria Source: https://help.relativity.com/RelativityOne/Content/index.htm/Collect/Data_sources/Slack Details the supported filter criteria, operators, descriptions, and examples for configuring Slack data collections in Relativity Collect. This includes fields like Channel Name, Conversation Type, End Date, Slice Interval in Hours, Start Date, and Workspace Name. ```APIDOC Slack Collection Filter Criteria: - Field: Channel Name Operators: Equals Description: When you use the Channel Name property, the search returns all message within the channels that equals the search word or phrase in the channel's name. Example: If you use the Channel Name property in a query, the search returns all messages that the channel name equals the text you’re searching for. In other words, the query does not return only those messages from channels that have an exact match. For example, if you search for subject “finance_team,” your results include messages from channels like "finance_team_project." - Field: Conversation Type Operators: Equals Description: When you use the Conversation Type property in a query, the search returns all messages that were either in a direct message or group message. Example: If you use the Group Message conversation type in a query, the search results returns messages that exist in group messages. Direct, one-on-one messages will not be included in the collection. - Field: End Date Operators: Less Than Or Equals Description: When you use the End Date property in a query, the search returns all messages the day of and before the entered date. Example: If you search a Start Date of 1/1/2001 and an End Date of 1/1/2020, the search returns all messages on and between the two dates. We recommend limiting the date range to maintain a high performance level and a lower collection time. - Field: Slice Interval in Hours Operators: Equals Description: When you use The Slice Interval in Hours property, the search returns all messages in a specific time range or defaults the slice interval to 24 hours. Example: If you search with a slice interval set to one hour and a conversation spans five hours, you will end up with five RSMFs after processing. For more information, see [RSMF Slicing](../../System_Guides/Relativity_Short_Message_Format/RSMF_Slicing.htm). - Field: Start Date Operators: Greater Than Or Equals Description: When you use the Start Date property in a query, the search returns messages that exist the day of and after the entered date. Example: If you search a Start Date of 1/1/2001 and an End Date of 1/1/2020, the search returns all messages on and between the two dates. We recommend limiting the date range to maintain a high performance level and a lower collection time. - Field: Workspace Name Operators: Equals Description: When you use the Workspace Name property, the search returns all messages in all channels within the workspace that equals the search word or phrase in the workspace's name Example: If you use the Workspace Name property in a query, the search returns all messages that the instance name equals the text you’re searching for. For example, if you search for subject “Company A,” your results include messages from that instance. ``` -------------------------------- ### Configure Okta SSO for Relativity Custodian Portal Source: https://help.relativity.com/RelativityOne/Content/index.htm/Relativity_Legal_Hold/Custodian_portal_authentication_provider This configuration guide outlines the necessary steps and field values for integrating Okta as an authentication provider for the Relativity Custodian Portal. It covers both the Okta application setup and the corresponding settings within the Custodian Portal Authentication Provider page. ```APIDOC Okta Application Setup (Applications > Applications): 1. Create a new app integration: - Sign-in method: OpenID - Application Type: Web Application Custodian Portal Authentication Provider Page Configuration: - Name: Enter a unique name. - OAuth2 Flow: Select Code. - Client ID: Copy this ID from the General tab under the Client Credentials section in Okta. - Client Secret: Copy this secret from the General tab under the Client Secrets section in Okta. - Authority URL: Copy the Authority URL from the Sign On tab in Okta (OpenID Connect ID Token section of the Issuer area, e.g., "http://customer.okta.com"). - Redirect URL: Copy the Redirect URL from Relativity to Okta. Go to the Login section in Okta and add it in the Sign-in redirect URLs section. - Subject Claim Type: - Default: http://schemas.xmlsoap.org/ws/2005/05/identity/claims/upn - If only OpenID selected in Scopes: Set to sub. - If OpenID and profile selected in Scopes: Set to a property available from the identity provider. - Claim ID Verification Field: Select Email (other options available). - Enabled: Select Yes. - Scopes: Default is openid. ``` -------------------------------- ### RelativityOne ARM Application Overview Source: https://help.relativity.com/RelativityOne/Content/index.htm/Site_Resources/Supporting_Applications Describes the Archive and Restore Relativity Workspaces (ARM) application, used for migrating workspaces between Relativity installations or SQL Servers. ```APIDOC ARM: Purpose: Archive and restore Relativity workspaces between Relativity installations or SQL Servers. ``` -------------------------------- ### Perform Silent Installation of Express Transfer via Command Line Source: https://help.relativity.com/RelativityOne/Content/index.htm/Relativity/Import_Export/Express_Transfer/Installing_Express_Transfer Install the Express Transfer desktop application without user interaction using command-line arguments. The /silent option displays the installation wizard with default selections, while /verysilent performs the installation completely hidden. This method is ideal for large enterprise deployments and requires administrator rights. ```Command Line "Express Transfer Setup.exe" /silent ``` ```Command Line "Express Transfer Setup.exe" /verysilent ``` -------------------------------- ### Resolving Application Installation Name Conflicts Source: https://help.relativity.com/RelativityOne/Content/index.htm/Relativity/Applications/Troubleshooting_application_installation_errors Procedure to resolve name conflicts during application installation by renaming the conflicting artifact or mapping fields. ```APIDOC Procedure: 1. On the Import Status page, locate the name conflict error. 2. Select an option in the 'Resolve Errors' drop-down menu (e.g., 'Rename' or 'Map Field'). 3. Perform one of the following tasks: - Rename: Enter a new, unique name in the provided field. A green check mark indicates a valid name. - Map Field: If selected, Relativity automatically maps the importing field to the conflicting field in the target workspace. 4. After resolving, click 'Retry Import'. ``` -------------------------------- ### Retrieve Distinct Edits Per Day Report Source: https://help.relativity.com/RelativityOne/Content/index.htm/Relativity/Case_Metrics/Case_Metrics Retrieves a report on the amount of distinct edits completed, grouped by day. An edit is distinct if it occurs only once on a document. For example, five edits on one document count as one Distinct Edit. This report considers 'update' and 'delete' actions and calculates the value over the number of days in the selected date range. ```APIDOC Report Name: Distinct Edits Per Day Actions Included: update, delete Grouping: Daily Distinctness: One edit per document Calculation: Over selected date range ``` -------------------------------- ### APIDOC: Integration Point Setup - General Fields Source: https://help.relativity.com/RelativityOne/Content/index.htm/Relativity/Integration_Points/Importing_data_through_Integration_Points Describes the general configuration fields for creating an Integration Point to import data, including name, type, source, destination, transferred object, and profile selection. ```APIDOC General: Name: The name of your integration for reference purposes Type: Select "Import" to designate the job as a data import. Selecting Import makes all of the possible import sources available for selection in the Source field below. Source: Select "Load File" here, since you want to import a load file into a workspace. On the Connect to Source layout, you'll have the option of specifying whether your importing a document, image, or production load file. Destination: By default, this is set to "Relativity" and is uneditable when you select Import as the type, since you've already designated that you want to import into a Relativity workspace. You'll select the specific workspace on a subsequent layout. Transferred Object: Select the specific Relativity Dynamic Object to which you want to import the data. Since you're importing the document object, select "Document" here. Profile: Complete the remaining Integration Points settings based on the settings of a saved profile. This includes all of the fields in the Connect to Source layout, as well as field mappings. If no profiles exist in the workspace, you do not have the option of selecting them. To apply a profile that you've already created, select it from the drop-down list. For more information on profiles, see [Integration Points profiles](Integration_Points_profiles.htm). ``` -------------------------------- ### Relativity Processing: Discovery Process Workflow Source: https://help.relativity.com/RelativityOne/Content/index.htm/Relativity/Processing/Discovering_files Describes the step-by-step workflow of file discovery within Relativity's processing engine, from initiating discovery to publishing files and handling errors. This outlines the system's internal operations and user interactions. ```APIDOC 1. User clicks 'Discover Files' on the processing set console. 2. Console event handler copies settings from processing profile to data sources, validates set. 3. Event handler inserts all data sources into the processing set queue. 4. Data sources wait in queue for agent pickup; priority can be changed. 5. Processing set manager agent picks up data sources by order, syncs password bank entries, submits each data source as individual discovery job to processing engine. Agent provides status updates to Relativity. 6. Processing engine discovers files, applies Inventory tab filters, sends finalized results back to Relativity, which updates reports. 7. Errors during discovery are logged in errors tabs; can be viewed and retried. 8. Discovered files can be published to workspace; auto-publish begins automatically if configured. ``` -------------------------------- ### iManage Collection Filter Criteria Reference Source: https://help.relativity.com/RelativityOne/Content/index.htm/Collect/Data_sources/iManage This section details the supported filter criteria for iManage data collections in Relativity Collect, including available operators, descriptions, and usage examples. All dates are in Coordinated Universal Time (UTC). Setting criteria is optional; if not selected, all results are collected by default. The 'Less Than' operator is only supported when used with 'Greater Than or Equals'. ```APIDOC iManage Collection Filter Criteria: - Criteria: Creation Date Operators: Greater than or equals; Less than or equals Description: When you use the Creation Date property in a query, the search returns all data that equals greater/less than the date entered. Example: If you search “Greater than or equals 1/1/2001,” your results include all emails sent on and after January 1, 2001. - Criteria: Document Class Operators: Equals Description: When you use the Document Class property, the search returns data with the entered document class. Example: If you search for a document class that equals one of your custom-defined class categories, your results will include documents only in that class. - Criteria: Document Subclass Operators: Equals Description: When you use the Document Subclass property, the search returns data with the entered document subclass. Example: If you search for a document subclass that equals one of your custom-defined subclass categories, your results will include documents only in that class. - Criteria: Edit Date Operators: Greater than or equals; Less than or equals Description: When you use the Edit Date property in a query, the search returns all data that equals greater/less than the date entered. Example: If you search “Greater Than 1/1/2001,” your results include all documents edited after January 1, 2001. - Criteria: File Extension Exclusion Operators: Equals Description: When you use the File Extension Exclusion property, the search returns data without the entered file extension. Example: If enter .csv, your results include all data that does not include .csv files. - Criteria: File Extension Inclusion Operators: Equals Description: When you use the File Extension Inclusion property, the search returns data with the entered file extension. Example: If enter .csv, your results include all data that does include .csv files. - Criteria: iManage Custom1-16 value Operators: Equals Description: When you use the iManage Custom1-16 Value properties in a query, the search returns all data that equals the entered value in its Custom 1 Property within iManage. Example: If you search for an iManage Custom1-16 value, your results will include documents that match your custom value between 1 and 16. For more information, see [iManage custom fields documentation](https://docs.imanage.com/cc-help/10.4.3/en-US/Custom_Fields.html). - Criteria: iManage Custom21-24 Value Operators: Greater than or equals; Less than or equals Description: When you use the Edit Date property in a query, the search returns all data that equals greater/less than the date entered. Example: If you search for an iManage Custom21-24 value, your results will include documents that match your custom value between 1 and 16. For more information, see [iManage custom fields documentation](https://docs.imanage.com/cc-help/10.4.3/en-US/Custom_Fields.html). - Criteria: iManage Custom25-28 Value Operators: Equals, Does Not Equal Description: When you use the iManage Custom25 Value property in a query, the search returns all data that matches the entered value in its Custom 25 Property within iManage. Example: If you search for an iManage Custom25 value, your results will include documents that match your custom value 25. For more information, see [iManage custom fields documentation](https://docs.imanage.com/cc-help/10.4.3/en-US/Custom_Fields.html). - Criteria: iManage Custom29-30 Value Operators: Equals Description: When you use the iManage Custom29-30 Value property in a query, the search returns all data that equals the entered value in its Custom 29-30 Property within iManage. Example: If you search for an iManage Custom29-30 value, your results will include documents that match your custom value between 29-30. For more information, see [iManage custom fields documentation](https://docs.imanage.com/cc-help/10.4.3/en-US/Custom_Fields.html). ``` -------------------------------- ### Required Configuration for Collect Data Sources Source: https://help.relativity.com/RelativityOne/Content/index.htm/System_Guides/User_quick_reference/Collect/Collect_QRG This section outlines the specific configuration parameters required for each supported cloud-based data source when setting up the Collect application in Relativity. These details must be obtained from the respective data source administrators to ensure successful data collection. ```APIDOC Microsoft 365 Mail: - Domain - Application ID - Application Secret Microsoft 365 OneDrive: Microsoft 365 Contacts: Microsoft 365 Calendar: Microsoft 365 Teams: Microsoft 365 Archived Mail: Microsoft 365 SharePoint: X1 Emails: - X1 Enterprise Manager Endpoint URL - X1 Enterprise Manager Endpoint Port - X1 Downloader API Endpoint URL - X1 Downloader API Endpoint Port - Client ID - Client Secret - Project ID - Project Path - Target External ID - Certificate Thumbprint X1 Files: Slack: - Temporary Code - Access Token Google Mail: - Temporary Code - Client ID - Client Secret - Refresh Token Google Chat: Google Drive: Google Groups: Bloomberg Chat: - Host - Path - Username - Password - Pass Phrase - PGP Key Bloomberg Email: Box: - Client ID - Client Secret - Public Key ID - Private Key - Passphrase - Enterprise ID iManage: - Client ID - Client secret - Username - Password - Library ID - iManage Base address Refinitiv Eikon: - Host - Port - Path - Username - Password ChatGPT: - API Key - Workspace ID Cellebrite: - Client ID - Client Secret - Relativity Domain - API Key - API User Name - API URL ``` -------------------------------- ### Resolving Application Installation Locking Conflicts Source: https://help.relativity.com/RelativityOne/Content/index.htm/Relativity/Applications/Troubleshooting_application_installation_errors Procedure to resolve locking conflicts during application installation. This temporarily unlocks the application for import, then re-locks it upon successful completion. ```APIDOC Procedure: 1. On the Import Status page, locate the locking conflict error. 2. Select the 'Unlock' checkbox associated with the error. 3. Click 'Retry Import'. Note: Relativity will re-lock the application automatically after a successful import. ``` -------------------------------- ### Relativity Integration Points: FTP/SFTP Source Connection Configuration Source: https://help.relativity.com/RelativityOne/Content/index.htm/Relativity/Integration_Points/Importing_data_through_Integration_Points Provides detailed documentation for configuring the "Connect to Source" layout in Relativity Integration Points, covering connection parameters for FTP/SFTP servers and file path specifications, including wildcard usage for CSV files. ```APIDOC Connect to Source Layout Fields: Connection Information: Host: string Description: The FTP or SFTP server address (e.g., filetransfer.example.com). Protocol: enum (FTP, SFTP) Description: Select the FTP or SFTP protocol. Port: integer Description: The server port to connect to. Default FTP: 21, SFTP: 22. Standard network ports 21 or 22 should be open on both RelativityOne and FTP server for outgoing connections from RelativityOne's Web and Agent servers and for listening (FTP server). Username: string (optional) Description: The username to use for authentication. If left blank, Integration Points will use "anonymous". Password: string (optional) Description: The associated password to use for authentication. If left blank, Integration Points will use "anonymous". File Information: CSV Filepath: string Description: The location of the .csv file that Integration Points imports from the FTP/SFTP server. Supports date wildcards so that Integration Points always imports the latest file. Example: /export/nightlyexport/*yyyy*-*MM*-*dd*_HRIS_export.csv Wildcard Rules: - Wildcards are case sensitive. - The wildcard feature only pulls data from a file name with the current date. - You can also use hh:MM:ss for hours, minutes, and seconds, with capital M's for minutes. When using times, only file names within the last hour are found. ``` -------------------------------- ### Meeting Start Time Field Source: https://help.relativity.com/RelativityOne/Content/index.htm/Relativity/Processing/Mapping_processing_fields Documents the 'Meeting Start Time' standard field, which records the time at which a meeting item in Outlook or Lotus Notes started. This field is of 'Long Text' type. ```APIDOC Meeting Start Time: Type: Long Text Description: The time at which a meeting item in Outlook or Lotus Notes started. Example: 11:59 PM ``` -------------------------------- ### Meeting Start Date Field Source: https://help.relativity.com/RelativityOne/Content/index.htm/Relativity/Processing/Mapping_processing_fields Documents the 'Meeting Start Date' standard field, which records the date on which a meeting item in Outlook or Lotus Notes started. This field is of 'Long Text' type. ```APIDOC Meeting Start Date: Type: Long Text Description: The date on which a meeting item in Outlook or Lotus Notes started. Example: 12/24/2015 ```