Display (custom) IDs
What are Display IDs?
Replace the automatically generated ID created by Content Controller for Accounts, Content, Equivalents and Bundles with your own Display (also known as custom) ID. These IDs can be used for searching, reporting and audit logs or interacted with via the API.
If you are integrated in any way with Content Controller or utilize the Automation API. Please make sure to check with your Manager or Engineering team before changing an ID.
Some things to keep in mind
Before working with these custom IDs there are a few limitations to be aware of.
The IDs must be unique
They cannot be more than 1000 characters
And they cannot contain any of the following: &$+,/:;=?@# <>[]{}|^%
Setting & editing IDs
To set a custom ID this can be done via the API or the UI. Within the UI, you have the option of applying an ID when importing a course or from the details panel for those already in your library. Similarly, this applies to Accounts, Equivalents and Bundles.
During content import
Navigate to the Content section
Click the + Add button then select the Course option.
Here you will see a checkbox “Automatically generate ID” selected. Uncheck this box to present a new text field where an ID may be set.
Enter your ID and upload the course as normal.
The same steps above also apply when creating an Equivalent or Bundle.
Editing existing content
Navigate to the Content, Equivalent or Bundle areas
Select the desired course by clicking on it
In the details panel that appears, click the Edit button under the Details title section.
Here you may edit the ID and save as normal.
During account creation
Navigate to the Account section
Click the + Add button to create a new account
Here you will see a checkbox “Automatically generate ID” selected. Uncheck this box to present a new text field where an ID may be set.
Enter your ID and create the account as normal.
Editing an existing account
Navigate to the Account section
Select the account you wish to assign an ID to
On the account dashboard you will see the ID near the bottom as shown in the screenshot.
Click Edit and uncheck the automatically assign ID checkbox. Enter your ID and save the account as normal.
Using and viewing IDs
Searching
When searching on the appropriate pages within Content Controller. You may preface your search with id: followed by the ID to find the desired course. Example id: RD5896521485 notice how the search icon changes to a key.
List views
IDs will now appear on the appropriate pages with a list view for Content, Equivalents, Bundles as well as the Accounts dashboard.
Anywhere an ID would normally appear in reports a new displayid will be added.
Last updated
Was this helpful?