...
- The External Data Source holds person related records. This is typically a SQL or LDAP database, a flat file, an API, or another similar repository.
- The Organizational identity Identity Source is a configured Organizational Identity Source plugin, typically with a Sync Mode configured. It obtains information from the External Data Source and converts it to Organizational Identity Format.
- The Organizational Identity Source Group Mapping is a configuration, attached to the Organizational Identity Source configuration, that maps attributes from the External Data Source into candidate CO Group Memberships.
- The Organizational Identity Source Record is an artifact created when an Organizational Identity is instantiated from an Organizational Identity Source. It is a copy of the record of the External Data Source, linked to the Organizational Identity that was created from it.
- The Pipeline takes the Organizational Identity record (including any candidate CO Group Memberships), and syncs them to the operational CO Person, CO Person Role, and CO Group Membership records. As part of this process, the Pipeline may attempt to instantiate a match process to determine if a new Organizational Identity matches an existing CO Person record in some way.
...
Connecting Pipelines
Pipelines can are intended to be connected to various contexts:
...
Organizational Identity Sources
...
This is also the order of preference. That is, if an Organizational Identity is created from an Enrollment Flow, and that Enrollment Flow also queries an Organizational Identity Source, and both the Enrollment Flow and Organizational Identity Source are connected to Pipelines, the Organizational Identity will be processed via the Pipeline connected to the Enrollment Flow.
as a means of automatically creating or linking CO Person records. Except when connected to an Enrollment Flow, when a Pipeline creates a new CO Person record, Identifier Assignment is triggered, and when a Pipeline creates or updates a CO Person or CO Person Role record, provisioning is triggered.
Pipelines are executed according to the current configuration, so it is possible for an Organizational Identity to be processed by a different Pipeline than the one it was originally attached to.
...
Pipelines can be attached to Enrollment Flows in two different ways: An Enrollment Flow can trigger a Pipeline, and a Pipeline can trigger an Enrollment Flow. Care should be taken to avoid circular dependencies.
Triggering Pipelines From Enrollment Flows
While Pipelines attached directly to Enrollment Flows are not currently supported (CO-1380), Pipelines can be implicitly attached to Enrollment Flows via a second mechanism, via Enrollment Sources. If an Organizational Identity is created from an Enrollment Source attached to an Enrollment Flow, and if a Pipeline is attached to the Organizational Identity Source that the Enrollment Source is configured to use, then that Pipeline will be executed (not any Pipeline directly attached to the Enrollment Flow)when the record is processed from the Source.
Triggering Enrollment Flows From Pipelines
...
- Enrollment Flows are only triggered during Add Sync operations.
- In the Enrollment Flow configuration
- Petitioner Enrollment Authorization should be set to CO Admin to reduce the likelihood of anyone starting it manually.
- The Enrollment Flow Status must be Active.
- Email Confirmation is required, as it is the mechanism by which control is passed to the Enrollee.
- A Pipeline should not be setattached via an Enrollment Source (as described above).
- Identity Matching should be set to None.
- Do not attach any Enrollment Attributes, since the attribute collection step will not run.
- In order to collect the authenticated user identifier, the use of EnvSource is recommended. (Use a configuration like the example provided for Self Signup.)
The Pipeline must create a (or link to an existing) CO Person identity for the Enrollment Flow to successfully run.
...
Pipeline execution during Default Registry Enrollment is not currently supported (CO-1381).
Manually Rerunning a Pipeline
...