HCL Workload Automation, Version 9.4

submit file

Submits a file to be launched as a job.

To run this command, in the security file you must have submit access for the job with the name specified in its database definition and, if you use the alias keyword, also with the name specified with this keyword. In addition, if you use the recoveryjob keyword, you must have submit access for the job specified with that keyword.

To include needs and prompt dependencies, you must have use access to the resources and global prompts.

If you submit the job from a workstation other than the master domain manager, you must be connecting as a user that:
  • Has proper credentials defined in the useropts file to connect to the master domain manager through WebSphere Application Server
  • Is authorized to perform submit commands in the security file stored on the master domain manager

Syntax

{submit file | sbf} "filename"
     [;alias[=name]]
     [;into=[workstation#]{jobstream_id
;schedid |jobstreamname([hhmm[ date]])}]
     [;joboption[;...]]
     [;noask]

Arguments

filename
Specifies the name of the file, up to 255 characters. Wildcard characters are permitted. The name must be enclosed in quotes (") if it contains characters other than alphanumeric characters, dashes (-), slashes (/), and underscores (_). See the examples.
alias=name
Specifies a unique name to be assigned to the job. If you enter the alias keyword without specifying a name, a name is constructed using up to the first six alphanumeric characters (in upper case) of the file name, depending on the number of characters in the file name, followed by a ten digit random number. For example, if the file name is jclttx5, the generated name will be similar to JCLTTX0123456789.

If you do not include alias, a filename is constructed using up to 255 alphanumeric characters of the file's base name, in upper case.

In either of the above cases, if the file name does not start with a letter, you are prompted to use alias= name.

If you submit a file a second time from the same workstation, the alias keyword is mandatory and must be unique for each file submission.

into=jobstream_instance
Identifies the job stream instance into which the job will be placed for launching. Select the job stream instance as follows:

[workstation#]jobstreamname([hhmm[date]])

or

[workstation#]jobstream_id ;schedid

If into is not used, the job is added to a job stream named JOBS.

joboption
Specify one of the following:

at=hhmm [timezone|tz tzname] [+n days | mm/dd[/yy]] | [absolute | abs]

confirmed

critical

deadline=time[timezone | tz tzname][+n days | mm/dd[/yy]]

every=rate

follows=[netagent::][workstation#]{jobstreamname(hhmm [mmdd[/yy]]) [.job | @] | jobstream_id.job;schedid}| job '[IF condition_name[| condition_name][| ...]]' [;nocheck][;wait=time][,...]

The condition_name variable indicates the name of the condition defined in the job definition. Conditions can be status conditions, based on job status, or other output conditions, based on a mapping expression such as a return code, output variables, or output found in a job log. In each follows statement, you can specify only one dependency type: either status or output conditions. At submission time, you can add status or output conditions, but no joined dependencies.

wait
The time in seconds HCL Workload Automation waits before performing a second check on the dependency if the object specified in the dependency does not exist. If the object specified in the dependency was created during the wait interval, the submission is performed, otherwise the job is not submitted.
nocheck
Ignores the dependency. If the object specified in the dependency does not exist, the submission is performed anyway.
Note: The ;nocheck argument is not supported in internetwork dependencies.
interactive
Note: This keyword can be used in Windows environments only.

logon=user

maxdur=time[onmaxdur action]

mindur=time[onmindur action]

needs=[num] [workstation#]resource[,...]

opens=[workstation#]"filename"[(qualifier)][,...]

priority=[pri | hi | go]

prompt="[: | !]text" | promptname[,...]

recovery=stop | continue | rerun

recoveryjob=[workstation#]jobname

The name of a recovery job different from the one (if present) specified in the job definition in the database.

after [workstation#]jobname

abendprompttext

until time [timezone|tz tzname][+n day[s] | [absolute | abs]] [;onuntil action]

noask
Specifies not to prompt for confirmation before taking action against each qualifying file.

Using local parameters

You can use local parameters as values with the following keywords:
  • opens
  • logon
  • prompt
  • abendprompt

Local parameters are defined and managed with the parms utility command in a local database on the workstation where the job is run. The parameters are resolved on the workstation while the submit command is running.

Comments

Jobs submitted in production from the conman command line are not included in the preproduction plan and so they cannot be taken into account when identifying external follows dependencies predecessors.

If you do not specify a workstation with follows, needs, opens, or into, the default is the workstation on which conman is running.

The scheduler classifies follows dependencies as internal when they are specified only by their job name within the job stream. It classifies them as external when they are specified in the jobStreamName.workstationName.jobName format.

When you submit the object into a job stream and add a follows dependency that shares the same job stream name (for example, you submit the object into job stream schedA and define a follows dependency on schedA.job2), the dependency is treated as an external follows dependency. Since Version 8.3, unlike in previous versions, because the scheduler uses the sameday matching criteria to resolve external dependencies, dependencies originated in this way are never added the first time the object is submitted.

Examples

To submit a file into the job stream jobs (the job name is myjcl), run the following command:
submit file=d:\jobs\lib\daily\myjcl
where the ;into sequence was omitted.
To submit a file, with a job name of misjob4, into the job stream missked, run the following command:
sbf /usr/lib/mis/jcl4;alias=misjob4;into=missked ;needs=2 slots
The job needs two units of the slots resource.
To submit all files that have names beginning with back into the job stream bkup, run the following command:
sbf "/usr/lib/backup/back@";into=bkup
To submit file tws_env.cmd, whose path contains a blank, on a Windows workstation run:
  • In interactive mode:
    sbf "\"C:\Program Files\HCL\TWS\lucaMDM\tws_env.cmd\"";alias=MYJOB
    Being in Windows, the double quotation marks (") must be escaped by the "\ character sequence.
  • In command line mode:
    conman sbf "\"\\\"C:\Program Files\HCL\TWS\lucaMDM\tws_env.cmd\\\"\"";alias=MYJOB
    Being in Windows, and running the command externally from the conman environment, the escape sequence becomes longer.
where "\" is the escape character for the blank in the file path.