Permissions: Users must have the Template Configure privilege to create and manage templates.
When conducting and managing studies, it is common to encounter similarities in how study and import details are defined. To streamline the setup process, elluminate supports the creation of templates that provide a common set of predefined details for studies and imports. While the specifics may vary between templates, the process of creating and using them remains consistent.
Typically, a new study or import definition is created and saved as a template, which can then be reused for future configurations. It is not necessary to include all object details when creating a template. The main purpose is to establish a standard framework for the object definition, which can be customized or adjusted as needed when applied to new studies or import definitions.
Note: Templates do not display in the list of studies or imports.
Create a New Import Definition Template
When creating an import definition template, the process occurs at the study level, and a study must be selected first.
- From the Platform Menu, select Importer under Study Management.
- Select a study or global data store from the list in the Platform Menu. Alternatively, access a study from the Studies home page or a global data store from the Global Data Stores home page, and then select Importer from the Study Management drop-down. The Importer window opens, listing the import definitions and domains.
- Click the New button in the master header. The Import Definition Details window opens.
- On the Import Definition tab, which is selected by default, 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 the Data Source tab. Select an existing data source from the Use System Data Source drop-down, or select a data source type from the Data Source Type drop-down and complete all required fields.
Note: For details on each data source type, refer to the Configure and Manage Data Sources article in the Data Sources section.
- If the Options tab displays for the selected data source type, configure the options as needed. For database import definitions, such as ODBC and Databricks, the Options tab lists the domain queries, and multiple domains can be selected and deleted in a single action. For details, refer to the Manage Data Imports article in the Importer section.
- Click Save as Template.
- Enter the Template Name.
- Click Save. The new template does not display in the list of imports. It is available in the Select Template list when New From Template is used.
Create an Import Definition from a Template
- From the Platform Menu, select Importer under Study Management.
- Select a study or global data store from the list in the Platform Menu. Alternatively, access a study from the Studies home page or a global data store from the Global Data Stores home page, and then select Importer from the Study Management drop-down. The Importer window opens, listing the import definitions and domains.
- Click the New From Template button.
- Select New From Template from the drop-down. The Select Template window opens.
- Click the row of the template to use.
- Click Select. The Import Definition Details window opens with the template details populated.
- Enter the required fields and update other fields on the Import Definition, Options (if available), and Data Source tabs as needed.
- Click Save.
Edit an Import Definition Template
- From the Platform Menu, select Importer under Study Management.
- Select a study or global data store from the list in the Platform Menu. Alternatively, access a study from the Studies home page or a global data store from the Global Data Stores home page, and then select Importer from the Study Management drop-down. The Importer window opens, listing the import definitions and domains.
- Click the New From Template button.
- Select Templates from the drop-down. The Templates window opens.
- Click the row of the template to edit.
- Click the Edit icon.
- Make changes in the window.
- Click Save Template.
- To apply changes to items created from a template after editing the template, click the Apply to config(s) (checkmark) icon. A message displays indicating whether any configurations are affected by the change.
- Click Close to close the Templates window.
Delete an Import Definition Template
- From the Platform Menu, select Importer under Study Management.
- Select a study or global data store from the list in the Platform Menu. Alternatively, access a study from the Studies home page or a global data store from the Global Data Stores home page, and then select Importer from the Study Management drop-down. The Importer window opens, listing the import definitions and domains.
- Click the New From Template button.
- Select Templates. The Templates window opens.
- Click the row of the template to delete.
- Click the Delete icon. A confirmation window opens.
- Click OK to delete the template, or Cancel to cancel the action. A confirmation message displays.
- Click Close to close the Templates window.