Managing Job Templates
Create a job template for a published pipeline to hide the complexity of job details from business analysts. Analysts can then start job instances from the template by modifying pipeline parameter values only.
When you edit a job template, Control Hub makes the same updates to all attached job instances. If any attached job instances are currently running, Control Hub restarts those instances to apply the updates to them.
You can archive a job template when you do not want new job instances to be created from the template, but want existing job instances to continue to run.
You can delete a job template that has no attached job instances.
Creating a Job Template
To create a job
template, in the Navigation panel, click Create a Job Template icon:
.
Define the Job Template
Define the job template essentials, including the template name and optionally a description and tags to identify similar jobs.
Select the Pipeline
Select the published pipeline that you want the job template to run.
Configure the Job Details
Configure the job details to determine how engines run the pipeline. Users cannot override or change these details when they create job instances for this job template.
Set Parameter Defaults
If the selected pipeline uses runtime parameters, define the default parameter values to use for job instances created from the template.
Review the Job Template
You've successfully finished creating the job template. Click Exit to display the new template in the Job Templates view.
For details about creating and starting job instances from the template, see Creating a Job from a Job Template.
Filtering Job Templates
Editing Job Templates
You can edit job templates to change the job definition. When you edit a job template, Control Hub makes the same updates to all attached job instances. If any attached job instances are currently running, Control Hub restarts those instances to apply the updates to them.
Edit job templates from the Job Templates view. Hover over the job template, and click
the Edit icon: .
- Name
- Description
- Pipeline version - You can select a different pipeline version to run.
For example, after you start a job instance from the template, you realize that the developer forgot to enable a metric rule for the pipeline, so you stop the job instance. You inform your developer, who edits the pipeline rules in the pipeline canvas and republishes the pipeline as another version. You edit the job template to select that latest published version of the pipeline, and then start the job instance again.
Important: If you edit the job template so that it contains a new pipeline version with a different origin, you must reset the origin before restarting job instances. - Engine Labels - You can assign and remove labels from the job template to change the group of engines that run the pipeline.
- Job Template Tags - You can assign and remove tags from the job template to identify the template in a different way.
- Statistics Refresh Interval - You can change the milliseconds to wait before Control Hub refreshes the statistics when you monitor job instances created from the template.
- Number of Instances - You can change the number of pipeline instances run for Data Collector jobs.
- Pipeline Force Stop Timeout - You can change the number of milliseconds to wait before Control Hub forces remote pipeline instances to stop.
- Enable or disable failover - You can enable or disable pipeline failover. Control Hub manages pipeline failover differently based on the engine type, as described in the following topics:
- Parameter defaults - You can edit default parameter values or change whether a parameter functions as a static or dynamic parameter.
Upgrading to the Latest Pipeline Version
You can upgrade a job template to use the latest published pipeline version.
When a job template includes a pipeline
that has a later published version, Control Hub
notifies you by displaying the New Pipeline Version icon () next to the template.
You can simply click the icon to upgrade the job template to use the latest pipeline
version. Or, you can select job templates in the Job Templates view, click the
More icon () and then click Use Latest Pipeline
Version.
When you upgrade to the latest pipeline version, Control Hub makes the same updates to all attached job instances. If any attached job instances are currently running, Control Hub restarts those instances to apply the updates to them.
Duplicating Job Templates
You duplicate job templates from the Job Templates view in Control Hub.
Archiving Job Templates
Archive a job template when you do not want new job instances to be created from the template, but want existing job instances to continue to run.
When you archive a job template, you cannot create new job instances from the template or edit the template. You can continue to run and restart existing job instances originally created from the archived template.
- In the Navigation panel, click .
- Click the name of a job template to view the template details.
- Click Archive.
- Click Ok to confirm.
Deleting Job Templates
You can delete job templates when all attached job instances created from that template are inactive.
When you delete a job template, Control Hub also deletes all attached job instances.
- In the Navigation panel, click .
-
Select templates in the list, and then click the Delete
icon:
.
- Click Ok to confirm.