Skip to content

Configuration

These are the options that can be specified in your .ini config file. NB: setting ckanext.attribution.debug to True means that the API accesses sandbox.orcid.org instead of orcid.org. Although both run by the ORCID organisation, these are different websites and you will need a separate account/set of credentials for each. It is also worth noting that you will not have access to the full set of authors on the sandbox.

API credentials [REQUIRED]

Name Description Options
ckanext.attribution.orcid_key Your ORCID API client ID/key
ckanext.attribution.orcid_secret Your ORCID API client secret

Optional

Name Description Options Default
ckanext.attribution.debug If true, use sandbox.orcid.org (for testing) True/False True
ckanext.attribution.enable_faceting Enable filtering by contributor name (requires change to SOLR schema) True/False False