Export Works

export

(javadoc)

Exports a list of local CRIS productions to an ORCID profile. This procedure essentially manages the works in the ORCID profile that are sourced by the CRIS.

The procedure detects every CRIS sourced work in the ORCID profile that matches any local production that is being exported; if there is no matching local production, the ORCID work is deleted from the profile. Otherwise it will be updated with the meta-data of one of the matching local productions. Finally, for local productions without any matching ORCID work new ORCID works are created. The matching is performed by detecting shared external ids.

Export has two modes of execution: in regular mode in, the ORCID works are only updated if the meta-data is not up-to-date; in forced mode works are always updated. Currently, the title, publication year and type are considered when testing whether works are up-to-date.

The update stage is two-phased in order to avoid potential conflicts: the first phase removes external identifiers that are obsolete from the CRIS sourced works, so that there are no conflicts with the new ones inserted in the second phase.

Requires

• The procedure expects the CRIS service to provide the local productions in the ORCID schema, in particular encoding productions as works. Thus, the meta-data of the CRIS sourced works in the ORCID profile will be exactly that of the provided local productions that are to be exported.

• The put-code of these local productions is expected to be used as local key identifiers, since these are disregarded during the update of the ORCID profile (new works are assigned fresh put-codes and updated works use the put-code of the existing ORCID work).

• The provided local productions must pass the PTCRISync quality criteria to be kept synchronized in ORCID.

Ensures

• The procedure reports the status for each of the input local productions, identifying them by the provided local put-code, including the ORCID error if the process failed. These are defined here.

• If every work is exported successfully, the procedure guarantees that the set of works in the ORCID profile sourced by the CRIS is exactly that which was passed to the procedure.

Performance

This procedure performs a single GET call to the API to obtain the work summaries and PUT or POST calls for each of the input local productions. Additionally, DELETE calls can also be performed to remove spurious works. The procedure only fails if the initial GET fails, otherwise individual failures are reported in the output mapping. No asynchronous workers are used.