Managing workload applications

Workload applications can be created and then exported so that they can be shared with other HCL Workload Automation environments. In the new environment, the workload application can be subsequently updated, replaced, or deleted.

Efficient workload processes can be reused in multiple environments. If you have a standardized solution that has been tested and fine-tuned then you can include it in a workload application template and deploy it to other environments for reuse.

The lifecycle of a workload application begins with the definition of the workload application template. The template is then exported to be deployed into the target environment.

You can define the workload application template by using either composer command line or the Dynamic Workload Console.

You can export the workload application template by using the procedure available in the Dynamic Workload Console, as described in ../src_tsweb/General_Help/reuse_wkld_anot_env.html#newwkldtemplate. You can also export a job stream definition from the Workload Designer, and save it as a workload application template in a compressed file, as described in ../src_tsweb/General_Help/reuse_wkld_anot_env.html#Exporting_js_as_wat.

You can import the workload application template by using the procedure available in the Dynamic Workload Console, as described in ../src_tsweb/General_Help/reuse_wkld_anot_env.html#importwkldtemplate. When importing, you can choose whether to import the workload application bound to the objects it contains, or to import only the contents of the workload application eliminating any ties to the workload application so that objects can be managed in the new environment with more flexibility.

To export and import the workload application, you can also use the wappman command line as described in the following topics.

Storing scheduling objects in folders is supported starting from version 9.5 and later. When importing a workload application from a product version earlier than 9.5, all imported objects are stored in the root folder. Ensure you have write access to the root folder before starting the import.

The export process produces a compressed file containing five files:
workload applicationname_Definitions.UTF8.xml
A file in XML format containing a definition of all the objects referenced in the workload application. The definitions are deployed in the target environment to populate the target database with the same objects existing in the source environment. Do not edit this file.
workload applicationname__Mapping.UTF8.properties
A mapping file that the target user modifies replacing the names of the objects in the source environment with the names that the objects will have in the target environment.
When the import process is performed from the wappman command line, you can optionally request that the mapping file is automatically modified according to rules defined using regular expressions and specified in one of the following ad-hoc files:
  • workload applicationname_BasicRegExpMapping.UTF8.rules
  • workload applicationname_AdvancedRegExpMapping.UTF8.rules
These files are produced by the export process and, if used, must be properly customized.
workload applicationname_SourceEnv_reference.txt
A file containing reference information about the workstations used in the workload application and other information that can be useful to correctly map the source environment to the target environment.
workload applicationname_BasicRegExpMapping.UTF8.rules
A file containing rules, defined using basic regular expressions, to modify the mapping file. Optionally customize this file according to the names that the objects will have in the target environment. The import process performed from the wappman command line then applies the defined rules to modify the mapping file.
workload applicationname_AdvancedRegExpMapping.UTF8.rules
A file containing rules, defined using advanced regular expressions, to modify the mapping file. Optionally customize this file according to the names that the objects will have in the target environment. The import process performed from the wappman command line then applies the defined rules to modify the mapping file.

You can skip objects when importing a workload application template by adding the SKP prefix before the object you want to skip. If you skip an object, an object with the same name must be present in the target environment, otherwise an error message is returned.

Each line in the mapping file specifies the objects to be imported in the new environment. To avoid importing a specific object, modify the mapping_properties_file by adding the SKP prefix before each object you want to skip.

Consider a mapping file containing two objects, as follows:
JOBSTREAM_TESTJS=TESTJS
JOB_TESTJOB1=TESTJOB1
If the JOB_TESTJOB1 job already exists in the target environment, modify the mapping_properties_file by adding the SKP prefix before the JOB_TESTJOB1 job, as follows:
JOBSTREAM_TESTJS=TESTJS
SKPJOB_TESTJOB1=TESTJOB1