Workload application definition

You can use workload applications to standardize a workload automation solution so that the solution can be reused in one or more HCL Workload Automation environments thereby automating business processes.

Workload applications are defined in an HCL Workload Automation environment, referred to as the source environment, using composer command line or the Workload Designer graphical user interface accessible from the Dynamic Workload Console. You create a new workload application template and then add one or more job streams to it. To reproduce the workload automation solution in another HCL Workload Automation environment, the workload application template is exported and then after some manual customizations, it can be imported in the target environment.

When creating a scheduling object, you can define it in a folder. If no folder path is specified, then the object definition is created in the current folder. By default, the current folder is the root (\) folder, but you can customize it to a different folder path. You can also use the composer rename command to move and rename objects in batch mode that use a naming convention to a different folder using part of the object name to assign a name to the object.

The export process produces a compressed file containing all the files and information required to make the workload run in a different HCL Workload Automation environment. The compressed file contains:

A definitions file: An XML file, workload applicationtemplatename_Definitions.UTF8.xml, that contains the definitions of all the exported objects. These definitions will be deployed in the target environment so as to populate the target database with the same objects existing in the source environment.
A mapping file: A mapping file, workload applicationtemplatename_Mapping.UTF8.properties, required to address those objects that are dependent on the topology of the environment and that cannot be reproduced without some manual customization. The target user will modify the file replacing the names of the objects in the source environment with the names that these objects have in the target environment.
A reference information file: A reference information file, workload applicationtemplatename_SourceEnv_reference.txt, containing the definitions of the workstations used in the workload application template and other information that can be useful to correctly map the source environment into the target environment so as to make the workload application run.

You can import the compressed package from the Dynamic Workload Console with an intuitive guided procedure, as described in Reusing a workload in another environment.

You can also manually import the compressed package into the target environment where the workload application will be deployed, thus creating all the required objects in the target environment. In the target environment, the workload application name_Mapping.UTF8.properties file must be edited manually, using a generic text editor, by specifying the names of the objects as they are defined in the target environment (for example, the names of the workstations on which the job streams run). The import operation must be performed in the target environment by using the command line. For more details, see Managing workload applications.

When using composer command line, each workload application definition has the following format and arguments:

Syntax

wat [folder/]wat_name
     [description "description"]
     [vendor "vendor"]
     jstreams
     [[folder/]workstation#[folder/]jobstream [[folder/]workstation#[folder/]jobstream]...]
   end

Arguments

[folder/]wat: Mandatory field that contains the name of the workload application template. The maximum length is 80 characters. In product versions prior to HCL Workload Automation version 9.4, Fix Pack 1, this keyword was named bapplication.
description: Optional descriptive text to help workload application users understand the purpose and characteristics of the workload application. The maximum length is 120 characters.
vendor: Optional field that specifies the creator of the workload application template. It can be useful to let workload application users know who created and provided it. The maximum length is 120 characters.
[folder/]jstreams: The job streams that you want to add to the workload application template.

Examples

To create two workload application templates, WAT_NAME1 and WAT_NAME2, run:


new wat
WAT WAT_NAME1
  DESCRIPTION "Description"
  VENDOR "Provider"
  JSTREAMS
      FTAfolder/FTA1#JS_1_1
      Agentfolder/AGENT1#JS_1_2
END

WAT WAT_NAME2
  DESCRIPTION "Description"
  VENDOR "Provider"
  JSTREAMS
      JS_2_1
      JS_2_2
END