Site-wide User ID Configuration

User IDs can be configured through JSON configuration files. This is useful if you wish to deploy a shared set of user IDs that should be present on various item types.

Configuration location for individual users

To deploy a user ID configuration for a single user, deploy a JSON configuration file (documented below) to:

%appdata%\Algenta\Colectica\UserIds.json

Configuration location for all users

To deploy a user ID configuration for all users on a machine, deploy a JSON configuration file (documented below) to:

%programdata%\Algenta\Colectica\UserIds.json

Configuration file format

The user ID configuration file is a simple JSON format that specifies which user ID types should appear by default for which item types. A sample file looks like this:

{
    "DefinedUserIds": [
        {
            "Label": "Study",
            "ItemType": "30ea0200-7121-4f01-8d21-a931a182b86d",
            "UserIds": [ "Study Number", "DOI" ]
        },
        {
            "Label": "Data Collection",
            "ItemType": "c5084916-9936-47a9-a523-93be9fd816d8",
            "UserIds": [ "Survey Code" ]
        }

    ]
}

Properties

Label

The Label property is optional, but can be useful to provide a human-readable name for the item type.

ItemType

The ItemType property specifies the item type for which the user IDs should be displayed. For a list of valid item types, see Item Type Identifiers.

UserIds

The UserIds property is an array of user ID types that should be displayed for the item type.