Create Ledger

A ledger is like a separated database and API keys in the same ledger
have the ability to verify notarized assets of each other. Therefore it
is recommended to create a ledger whenever data separation is required,
i. e. different developer teams, different asset types, different
locations.

New Ledgers are created in the web UI from the Home page by clicking
the + Add Ledger button.

Alternatively you can navigate to the Ledgers page from the left-side
navigation bar. The Ledgers page opens.

1. Click the + Add Ledger button. The Define Ledger panel opens.

2. Enter a unique Ledger name in the Ledger name field. Your Ledger name appears in tabular views. It must be globally unique and can contain only alphanumeric characters as well as dash and underscore ('-', '_'). Note that you have the option to change the Ledger name at any time.

   Add Data Labels (optional) Under Data Labeling you can create one or more labels to associate with the Ledger. Enter a plain-text label and click + or hit the Enter key to add it.

   Click the X on any label to remove it. Labels are user-defined tags you can use to help categorize, group or otherwise track identifying aspects of the Ledger. The remaining is associated with the Ledger as metadata.

   Click the Next step button when you're ready to continue. The Define Signer ID panel opens.

   Click the Previous step button to return to the Define Ledger panel.

3. Enter a unique name for the Signer ID in the Signer ID field.

   The key name must be globally unique, and can contain only alphanumeric characters as well as dash, underscore, dot and 'at' sign ('-', '_', '.', '@').

   The key name is simply an identifier that allows you to select it in other contexts.

4. Click the Next step button when you're ready to continue.

   The Summary panel opens.

   NOTE If you have exceeded the total number of Ledgers allowed by your user license you will see an error when you click the Next step button on the Define Signer ID panel. (See Errors Creating a Ledger below.)

   Click the Previous step button to return to the Define Signer ID panel.

Errors Creating a Ledger

A red error message may pop up if the system can't validate or process an entry, or if your action exceeds limits set by your user license. Most error messages explain in detail what the problem is.

Illegal characters

Most text fields in the UI will accept numbers and letters, as well as dashes and underscores. Be sure to remove punctuation and spaces to ensure your text is validated.

Duplicate name

All Ledger names and Signer IDs must be unique across the entire system. Rename the Ledger if this happens.

Ledgers Page

The Ledgers page displays a searchable (by name), paginated table of all Ledgers in the system. The top-level Ledgers page lists all the Ledgers currently defined in the system, along with usage information.

• Clicking the name of the ledger directs to the Ledgers/Query Ledger page
• By clicking the Actions icon, privileged users can enable/disable a Ledger. Clicking on a Ledger name takes you to its Dashboard page.

Ledger Management Features

After a Ledger is created, you can enable/disable it, generate new Signer IDs or delete keys no longer in use and query it. To access management tools, select the appropriate tab at the top of the page.

Managing Signer IDs

The Signer IDs tab lists every API configured for the selected Ledger - its name, type (SDK, CI/CD, Postgres), and most recent usage date. You can have multiple Signer IDs for the same Ledger. That way you can assign a unique key to each application when you have more than one access to the same Ledger.

By clicking the Actions icon you can add new keys, get the value for existing keys, delete a key or show the Signer ID (for CI/CD keys).

Caution: Deleting a Signer ID here will prevent any application currently using it from authenticating with the API.

To create a new Signer ID by clicking on "Create Signer ID" and provide a Signer ID. Only alphanumeric characters, plus dash, underscore, dot and 'at' sign ('-', '_', '.', '@') are valid. After creating your Signer ID, you can copy it or download to a file on your local system.

To copy the Signer ID string to the clipboard, click the copy icon to the right of the key. Once a key is created, if you need to reset it, you can use the Rotate key function.

Note Once a key is created, if you need to reset it, you can use the Rotate key function.
If you suspect a key is compromised, you can also use the Revoke key option to disable it from being used. Assets notarized with a revoked key will be not shown as trusted.

Querying a Ledger

The Query Ledger tab lets you query Ledger contents directly through the UI. The functionality is described in detail in the Query a Ledger chapter.

Note an important distinction between Ledger/Query Ledger tab and Query Ledger/Query tab that was introduced in TC 3.1.

• The Ledger/Query Ledger tab allows you to query one ledger at the same time. You can see in the search bar that the previously selected ledger's name is there. You can remove or edit the signer_id term.
• In the Query Ledger/Query tab you can search all ledgers at the same time. The search term ledger_name is optional here.