Managing job definitions

The purpose of the following scenario is to show how to create a job definition in the context of an example.

About this task

Jobs can either be an embedded job, or they can reference a job definition. For information about how to define an embedded job from the UI, see Creating embedded jobs.

David is an HCL Workload Automation user who needs to upgrade the Java version on the existing backup server named BK_server. To automate the process, David decides to create a job stream that references a job definition. David prefers to reference a job definition instead of creating an embedded job because he needs to use the same job definition in other job streams and he wants to avoid to duplicate the definition. In this way, if David needs to modify any parameter, he can modify just one job definition and every job stream that references that job definition will be affected by the change.

To create a job definition named UPGRADE_JAVA_TEMPLATE and then reference the job definition inside the existing UPGRADE_JAVA job stream, perform the following steps:

Procedure

  1. Create a job definition named UPGRADE_JAVA_TEMPLATE and enter the command that performs the Java upgrade procedure.
    1. From the Graphical Designer page, select the Assets tab and click the add icon +.
    2. From the drop-down menu, select Job definition.
    3. In the search bar, type Executable, then select the executable job type and click Next.
    4. In General information, in Workstation, select the existing workstation BK_server.
    5. In Folder, select IT_operations.
    6. In Name, type UPGRADE_JAVA_TEMPLATE.
    7. In Task, from the drop-down menu, select Inline script.
    8. In Command text or script name, enter apt install --only-upgrade openjdk-11-jre-headless -y.
    9. Click Add to add the job definition to the database.
  2. Reference the UPGRADE_JAVA_TEMPLATE job definition into the existing UPGRADE_JAVA job stream.
    1. From the Assets, use the search bar to find the UPGRADE_JAVA_TEMPLATE job definition.
    2. Drag the UPGRADE_JAVA_TEMPLATE job definition into the UPGRADE_JAVA job stream.
    3. Click Deploy to deploy the workspace.
    You created a job definition to upgrade the Java version on the backup server named BK_server and you referenced the UPGRADE_JAVA_TEMPLATE job definition into a job stream.