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.

Overview

The Data Governance > Templates tab enables you to create templates for managing standards and guidelines for quality, product specifications, and process specifications for research experiments. A template is a set of units of measurement, parameters, and domains that research experiments to follow.

Templates are used as a data governance feature to validate the structure and naming conventions of elements in data files to be uploaded to the database.

Node inheritance of a template assigned to a project

CoBaseKRM enables new nodes created within a network map to inherit automatically the assigned default template for a project, as follows:

• For a new root node or a new node within a branch, it inherits automatically the default template assigned to a related project.

• For a new branch node, it inherits automatically the template assigned to its predecessor node.

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.

     

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

   Tips:

   • To select all of the parameter names displayed in the list to be added to the Parameters to use in template panel, click or tap Select All.

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

   • To remove all of the selected parameters in the Selected Parameters box, click or tap Remove All.

   • To preview the template while you are in process of defining it, click or tap Preview.

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

   

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. Change the details of the template, as needed.

3. 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 exported in an Excel file format and the assigned file name contains the prefix "template" and the actual name of the template 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

Delete a Template

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

Warning

Once you have deleted a template, 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 are preserved.

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 are preserved.