Truedat contains an administration module to manage dynamic forms to be used by different type of documents within the application. This will allow the administrator to customize the fields to be displayed in different features. We call the definition of this forms template.
Templates can be defined for:
- Business Glossary: Each template defined in the Business Glossary scope will define a new type of business concepts. You will be able to customize which types of business concepts you want to have and the fields that need to be documented for each of them. Examples: Metrics, Attributes, Business Term, Policy.
- Data Catalog: Although most of the information in the Data Catalog is discoverd automatically using the corresponding connectors, you are able to define aditional information to be documented manually. This will be done with templates with Data Catalog scope.
- Quality Rules: Usually a single template in which you will define your customized fields to be added to your Quality Rules. This will help implement your Quality Model giving you total freedom to define Quality Principles, criticity, weight or whatever attribute you want to have within your quality rules.
- Remediation plan: In order to add additional information such a remediation plan to the result of the execution of quality implementations, a template has to be defined. This will include all the relevant information, e.g. name of the remediation plan, date for its implementation, owner of the plan, etc.
You will find this option in the administration panel where you will be able to see a tab for each of the modules using templates.
To create a new template just use the corresponding action "New template". You will get following form to be completed:
Common fields for all templates:
- Name: It must be unique in the application, it is the code that identifies the template.
- Label: User name for the template. Will be used when presenting this template to any user.
- Scope: Module where the template will be used. It must be one of the following.
Templates consist of a number of fields grouped by any group you want to define. In case that you have long forms it is recommended to define fields groups to facilitate the user understanding of 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.
Inside each group, you can setup new fields and define their order.
Field setup will allow several options:
- Label: Text used in the form to display the field.
- Name: Field code, must be unique in the template and must not have spaces. This value cannot be modified once the template has been saved. If you use this same name in other templates, the field needs to have the same definition.
- Description: It is not mandatory. When a value is indicated in this field, a button will appear on the form, which will show this description when clicking on it.
- Type: Field data type. Available types will depend on selected widget.
- Cardinality: indicates whether it is single or multiple, as well as whether it is mandatory or not:
- One or none: single value not required
- One: a required single value
- None or more: A list of values from which several can be chosen on a non-mandatory basis
- One or more: List of values where at least one must be indicated but allows multiple value to be selected.
- Values : Possible values to be selected by the user. Depends on widget.
- Fixed list: Allows you to add a list with the possible values of the field.
- Key/Value list: Defines a list with the code that will be saved as a value and the label that will displayed to the user. This allows to change the label in the future without having to change all the documents.
- Depending on another field: You can define a fixed list for each possible value of another field in the template. For example, if there was a "Country" field, there could be a "Region" field where the possible values would change in relation to the value selected in the "Country" field. This type of field also allows to define the default value based on the value of the dependency field.
- Dependent on domain: You will be able to provide a different set of possible values depending on the domain selected for the concept, structure, quality rule o quality implementation.
- Default value: For "Fixed list" or "free text" type values, a default value can be entered. This will result in the field being pre-populated with this default value when a document is created from the corresponding template.
- Conditional visibility: The visibility of the field will depend on the value of another field. This will allow to activate a field depending in a list of values from a previous field.
- Mandatory dependency: Field will be mandatory depending on the value of a previous field.
- Subscribable: In case that this option is checked, this field may be used as a filter when setting up subscriptions by role.
They are the different components that can be selected for the form. There is a very specific correlation of which components can be used with each Type, Cardinality and Values.
If the values are Users of a Role then the Type must be User. For the other 3 possible values: Fixed list, Code / description list or Depending on another field, the Type must be Text String: