Template management

Truedat includes an administration module for managing dynamic forms used by different document types. It allows administrators to customize fields displayed in different features. We call each form definition a template.

Templates can be defined for:

Business Glossary: Each template in the Business Glossary scope defines a new business concept type. You can customize the concept types and fields documented for each. Examples include metrics, attributes, business terms, and policies.
Data Catalog: Although connectors discover most Data Catalog information automatically, you can define additional information for manual documentation. Use templates with the Data Catalog scope.
Quality Rules: Typically, use one template to define custom fields for Quality Rules. This supports your Quality Model. It lets you define Quality Principles, criticality, weight, or other attributes.
Quality Implementations: Typically, use one template to define custom fields for quality implementations.
Quality Executions: Define information used when manually requesting quality implementation executions. The quality engine may use this information, such as periodicity.
Grant request: Define templates for requesting access to data.
Remediation plan: To add information such as a remediation plan to quality implementation results, define a template. It can include the plan name, implementation date, plan owner, and other relevant information.

Template Management

Find this option in the administration panel. It includes a tab for each module that uses templates.

To create a template, select New template. Complete the following form:

Common fields for all templates:

Name: A unique application-wide code that identifies the template.
Label: The template's display name. It appears when users select the template.
Scope: The module where the template is used. Select one of the available options.
Subscope (Business Glossary and Implementations only): Business concepts/Implementations using a template with a subscope appear in a separate menu after publication. The subscope becomes the menu name.

Templates contain fields organized into groups. For long forms, define field groups to help users understand the document.

The group name must be unique when saving the template. If there are groups with the same names, their fields will be merged into a single group.

Within each group, you can add fields and define their order.

Each field has the following options:

Label: The text displayed for the field in the form.
Name: A unique field code without spaces. You cannot modify this value after saving the template. Fields with the same name in other templates must have the same definition.
Description: Optional. When set, a button appears in the form. Select it to view the description.
Widget: The component used to select the field value. See Widgets.
Type: The field data type. Available types depend on the selected widget.
Cardinality: Indicates whether the field accepts one or multiple values, and whether it is required:
- One or none: An optional single value.
- One: A required single value.
- None or more: An optional list with multiple values.
- One or more: A list with at least one value. Multiple values are allowed.
Editable: When a field is non-editable, you cannot modify its value after completing the template.
Searchable: All fields are searchable by default. Text searches look for matches in the field content. Disable this option to exclude the field from searches.
Values: The values users can select. Options depend on the widget.
- Fixed list: Add a list of possible field values.
- Key/Value list: Define a saved code and displayed label for each value. You can change labels later without changing documents.
- Depending on another field: Define a fixed list for each value of another template field. For example, the values available in a Region field can depend on the selected Country. You can also define a default value based on the dependency field value.
- Dependent on domain: Provide different possible values based on the domain selected for the concept, structure, quality rule, or quality implementation.
Default value: For fixed-list or free-text values, enter a default value. The field is prepopulated when a document is created from the template.
Conditional visibility: The field's visibility can depend on another field's value. This activates the field for specified values in a previous field.
Mandatory dependency: The field can be required based on a previous field's value.
Subscribable: When selected, this field can filter role-based subscriptions.

Widgets

Widgets are components that you can select for a form. Each widget supports specific types, cardinalities, and values.

Data entry widgets

Widget / Example

Information

Type: String Cardinality: None (autogenerated) This field is automatically populated with an autogenerated id that cannot be modified.

For single values, a standard input appears. For multiple values, press Enter to add each value.

Text input in a box.

Add link-and-value pairs. When viewing, select the displayed text button to open the link.

Enter rich text. You can underline, bold, italicize, create numbered or bulleted lists, and add web links.

Type: Table

Cardinality: One or none

Define a table for template users to complete. Specify the table columns. Cells accept text input only.

Type: Dynamic Table

Cardinality: One or none

Define a table for template users to complete. Specify columns and their content type: text input, user drop-down, user or group drop-down, or text-input drop-down.

Type: Text string

Cardinality: One or none / One / None or more / One or more

Masks a text field so its value is not displayed when users enter data or view the template.

Type

Integer
Decimal

Cardinality: One or none / One

Displays a field that accepts numeric data only.

Type: Date

Cardinality: One or none / One

Displays a calendar widget for selecting a date.

Type: Date Time

Cardinality: One or none / One

Displays a calendar widget for selecting a date and time.

Fixed value widgets

For users or groups of users in a role, the Type must be User or User or Group. For Fixed list, Code / description list, or Depending on another field, the Type must be String: