The File Organizational Identity Source Plugin is designed to integrate using CSV files.
Modes
Org Identity Source Mode | Support |
---|---|
Manual Search and Linking | Supported |
Enrollment, Authenticated | Not supported |
Enrollment, Claim | Not supported |
Enrollment, Search | Supported |
Enrollment, Select | Supported |
Org Identity Sync Mode | Support |
---|---|
Full | Supported |
Query | Supported |
Update | Supported |
Manual | Supported |
Installation
This is a non-core plugin, see Installing and Enabling Registry Plugins for more information.
Configuration
The path specified in File Path must be readable by the COmanage Registry web server.
Archive Directory
As of Registry v3.1.0, FileSource supports an Archive Directory. If specified, this directory must be writeable by the COmanage Registry web server, and FileSource will maintain two previous copies of the source file (using the basename of the file, appended with .1 or .2). This allows FileSource to perform a diff in order to determine changed records, which performs significantly better for larger files.
Use of this configuration option is especially recommended for source files containing more than a few hundred sync'd records.
File Format
The currently supported format is experimental, and is subject to change in a future release.
The source file must be in CSV format, with the following columns:
Column | Description | Required? | Notes |
---|---|---|---|
1 | Unique Record Key | Yes | |
2 | blank | ||
3 | blank | ||
4 | Given Name | Yes | |
5 | blank | ||
6 | Family Name | ||
7 | Street Address | ||
8 | Locality | ||
9 | blank | ||
10 | State | ||
11 | Postal Code | ||
12 | Country | ||
13 | Email Address | ||
14 | Telephone Number | ||
15 | Telephone Country Code | ||
16 | National Identifier | ||
17 | Title | ||
18 | Organization | ||
19 | Match Reference Identifier | ||
20 | Valid From | Any format supported by strtotime(), expected in UTC | |
21 | Valid Through | Any format supported by strtotime(), expected in UTC | |
22 | Personal URL | Added in v3.1.0 | |
23 | Affiliation | Affiliation corresponding to values of AffiliationEnum (Extended Types not supported) Added in v3.2.0 | |
24 | Identifiers | Semi-colon ( Added in v3.2.0 | |
25 | Date of Birth | YYYY-MM-DD format. Added in v3.3.0. |