Templates

Permissions and access

Minimum role: Lab manager
Client type: web client

Prerequisites: You are required to have existing units of measurement, parameters, and domains saved in the database before you can use them in templates.

The Data Governance - Templates tab lets you set up templates for parameter matching within the context of a node of a project's network map, where parameter names within a data table selected for upload are harmonized with the parameter names in a template instead of being matched against all of the parameter names in the database.

Create a Template

To create a template:

1. Navigate to the Data Governance - Templates tab.

2. Click or tap the New Template button.

   

   The New Template dialog appears.

   

3. In the Name field, type a unique name for the template.

4. Optional: In the Description field, type a description for the template.

5. Optional: To assign the template to a project, click the Assign to Project drop-down field and select a project name from the list.

6. In the Domains list, select a domain name to display associated parameters in the Parameters list.

   

   Notes:

   • To display all domain names, including nested domains that are hidden from view under their parent domains by default, click the Expand All function.

   • To narrow the list of domain names, type characters in the search field by which you want to search and filter the domain names displayed.

   • To sort the list of domain names in ascending or descending alphabetical order, use the sort icon button to the right of the search domain names field.

     

   • After you select a domain, a counter is displayed above the parameters list, showing the maximum number of parameter names associated to the domain that can be selected.

     

7. In the Parameters list, click on a parameter name and drag it to the Parameters to use in template panel on the right.

   Notes:

   • To select all of the parameter names that are associated to a domain, click or tap Select All above the parameters list.

   • The counter for the selected parameters of a template displays a maximum limit of 750 parameters. If you exceed the maximum limit, a warning message is displayed.

     

   • To remove a parameter name from the Selected Parameters box, click or tap the close icon to the right of the corresponding parameter name.

   • To remove all of the selected parameters in the Parameters to use in template panel, click or tap Remove All.

   • To preview the new template, click or tap Preview.

     The Preview template dialog appears, which enables you to view and then close it.

     

8. In the New Template dialog, click or tap Save.

   The new template is saved to the database and is displayed on the Templates tab.

Edit a Template

The Edit function enables you to make changes to the details of an existing template.

To edit a template:

1. On the Templates view, click or tap the Edit icon beside the name of the template that you want to edit.

   The Edit template dialog appears.

   

2. Optional: If you want to export the existing template, click or tap Export.

3. Change the details of the template, as needed.

4. Click or tap Save.

Download a Template

If you want to download an existing template, click or tap the Download icon beside the name of a template.

The template that is exported in an Excel file format. The assigned file name contains the prefix "template" and is in lowercase characters. Spaces in the file name are represented by the underscore character (_). For example, if the name of your template is "Product A," the name of the downloaded Excel file is assigned as "template_product_a".

When you open a downloaded template, it contains four worksheets:

• Data - the column headings of this worksheet are the parameter names defined for the template
• Metrics - the column headings of this worksheets are the metric category, metric name, and metric description defined for the template
• Description - the description that is defined in the Template Description field for a template
• Instructions - the instructions for using a template

Delete a Template

The web client supports the ability to delete an existing template from the database.

Warning

Once you have deleted an existing template from the database, you will not be able to recover it for future use. Any existing object relationships between the given template and assigned projects, network maps, and nodes will continue to remain active.

To delete a template:

1. On the Templates view, click or tap the Delete icon beside the name of the template that you want to delete.

   The Delete template dialog appears.

   

   Note

   To cancel the deletion, click or tap Cancel.

2. To proceed with the deletion, type the exact name of the template in the Template Name field.

   Note

   The Template Name field is case sensitive. You are required to input the exact spelling and case of the parameter name before the web client will allow you to proceed with the deletion.

3. Click or tap Delete.

   The template is removed from the Templates tab and is unavailable for future use. Any existing object relationships between the given node and assigned projects, network maps, and nodes will continue to remain active.

Create Metrics in a Template

The web client lets you create a list of metrics for parameter values of a numeric data type in a template. The selected parameters for the template are defined on the Data tab. The selected metrics are defined on a separated Metrics tab of a template.

To assign metrics to a template:

1. In the web client, navigate to the Data Governance - Templates tab.

2. Click the New Template button.

   The New Template dialog appears.

3. In the Template Name field, type the name of the template.

4. Optional: In the Template Description field, type a description of the template.

5. Optional: Click the Assign to Project drop-down field and select a project name to be assigned to the template.

6. On the Data sub-tab, selecte a domain name in the Domains list to filter the list of parameters.

   Note

   To view all domain and subdomain names, click Expand All above the list of domain names.

7. In the Parameters list, click one or more parameter names of a numeric data type to select them for the template.

   Note

   To select all of the filtered parameter names, click Select All above the filtered list of parameters.

8. Click the Metrics sub-tab.

9. In the list of metric categories, select a metric category to filter the list of metrics.

10. In the list of metrics, selece one or more metrics for the template.

11. To preview the template, click the Preview button.

12. To save the template, click Save.

    The new template has been saved to the database.