# SailPoint Generic Flat File Connector Documentation

> Generic Flat File Connector Documentation

# Documentation

# Account Status

For the Flat File source, to set an account as enabled or disabled based on the values inside a specific column, you can add the `IIQDisabled` (string) attribute in the source account schema. For more information on editing the account schema, refer to [Managing Source Account Schemas](<https://documentation.sailpoint.com/saas/help/accounts/schema.html>).

The following SQL query can be used to set up the state for the account:

```sql
select ... case when Active=1 then 'false' else 'true' end as IIQDisabled from ...
```

# Additional Information

- To load or aggregate account data into SailPoint, refer to [Loading Account Data](<https://documentation.sailpoint.com/saas/help/accounts/loading_data.html>) for more information.
- To modify some information about entitlements within SailPoint, refer to [Managing Entitlements](<https://documentation.sailpoint.com/saas/help/access/entitlements.html>) for more information.
- To fix uncorrelated accounts even after manually correlating the account, refer to this [Knowledge Base](<https://support.sailpoint.com/csm/en/accounts-on-flat-file-csv-source-remain-uncorrelated?id=kb_article_view&amp;sysparm_article=KB0020886>) article for more information.
- To fix an Identity correlation, refer to this [Knowledge Base](<https://support.sailpoint.com/csm?id=kb_article_view&amp;sysparm_article=KB0010952&amp;sys_kb_id=88d2895d974b5910e34a3b371153af1e&amp;spa=1>) article for more information.

# Configuring a Generic Flat File Source

With the Generic Flat File source, you can create [identity profiles](<https://documentation.sailpoint.com/saas/help/setup/identity_profiles.html>).

> [!NOTE]
>
> The Authentication and Password Management for the Generic Flat File are disabled because the associated features are only supported for [direct connect](<https://community.sailpoint.com/docs/DOC-4065>) sources.

## Creating a Generic Flat File Source

1. Sign in to SailPoint.
2. Go to **Admin \> Connections \> Sources**.
3. Select **Create New**.
4. Search for **Generic**, and then select **Configure**.
5. Enter the following information:

   - **Source Name** - Enter a name for the new source.
   - **Description** - Enter a description for the new source to help distinguish it from similar sources.
   - **Source Owner** - Begin typing the name of an owner. Matches appear after you type two or more letters.

     > **Note**
     >
     > You must add a source owner at the same time as you add a Name, Description, and Source Type while creating the source.
   - **Governance Group** (Optional) - Select an optional governance group from the dropdown list.
6. Select **Continue** to create the new source with your selections.
7. The **Base Configuration** page displays. Verify the information is correct and then select **Save**.

## Review and Import Accounts

If you are configuring a flat file source for the first time, you can select **Review and Import Accounts** to review your connectivity details, and you can import a .csv file of your accounts for correlation recommendations. Importing at this stage does not aggregate those accounts. For more information, refer to [Using Source Recommendations](<https://documentation.sailpoint.com/saas/help/ai/app_onboarding/source_recommendations.html>) in the SailPoint SaaS documentation.

# Flat File Structure

In the file each row represents one account (with exception of multi-valued values). Each column has the ability to hold values of data that are associated with the account and are of a certain fixed order. These columns should be in the same order as the Account Schema. Their data can be "left blank" as long as the fields are not required. The file should be sorted based on the Account ID attribute. This is especially important for handling multi-valued attributes.

The first row of the file is the header of the file, and will not be read.

Example:

| id | name | givenName | familyName | ... | This header row will be skipped |
| --- | --- | --- | --- | --- | --- |
| 1 | jdoe | John | Doe | ... | This is the first account |
| 2 | msmith | Mary | Smith | ... | This is the second account |

# Handling Multi-Valued Attributes

Some attributes, like groups, support the ability to have multiple values, and are stored as a list. In order to model this, you will put each value on a separate row for that field. All additional values should be repeated.

Example:

| id | name | ... | groups | ... | This header row will be skipped |
| --- | --- | --- | --- | --- | --- |
| 1 | jdoe | ... | Admins | ... | This is the first account |
| 1 | jdoe | ... | Employee | ... | This is a continuation of the first account.<br>Notice how values repeat, except for the multi-valued column |
| 2 | msmith | ... | Employee | ... | This is the second account |

> [!NOTE]
>
> The `name` is a single-valued attribute.

This will yield **jdoe** with Admins and Employee groups, and **msmith** with a single Employee group.

# Importing the Flat File

Import a flat file into SailPoint.

1. Go to **Admin \> Connections \> Sources**.
2. Select or edit the new flat file source.
3. In the Account Management section, select **Account Schema**.
4. Select **Download Schema** to download the template for the source.
5. If you have an existing flat file for your accounts, you can edit your flat file to include the column headings from the template, or you can enter the columns in this template based on the required attributes on your source. For more information on structuring your file, refer to [Flat File Structure](<https://documentation.sailpoint.com/connectors/flat_file/va/help/flat_file_structure.html>).

   > **Important**
   >
   > Attribute schemas and columns for Flat File sources cannot be altered.

   > **Note**
   >
   > For more information about how the contents of the flat files correlate to accounts, refer to [Assigning Source Accounts to Identities](<https://documentation.sailpoint.com/saas/help/accounts/correlation.html>).
6. When you've completed your edits, select **Upload Schema** and select your .csv file.

   > **Note**
   >
   > You might see an error message if your flat file does not match the template required for the source you are editing. For more information, refer to [Source Status Messages](<https://documentation.sailpoint.com/saas/help/sources/index.html#source-status-messages>).

If you are managing accounts in a .csv file outside of SailPoint, follow the steps to download the schema and append accounts as new lines to the file before uploading it again.

From this screen, you can also add and delete attributes and edit the Account ID and Account Name used in your schema. For more information, refer to [Managing Source Account Schemas](<https://documentation.sailpoint.com/saas/help/accounts/schema.html>).

> [!IMPORTANT]
>
> Attribute schemas and columns for Flat File sources cannot be altered.

Your next steps depend on how your organization is currently configured:

- To create identities based on the account information from this source, you must create an identity profile for the source. For more information, refer to [Creating Identity Profiles](<https://documentation.sailpoint.com/saas/help/setup/identity_profiles.html>).
- If you already have identities in your organization, you can manage them. For information on verifying that your source accounts display as expected, refer to [Managing Identities](<https://documentation.sailpoint.com/saas/help/accounts/identities.html>).

> [!NOTE]
>
> You can also export your current account data, edit it, and upload it again using the steps described in this section. For more information on exporting your data, refer to [Sharing and Exporting Data, Visualizations, and Dashboards](<https://documentation.sailpoint.com/saas/help/ai/access_insights/data_explore.html#sharing-and-exporting-data-visualizations-and-dashboards>).

# Integrating SailPoint with Generic Flat File

This document is designed to give specific information about the requirements and field definitions needed to get a working instance of a Generic Flat File source in SailPoint. This is an integration between a Flat File source and SailPoint that reads data from a file. The file contains all the relevant information about the accounts.

The Generic Flat File connector is a general-purpose tool used to load user account information from CSV files. It supports some account provisioning operations and Access Certifications (certification of entitlements connected to accounts), but only if those features are activated for your site. Generally, this connector is used as a read-only connector.

> [!NOTE]
>
> You also have the option to use [Delimited File Source Configuration Reference Guide](<https://documentation.sailpoint.com/connectors/delimited_file/va/help/index.html>).

## Supported Features

The Generic Flat File source supports the following features:

> [!NOTE]
>
> Before you can use any item marked with an asterisk (\*), SailPoint must activate the feature for your site.

- Load and \*Provision Accounts
- \*Access Certifications (certification of entitlements connected to accounts)

For more information on SailPoint features, refer to [Source Features](<https://community.sailpoint.com/knowledge/Identity-Security-Cloud-Source-Features>).

## Prerequisites

- Configure at least one virtual appliance cluster and successfully test the connection. For more information, refer to the [Virtual Appliance Reference Guide](<https://documentation.sailpoint.com/saas/help/va/index.html>).

### CSV File Requirements

- The flat file you import must use the column headings included in the Flat File Template.

  > **Caution**
  >
  > This can be impacted by schema changes on any flat file source. You should always use the most current Flat File Template when loading data.
- If you remove a row from your flat file and import it, that account data will also be removed from SailPoint.
- All accounts and entitlements must be sorted by the account name. For example, joe.smith's entitlements must all appear together in the file.
- To import sources with large numbers of accounts and entitlements, SailPoint recommends breaking up the flat file source into separate CSV files of 400,000 lines or fewer. Each CSV file shows as a source in SailPoint.

### SailPoint File Upload Utility

The SailPoint File Upload Utility provides a way for SailPoint customers to upload files to the cloud automatically.

You may use the SailPoint File Upload Utility with the Generic Flat File source. For more information about downloading and using the SailPoint File Upload Utility, refer to [SailPoint File Upload Utility](<https://community.sailpoint.com/knowledge/SailPoint-File-Upload-Utility>).

# Provisioning

The Generic Flat File connector supports provisioning, allowing you to create and manage accounts and entitlements in Generic Flat File directly from SailPoint.

**Prerequisite:** Your system is configured for provisioning.

When SailPoint provisions new accounts to the source, it uses the attributes on the **Create Account** page as instructions or a template for what to include in the account. This page is also referred to as the *provisioning policy*.

When new access is granted on a source where a user does not already have an account, SailPoint automatically includes account creation in the provisioning. This applies whether provisioning is started from an access request or from an automated role or lifecycle state assignment.

For direct-connect sources, SailPoint automatically creates the account from this configuration. If the source is not configured as a direct-connect source, SailPoint creates and assigns a provisioning task to the source owner and includes the values for the source owner to use in manually creating the account.

> [!IMPORTANT]
>
> This section describes the default **Create Account** configuration. SailPoint recommends that you work with Services to define a provisioning configuration specific to your company's needs. Be sure to verify large changes to the provisioning policy before implementation. Failure to do so might cause provisioning to fail.

## Default Create Account Attributes

| Account Attribute | Generator | Description |
| --- | --- | --- |
| id | Disable | This is the account identity |
| name | Disable | This is the display name of the account |
| displayName | Disable | The home directory of user |
| comments | Disable | These are comments |
| created | Disable | This is the created time for the account |
| endDate | Disable | This is the end date/ time line for the account |
| lastLogon | Disable | This is the time for the last logon of the account |
| modified | Disable | This is the time for modification of the account |
| startDate | Disable | This is the start date/ time line for the account |
| status | Disable | This is the status of the account |
| type | Disable | This is the type of the account |
| groups | Disable | This is the groups of the account |
| costCenter | Disable | This is the cost center for the account |
| country | Disable | This is the country for the account |
| department | Disable | This is the department for the account |
| division | Disable | This is the division for the account |
| email | Disable | This is the primary email address of the account |
| employeeNumber | Disable | This is the employee number of the account |
| familyName | Disable | This is the family, last or surname |
| givenName | Disable | This is the first or given name |
| honorificPrefix | Disable | This is the honorary prefix that is used for the account |
| honorificSuffix | Disable | This is the honorary suffix that is used for the account |
| locale | Disable | The locale for the account |
| location | Disable | The location for the account |
| manager | Disable | The manager for the account |
| middleName | Disable | The middle name of the account |
| organization | Disable | The organization for the account |
| phoneNumber | Disable | The primary phone number for the account |
| preferredLanguage | Disable | The preferred language for the account |
| preferredName | Disable | The preferred name for the account |
| secondaryEmail | Disable | This is the secondary email address of the account |
| secondaryPhoneNumber | Disable | The secondary phone number for the account |
| timezone | Disable | The time zone for the account |
| title | Disable | The title for the account |
| risk | Disable | The risk for the account |

> [!NOTE]
>
> All attributes mentioned in the table above have "Disable" generators in the **Create Account** section because the Generic Flat File source is used only as an authoritative source for loading accounts into SailPoint.