Versions Compared

Old Version 12

changes.mady.by.user Benn Oshrin

Saved on

compared with

New Version 13

changes.mady.by.user Benn Oshrin

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

If a large number of changes are expected, the Warning Threshold Override can be enabled to skip the threshold check. The override will be automatically unset after processing. Note the first time a source is processed, the threshold check is automatically skipped. (The Core Job Plugin Sync job force parameter will also skip threshold checking, but the override is the recommended mechanism.)

File Format

Note

The currently supported format is experimental, and is subject to change in a future release.

As of Registry v4.0.0, multiple file formats are supported:

  • CSV v1: Legacy CSV format
  • CSV v2: Flexible CSV format

For earlier versions, the only supported version is CSV v1.

Info

CSV, or comma-separated value format, is not consistently implemented everywhere. While there is an RFC defining the format, a given implementation may or may not support it fully. For the avoidance of doubt, FileSource uses PHP's CSV parsing functions, and so for any particular inconsistency PHP's behavior should be considered normative.

CSV v2

The first line of the file is a header documenting which columns are present in the file:

  • The first column in this file must always be SORID, a unique string identifying the record.
  • Remaining columns are specified as follows:
    • Model.field.[type], for example EmailAddress.mail.personal or OrgIdentity.affiliation
      • Values for OrgIdentity.valid_from and OrgIdentity.valid_through may be in any format supported by strtotime(), but are expected in UTC
      • Values for OrgIdentity.date_of_birth are expected in YYYY-MM-DD format
    • Identifier.identifier.type+login, to flag that this column represents a login identifier, for example Identifier.identifier.network+login
    • AdHocAttribute.tag, for example AdHocAttribute.color

Remaining lines in the file each represent one inbound record, with columns as specified by the header.

Example files are attached to this page.

CSV v1 (Legacy)

The file format is fixedThe source file must be in CSV format, with the following columns:

...