# CSV connector in Soffid 4

## Introduction

### Description

The "**CSV connector**" of <span style="text-decoration: underline;">Soffid 4</span> includes the “**Customisable CSV file**” <span style="text-decoration: underline;">agent</span>.

This agent is used to **generate a CSV file** as part of the Soffid synchronisation engine.

### Managed System

This connector has been designed to interpret a CSV file as if it were an end system.

### Prerequisites

Users who need to be created in the CSV file must have an **account** with that agent.

Please note the **location** where the file will be created; its configuration will depend on the operating system and the type of Soffid architecture/installation

## Download and Install

This plugin is located in the Connectors section and its name is **CVS plugin** (Test plugin once is installed).

<p class="callout info">For more information about the installation process you can visit the [Addons Getting started](https://bookstack.soffid.com/books/addons-getting-started/page/getting-started "Addons installation") page.</p>

## Agent Configuration

The "Customisable CSV file" agent is **used to synchronice**, not for load authoritative o reconcile.

The only object that can be configured is the **User object**.

### Basics tab

It has no custom parameters.

### Attribute mapping tab

Use the option "Create default mapping" to create a first version of the mapping.

Adjust the properties and attributes to suit your needs.

#### Property section

Here, you need to define some **configuration parameters**.

<div id="bkmrk-property-description"><table class="wrapped confluenceTable tablesorter tablesorter-default" role="grid" style="width: 100%;"><colgroup><col style="width: 9.65279%;"></col><col style="width: 90.3472%;"></col></colgroup><thead><tr class="tablesorter-headerRow" role="row"><th aria-disabled="false" aria-label="Property: No sort applied, activate to apply an ascending sort" aria-sort="none" class="confluenceTh tablesorter-header sortableHeader tablesorter-headerUnSorted" data-column="0" role="columnheader" scope="col" tabindex="0"><div>Property</div></th><th aria-disabled="false" aria-label="Description: No sort applied, activate to apply an ascending sort" aria-sort="none" class="confluenceTh tablesorter-header sortableHeader tablesorter-headerUnSorted" data-column="1" role="columnheader" scope="col" tabindex="0"><div>Description</div></th></tr></thead><tbody aria-live="polite" aria-relevant="all"><tr role="row"><td class="confluenceTd">file</td><td class="confluenceTd"><u>Mandatory</u>: **Path** where the file is placed in the directory system.</td></tr><tr role="row"><td class="confluenceTd">key</td><td class="confluenceTd"><u>Mandatory</u>: The **field** to be used as **key**.</td></tr><tr><td>columns</td><td><u>Mandatory</u>: The **names of the columns** to be created in the file. <span style="text-decoration: underline;">They must be separated by a space</span>. They correspond to the "system attributes".</td></tr><tr><td>separator</td><td><u>M</u><u>andatory</u>: The **symbol used to separate** attributes in the file. It can be anything other than a comma.

</td></tr></tbody></table>

</div> [![image.png](https://bookstack.soffid.com/uploads/images/gallery/2026-06/scaled-1680-/B0toO4UCjIyxZGXX-image.png)](https://bookstack.soffid.com/uploads/images/gallery/2026-06/B0toO4UCjIyxZGXX-image.png)

#### Attributes section

Mapping between CSV fields and Soffid objects.

[![image.png](https://bookstack.soffid.com/uploads/images/gallery/2026-06/scaled-1680-/IP24dbNGUpgLjAfG-image.png)](https://bookstack.soffid.com/uploads/images/gallery/2026-06/IP24dbNGUpgLjAfG-image.png)

Some tips:

- The system attributes will be the csv columns
- The direction will be to the left
- Check here the [Soffid Objects (for agent mappings)](https://bookstack.soffid.com/books/soffid-4-reference-guide/page/soffid-objects-for-agent-mappings "Soffid Objects (for agent mappings)")
- You can use additional attributes like this: attribute{"CODE"}, you can check de CODE of the attribute in the [Metadata](https://bookstack.soffid.com/books/soffid-4-reference-guide/page/metadata "Metadata") page.

### Incoming data tab

Nothing to do.

### Massive actions tab

We can use the "**CSV file: Provision all users on to managed systems.**" to sinchronise all users.

[![image.png](https://bookstack.soffid.com/uploads/images/gallery/2026-06/scaled-1680-/aMRoIGVoSBubuT6Z-image.png)](https://bookstack.soffid.com/uploads/images/gallery/2026-06/aMRoIGVoSBubuT6Z-image.png)

### Account metadata tab

Nothing to do.

## Operational

### Monitoring

After the agent configuration you could check in the [Sync server monitoring](https://bookstack.soffid.com/books/soffid-4-reference-guide/page/sync-server-monitoring "Sync server monitoring") page if the agent is active.