Permissions: Users must have the Template Configure privilege to create and manage templates.
When conducting and overseeing studies, you will often come across similarities in defining their aspects. To streamline the setup process, elluminate allows the creation of templates that establish a common set of details for studies and imports. Although the details may differ for each template, the process of creating and using templates remains similar.
The typical process involves creating a new study or import definition and saving it as a template. This template can then be reused for future purposes. When crafting a template, it is not mandatory to input all the object details. The primary aim of the template is to furnish the standard information for the object definition, allowing you to customize or adjust the remaining aspects each time you create a new study or import definition using the template.
Templates do not appear in the list of studies or imports.
Create a New Import Definition Template
When creating a template for an Import Definition, you are working at the study level; a study must first be selected.
- From the Platform Menu, select Importer under Study / Global Data Stores Management.
- Select a study / global data store from the right side of the Platform Menu.
OR - Access a study from the Studies Home Page / global data store from the Global Data Stores Home Page.
- Select Importer from the Module drop-down. The Importer window opens with Imports listed at the top half of the window and Domains in the bottom half of the window.
- Click the New button in the Master Header. An Import Definition Details window opens.
- Import Definition Tab: Enter a unique Name (required), optionally select a Data Source from the drop-down, and select the data store from the Import To drop-down.
- Click on the Data Source Tab: Select an existing data source from the Use System Data Source drop-down, or select a data source from the Data Source Type drop-down and complete all required fields. For details on each data source type, see the article Configure and Manage Third-Party Data Sources.
- Click Save as Template.
- Enter the Template Name.
- Click Save. The newly saved template is not listed in the list of imports. It is available in the New From Template drop-down.
Create an Import Definition from a Template
- From the Platform Menu, select Importer under Study / Global Data Stores Management.
- Select a study / global data store from the right side of the Platform Menu.
OR - Access a study from the Studies Home Page / global data store from the Global Data Stores Home Page.
- Select Importer from the Module drop-down. The Importer window opens with Imports listed at the top half of the window and Domains in the bottom half of the window.
- Click the New From Template button.
- Select New From Template. The Select Template window opens.
- Click in the row of the template you wish to use.
- Click Select. The Import Definition Details window opens with the details in the template.
- Enter required fields and update other fields within the Import Definition and Data Source tabs.
- Click Save.
Edit an Import Definition Template
- From the Platform Menu, select Importer under Study / Global Data Stores Management.
- Select a study / global data store from the right side of the Platform Menu.
OR - Access a study from the Studies Home Page / global data store from the Global Data Stores Home Page.
- Select Importer from the Module drop-down. The Importer window opens with Imports listed at the top half of the window and Domains in the bottom half of the window.
- Click the New From Template button.
- Select Templates. The Template window opens.
- Click in the row of the template you wish to edit.
- Click the Edit icon.
- Make changes in the window.
- Click Save Template.
- To apply changes to items created by templates after you have edited the template, click the Apply to config(s) icon (the checkmark). A message displays stating if any configs are affected by the change.
- Click Close to close the Template window.
Delete an Import Definition Template
- From the Platform Menu, select Importer under Study / Global Data Stores Management.
- Select a study / global data store from the right side of the Platform Menu.
OR - Access a study from the Studies Home Page / global data store from the Global Data Stores Home Page.
- Select Importer from the Module drop-down. The Importer window opens with Imports listed at the top half of the window and Domains in the bottom half of the window.
- Click the New From Template button.
- Select Templates. The Template window opens.
- Click in the row of the template you wish to delete.
- Click the Delete icon. A confirmation window opens.
- Click OK to delete the template, or Cancel to cancel your action.
- Another confirmation window displays stating Template Deleted.
- Click Close to close the Template window.