CSV

This connector exports data from a CSV file.

This page is about CSV .

Overview

Files in CSV format are commonly used to store information.

Prerequisites

Implementing this connector requires the source file to be in CSV format.

Export

This export copies the information found in a CSV file and transforms it into a new CSV file in the Identity Manager's format.

Configuration

This process is configured through a Connection in the UI and/or the XML configuration, and in the appsettings.agent.json > Connections section:

appsettings.agent.json
{
  ...
  "Connections": {
    ...
    "<ConnectionIdentifier>": {
      ...
    }
  }
}

The identifier of the connection and thus the name of the subsection must:

• be unique.
• not begin with a digit.
• not contain <, >, :, ", /, \, |, ?, * and _.

For example:

appsettings.agent.json
{
  ...
  "Connections": {
    ...
    "HRContoso": {
      "Path": "C:/identitymanagerContoso/Contoso/hr_conto(.*?).csv",
      "PathIncremental": "C:/identitymanagerContoso/Contoso/hr_delta_conto(.*?).csv",
      "Encoding": "UTF-16",
      "Separator": ";",
      "IsFileNameRegex": true,
      "NumberOfLinesToSkip": 1,
      "ValuesToTrim": [
        "*",
        "%"
      ]
    }
  }
}

Setting attributes

Name	Details
Path Required if PathIncremental is not defined.	Type String Description Path of the input file to be used for complete synchronization.
PathIncremental Required if Path is not defined.	Type String Description Path of the input file to be used for incremental synchronization.
IsFileNameRegex optional	Type Boolean Description True to enter a regex instead of a normal string for Path and PathIncremental. Note: if several files correspond to the regex, then the export will use the last created file. Info: useful when the filename is only partially known, for example when using a generated file.
ValuesToTrim optional	Type String List Description Ordered list of the characters to trim at the beginning and at the end of the headers and values of the input file. Note: the second value will be trimmed after the first, the order is important. Example When writing $ first and then % in ValuesToTrim, then "$%I am an example$%" becomes "I am an example$".
Encoding default value: UTF-8	Type String Description Encoding of the input file. See the list of available encodings.
NumberOfLinesToSkip default value: 0	Type Int32 Description Number of lines to skip in order to reach the line used as data header.

Output details

This connector is meant to generate a CSV file, named <connectionIdentifier>.csv, to the Export Output folder. See the Application Settingstopic for additional information.

For example, when exporting a connection named HRCountries, the output file will be named HRCountries.csv.

The file's columns come from the header line from the input CSV file.

All columns with headers, even empty ones, will be written to the output. However, columns without headers will not be written.

Fulfill

There are no fulfill capabilities for this connector.

Authentication

Password reset

This connector does not reset passwords.

Credential protection

This connector has no credential attributes, and therefore does not use Connection , nor a Connection .

Still, data protection can be ensured through an Connection safe.