There are several approaches available for integrating Registry with ORCID®, starting with Registry v2.0.0. Currently, these all are designed around the ORCID iD itself, and not other parts of the ORCID record, though additional capabilities may be added in future releases.
If you plan on exporting the ORCID iD to a provisioning target, keep in mind you probably need the ORCID iD to be attached to the CO Person record. (The LDAP Provisioning Plugin, however, can read an ORCID iD attached to an Org Identity.) |
Recommended Approaches
Self Service Linking Enrollment Flow
- Configure the ORCID Source plugin, if not already done. The ORCID Source must be attached to a Pipeline with the following configuration:
- Match Strategy: Do Not Match
- Sync Strategy: Sync on Add, Update, Delete
- Create CO Person Role Record: No (unticked)
- Create a new Enrollment Flow with the following settings:
- Status: Active
- Email Confirmation Mode: None
- Petitioner Enrollment Authorization: CO Person
- Pipeline: None
- Identity Matching: Self
- Terms and Conditions Mode: Ignore
- Do not add any Enrollment Attributes. (You will be asked to add one by default, simply page back or follow the breadcrumbs to skip it.)
- From the Enrollment Flow configuration page, click Attach Org Identity Sources.
- Click Add Enrollment Source
- Organizational Identity Source: Select the ORCID Source you previously configured
- Org Identity Mode: Authenticate
CO Participants can now link their own ORCID record by logging into Registry and selecting Enroll >> Your ORCID Enrollment Flow.
Alternate Approaches
Administrator Search Enrollment Flow
Administrator driven ORCID linking is subject to error since it is not possible to strongly authenticate the appropriate record. Self Service linking is strongly preferred. |
- Configure the ORCID Source plugin, if not already done. The ORCID Source must be attached to a Pipeline with the following configuration:
- Match Strategy: Do Not Match
- Sync Strategy: Sync on Add, Update, Delete
- Create CO Person Role Record: No (unticked)
- Create a new Enrollment Flow with the following settings:
- Status: Active
- Petitioner Enrollment Authorization: CO or COU Admin, or CO Admin
- Pipeline: None
- Identity Matching: Select
- Terms and Conditions Mode: Ignore
- Do not add any Enrollment Attributes. (You will be asked to add one by default, simply page back or follow the breadcrumbs to skip it.)
- From the Enrollment Flow configuration page, click Attach Org Identity Sources.
- Click Add Enrollment Source
- Organizational Identity Source: Select the ORCID Source you previously configured
- Org Identity Mode: Select
CO(U) Administrators can now link ORCID records on behalf of their users. To do so:
- Start at Enroll > Your Admin ORCID Enrollment Flow.
- Select the CO Person you wish to add an ORCID record link for.
- Select the ORCID Source.
- Search for the appropriate ORCID record.
- View the ORCID record.
- Click Add New Org Identity From Source and Link To Petition.
Administrator Search and Link
Administrator driven ORCID linking is subject to error since it is not possible to strongly authenticate the appropriate record. Self Service linking is strongly preferred. |
This approach will result in an ORCID iD attached to an Org Identity, and assumes an existing CO Person record. |
- Configure the ORCID Source plugin, if not already done.
- The ORCID Source cannot be attached to a Pipeline, as there is not currently a way to automatically connect the new Org Identity record to an existing CO Person using this method.
- Go to People >> Organizational Identities.
- Click Add New Org Identity From Source.
- Search for the desired ORCID record.
- View the ORCID record.
- Click Add New Org Identity From Source.
- After the Org Identity is created, find the desired CO Person record.
- Click Link in the Organizational Identities section.
- Find the Org Identity you just created, associated with the desired ORCID iD.
- Click Link.
Manual Data Entry During Enrollment (Not Recommended)
- Configure a self signup Enrollment Flow and define one of the attributes to be Identifier (ORCID iD, CO Person).
- Note that after collection, it is not currently possible for a user to update the identifier. (CO-1255)
Manual Data Entry By Administrator (Not Recommended)
- An Administrator can add an ORCID iD to an existing CO Person record by visiting the appropriate CO Person page and clicking Add in the Identifiers section.
- Enter the ORCID iD as the identifier, and set the identifier type to ORCID iD.