- 25 Mar 2024
- 4 Minutes to read
- Contributors
- Print
- DarkLight
Script Templates
- Updated on 25 Mar 2024
- 4 Minutes to read
- Contributors
- Print
- DarkLight
This topic is related to the following section - Validation Hub
Overview
Script Templates allows for building and editing validation hub scripts that have been saved as a template. This is very useful for a project that expects a standard for the Preload and Postload scripts in validation. The script template may be used to copy from during the Add Script process within the Validation Hub.
Users & Roles in Script Templates
Admin level access is required to maintain this section of the system.
Working in Script Templates
View the following page by navigating to Administer > Advanced > Script Templates from the Syniti Migrate Homepage. The system defaults two templates (Preload Validation and Postload Validation). Each script template may contain multiple tasks. Maintenance of the script templates and tasks are available within this section.
The Scripts panel grid displays the following fields:
Heading | Description |
---|---|
Name | Name of the Dataset. |
Type | Displays the Script Type. Refer to Script Types and Use below. |
Active | Toggle to set status of the Script Template.
|
The Tasks panel grid displays the following fields:
Heading | Description |
---|---|
Index | Sequence of the Tasks. Value increases by factor of 10 for each new entry. |
Name | Name of the Task. |
Type | Displays the Type of Task. Refer to Task Types and Use below. |
Notes | Displays additional notes for the task. |
Active | Toggle to set status of the Task.
|
Add a Script Template
To add a script template, click Add icon within the header of Scripts panel and fill in the required fields.
Note
Add a Script Template from within the Validation Hub through the Save as Template option within a card.
Field definitions for Script Template:
Field | Description |
---|---|
Script Template Name* | Enter a name for the Script Template. (Required) |
Script Type* | The Script Type will default to Validation Script. |
Active | Toggle to set status of the Script Template. NOTE: Defaults as Active. |
Once the required fields are filled, click Save icon to complete or Cancel icon to exit the process. The script template is displayed in the list.
Edit a Script Template
To edit an existing script template, click Edit icon, modify the fields and click Save icon to complete or Cancel icon to exit the process.
Delete a Script Template
To delete a script template, click the Delete icon for that row. A confirmation warning will display. Click OK button to proceed, or Cancel button to exit the action.
Add a Task
To add a task, click Add icon within the header of Tasks panel and fill in the required fields.
Field definitions for Task:
Field | Description |
---|---|
Task Name* | Enter a name for the Task. (Required) |
Index* | Enter the Index value for this task. |
Task Type* | Select from the list the task type. (Ex: Complete, Tracking, Email). Refer to section Task Type and Use for details. |
Tracking Field Name* | Enter the Tracking Field Name for this task to allow for entry of tracking values.
|
Email To | Enter one or more email addresses separated by a semicolon. (Required)
|
Email Cc | Enter one or more email addresses separated by a semicolon. (Required)
|
Email Subject | Enter the subject of this email. (Required)
|
Email Body | Enter the body text for this email. (Required)
|
Notes | Enter additional information about this task. |
Active | Toggle to set status of the Script Template.
|
Task | Select from the list of existing tasks for this script template as a dependency task.
|
Once the required fields are filled, click Save icon to complete or Cancel icon to exit the process. The task is displayed in the list.
Edit a Task
To edit an existing task, click Edit icon, modify the fields and click Save icon to complete or Cancel icon to exit the process.
Delete a Task
To delete a script template, click the Delete icon for that row. A confirmation warning will display. Click OK button to proceed, or Cancel button to exit the action.
Script Type and Use
The field Script Type is a required field that provides the setting in which this script template is used. There may be multiple Script Types going forward, and although the system defaults a Script Type of Validation Script there may be other selections for use in the future.
Note
The value Execution Script is not yet in use.
Task Type and Use
The field Task Type is a required field that provides the type of task. Currently there are two task types:
Complete - This is a task that has to be completed in the sequence stored.
Tracking - This is a task that contains an additional field to track a value relevant to the task.
Email - This task provides an email to the user once the task is completed.
Task Dependencies
Within the Tasks, a task may be assigned dependencies to other tasks of the same script template. Dependencies may be added during the add or edit process, and they must be saved individually for each prior to saving the task. These tasks cannot complete until the dependencies are complete.