Organization Sources allow for the creation of Organizations based on an external source. Organization Sources are similar in concept to Organizational Identity Sources, and are also plugin based, allowing for arbitrary sources. Organization Sources are available as of Registry v4.4.0.

Overview

Organization Sources sync records from an external source to the Organization Registry. Unlike Org Identity Sources, no duplicate detection or processing is performed (other than normalizing the data to the Registry format, a task handled by the plugin). As a result, the Organization Registry within a CO can contain a mix of records from different Organization Sources, as well as manually created records (added via the UI or REST API),

To use Organization Sources, first enable one or more Organization Source Plugins. Then, define the new Organization Source via ConfigurationOrganization Sources > (plus) Add Organization Source. Select the desired Plugin. Sync Modes are discussed in more detail, below.

Once configured, Organizations can be created from these sources in several ways:

  • Manually, by using the Search option from the Organization Source configuration to search for the desired record, then (plus) Add New Organization From Source
  • Via the Registry Job Shell, as described below.

Sync Modes

Organization Sources can be configured in one of several sync modes to allow for periodic automatic synchronization of records via Org Sync Job. Organization Source Sync Modes vary slightly from Org Identity Source Sync Modes.

Full Mode

In Full Mode, new Organizations are created for any record in the Organization Source that does not already have one, and existing records are updated. Additionally records that are no longer present in the source are deleted from the Organization Registry. (If this behavior is not desired, use Accrual Mode instead.)

(warning) Organization Source Plugins that do not support inventory() calls cannot be run in Full Mode.

Accrual Mode

Like Full Mode, Accrual mode will add new Organizations and update existing ones. However, records that are removed from the source are not deleted from the Organization Registry. This mode is recommended if maintaining referential integrity is important, for example if the Organization Registry is used to populate a Dictionary for use with Attribute Enumerations.

(warning) Organization Source Plugins that do not support inventory() calls cannot be run in Accrual Mode.

Update Mode

As its name suggests, Update mode will only update existing Organizations. This implies records must be added to the Organization Registry manually, by searching for them and then selecting (plus) Add New Organization From Source. Similarly, Organizations can only be deleted manually.

Manual Mode

When configured in Manual Mode, Org Sync Job will not process the Organization Source. Records must be added, updated, and removed manually.

Forcing Record Changes

When syncing records, the raw record retrieved from the source will be compared with the cached copy, and if they are the same no further processing will occur. It is possible to force records to process using the Org Sync Job --force flag. When specified, all records are fully reprocessed, whether or not there were changes compared to the cached copy.

Manually syncing a record (via the UI) will always process it, regardless of whether or not there were changes compared to the cache copy.

See Also


  • No labels