Overview

The Template menu is used to manage Token Templates in OneDB.

A token template defines how OneDB handles tokenized data when it is accessed, detokenized, or displayed through an application or API request. Each template is associated with a cryptographic key and may optionally include masking rules.

Templates help administrators control whether sensitive data should be returned in full, returned with masking, or processed using a specific masking format.

Main Functions

Administrators can use the Template menu to:

• View existing token templates
• Add a new token template
• Assign a key to a token template
• Assign a masking rule to a token template
• Configure date parsing and formatting behavior
• Configure visible characters using Keep Left and Keep Right
• Edit an existing token template
• Delete an unused token template

Token Template Management

The Token Template Management page displays the list of configured token templates.

Example information displayed:

Example templates:

Add Token Template

The Token Template Add page is used to create a new token template.

Administrators must define the template name, select the key, and optionally configure masking behavior.

Token Template Fields

Template Name

The Template Name field defines the unique name of the token template.

Applications or API requests may refer to this template name when requesting tokenization, detokenization, or protected data display.

Example template names:

App_With_Masking
App_With_Masking_Regex
App_Without_Masking
Customer_API_Masked
Customer_API_Unmasked

Recommended naming convention:

<Application>_<Purpose>_<MaskingBehavior>

Example:

CRM_Detokenize_Masked
MobileApp_Detokenize_Partial
BackOffice_Detokenize_Unmasked

Key Name

The Key Name field is used to select the cryptographic key associated with the token template.

The selected key determines which key OneDB uses when processing tokenized data for this template.

Before creating a token template, ensure that the required key has already been created in the Keys menu.

Apply Date Parsing and Formatting

The Apply Date Parsing and Formatting option is used when the column contains date or timestamp values.

When enabled, OneDB applies date parsing and formatting logic before returning the value. This option is useful when the protected field contains date-based data that must be displayed in a consistent format.

Recommended usage:

Masking

The Masking field is used to select the masking rule that should be applied to the returned value.

If a masking rule is selected, OneDB returns the value according to the selected masking behavior. If no masking rule is selected, OneDB may return the value without masking, depending on the template configuration and access policy.

Example masking options:

Keep Left and Keep Right

Keep Left and Keep Right define how many characters remain visible from the beginning and end of the returned value.

These options are useful when administrators want to display partial data while hiding the sensitive portion.

Example:

The actual masking output depends on the selected masking rule.

Template Behavior Examples

Templates allow administrators to create different access behavior for different applications or user groups.

Example scenario:

How to Add a Token Template

1. Open the Template menu.
2. Click Add Token Template.
3. Enter the Template Name.
4. Select the Key Name.
5. Select whether to enable Apply Date Parsing and Formatting.
6. Select a Masking rule if masking is required.
7. Configure Keep Right and Keep Left values if partial display is required.
8. Click Submit.

How to Edit a Token Template

1. Open the Template menu.
2. Find the token template that needs to be updated.
3. Click the Edit icon.
4. Modify the required fields.
5. Save the changes.

How to Delete a Token Template

1. Open the Template menu.
2. Find the token template that should be removed.
3. Click the Delete icon.
4. Confirm the deletion if prompted.

Before deleting a token template, ensure that it is no longer used by any application, API user, or data protection flow.

Important Notes

• A token template requires a valid key.
• Masking is optional, depending on the intended template behavior.
• A template without masking may return full detokenized data.
• Date parsing and formatting should only be enabled for date or timestamp values.
• Keep Left and Keep Right values should be configured carefully to avoid exposing too much sensitive information.
• Template names should be clear and consistent because they may be referenced by API requests.

Recommended Practice

Use different templates for different application access requirements.

Recommended examples:

Recommended controls: