HCL Workload Automation, Version 9.4

Access method jobs

Access method jobs extend HCL Workload Automation scheduling functions to other systems and applications using access methods. The access methods communicate with the external system to launch the job and return the status of the job.

A description of the job properties and valid values are detailed in the context-sensitive help in the Dynamic Workload Console by clicking the question mark (?) icon in the top-right corner of the properties pane.

This section describes the required and optional attributes for access method jobs. Each job definition has the following format and arguments:

Table 1. Required and optional attributes for the definition of an access method job
Attribute	Description/value	Required
application name	xajob	✓
accessMethod	The name of the access method used to communicate with the external system to start the job and return the status of the job.	✓
target	The name of an option file.
taskString	Command to be interpreted by the selected method. The maximum line length is 8 KB.	✓
credentials	The name and password of the user running this job. As an alternative to hard-coding actual values, you can parametrize in one of the following ways: Enter a username specified in the database with the user definition (it is applicable to all operating systems on this job type) and key the statement: `<jsdl:password>${password:username}</jsdl:password>` The password is retrieved from the username user definition in the database and resolved at runtime. For further details, see Using user definitions on job types with advanced options. You can also specify the user of a different workstation and use the following syntax for the password: `<jsdl:password>${password:workstation#username} </jsdl:password>` Enter a user and password defined with the `param` utility command locally on the dynamic agent that will run the job (if the job is to be submitted to a pool or to a dynamic pool, the definition must be present on all the agents of the pool). If you defined the user name with the variable user and a password, the corresponding credential statements is: `<jsdl:userName>${agent:user}</jsdl:userName> <jsdl:password>${agent:password.user}</jsdl:password>` The user and password variables are resolved on the agent at runtime. For further details, see Defining variables and passwords for local resolution on dynamic agents.

The following example shows a job that creates a file in the /methods folder using a default access method job:

$JOBS
AGENT#XA_JOB
TASK
<?xml version="1.0" encoding="UTF-8"?>
<jsdl:jobDefinition xmlns:jsdl="http://www.ibm.com/xmlns/prod/scheduling/1.0/jsdl" xmlns:jsdlxa=
"http://www.ibm.com/xmlns/prod/scheduling/1.0/jsdlxa" name="xajob">
  <jsdl:application name="xajob">
    <jsdlxa:xajob accessMethod="unixlocl" target="optionFile">
       <jsdlxa:taskString>touch file</jsdlxa:taskString>
       <jsdlxa:credentials>
         <jsdlxa:userName>TestUser</jsdlxa:userName>
         <jsdlxa:password>{aes}IEr/DES8wRzQEij1ySQBfUR587QBxM0iwfQ1EWJaDds=</jsdlxa:password>
       </jsdlxa:credentials>
     </jsdlxa:xajob>
  </jsdl:application>
</jsdl:jobDefinition>
DESCRIPTION "Defined using composer."
RECOVERY STOP

Access method jobs

See also