CSV Connector

Last modified 05 Mar 2024 13:10 +01:00

Identity connector for for CSV-formatted text files.

Functionalitystable
Development statusactive (actively developed and maintained)
Support statussupported
OriginEvolveum
Support provided byEvolveum
Target systemsCSV files (local)
ProtocolLocal filesystem I/O operations
Source codehttps://github.com/Evolveum/connector-csv

This connector is useful to connect to systems that regularly export or import user databases in a form of CSV files. It is usually used to connect to HR-like systems that export the HR data every night. MidPoint deployments are usually using this connector to pull that data. This connector pretends that the CSV file is actually the complete resource. Therefore, the usual configuration of an authoritative resource can be used to connect such an export-based resource.

This connector can also be used as a remote connector if the file is on a different machine than midPoint.

Capabilities and Features

Schema

YES

Determined from CSV file header.

Provisioning

YES

Live Synchronization

YES

Password

YES

Activation

SIMULATED

No activation for generic CSV is possible.

Paging support

NO

Native attribute names

YES

History

This is an CSV connector completely rewritten from scratch during 2016 and 2017.

Versions

Version Origin Binary Sources Build Date Framework version Bundled with midPoint Description

2.0-SNAPSHOT

Polygon

download snapshot jar

GitHub (master)

N/A

1.4.2.14

Development version. Planned to be bundled with midPoint 3.6

2.0

Polygon

download jar

GitHub

Jun 3rd 2017

1.4.2.14

3.6

Stable version

2.1

Polygon

download jar

GitHub

October 4th 2017

1.4.2.14

3.6.1

Improved live synchronization. Fixed file locking.

2.2

Polygon

download jar

GitHub

April 12th 2018

1.4.2.14

3.8

Script execution (exec)

2.3

Polygon

download jar

GitHub

December 19th 2018

1.4.2.35

4.0

Parallel provisioning operation (thread locking)
Name no longer required
Minor fixes

2.4

Polygon

download jar

GitHub

April 3rd 2020

1.4.2.35

4.1

Fix for getLastSynchronizationToken-always returning new token
Java 11 support (Java 8 support is deprecated)

2.5

Polygon

download jar

GitHub

10th October 2022

1.5.1.3

4.6

Added support for configuration discovery.

2.6

Polygon

download jar

GitHub

13th March 2023

1.5.1.3

4.7

Internal search filtering - no need for ConnId result handlers any more.

2.7

Polygon

download jar

GitHub

9th October 2023

1.5.1.3

4.8

Fix of suggestions for configuration discovery.

Known Issue

The csv connector can’t initialize if the input file contains UTF-8 BOM characters. To avoid the issue, remove the UTF-8 BOM characters from the csv files.

Error message
WARN (com.evolveum.midpoint.provisioning.ucf.impl.connid.ConnIdUtil): Got ConnId exception (might be handled by upper layers later) org.identityconnectors.framework.common.exceptions.ConfigurationException in connector:...(ConnId com.evolveum.polygon.connector.csv.CsvConnector v2.7): ConnectorSpec.Main(resource:...): Header in csv file doesn't contain unique attribute name as defined in configuration., reason: Header in csv file doesn't contain unique attribute name as defined in configuration. (class org.identityconnectors.framework.common.exceptions.ConfigurationException)

Interoperability

This connector was developed using standard Java I/O libraries. It relies on Java platform for all I/O operations, including potentially problematic operations that involve concurrent and remote access to files. The capabilities of the Java platform on specific operating systems and filesystems may be limited.

The connector is only tested using local files on standard local filesystems in Linux and Windows environments. Network filesystems are not tested - although we have reports that this connector works with some network filesystems.

Support

This connector is bundled with midPoint distribution, therefore it is a subject to bundled support program. Such bundled support includes only support for local files on standard local filesystems in Linux and Windows environment (ext4 and NTFS file systems). Other operating systems are not supported. Network file systems and unusual (experimental) filesystems are not supported.

Support for other operating systems, remote or unusual filesystems has to be explicitly negotiated in a support contract.

Was this page helpful?
YES NO
Thanks for your feedback