Specifying local variables and passwords in job types with advanced options
After defining a variable and its value with the
param
command,
to add it within a job definition so that it is resolved locally on
the agent at run time, use the following syntax:${agent:variable_name}
After defining a password with the
param
command,
to add it within a job definition so that it is resolved locally on
the agent at run time, use the following syntax:${agent:password.user_name}
You
can nest variables within passwords. If you used a variable to define
a user, enter the password as follows within the job definition:
${agent:password.${agent:variable_name}}
where variable_name was
previously defined as having value user_name with the param
command.Example
An HCL Workload Automation administrator
needs to define a file transfer job that downloads a file from a remote
server to one of the HCL Workload Automation Agents making
up a pool of agents. The administrator wants to parametrize in the
job definition:
- The name with which the remote file will be saved locally
- The remote user name and its password
The administrator proceeds in the following way on one
of the agents:
- Defines a variable named
localfile
. The variable is given a value equal to./npp.5.1.1.Installer.DW.exe
and is created in a new variables file namedFTPvars
(no section). The command to do this is:E:\IBM\TWA\TWS\CLI\bin>param -c FTPvars..localfile ./npp.5.1.1.Installer.DW.exe
- Defines a variable named
remoteUser
. The variable is given a value equal toFTPuser
and is created in theFTPvars
file (no section). The command to do this is:E:\IBM\TWA\TWS\CLI\bin>param -c FTPvars..remoteUser FTPuser
- Defines the password for
FTPuser
. The password value istdwb8nxt
and is created in thepassword
section of theFTPvars
file. The command to do this is:E:\IBM\TWA\TWS\CLI\bin>param -c FTPvars.password.FTPuser tdwb8nxt
- With a text editor opens file E:\IBM\TWA\TWS\ITA\cpa\config\jm_variables_files\FTPvars and
checks its contents:
localfile = ./npp.5.1.1.Installer.DW.exe remoteuser = FTPuser [password] FTPuser = {aes}XMMYMY2zBHvDEDBo5DdZVmwOJao60pX1K6x2HhRcovA=
- Copies file
FTPvars
in the agent_installation_path\TWA\TWS\ITA\cpa\config\jm_variables_files> path of every other agent defined in the pool. - Starts defining the new file transfer job in the Workload - Design
windows of Dynamic Workload Console.
In the
FileTransfer
window:- Enters
${agent:FTPvars..localfile}
in theLocal file
field. - Enters
${agent:FTPvars..remoteuser}
in theRemote Credentials
→;User Name
field. - Clicks the
...
button next to theRemote Credentials
→;Password
field. ThePassword type
window pops up and the administrator selectsAgent User
. - After the administrator clicks the
OK
button for confirmation in the popup window, theRemote Credentials
→;Password
field is complete with the${agent:password.${agent:FTPvars..remoteuser}}
value.
- Enters
- Type in all the other fields to complete the job definition.
FTPvars
file.