Skip to content

PID Generator

The Accurids PID Generator allows for generation and maintenance of persistent identifiers (PIDs) for any or all datasets loaded in Accurids. To obtain persistent identifiers, so-called ID Generators have to be created and assigned to datasets. ID Generators can be managed by eligible users (Contributors and admins).

Create ID Generator

To create an ID Generator, select ID Management in the sidebar and select the tab ID GENERATOR. A list of existing ID Generators is shown.

To create a new ID Generator, click plus in the upper right corner. In the presented form, enter the following mandatory information:

  • Name: Label that will be used to denote the generator
  • Namespace: Root URI that will be used as a basis for the PIDs
  • Path: Local name that will be appended to the namespace
  • Type: Type of generator to create:

    • UUID: creates a random 128bit number encoded as hexadecimal
    • Counter: creates an ascending number
    • Alphanumeric: creates a random string of alphanumeric characters
  • Generic Configuration: Option to further customize the ID Generation. If not needed, enter empty JSON {}. See below for allowed configurations.

To ensure persistence of the PIDs created, once an ID Generator is created, the mandatory information cannot be modified. If needed, the generator can be deleted and newly created.

Lastly, the generator can be assigned to one or more datasets. To do so, select Used by datasets and select the respective datasets by clicking on their tag. Note that to non-admin users only own datasets are available for assignment. Hit the escape key or click on the background to close the dataset list. The assignment to a dataset can be modified later.

After clicking SAVE ID GENERATOR, the generator is saved and can be used.

View and Assign ID Generators

To view details on an existing ID Generator, click the eye-icon next to it. Here you can also modify the assignment of the generator to datasets. To do this, click the pencil icon next to "Used by datasets" and select or deselect datasets. Hit the escape key or click on the background to close the dataset list. Alternatively, ID Generators can be assigned to a dataset from the dataset details view, see Dataset Management for details.

Generate PIDs

Persistent identifiers can be created by anyone who has editing rights on the particular dataset IDs are generated for. This includes the owner of the dataset (as denoted under "Created by") and admins. To manually create persistent identifiers, open the dataset overview and click the eye-icon next to a dataset . If an ID Generator has been assigned to the dataset and the user is allowed to use it, the ID Generator symbol is visible in the top right corner. Click it to open the manual ID creation.

Enter the number of IDs you want to create and click GENERATE IDS. A text field with the generated IDs (one ID per line) is shown. You can copy them to clipboard by clicking the symbol . You can paste the IDs directly into your program of choice, e.g. a spreadsheet application.

Generic Configurations

For further customization, the following parameters can be configured as JSON variables in the Generic Configurations field upon creating a generator. The available parameters differ by type of ID Generator:

Generator type Parameter Allowed values Description
Alphanumeric idType ALPHABETIC, NUMERIC, ALPHANUMERIC defines type of alphanumeric characters used
Alphanumeric idCase UPPER, LOWER, MIXED defines case of alphanumeric characters used
Alphanumeric numberOfDigits any integer defines numbers of digits of the created IDs
Counter idPrefix any string defines a prefix appended before the IDs created
Counter minimumNumberOfDigits any integer defines the number of digits used, if needed leading zeros will be added
UUID n.a. n.a. no parameters configurable, please enter empty JSON {}

Multiple parameters can be combined like this (example for an alphanumeric ID Generator).

{"idType":"ALPHANUMERIC","idCase":"MIXED","numberOfDigits":10}