Configuring properties of the native job launcher [NativeJobLauncher]

About this task

In the JobManager.ini file, the section containing the properties of the native job launcher is named:

[NativeJobLauncher]

You can change the following properties:

AllowQECOFR

Applies to IBM i systems only. Specifies if QSECOFR user can run jobs on the agent. It can be true or false. The default is true. Add a line like AllowQSECOFR = false to the JobManager.ini file to deny job execution to QSECOFR.

AllowRoot

Applies to UNIX™ systems only. Specifies if the root user can run jobs on the agent. It can be true or false. The default is false. This property does not apply to IBM i, use the AllowQSECOFR property instead

AppendJobOutputs

Specifies how standard output and standard error logs are recorded. Starting from version 10.2.8, HCL Workload Automation overwrites these logs by default. To change this behavior and revert to appending data, manually add this property to the [NativeJobLauncher] section of the JobManager.ini file and set it to true. This property is not present in the file by default; if it is not specified, the default value is considered false. You can add the property manually if you need to modify the default behavior. This property applies to all supported operating systems.

CheckExec

If true, before launching the job, the agent checks both the availability and the execution rights of the binary file. The default is true.

DefaultWorkingDir

Specifies the working directory of native jobs. You can also specify the value for the working directory when creating or editing the job definition in the Graphical Designer. When specified in the Graphical Designer, this value overrides the value specified for the DefaultWorkingDir property. If you do not specify any working directories, the <TWS_home>\bin directory is used.

InheritParentEnv

Specifies how environment variables are inherited and loaded when a job is run. The behavior of this property interacts directly with the user profile loading settings (LoadProfile property), as follows:

InheritParentEnv is set to false and LoadProfile is false: HCL Workload Automation loads only a minimal set of default environment variables.
InheritParentEnv is set to false and LoadProfile is true: HCL Workload Automation loads the minimal set of environment variables plus the profile associated with the user running the job (such as the .profile file).
InheritParentEnv is set to true and LoadProfile is false: HCL Workload Automation loads the full environment of the agent including its environment variables.
InheritParentEnv is set to true and LoadProfile is true: HCL Workload Automation loads the full environment of the agent including its environment variables and also loads the user profile and its environment variables. If any variables are duplicated, the variables in the user profile are loaded and the corresponding variables in the agent environment are discarded.

The minimal set of variables that are loaded, in addition to variables defined by the user in the job definition, is as follows:

HOME
UNISON_SHELL
LOGNAME
LOGIN
USER

This property is not present in the file by default; if it is not specified, the default value is considered false. You can add the property manually if you need to modify the default behavior. This property applies to all supported operating systems with the exception of Windows.

JobUnspecifiedInteractive

Applies to Windows™ operating systems only. Specifies if native jobs are to be launched in interactive mode. It can be true or false. The default is false.

KeepCommandTraces

Set to true to store the traces of the method invocation for actions performed on a job definition, for example, when selecting from a picklist. These files are stored in the path /opt/HCL/TWA_<TWS_user>/TWS/stdlist/JM/r3batch_cmd_exec. The default setting is false.

KeepJobCommandTraces

Set to true to store the traces of the method invocation for actions performed on a job instance, for example, viewing a spool list. These files are stored in the .zip file of the job instance. The default setting is true.

LoadProfile

Starting from 10.2.8, applies to all supported operating systems. Specifies whether the profile of the user running the job is loaded. Valid values are true and false. The default value is true. If you are upgrading from a version earlier than 10.2.8 on an operating system other than Windows, this property is automatically set to false to maintain backward compatibility with previous releases, which did not support this feature for operating systems other than Windows.

MonitorQueueName

Specifies the name of the queue where the IBM i jobs are monitored. If you do not specify this property, the default queue (QBATCH) is used.

PortMax

The maximum range of the port numbers used by the task launcher to communicate with the Job Manager. The default is 0, meaning that the operating system assigns the port automatically.

PortMin

The minimum range of the port numbers used by the task launcher to communicate with the Job Manager. The default is 0, meaning that the operating system assigns the port automatically.

PostJobExecScriptPathName

The fully qualified path of the script file that you want to run when the job completes. By default, this property is not present in the JobManager.ini file. If you do not specify any file path or the script file doesn't exist, no action is taken.

This property applies to dynamic agent and z/OS agent. For details about running a script when a job completes, see User's Guide and Reference.

PromotedNice

Used in workload service assurance. This property is not supported on the Agent for z/OS.

For UNIX and Linux operating systems only, assigns the priority value to a critical job that needs to be promoted so that the operating system processes it before others. Applies to critical jobs or predecessors that need to be promoted so that they can start at their critical start time.

Boundary values vary depending upon each specific platform, but generally lower values correspond to higher priority levels and vice versa. The default is -1.

Be aware that:

The promotion process is effective with negative values only. If you set a positive value, the system runs it with the -1 default value.
An out of range value (for example -200), prompts the operating system to automatically promote the jobs with the lowest allowed nice value.
Overusing the promotion mechanism (that is, defining an exceedingly high number of jobs as mission critical and setting the highest priority value here) might overload the operating system, negatively impacting the overall performance of the workstation.

PromotedPriority

Used in workload service assurance. This property is not supported on the Agent for z/OS.

For Windows operating systems only, sets to this value the priority by which the operating system processes a critical job when it is promoted. Applies to critical jobs or predecessors that need to be promoted so that they can start at their critical start time. Valid values are:

High
AboveNormal (the default)
Normal
BelowNormal
Low or Idle

Note that if you a set a lower priority value than the one non-critical jobs might be assigned, no warning is given.

RequireUserName

When true, requires that you add the user name in the JSDL job definition.

When false, runs with the user name used by job manager, that is:

TWS_user on UNIX™ and Linux™ systems
The local system account on Windows™ systems

The default is false.

RunExecutablesAsIBMiJobs

If you set this property to true, you can define IBM i jobs as generic jobs without using the XML definition. Generic jobs are automatically converted to IBM i jobs. As a side effect, generic jobs cannot be run when this parameter is enabled (RunExecutablesAsIBMiJobs=true). There is no default value because this property is not listed in the JobManager.ini file after the agent installation.

If you set this property to true, ensure that the user you used to install the agent has been granted the *ALLOBJ special authority.

RunInteractiveJobOnInvalidSession

Applies only to native and executable jobs starting interactive programs running on dynamic agents installed on Windows operating systems. Interactive programs run only if the job user has an active session open when the job runs. If there is no active session for the job user, the job behavior is defined by this property, as follows. Set the property to true to enable jobs to start interactive programs even if there is no active session for the job user. Set the property to false to prevent jobs from starting interactive programs if there is no active session for the job user.

ScriptSuffix

The suffix to be used when creating the script files. It is:

.cmd: For Windows™
.sh: For UNIX™

SpawnLifecyclePolicy

Specifies how the scripts ran by jobs are monitored. The following options are available:

wait-spawned-immediate: The status of the job is returned as soon as the job completes, regardless of whether the job started any background processes. HCL Workload Automation keeps monitoring the background processes generated by the job, if any. This might be useful, for example, if you need to retrieve the standard output or the standard error of the job. This is the default value.
wait-spawned-deferred: The status of the job is returned after all background processes started by the job, if any, have completed.
nowait-spawned-immediate: The status of the job is returned as soon as the job completes, regardless of whether the job started any background processes. HCL Workload Automation does not monitor any background processes generated by the job.

This property is not present in the file by default; if it is not specified, the default value is considered wait-spawned-immediate. You can add the property manually if you need to modify the default behavior. This property applies to all supported operating systems with the exception of Windows.

VerboseTracing

Enables verbose tracing. It is set to true by default.