Prepare a Data File for Import
Data Transfer Manager Premium Feature Reach out to your Customer Success Manager or Account Executive to learn more about this feature. |
You can use the Data Transfer Manager to import data from another system into your Case IQ application via a Secure File Transfer Protocol (SFTP) integration. This allows you to efficiently populate records in Case IQ with data from an external system, such as your organization’s human resources information system or a legacy case management system. You can migrate data into cases, emails, files, notes, parties, profiles, to-dos, user profiles, and any data forms or custom forms in your Case IQ application.
Transferring data into Case IQ involves the following steps:
- Collecting the data you want to import and organizing it into .csv, .txt, or .xlsx files.
- Configuring the settings for the data import with the Data Transfer Manager, which tells Case IQ how to import the data.
- Running the data import or scheduling when Case IQ should run it.
This article covers step 1 in this process by explaining how to format and structure your source data and data files. If you are preparing to import file attachments, see the Import File Attachments in Bulk article instead, as the process is slightly different. If you have already prepared your data files, refer to Configure, Edit, or Test Data Import Settings with the Data Transfer Manager and Run or Schedule a Data Import for steps 2 and 3 respectively.
We use several technical terms in this article to explain how importing data works. See a glossary of important terms below:
Term | Definition |
---|---|
Source data file | A .csv, .txt, or .xlsx file containing the data you want to bring in to Case IQ. Generally, your organization would export this data as a file from your source system. |
Data import settings | The settings that you configure in Case IQ's Data Transfer Manager to tell Case IQ how to import data from your source system. |
Import entity or record type | One kind of record in your Case IQ application, for example cases, emails, files, notes, parties, profiles, to-dos, users, and any data forms or custom forms configured in your Case IQ system. |
Secure File Transfer Protocol (SFTP) | A secure method of transferring files from one system to another. |
Source system | The application containing the data you want to bring in to your Case IQ system. For example, your organization's human resources information, ticketing, customer relationship management, or legacy case management system. |
Source field | A column in your data file, which reflects a field in your source system. For example, if your source system has a "Department" field, you can migrate the data contained in that field by adding a "Department" column in your data file. |
Unique identifier | A source field that identifies each record in both your source system and Case IQ, such as an email address or identification number. You choose the unique identifier when configuring the data import's settings. Each record must have a different value in the unique identifier field. When running a data import, the system will compare the unique identifier values in each data file row with records in Case IQ. If a row in the data file and a record in Case IQ have the same unique identifier, Case IQ will consider those the same record. For example, if you choose "Case Number" as the unique identifier for a case data import, the system will look through all Case IQ case numbers to determine if any match the case numbers in the data file. If a case in Case IQ has the same case number as a row in the data file, the system will consider those the same case. |
Data File Requirements Checklist
While this article explains all our data file requirements in detail, we have also created this quick checklist for your reference. This checklist is also available as a .xlsx file, so you can check off requirements as you complete them. In step 2 of the data transfer process, you can also validate your data file in Case IQ when configuring your data import settings to check if the Data Transfer Manager can import your source data.
Data File Requirements Checklist | Section for Details and Examples |
---|---|
.csv, .txt, or .xlsx format. | Data File Format |
File name begins with unique prefix in lowercase characters. No spaces or special characters. | |
Maximum 500,000 rows. | |
Maximum 200MB. | |
1 row/record. | Data File Structure |
1 column/field. | |
For .csv or .txt: 1 record type/data file. | |
For .xlsx: 1 record type/worksheet. | |
For case data file: 1 column/workflow field. | |
For user profile data file: SSO user column if applicable. | |
No scattered empty rows. | |
Double quotation marks (") around text values with commas (,). | Text String Format |
Double quotation marks (") around array data. | |
Commas (,), newlines (\n), or tabs (\t) separating elements in arrays. | |
Recommended for email data file: no complex HTML in email body. | |
Dates are in consistent format and plain text. | Date Format |
All data matches Case IQ field data format and requirements.
|
Match Data to Field Type |
Source Data File Format
Make sure the source data files you want to import into Case IQ meet the following format requirements:
Source Data File Format Requirements | |
---|---|
File format | .csv, .txt, or .xlsx
|
File name |
[unique file name prefix]_{arbitraryId}, e.g. employees_Jan2025.csv
|
Maximum number of records per import | 500,000. This means your data file can have a maximum of 500,000 rows. |
Maximum file size | 200 MB |
Source Data File Structure
Case IQ can read data that is in a specific structure in .csv, .txt, or .xlsx files. Organize the data in your data files into the following structure:
Source Data File Structure Requirements | |
---|---|
1 source data file/import | Include all data for an import in one data file. For a recurring data import, you can upload a new data file to Case IQ's SFTP for each scheduled import. |
1 row/record | Make sure the data for each record is contained in one row of the data file. For example, the images below show a sample data file for parties. The data for each party is contain in one row in this data file. |
1 column/field | Ensure each field has its own column. In the images below, there is a "First Name" column, which contains each record's first name. |
For case data file: 1 column/workflow field |
If you are preparing a data file for cases, create a separate column for each workflow field you want to set. For example, suppose you have three workflows in your application, called "HR Investigation", "Security Investigation", and "Fraud Investigation", and you want to set a status for each of them via the import. Your data file would need to contain the following three columns: "HR Investigation Status", "Security Investigation Status", and "Fraud Investigation Status". |
Unique identifier column | Include a column for a unique identifier, such as an email address or identification number. Each record must have a different value in the unique identifier field, so that Case IQ can use each unique identifier value to find any records that have already been added into the system. If a row in the data file and a record in Case IQ have the same unique identifier, Case IQ will consider those the same record. |
For email, note, party, to-do, or custom form data file: Reference record target column |
If you are preparing a data file for emails, notes, parties, to-dos, or custom forms, make sure the data file contains a column that tells Case IQ to which case the system should add each record. When configuring your data import's settings, you can map this column to a Case IQ field. We generally recommend using the case's identification number or name in your source system. In the images below, this is the "Legacy Case Number" column. |
For user profile data file: SSO user column |
If you are preparing to import users into Case IQ and your application has an Single Sign On (SSO) integration, the system can automatically set them as SSO users via the import. In your source data file, you can add a column called "SSO User". For each user you want to set as an SSO user, enter "true", "yes", or "1" for the user's row in the "SSO User" column. To configure SSO for your application, see Set up Single Sign On (SSO). |
For .csv or .txt: 1 record type/data file. |
If you are using .csv or .txt format data files, make sure each data file only contains data for one record type. If you plan to migrate multiple record types into Case IQ, create a data file for each record type. For example, if you are migrating data into cases and parties, you would need a data file for parties and another separate data file for cases.![]() |
For .xlsx: 1 record type/worksheet. |
If you are using .xlsx format for your data file, ensure each worksheet in the .xlsx file only contains data for one record type. Name each worksheet by record type. For example, if you are migrating data into cases and parties, organize all case data in one worksheet and all party data in another. The system can only import data from one worksheet in the file at once. When running an import, the system will look for a worksheet with a name that includes the data import's entity. For example, if you are importing cases, it will look for a worksheet named "cases". If the Case IQ cannot find such a worksheet, it will import the first worksheet in the .xlsx file. |
No scattered empty rows. | Remove any scattered empty rows in your data file, as they will cause errors during an import. However, empty rows at the end of a dataset will not cause errors.![]() |
Text String Format
Your text string data, such as descriptions or email body content, may contain text characters that are ambiguous for Case IQ. By adding double quotation marks (") around text with these characters, the system can properly populate your data in Case IQ fields.
Text String Format | |
---|---|
Double quotation marks (") around text values with commas (,). | Add double quotation marks (") around text values with commas (,), for example "John, a witness, spoke to the subject about the incident". |
Double quotation marks (") around array data. | Add double quotation marks (") around array data. To separate each element, use one of the following delimiters: commas (,), newlines (\n), or tabs (\t). For example, a list of emails using newlines would look like: "maria@email.com rashid@email.com john@email.com" |
Commas (,), newlines (\n), or tabs (\t) separating elements in arrays. | No other special characters require double quotes, such as apostrophes (' and "), ampersands (&), dashes (-), number signs (#), and slashes (/ and \). |
Recommended for email data file: No complex HTML in email body. |
You can include basic HTML formatting for email body content you want to migrate into Case IQ. This includes headers, basic tables, bolding, italics, and bulleted lists. More complex HTML may not appear as expected when viewing migrated emails in Case IQ. |
Date Format
Dates in .csv files are stored as plain text. However, spreadsheet software, like Microsoft Excel or Google Sheets, may automatically reformat date values using your regional settings. If you open your source data files in these applications before importing them, dates may not appear in the correct format. You can follow the steps below to prevent this automatic reformatting.
-
Microsoft Excel
-
Google Sheets
-
Text Editor (Notepad++ etc.)
- Add Button
- Open the .csv data file in Microsoft Excel.
- Select a date column in your data file.
- Right-click (on Windows Operating System) or command-click (on Mac OS), then select "Format Cells".
- In Category, click "Custom".
- Select the date format you want to use from the list. We recommend "yyyy-dd-mm".
- Click OK.
- Repeat steps 2 to 6 for any other date columns in your data file.
- Save the data file as .csv.
Do not reopen your file in Excel before importing it, as Excel may reformat your dates.
- Upload your .csv data file into your Google Drive.
- Open the data file in Google Sheets.
- Select a date column in your data file.
- In the top bar, click "Format" > "Number" > "Custom date and time format".
- Select the date format you want to use from the list or the dropdown. We recommend "yyyy-dd-mm".
- Click Apply.
- Repeat steps 3 to 6 for any other date columns in your data file.
- In the top bar, click "File" > "Download" > "Comma Separated Values (.csv)".
Do not reopen your file in Sheets before importing it, as Sheets may reformat your dates.
- Open your .csv data file in Notepad++ or any other text editor.
- Manually check and adjust dates to YYYY-DD-MM format.
- Save the file as "UTF-8 CSV".
Phone Number Format
The Data Transfer Manager supports a variety of standard phone number formats, which it can automatically detect in your source data file and import into Case IQ. See all phone number formats that Case IQ can accept in the Supported Phone Number Formats chart. The phone numbers in your source data file must include a country code.
If your source data uses an unsupported phone number format, you can still migrate your phone number data into Case IQ. When configuring your data import settings, you can manually set the phone number format that your data uses in the Overrides section.
Supported Phone Number Formats
Phone Number Format | Examples |
---|---|
[country code] XXXXXXXXXX | +11234567890 11234567890 1 1234567890 |
[country code] XXX-XXX-XXXX | +1 123-456-7890 1123-456-7890 1 123-456-7890 |
[country code] XXX XXX XXXX | +1 123 456 7890 1123 456 7890 1 123 456 7890 |
[country code] (XXX) XXX-XXXX | +1 (123) 456-7890 1(123) 456-7890 1 (123) 456-7890 |
Match Data to Field Type
Each type of field in Case IQ can only accept certain kinds of data. For example, textboxes, text areas, and picklists can contain text strings, like names and descriptions. If you import text to an integer, number, or money field, the text could not be displayed properly in Case IQ. Likewise, if you import numeric data into a textbox, text area, and picklist field, Case IQ would treat the numeric data like text, so you would not be able to use that data to run calculations in the application.
While preparing your source data file, consider how your organization intends to use the data you want to import. To do this:
- Plan the Case IQ fields into which you want to import data. You can add fields to record types if necessary, see Edit a Standard Record Type and Add and Edit a Custom Form Type for details.
- Check the type for each field. You can check a field's type in the data dictionary, under the System tab in Settings, see detailed steps in the Generate a Data Dictionary File article. We have also listed the field types for the standard profile fields in the Static Profile Field Types section of this article.
- Find each field type in the chart below, Field Type Formats and Requirements.
- Confirm that your source system data meets the requirements detailed in the Field Type Formats and Requirements chart.
Field Type Formats and Requirements
Field Type | Data Format and Requirements | Example |
---|---|---|
Checkbox | Boolean. | True False |
Date | YYYY-MM-DD format. Must comply with ISO8601 standards (see ISO 8601 Date and time format). | 2023-12-31 |
Use the following format: local-part@domain. Must comply with RFC 6854 standards (see the Update to Internet Message Format to Allow Group Syntax in the "From:" and "Sender:" Header Fields memo). All characters will be converted to lowercase when imported. | jane.doe@example.com | |
Integer | 15 digits maximum. | 123456789123456 |
Money | Maximum of 9 leading digits and 2 decimal digits. | 123456789.12 |
Number | Maximum of 9 leading digits and 6 decimal digits. | 123456789.123456 |
Picklist | Each option can be 255 UTF-8 characters maximum. | Discrimination (age, disability, gender, marital status, military status, national origin, pregnancy, race, religion, sexual orientation), harassment, drug/alcohol abuse, hostile work environment, environmental hazards, or unsafe working condition/process |
Postal Code | Either US Zip Code or Canadian Postal Code format, depending on your application's configuration. |
US: 12345 Canada: A1A 1A1 |
Text Area | 10,000 UTF-8 characters maximum. | |
Text Editor | 10,000 UTF-8 characters maximum, supporting HTML5 formatting. HTML excluded from character limit. | <ol><li>Review the relevant details of the case.</li><li>Confirm the role of the witness and their significance to the case.</li><li>Obtain any available background information on the witness.</li><li>Review prior statements or testimonies they may have given.</li><li>Draft a list of open-ended questions to elicit detailed responses.</li><li>Include questions that clarify any inconsistencies or unclear points.</li><li>Anticipate the witness’s perspective and potential biases.</li><li>Prepare questions that may uncover any personal or situational biases.</li><li>...</li></ol> |
Textbox | 255 UTF-8 characters maximum. | See picklist example. |
Time | 24-hour time. Must comply with ISO8601 standards. | 23:59:59 |
Toggle | Boolean. |
True False |
URL | 255 UTF-8 characters maximum. | https://caseiq.app/note/d3ea373c-1968-40f4-…a369-517b48d5cbba/edit |
Phone Number | 15 digits maximum in E.164 format. |
+447911123456, where:
|
Static Profile Field Types
Field | Field Type |
---|---|
First Name | Textbox |
Last Name | Textbox |
Middle Initial | Textbox |
Date of Birth | Date |
Address | Textbox |
City | Textbox |
State / Province | Picklist |
Country | Picklist |
Zip Code /Postal Code | Textbox |
Home Phone # | Phone Number |
Work Phone # | Phone Number |
Email Address | |
Date Submitted | Date |