---
title: "Importing data through Integration Points"
description: "Integration Points provides you with the ability to import data directly into your workspace through the same functionality that the Relativity Desktop Client (RDC) provides for importing the document object."
feature: "Integration Points"
audience: ["end user", "developer", "system analyst", "system administrator", "system engineer"]
version: "Relativity aiR"
type: ["User Guide", "Tutorial"]
tocPath: "Features|Data transfer|Integration Points"
url: "https://help.relativity.com/RelativityaiR/Content/Relativity/Integration_Points/Importing_data_through_Integration_Points.htm"
lastModified: "2026-10-29"
---

# Importing data through Integration Points

> **Note:** We’ve streamlined our Staging boundaries to more effectively separate staging data from workspace and system data. With this change, you can no longer write to or access data outside of the four defined staging area folders. The four defined staging area folders: *ARM*, *ProcessingSource*, *StructuredData*, and *TenantVM*.  
> Folders removed in the update include *FTA*, *Temp*, *Export*, and *dtSearch*. In addition to any other folders you manually created. Refer to the [Staging Area](https://help.relativity.com/RelativityaiR/Content/Relativity/Staging_Area.md) topic and [Staging Area FAQ](https://community.relativity.com/s/article/Staging-Area-FAQ?) in Community for more details.

Integration Points provides you with the ability to import a .csv file, LDAP, or load file directly into your workspace, and schedule future or recurrent import jobs.

> **Note:** This documentation contains references to third-party software, or technologies. While efforts are made to keep third-party references updated, the images, documentation, or guidance in this topic may not accurately represent the current behavior or user interfaces of the third-party software. For more considerations regarding third-party software, such as copyright and ownership, see [Terms of Use](https://www.relativity.com/terms-of-use/).

## Considerations

Consider the following before importing data through Integration Points:

- Although importing and exporting a load file is still possible in Integration Points, this functionality will be deprecated in the near future. For continued stability and efficiency, [Import/Export](https://help.relativity.com/RelativityaiR/Content/Relativity/Import_Export/Import_Export_Overview.md) is the recommended application for load file imports and exports going forward.
- All integration points jobs are fully editable after run.
- Changing root folder permissions during import is not a supported workflow.

## Creating an import Integration Point

The general workflow for creating Integration Points to import data are listed below. For specific details and parameters surrounding each type of integration point you need to create, refer to the other sections in this topic:

1. Navigate to **Integration Points** in your workspace.
2. On the Integration Points tab, click **New Integration Point**.
3. Set up the new integration point parameters.
4. Connect to the data source by setting up the connection parameters.
5. Map the import fields.
6. Click **Save**.

Once you save the integration point, you can run the import job. For more information, see [Manually running the import job](#Running).

### Import sources

With Integration Points, you can import data from the following sources:

- [FTP, .csv file](#Importin)
- [LDAP](#Importin2)
- [Document load file](#Importin3)
- [Image load file](#Importin5)
- [Production load file](#Importin6)
- [Microsoft Entra ID](#ImportingMSAzureAD)

## Importing a .csv file

<details>
<summary>See the steps for importing a CSV file</summary>

> **Note:** Opening a new port for your Relativity aiR instance will require a Security assessment.

### Setup

To create an integration point for importing an FTP (CSV file), begin by configuring the Setup parameters.

1. Complete the fields in the **Setup** layout:  
   ![Setup](https://help.relativity.com/RelativityaiR/Content/Resources/Images/Features/Integration_Points/SCR_ImportFTP.png)  
   **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 **FTP (CSV File)** to sync to a custodian list on an FTP Server to automatically update custodian information in your workspace. We strongly recommend using a secured FTP server and not using anonymous authentication.
   - **Destination**—by default, this is set to **Relativity** and is uneditable when you select Import as the type, since you have already designated that you want to import into a Relativity workspace. You will select the specific workspace on a subsequent layout.
   - **Transferred Object**—select the specific Relativity Dynamic Object to which you want to import the data. If you are importing the entity object, select **Entity** 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 have already created, select it from the drop-down list. For more information on profiles, see [Integration Points profiles](https://help.relativity.com/RelativityaiR/Content/Relativity/Integration_Points/Integration_Points_profiles.md).

   **Advanced:**
   - **Email Notification Recipients**—enter the email addresses of those who should receive notifications of whether the integration point export succeeded or failed. Use semi colons between addresses.
   - **Log Errors**—select **Yes** or **No** to denote whether Relativity tracks item level errors.
     - If you select **Yes**, each job also logs any item level errors.
     - If you select **No**, Relativity doesn't log these item level errors.
     - Regardless of your selection, job-level errors are always recorded in Relativity.

   **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.
2. Click **Next** to advance to the Connect to Source layout.

### Connect to source

Continue to create your import integration point by connecting Relativity to the data source by following the steps below.

1. In the **Connect to Source** layout, complete the following fields:  
   ![Connect to source](https://help.relativity.com/RelativityaiR/Content/Resources/Images/Features/Integration_Points/SCR_ConnectSourceFTP.png)  
   **Connection Information:**
   - **Host**—the FTP (File Transfer Protocol) or SFTP (SSH File Transfer Protocol) server address. For example, *filetransfer.example.com*. If Relativity cannot locate this address, you will receive an error stating that the remote could not be resolved, and you will not be able to proceed.
   - **Protocol**—select the FTP or SFTP protocol.
   - **Port**—the server port to which you want to connect. The FTP protocol default Port number is 21. The SFTP protocol default Port number is 22. The standard network ports 21 or 22 should be open on both Relativity aiR and FTP server for outgoing connections from Relativity aiR's Web and Agent servers and for listening (FTP server). Some firewall solutions may impact the connectivity between Relativity aiR and the FTP server.

     > **Note:** If you need to open any port, please contact [Relativity Support](https://community.relativity.com/s/contactsupport) and allow at least three days to respond. Opening a new port for your Relativity aiR instance requires a Security assessment. To successfully import an FTP (CSV file), the standard network ports should be open on both Relativity aiR and FTP server for outgoing connections from Relativity aiR's Web and Agent servers and for listening (FTP server). Note that the firewall solutions may impact the connectivity between Relativity aiR and the FTP server.
   - **Username**—(Optional) the username to use for authentication. If left blank, Integration Points will use "anonymous."
   - **Password**—(Optional) the associated password to use for authentication. If left blank, Integration Points will use "anonymous."

   **File Information:**
   - **CSV Filepath**—the location of the .csv file that Integration Points imports from the FTP/SFTP server. If you set the generated .csv file to always include the date, you can specify this file path value to use date wildcards so that Integration Points always imports the latest file. For example, the following file path will import the most recently dated file:  
     */export/nightlyexport/\*yyyy\*-\*MM\*-\*dd\*\_HRIS_export.csv*
     - 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.
2. Click **Next** to advance to the Map Fields layout, which contains a list of Relativity fields from their destination RDO as well as attributes that the source provider pulled back.

### Map fields

Map the attributes or fields so that Integration Points imports the targeted data into specific Relativity fields.

1. In the **Map Fields** wizard, you have the following options for mapping fields:
   - Click the **Map All Fields** button to automatically map all Source fields with matching Destination field names, except single and multiple object fields.
   - Use the Shift+click and Ctrl+click method to select multiple fields at a time.
   - Use the single and double arrow buttons or double-click a field to move the selected fields between columns.
   - If you have Destination Fields that are mapped to fields in the Field Catalog, Relativity tries to find name matches between these Catalog Fields, as well.
   - The field names in the Destination columns include the type of each field listed.  
     When mapping fields, here are some issues to note:
   - If the WebAPIPath instance setting in kCura.IntegrationPoints is not configured correctly after upgrade or installation, the Source Fields list will be empty because it cannot return any attributes. As a result, you cannot map fields.
   - When importing the Entity object:
     - You need to map the First Name and Last Name fields. In case the Full Name field is not being mapped, those two fields are combined for the Full Name value, which is then written to the Entity object.
     - You can link the imported entity to a manager if the manager also exists in the entity database. To proceed with linking them, you must map the Manager field on the Field Mappings page. Previously this was done via the Entity Manager Contains Link option, which has been deprecated.
     - We recommend setting the Unique Identifier field to UniqueID.  
       ![Map Fields](https://help.relativity.com/RelativityaiR/Content/Resources/Images/Features/Integration_Points/SCR_MappingFields_CSV_LDAP.png)
2. Complete the following import Settings on the **Map Fields** layout:
   - **Overwrite**— determines how the system overwrites records once you promote data to the review workspace. This field provides the following choices:
     - **Append Only**—promote only new records into the review workspace.
     - **Overlay Only**—update existing records only in the review workspace. Any documents with the same workspace identifier are overlaid. This field acts as a link indicating to Relativity where to import the data. When you select this or Append/Overlay, you must complete the Multi-Select Field Overlay Behavior field described below.
     - **Append/Overlay**—adds new records to the review workspace and overlays data on existing records. When you select this or Overlay Only, you must complete the Multi-Select Field Overlay Behavior field described below.
   - **Multi-Select Field Overlay Behavior**—determines how the system overlays records when you promote documents to the review workspace. This field is only available if you have selected either Overlay Only or Append/Overlay above. This field provides the following choices:
     - **Merge Values**—merges all values for multi-choice and multi-object fields in the source data with corresponding multi-choice and multi-option fields in the workspace, regardless of the overlay behavior settings in the environment.
     - **Replace Values**—replaces all values for multi-choice and multi-object fields in the source data with corresponding multi-choice and multi-option fields in the workspace, 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 source data with corresponding multi-choice and multi-option fields in the workspace according to the overlay behavior settings in the environment.
   - **Unique Identifier**—this option is only available when the Overwrite mode is set to Overlay Only.
     - Enter a unique value that no other item in the workspace contains. For example, use the GUID or distinguishedName attribute.
     - If the value is not unique in the workspace, it may lead to unintentional overwriting of existing data.

       > **Note:** We recommend setting the Unique Identifier field to UniqueID. Using a name field can cause an error because there is the possibility of having two custodians with the same name.
3. Click **Save** to save the Integration Point.

Once you save the Integration Point, you can run the import job. For more information, see [Manually running the import job](#Running).

</details>

## Importing LDAP

<details>
<summary>See the steps for importing LDAP</summary>

Before importing LDAP (Lightweight Directory Access Protocol), the Integration Points LDAP Provider needs to be connected to the LDAP server. To connect successfully, open the standard network ports for both Relativity aiR and the LDAP Server for outgoing connections from Relativity aiR's Web and Agent servers and for listening (LDAP Server). To connect these ports, contact [Relativity Support](https://community.relativity.com/s/contactsupport).

> **Note:** To successfully connect Integration Points LDAP Provider to the LDAP server, the standard network ports should be open on both Relativity aiR and the LDAP Server for outgoing connections from Relativity aiR's Web and Agent servers and for listening (LDAP Server). LDAP connection requires using 636 (Secure Socket Layer) network ports. Custom ports are not supported and may not work correctly. Please be aware that firewall solutions may impact the connectivity between Relativity aiR and LDAP server.

### Setup

To create an integration point for importing LDAP:

1. In the **Setup** layout, complete the following fields:  
   ![Setup](https://help.relativity.com/RelativityaiR/Content/Resources/Images/Features/Integration_Points/SCR_ImportLDAP.png)  
   **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 **LDAP** here, since you want to import data from a Lightweight Directory Access Protocol source. For example, use this source provider to import an organization's people directory.
   - **Destination**—by default, this is set to **Relativity** and is uneditable when you select Import as the type.
   - **Transferred Object**—select the specific Relativity Dynamic Object to which you want to import the data. It is typical to use the LDAP source to sync the Entity object.
   - **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 have already created, select it from the drop-down list. For more information on profiles, see [Integration Points profiles](https://help.relativity.com/RelativityaiR/Content/Relativity/Integration_Points/Integration_Points_profiles.md).

   **Advanced:**
   - **Email Notification Recipients**—enter the email addresses of those who should receive notifications of whether the integration point export succeeded or failed. Use semi colons between addresses.
   - **Log Errors**—select **Yes** or **No** to denote whether Relativity tracks item level errors.
     - If you select **Yes**, each job also logs any item level errors.
     - If you select **No**, Relativity doesn't log these item level errors.
     - Regardless of your selection, job-level errors are always recorded in Relativity.

   **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.
2. Click **Next** to advance to the Connect to Source layout.

### Connect to source

Continue create your import integration point by connecting Relativity to the data source. Follow the steps below.

1. In the **Connect to Source** layout complete the following fields:  
   ![Connect to source](https://help.relativity.com/RelativityaiR/Content/Resources/Images/Features/Integration_Points/SCR_ConnectLDAP.png)
   - **Connection Path**—the URL used to locate the directory. For example, “Relativity.com.” You will need to add **636** to the URL to access that port. Also, note that you can optionally include specific organizational unit references by adding a forward slash (/) after the server. The following example looks up items in the Relativity.com domain within the Employees organizational unit:ldap.*Relativity.com:636/OU=Employees,OU=Accounts,OU=Relativity,DC=Relativity,DC=corp*

     > **Note:** Contact [Relativity Support](https://community.relativity.com/s/contactsupport) to open port 636.
   - **Object Filter String**—this string specifies certain attributes that the requested LDAP entries must contain that Integration Points considers for import. For example, if you want to import users, you would use an object filter string such as *(objectClass=user)*. For more information on search filter syntax, refer to this Microsoft article: [Search Filter Syntax](https://docs.microsoft.com/en-us/windows/win32/adsi/search-filter-syntax).
   - **Authentication**—Secure Socket Layer is the only applicable authentication type for port 636.
   - **Username**—if required by the server’s authentication, enter a username to connect to the server (connection path). For external SaaS LDAP instances, the username may need to include user ID (UID), organization unit (ou), organization's distinguished name (o) and the connection path:  
     *uid=johndoe,ou=Users,o=6065d44947314c4eb10ca904,dc=somesaasldap,dc=com*
   - **Password**—if required by the server’s authentication, you can enter a password to connect to the server (connection path).
   - **Import Nested Items**—select **Yes** for the import to include all sub directories in the specified connection path. Select **No** for the import to include only the first level items brought back in the connection path.

2. Click **Next** to advance to the Map Fields layout, which contains a list of Relativity fields from their destination RDO as well as attributes that the source provider pulled back.

### Map fields

Map the attributes or fields so that Integration Points imports the targeted data into specific Relativity fields.

1. In the **Map Fields** wizard, you have the following options for mapping fields:
   - Click the **Map All Fields** button to automatically map all Source fields with matching Destination field names, except single/multiple object fields.
   - Use the Shift+click and Ctrl+click method to select multiple fields at a time.
   - Use the single and double arrow buttons or double-click a field to move the selected fields between columns.
   - If you have Destination Fields that are mapped to fields in the Field Catalog, Relativity tries to find name matches between these Catalog Fields, as well.
   - The field names in the Destination columns include the type of each field listed.

   When mapping fields, here are some issues to note:
   - If the WebAPIPath instance setting in kCura.IntegrationPoints is not configured correctly after upgrade or installation, the Source Fields list will be empty because it cannot return any attributes. As a result, you cannot map fields.
   - When importing the Entity object:
     - You need to map the First Name and Last Name fields. In case the Full Name field is not being mapped, those two fields are combined for the Full Name value, which is then written to the Entity object.
     - You can link the imported entity to a manager if the manager also exists in the entity database. To proceed with linking them, you must map the Manager field on the Field Mappings page. Previously this was done via the Entity Manager Contains Link option, which has been deprecated.

![Map Fields](https://help.relativity.com/RelativityaiR/Content/Resources/Images/Features/Integration_Points/SCR_MappingFields_CSV_LDAP.png)
2. Complete the following import Settings on the **Map Fields** layout:
   - **Overwrite**—determines how the system overwrites records once you promote data to the review workspace. This field provides the following choices:
     - **Append Only**—promote only new records into the review workspace.
     - **Overlay Only**—update existing records only in the review workspace. Any documents with the same workspace identifier are overlaid. This field acts as a link indicating to Relativity where to import the data. When you select this or Append/Overlay, you must complete the Multi-Select Field Overlay Behavior field described below.
     - **Append/Overlay**—adds new records to the review workspace and overlays data on existing records. When you select this or Overlay Only, you must complete the Multi-Select Field Overlay Behavior field described below. You are able to create folders or re-folder documents when you select Append/Overlay.

   - **Multi-Select Field Overlay Behavior**—determines how the system will overlay records when you push documents to the review workspace. This field is only available if you have selected either Overlay Only or Append/Overlay above. This field provides the following choices:
     - **Merge Values**—merges all values for multi-choice and multi-object fields in the source data with corresponding multi-choice and multi-option fields in the workspace, regardless of the overlay behavior settings in the environment.
     - **Replace Values**—replaces all values for multi-choice and multi-object fields in the source data with corresponding multi-choice and multi-option fields in the workspace, 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 source data with corresponding multi-choice and multi-option fields in the workspace according to the overlay behavior settings in the environment.

   - **Unique Identifier**—this option is only available when the Overwrite mode is set to Overlay Only. Enter a unique value that no other item in the workspace contains. For example, use the GUID or distinguishedName attribute. If the value is not unique in the workspace, it may lead to unintentional overwriting of existing data.

3. Click **Save** to save the Integration Point.

Once you save the Integration Point, you can run the import job. For more information, see [Manually running the import job](#Running).

</details>

## Importing a document load file

<details>
<summary>See the steps for importing a document load file</summary>

> **Note:** Before creating an integration point to import a load file, you must first place the load data in the \\\\Fileshare\\StructuredData folder. Otherwise, you will not be able to select that data for the Import Source field.

### Setup

To create an integration point for importing a document load file, follow the steps below.

1. In the **Setup** layout, complete the following fields:

   ![Setup](https://help.relativity.com/RelativityaiR/Content/Resources/Images/Features/Integration_Points/SCR_ImportLoadFile.png)

**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](https://help.relativity.com/RelativityaiR/Content/Relativity/Integration_Points/Integration_Points_profiles.md).

**Advanced:**
- **Email Notification Recipients**—enter the email addresses of those who should receive notifications of whether the integration point export succeeded or failed. Use semi colons between addresses.
- **Log Errors**—select **Yes** or **No** to denote whether Relativity tracks item level errors.
  - If you select **Yes**, each job also logs any item level errors.
  - If you select **No**, Relativity doesn't log these item level errors.
  - Regardless of your selection, job-level errors are always recorded in Relativity.

**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.

2. Click **Next** to advance to the Connect to Source layout.

### Connect to source

Continue to create your import integration point by connecting Relativity to the data source. Follow the steps below.

1. In the **Connect to Source** layout complete the following fields.

   **![Connect to source](https://help.relativity.com/RelativityaiR/Content/Resources/Images/Features/Integration_Points/SCR_DocLoadFileMarch95.png)**

**Load File Settings:**

- **Import Type**—select the type of load file you'd like to import to the workspace. Select **Document Load File** from the drop-down list.
- **Workspace Destination Folder**—select the specific folder within the destination workspace in which you want to place the documents you are importing. The folder tree you see when you click this drop-down menu is identical to the folder structure in the destination workspace.
- **Import Source**—click the down arrow and select a load file from the workspace's DataTransfer import location in the fileshare.
  - These locations are hard-coded into Relativity and cannot be changed. You cannot load or export data to a different location than is listed here.
  - For reference purposes, the folder(s) displayed in the Import Source field actually reside in the following generic path: \\\\Fileshare\\StructuredData. Accordingly, when an admin adds data to the Import folder inside the DataTransfer folder inside the folder displaying the workspace's artifact ID, that data then becomes available for selection in the Import Source field.
   - **Start Line**—select the line number in the load file where you want the import process to begin. The default value is 1, which results in loading the entire file.

**File Encoding:**

- **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 language other than English, choose a Unicode option. Note the following details about encoding:
  - Relativity immediately applies any changes that you make to the encoding of a load file, and displays these changes in the column header preview.
  - Relativity provides you with the ability to audit the encoding of a load file.
- **Column**—select the character used to separate columns.
- **Quote**—select the character used as the text qualifier.
- **Newline**—select the character used to indicate the end of a line in any extracted text or long text field.
- **Multi-Value**—select the character used to separate choices within a field.
- **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
- **File Column Headers**—displays the load file's column headers. Relativity automatically updates this section of the Load File tab when you select the file encoding. Note the following details about file column headers:
  - After you select an 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.

2. Click **Next** to advance to the Map Fields layout, which contains a list of Relativity fields from their destination RDO as well as attributes that the source provider pulled back.

### Map fields

Map the attributes or fields so that Integration Points imports the targeted data into specific Relativity fields.

1. In the **Map Fields** wizard, you have the following options for mapping fields:
   - Click the **Map All Fields** button to automatically map all Source fields with matching Destination field names, except single/multiple object fields.
   - Use the Shift+click and Ctrl+click method to select multiple fields at a time.
   - Use the single and double arrow buttons or double-click a field to move the selected fields between columns.
   - If you have Destination Fields that are mapped to fields in the Field Catalog, Relativity tries to find name matches between these Catalog Fields, as well.
   - The field names in the Destination columns include the type of each field listed.

   When mapping fields, here are some issues to note:
   - If the WebAPIPath instance setting in the kCura.IntegrationPoints section is not configured correctly after upgrade or installation, the Source field list is empty because it cannot return any attributes, and you are not able to map fields.
   - When the load file data is being imported to Entity RDO, then **Full Name**, **First Name** and **Last Name** fields in the destination workspace must be mapped.

   ![Map fields](https://help.relativity.com/RelativityaiR/Content/Resources/Images/Features/Integration_Points/SCR_ImportDocLoadFile_MapFields.png)
2. Complete the following import Settings on the **Map Fields** layout:
   - **Overwrite**—determines how the system overwrites records once you promote data to the review workspace. This field provides the following choices:
     - **Append Only**—promote only new records into the review workspace.
     - **Overlay Only**—update existing records only in the review workspace. Any documents with the same workspace identifier are overlaid. This field acts as a link indicating to Relativity where to import the data. When you select this or Append/Overlay, you must complete the Multi-Select Field Overlay Behavior field described below.
     - **Append/Overlay**—adds new records to the review workspace and overlays data on existing records. When you select this or Overlay Only, you must complete the Multi-Select Field Overlay Behavior field described below. You are able to create folders or re-folder documents when you select Append/Overlay.

   - **Multi-Select Field Overlay Behavior**—determines how the system will overlay records when you push documents to the review workspace. This field is only available if you've selected either Overlay Only or Append/Overlay above. This field provides the following choices:
     - **Merge Values**—merges all values for multi-choice and multi-object fields in the source data with corresponding multi-choice and multi-option fields in the workspace, regardless of the overlay behavior settings in the environment.
     - **Replace Values**—replaces all values for multi-choice and multi-object fields in the source data with corresponding multi-choice and multi-option fields in the workspace, 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 source data with corresponding multi-choice and multi-option fields in the workspace according to the overlay behavior settings in the environment.
   - **Copy Native Files**—this Yes/No field is only visible when you select the Documents RDO, and lets you indicate whether Integration Points should import any native files in the sync.
     - **Native File Path**—this field appears if you select Yes to import the native files. From the drop-down menu, select the source provider attribute containing the file path links to the natives that you want to import.
   - **Use Folder Path Information**—use a metadata field to build the folder structure for the documents that you promote to the review workspace.
     - Select **Yes** to use a metadata field to build the folder structure for the documents that you promote to the review workspace. Selecting Yes makes the Folder Path Information field required below.
     - Select **No** if you do not want to build a folder structure based on metadata. In this case, Relativity loads all documents directly into the folder indicated by the promote destination, and you create no new folders in the destination workspace.
     - You have the option of creating folders or re-foldering documents when you select Append/Overlay for the Overwrite field.
     - You have the option of re-foldering documents for the Overwrite field through the Move Existing Documents field below.

   - **Folder Path Information**—specify a metadata field to build the folder structure for the documents that you promote to the review workspace. For the purposes of ECA and Investigation, select the **Processing Folder Path** option.
   - **Move Existing Documents**—re-folder documents that were previously imported into the destination workspace, but were only placed in the root case folder and not to any subfolders. This field is useful for situations in which you want to add new data to the destination workspace while overlaying existing data.
     - Select **Yes** to move existing documents into the folders provided in the previous **Folder Path Information** field. For example, you previously imported custodian Sally Smith's files into the destination workspace's root folder. Now, in addition to placing the documents from the saved search specified in this integration point in their subfolder, you also want to move those previously migrated documents into Sally Smith's subfolder, so you would select Yes.
     - Select **No** if you do not want to re-folder existing documents.
   - **Extracted Text**—select the destination field that is mapped to a path to Extracted Text files. The content of these files will be read into the selected field. Note that only Long Text destination fields that are mapped will show up as options in the Extracted Text drop-down. You can select an encoding type for the extracted text files as well.
   - **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.
   - **Encoding for undetectable files**—select an encoding for the text file.
   - **Entity Manager Contains Link**—this Yes/No field is visible for all import sources when the Entity RDO is selected as the destination of the imported data. Some import sources populate the manager field with a link to the manager’s profile on their internal system. Set this field to **No** if the Document Load File source is selected.
3. Click **Save** to save the Integration Point.

Once you save the Integration Point, you can run the import job. For more information, see [Manually running the import job](#Running).

</details>

## Importing an image load file

<details>
<summary>See the steps for importing an image load file</summary>

> **Note:** Before creating an integration point to import a load file, you must first place the load data in the \\\\Fileshare\\StructuredData folder. Otherwise, you will not be able to select that data for the Import Source field.

### Setup

To create an integration point for importing an image load file, perform the following steps:

1. In the **Setup** layout, complete the following fields:  
   ![Setup](https://help.relativity.com/RelativityaiR/Content/Resources/Images/Features/Integration_Points/SCR_ImportLoadFile.png)

**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](https://help.relativity.com/RelativityaiR/Content/Relativity/Integration_Points/Integration_Points_profiles.md).

**Advanced:**
- **Email Notification Recipients**—enter the email addresses of those who should receive notifications of whether the integration point export succeeded or failed. Use semi colons between addresses.
- **Log Errors**—select **Yes** or **No** to denote whether Relativity tracks item level errors.
  - If you select **Yes**, each job also logs any item level errors.
  - If you select **No**, Relativity doesn't log these item level errors.
  - Regardless of your selection, job-level errors are always recorded in Relativity.

**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.

2. Click **Next** to advance to the Source Information layout.

### Source information

Continue create your import integration point by connecting adding the source information. Follow the steps below.

1. In the **Source Information** layout, complete the following fields.  
   ![Source information](https://help.relativity.com/RelativityaiR/Content/Resources/Images/Features/Integration_Points/SCR_ImageLoadFile-ImportType.png)

**Load File Settings:**

- **Import Type**—select the type of load file you'd like to import to the workspace. Select **Image Load File** from the drop-down list.
- **Workspace Destination Folder**—select the specific folder within the destination workspace in which you want to place the documents you're importing. The folder tree you see when you click this drop-down menu is identical to the folder structure in the destination workspace.
- **Import Source**—click the down arrow and select a load file from the workspace's DataTransfer import location in the fileshare.
  - These locations are hard-coded into Relativity and cannot be changed. You cannot load or export data to a different location than is listed here.
  - For reference purposes, the folder(s) displayed in the Import Source field actually reside in the following generic path: \\\\Fileshare\\StructuredData. Accordingly, when an admin adds data to the Import folder inside the DataTransfer folder inside the folder displaying the workspace's artifact ID, that data then becomes available for selection in the Import Source field.
   - **Start Line**—select the line number in the load file where you want the import process to begin. The default value is 1, which results in loading the entire file.

**Import Settings:**

- **Numbering**—determines the numbering scheme of the images you're importing.
  - **Use load file page IDs**—select this to use the default setting to number the images, which is the control number.
  - **Auto-number pages**—select this option if page IDs in the production or image load file 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.
- **Import Mode**
  - **Append Only**—select this to load only new records. Select this option to import the extracted text and natives from a .dat file.
  - **Overlay Only**—select this to update existing records only. When you select this, the required Overlay Identifier field appears below This field acts as a link indicating to Relativity where to import the data. Select this option when overlaying production images onto the existing documents.
  - **Append/Overlay**—select this to add new records and overlay data on existing records.
- **Overlay Identifier**—select a field that stores overlaid document-level Bates information on the document. This is only available if you selected Overlay Only for the import mode.
- **Copy Files to Document Repository**—determines whether Relativity copies files from the location in the image load file field to the workspace's default document repository.
  - **Yes**—copies files to the workspace's default document repository automatically.
  - **No**—select this if the native files already reside in a location that Relativity can access.
- **File Repository**—select the file repository to which you want to copy the files in the image load file. This field is only visible if you selected Yes for the Copy Files to Document Repository field above. Click **Default** to switch this value to the default file repository used by the workspace.
- **Load Extracted Text** - determines whether or not Relativity will load new text for Production documents that may be revised based on redactions.
  - The text files must have .txt extensions, be stored in the same directory as the TIFF files, and be named in the same as the TIFF files.
  - This field is only available for image load files.
  - When you select this, the required Encoding for undetectable files field appears below.
   - **Encoding for undetectable files**—select an encoding for the new text file that Relativity loads, per your enabling of the Load Extracted Text field above.

2. Click **Save** to save the Integration Point.

Once you save the Integration Point, you can run the import job. For more information, see [Manually running the import job](#Running).

</details>

## Importing a production load file

<details>
<summary>See the steps for importing a production load file</summary>

> **Note:** Before creating an integration point to import a load file, you must first place the load data in the \\\\Fileshare\\StructuredData folder. Otherwise, you will not be able to select that data for the Import Source field.

### Setup

To create an integration point specifically for importing a production load file, follow the steps below.

1. In the **Setup** layout, complete the following fields:

   ![setup](https://help.relativity.com/RelativityaiR/Content/Resources/Images/Features/Integration_Points/SCR_ImportLoadFile.png)

**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](https://help.relativity.com/RelativityaiR/Content/Relativity/Integration_Points/Integration_Points_profiles.md).

**Advanced:**
- **Email Notification Recipients**—enter the email addresses of those who should receive notifications of whether the integration point export succeeded or failed. Use semi colons between addresses.
- **Log Errors**—select **Yes** or **No** to denote whether Relativity tracks item level errors.
  - If you select **Yes**, each job also logs any item level errors.
  - If you select **No**, Relativity doesn't log these item level errors.
  - Regardless of your selection, job-level errors are always recorded in Relativity.

**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.

2. Click **Next** to advance to the Connect to Source layout.

### Source information

Continue create your import integration point by connecting adding the source information. Follow the steps below.

1. In the **Source Information** layout complete the following fields.  
   ![Setup](https://help.relativity.com/RelativityaiR/Content/Resources/Images/Features/Integration_Points/SCR_ProductionLoadFile.png)

**Load File Settings:**

- **Import Type**—select the type of load file you'd like to import to the workspace. Select **Production Load File** from the drop-down list.
- **Workspace Destination Folder**—select the specific folder within the destination workspace in which you want to place the documents you are importing. The folder tree you see when you click this drop-down menu is identical to the folder structure in the destination workspace.
- **Import Source**—click the down arrow and select a load file from the workspace's DataTransfer import location in the fileshare.
  - These locations are hard-coded into Relativity and cannot be changed. You cannot load or export data to a different location than is listed here.
  - For reference purposes, the folder(s) displayed in the Import Source field actually reside in the following generic path: \\\\Fileshare\\StructuredData. Accordingly, when an admin adds data to the Import folder inside the DataTransfer folder inside the folder displaying the workspace's artifact ID, that data then becomes available for selection in the Import Source field.
   - **Start Line**—select the line number in the load file where you want the import process to begin. The default value is 1, which results in loading the entire file.

**Import Settings:**

The following fields are only available if you selected Image or Production Load File for the Import Type field above.

- **Numbering**—determines the numbering scheme of the production you're importing.
  - **Use load file page IDs**—select this to use the default setting to number the production, which is the control number.
  - **Auto-number pages**—select this option if page IDs in the production or image load file 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. Auto-numbering pages is useful if you are importing productions or image load files that use document-level numbering without page numbers, and include documents that contain multiple pages.
- **Import Mode**
  - **Append Only**—select this to load only new records. Select this option to import the extracted text and natives from a .dat file.
  - **Overlay Only**—select this to update existing records only. When you select this, the required Overlay Identifier field appears below This field acts as a link indicating to Relativity where to import the data. Select this option when overlaying production images onto the existing documents.
  - **Append/Overlay**—select this to add new records and overlay data on existing records.
- **Overlay Identifier**—if you selected Overlay Only for the import mode, select a field that stores overlaid document-level Bates information on the document.
- **Copy Files to Document Repository**—determines whether or not Relativity will copy files from the location in the image load file field to a selected document repository.
  - **Yes**—copies files to the workspace's default document repository automatically.
  - **No**—select this if the native files already reside in their final location, which is accessible by Relativity.
   - **Production**—select a Relativity production that you want to upload images to. Only new production sets without a production source appear in this list.

2. Click **Save** to save the Integration Point.

Once you save the Integration Point, you can run the import job. For more information, see [Manually running the import job](#Running).

</details>

## Importing from Microsoft Entra ID

> **Note:** Microsoft has renamed Azure Active Directory (Azure AD) to Microsoft Entra ID. This site has been updated to reflect the name change, where applicable. Refer to [Microsoft documentation](https://learn.microsoft.com/en-us/entra/fundamentals/new-name) for more information.

<details>
<summary>See information on importing from Microsoft Entra ID</summary>

The Integration Points Microsoft Entra ID Provider is a separate and standalone application that can be downloaded from the [Relativity Community](https://community.relativity.com/s/contentdocument/0691T000005CE6lQAG). For more information, see [Microsoft Entra ID provider](https://help.relativity.com/RelativityaiR/Content/Relativity/Integration_Points/Azure_AD_provider.md).

You will need the following to complete the setup in Integration Points:

- Application ID from Microsoft Azure
- Application Secret Value from Microsoft Azure
- Domain address of Microsoft Azure instance
- Any filtering requirements that will be used to filter imported data
- Field Mappings to map fields between Relativity and Microsoft Entra ID.

### Setup

To create an integration point for importing from Microsoft Entra ID:

1. Complete the following fields in the Setup layout:  
   **General**:
   - **Name**—the name of your integration for reference purposes.

     > **Note:** Name the application in Integration Points the same as you did in Microsoft Entra ID for easy location of application when needing to make updates.
   - **Type**—select Import to designate the job as a data import. Selecting Import makes all the possible import sources available for selection in the Source field below.
   - **Source**—all possible third-party systems that you can import data from. Select **Microsoft Entra ID**, formerly known as Azure AD.
   - **Destination**—by default, this is set to Relativity and is not editable 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**—the Relativity Dynamic Object (RDO) to which you want to import the data. Select the Entity object.
   - **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.

   **Advanced:**
   - **Email Notification Recipients**—enter the email addresses of those who should receive notifications of whether the integration point export succeeded or failed. Use semi colons between addresses.
   - **Log Errors**—select **Yes** or **No** to denote whether Relativity tracks item level errors.
     - If you select **Yes**, each job also logs any item level errors.
     - If you select **No**, Relativity doesn't log these item level errors.
     - Regardless of your selection, job-level errors are always recorded in Relativity.

   **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.
2. Click **Next** to continue to the Connect to Source layout.

### Connect to source

Continue to create your import integration point by connecting Relativity to your Microsoft Entra ID data source. You can select to import from your commercial or government Microsoft Entra ID profile. Follow the steps below.

1. Complete the following fields in the Connect to Source layout:
   - **Version**—select either a Commercial or Government Microsoft Entra ID version to import from.
   - **Application ID**—the ID of the application was created in the Azure Portal. For more information, see [Finding Azure credentials](https://help.relativity.com/RelativityaiR/Content/Relativity/Integration_Points/Azure_AD_provider.md#FindingAzurecredentials).
   - **Password**—the associated Application Secret Value, not the Secret ID, is the password for the application that was created in the Azure Portal. For more information, see [Finding Azure credentials](https://help.relativity.com/RelativityaiR/Content/Relativity/Integration_Points/Azure_AD_provider.md#FindingAzurecredentials).
   - **Directory ID**—the Microsoft Entra ID tenant domain the Azure application resides in.
   - **Filter By**—you can limit the records imported by limiting import to specific users or groups.
   - **Filter**—Optional. Limits the users or groups imported from Microsoft Entra ID.
     - Enter only the filter condition using Microsoft Graph query syntax.
       - Do not include the *$filter* query parameter. Including *$filter=* in the field may cause errors.
       - Relativity automatically applies *$filter* when submitting the request to Microsoft Entra ID.
     - Examples:
       - department eq 'Engineering'
       - userType eq 'Member'
     - For more information on using Graph query syntax, see [Microsoft's Graph REST API documentation](https://docs.microsoft.com/en-us/graph/api/overview?view=graph-rest-1.0&preserve-view=true).
     - The Microsoft Entra ID provider supports both standard and advanced Microsoft Graph filters. For more information on filter syntax, supported operators, and query requirements, see Microsoft's [Use the $filter query parameter](https://learn.microsoft.com/en-us/graph/filter-query-parameter?tabs=http).
   - **MS-Graph Version**—determines which version of the Graph API Integration Points will be used when interfacing with Azure AD. Defaults to version 1.0 of the Graph API if left blank. Another available option is Beta.
2. Click **Next** to continue to the Map Fields layout.

   > **Note:** A warning message appears at the top of page if information is not valid, and you will not be able to continue to the next step until the error is resolved.

#### Microsoft Graph advanced filters

The Microsoft Entra ID provider supports Microsoft Graph advanced filters. You can use advanced filters to further refine the users or groups returned from Microsoft Entra ID during an import. Filter syntax, supported operators, and query requirements vary by object type and property. For more information, see [Microsoft Graph filter query parameter documentation](https://learn.microsoft.com/en-us/graph/filter-query-parameter?tabs=http).

### Map fields

Map the attributes or fields so that Integration Points imports the targeted data into specific Relativity fields.

1. In the **Map Fields** wizard, you have the following options for mapping fields:
   - Click the **Map All Fields** button to automatically map all Source fields with matching Destination field names, except single/multiple object fields.
   - Use the Shift+click and Ctrl+click method to select multiple fields at a time.
   - Use the single and double arrow buttons or double-click a field to move the selected fields between columns.
   - If you have Destination Fields that are mapped to fields in the Field Catalog, Relativity tries to find name matches between these Catalog Fields, as well.
   - The field names in the Destination columns include the type of each field listed.  
     When mapping fields, here are some issues to note:
   - If the WebAPIPath instance setting in kCura.IntegrationPoints is not configured correctly after upgrade or installation, the Source Fields list will be empty because it cannot return any attributes. As a result, you cannot map fields.
   - When importing the Entity object:
     - You need to map the First Name and Last Name fields. In case the Full Name field is not being mapped, those two fields are combined for the Full Name value, which is then written to the Entity object.
     - You can link the imported entity to a manager if the manager also exists in the entity database. To proceed with linking them, you must map the Manager field on the Field Mappings page. Previously this was done via the Entity Manager Contains Link option, which has been deprecated.  
       ![Map Fields](https://help.relativity.com/RelativityaiR/Content/Resources/Images/Features/Integration_Points/SCR_MappingFields_CSV_LDAP.png)
2. Complete the following import Settings on the **Map Fields** layout:
   - **Overwrite**— determines how the system overwrites records once you promote data to the review workspace. This field provides the following choices:
     - **Append Only**—promote only new records into the review workspace.
     - **Overlay Only**—update existing records only in the review workspace. Any documents with the same workspace identifier are overlaid. This field acts as a link indicating to Relativity where to import the data. When you select this or Append/Overlay, you must complete the Multi-Select Field Overlay Behavior field described below.
     - **Append/Overlay**—adds new records to the review workspace and overlays data on existing records. When you select this or Overlay Only, you must complete the Multi-Select Field Overlay Behavior field described below.
   - **Multi-Select Field Overlay Behavior**—determines how the system overlays records when you promote documents to the review workspace. This field is only available if you have selected either Overlay Only or Append/Overlay above. This field provides the following choices:
     - **Merge Values**—merges all values for multi-choice and multi-object fields in the source data with corresponding multi-choice and multi-option fields in the workspace. These merge regardless of the overlay behavior settings in the environment.
     - **Replace Values**—replaces all values for multi-choice and multi-object fields in the source data with corresponding multi-choice and multi-option fields in the workspace. These merge 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 source data with corresponding multi-choice and multi-option fields in the workspace according to the overlay behavior settings in the environment.
   - **Unique Identifier**—this option is only available when the Overwrite mode is set to Overlay Only. Enter a unique value that no other item in the workspace contains. For example, use the GUID or distinguishedName attribute. If the value is not unique in the workspace, it may lead to unintentional overwriting of existing data.
3. Click **Save** to save the Integration Point.

Once all of the settings have been entered the Integration Points job will run according to the schedule that was set. If you would like to run the job ahead of that time. For more information, see [Manually running the import job](#Running).

### Reporting on Microsoft Entra ID imports

Reporting on Microsoft Entra ID imports can be done in Integration Points. For more information, see [Monitoring job history and errors](https://help.relativity.com/RelativityaiR/Content/Relativity/Integration_Points/Monitoring_job_history_and_errors.md).

</details>

## Manually running the import job

Once you have created an Integration Point, you can manually run an integration point by selecting the Integration Point, and clicking **Run** from the console. This lets you run an integration point instantly, as opposed to scheduling an integration point to run.

![Arrow pointing to Run button under Transfer Options console](https://help.relativity.com/RelativityaiR/Content/Resources/Images/Features/Integration_Points/SCR_RunImport_238x225.png)

Click **OK** on the run confirmation message.

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

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

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

You can calculate the number of documents, as well as images and natives if applicable, to be transferred in the scope of a particular Integration Point.

1. Navigate to the **General** tab on the Integration Points details page for the integration point job.  
   ![Integration Points details page](https://help.relativity.com/RelativityaiR/Content/Resources/Images/SCR_IP_GeneralTab.png)

   > **Note:** Before the first calculation for this integration point, you will see the "Press 'Calculate statistics' button" message in the Total of Documents field.  
   > ![Highlighted the Press Calculate statistics button message in the Total of Documents field](https://help.relativity.com/RelativityaiR/Content/Resources/Images/Import_Export/SCR_IP_TotalOfDocsField_FirstUse_PressCalcButton_Nov24.png)
2. Click the **Calculate statistics** button under Transfer Options in the right-hand panel.

![Arrow pointing to Calculate statistics under Transfer Options console](https://help.relativity.com/RelativityaiR/Content/Resources/Images/Import_Export/SCR_IP_CalcStatsButton_Nov24.png)

- A message appears confirming that this action launches the calculation of the Saved Search or Production content, depending on the integration point selected.
- The calculation runs in the background. You can continue using other Transfer Options or leave the page and return for results later.
- If your job includes more than 500,000 documents, a warning banner appears after the calculation runs.
- The same warning appears if your job includes more than 25 GB of extracted text across mapped fields. Split the job into smaller batches before running to reduce job time.
- Calculation results appear on the details page and depend on Integration Point content.

- The total number of documents with a date and time mark of the last calculation will display.
- Depending on the transferred content, the total number and size of images or natives may also display.  
  ![Sample of calculated results showing total of documents and total of natives](https://help.relativity.com/RelativityaiR/Content/Resources/Images/SCR_IP_TotalNumDocsAndNatives.png)

## Disabling a scheduled Integration Point job

To disable a scheduled integration point , simply turn off the scheduler.

1. From the Integration Points landing page, click the **Integration Point Name** that you wish to disable.
2. Click **Edit**.
3. In the Scheduling section, select **No** for Enable Scheduler. The integration point is no longer scheduled to run.  
   ![Scheduling options of Yes or No.](https://help.relativity.com/RelativityaiR/Content/Resources/Images/Features/Integration_Points/SCR_DisableScheduler.png)

## Scheduler date format considerations

The integration points scheduler accepts U.S. and non-U.S. date formats based off the default language setting in your browser settings.

For example, if the language setting is English (Australian), the date format would be Day/Month/Year instead of Month/Day/Year.

![Browser Language settings dialog](https://help.relativity.com/RelativityaiR/Content/Resources/Images/Features/Integration_Points/SCR_LanguageSettingBrowser.png)

Relativity properly displays the date for the Start and End Date fields when setting up Scheduling.

![Example of properly formatted Start and End dates](https://help.relativity.com/RelativityaiR/Content/Resources/Images/Features/Integration_Points/SCR_NonUSSchedulerDates.png)

This date format appears in Relativity wherever a date is displayed, such as on the saved Integration Point Details layout and the Date Last Modified field on the Document list.

## Automatically stopping a scheduled job that repeatedly fails

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

1. Navigate to the **Instance Settings** page.
2. Create a new instance setting with the following settings.
   - **Name**—enter **MaxFailedScheduledJobsCount**.
   - **Section**—enter **kcura.IntegrationPoints**.
   - **Value Type**—select **Integer 32-bit**.
   - **Value**—enter the number of consecutive failed attempts to be executed before the scheduled job is stopped.

   ![Sample of new integration point listed in table.](https://help.relativity.com/RelativityaiR/Content/Resources/Images/SCR_Instance_Setting_MaxFaileds.png)

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

![Schedule tab displaying jobs failed list](https://help.relativity.com/RelativityaiR/Content/Resources/Images/SCR_SchedTab_JobFaileds.png)

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

![A blank Next Scheduled Runtime field outlined on Scheduling tab](https://help.relativity.com/RelativityaiR/Content/Resources/Images/SCR_No_NextScheduleRuntime.png)

The Job History page displays the system-generated error description explaining why the scheduled job was stopped.

![Sample screen of error message](https://help.relativity.com/RelativityaiR/Content/Resources/Images/SCR_JobHist_Error_Message.png)
