Create and Manage Templates

Before creating a template, make sure you have:

• A working Gathr ETL Application that you want to convert into a template.

• Appropriate permissions to create and manage templates.

• A clear understanding of which parameters should be configurable.

Accessing Templates #

1. Navigate to Applications > Advanced ETL section.

2. Click on the Templates tab.

3. You’ll see the template listing page with these options:

   • + (Create Template)

   • Refresh (to update the template list)

   • Save User Preferences (to save your current view settings)

Creating a New Template #

Method 1: From Template Listing Page #

1. Click the + button on the template listing page.

2. A new template canvas will open where you can build your ETL Application.

Method 2: From Existing ETL Application #

1. Locate your ETL Application in the ETL Application listing.

2. Click the ellipsis (…) on the ETL Application tile.

3. Select Create Template.

4. The ETL Application will open in template mode.

Building Your Template #

1. Add Components:

   • Use the Components tab to add sources, transformations, and targets.

   • Configure each component as needed.

2. Parameterize Your Template:

   • Identify values that should be configurable (e.g., connection strings, table names, file paths).

   • Replace these values with parameters.

3. Add Parameters:

   • Click the Parameters option.

   • Click + Add Parameter.

   • Fill in the parameter details (see Parameter Configuration below).

Parameter Configuration #

When adding a parameter, you’ll need to provide:

Applying Parameters to Components #

1. Right-click on a component and select Parameterize.

2. In the parameterization table:

   • Identify the field you want to parameterize from the list.

   • Click Validate to validate that the values match.

3. Click Apply to save your changes.

Externalize a Template Component’s Configurations #

A template’s component configurations can be externally provided in the same manner as done for ETL applications.

For more details, see the topic Externalize ETL Component Configurations.

Saving and Managing Templates #

Saving Your Template #

1. Click Update (save icon) in the top.

2. Provide a name, update configurations, and add optional description.

3. Click Save & Exit to confirm.

Templates Listing Page #

The template listing page provides several views and actions:

• Search: Find templates by Application Name.

• Filter: Sort by Application Name, Source, Target,Processor (Transformations), or Analytics components.

• Pagination: Navigate through multiple pages of templates.

Template Actions #

Each template tile includes an actions menu (…) with these options:

Next Steps

• Learn how to use templates as components in other ETL applications.

Create Instance #

Click the template actions menu (…) to select the Create Instances option. Provide the below details for instance creation:

Note: When creating multiple instances, the parameter details will remain the same for all the newly created instances.

Under the Component Used column, the variables used in the listed components are mentioned.

Click Create to create the instance(s).

Schedule All Instances #

Update Instances Parameters #

Option to update all the instances of template.

On the Update Instance Parameter window you can select the instances and Download JSON for Selected Instance’s Parameters and Upload modified JSON.

View Templates #

From the ellipsis of the template tile, you can select View to view its details and the existing instances of a particular template.

Template Details Tab #

Instances Tab #

Once the instances are created, you can view them under Instances tab.

Perform various actions by clicking the ellipses of the instance tile as explained below: