submit sched

You can use the submit sched command to start a workflow.

Overview

You can use the submit sched command to start a workflow with pre-defined conditions. You must have the submit access to the workflow to run the command. To use the alias keyword for the task, make sure the task name in the database and keyword are specified.

Syntax and command line options

Before you run the command, you must specify the details of the command line options such as workflow name and required permissions. There are mandatory and optional parameters which you can use to schedule the start of a workflow. You can enter the command as follows:

ocli plan submit sched | sbs [[folder/]workstation#][folder/]jstreamname [;alias[=name]] [jstreamoption[;...]] [;vartable=tablename] [;variable="variablename=value[,...]"] [;noask]

You can add parameters according to the specific results you want to achieve. The only mandatory parameter is jstreamname. The details required for each parameter are as follows:

workstation: Specify the workstation to run the task on. You can use wildcard characters and in such cases, the task is launched on all the matching workstations. If you do not specify any workstation, the task will run on the default workstation.

[folder/]: You can specify the name of the workflow folder that contains the workflow definition.

jstreamname: You must specify the name of the workflow to start. You can use wildcard characters. If you use wildcards all the matching workflow are submitted. If the workflow is already in the plan, you must use the alias parameter to assign it a unique name.

alias=name: You can specify a unique name for the workflow to use instead of the jstreamname name value. If you add the alias keyword without specifying a name, a name is created that use the first 5 alphanumeric characters followed by a random ten digit number.

jstreamoption

You can customize the start of a workflow with optional parameters. You can specify one or more of the options in the following table.

Table 1. jstream options
Options	Reference
`at time[timezone \| tz tzname][+n day[s] \| mm/dd \| mm/dd/yy]`	at
`schedtime=[hhmm [date [mm/dd \| mm/dd/yy] \| [+n days]`	schedtime
`deadline= time [timezone \| tz][+n day[s] \| [mm/dd \| mm/dd[/yy]]]`	deadline
`follows [[folder/]workstation#][folder/]{jobstreamname[hhmm [mm/dd[/yy]]][.job \| @] \| jobstream_id.job;schedid}\| job[,...] [if 'condition_name[\| condition_name][\| ...]']`	follows.
`until time [timezone\|tz tzname][+n day[s]] [;onuntil action]`	until and onuntil
`vartable=tablename`	You must specify the name of the variable table, if you are not using the default variable table to run the task. For more information, see Variable table definition. Important: You must use the backslash (\) as an escape character before the dollar sign ($) in a JSONATA expression, to prevent the substitution of value at the command line based on environment variables. If not, the command returns with a bad substitution error. Important: You must use the backslash (\) as an escape character before the dollar sign ($) in a JSONATA expression, to prevent the substitution of value at the command line based on environment variables. If not, the command returns with a bad substitution error. Note: Enclose the variable between carets (^), and then enclose the entire string between double quotation marks. If the variable contains a portion of a path, ensure that the caret characters are not immediately preceded by a backslash (\). Because the parser might incorrectly interpret the `\^` sequence as an escape sequence and resolve it as a caret character. If necessary, move the backslash into the definition of the variable between carets. Restriction: If the variables in the task definition are specified in ${variablename} format, the variable table is not resolved.
`variable`	You can specify a list of names or value pairs for variables that you want to set during the submission. They can be used in the tasks like normal variables defined in variable tables. The value passed on the variable argument on the submit will override the value specified in the variable table, if any.
`;noask`	When you add the noask option as an argument, the agent does not ask for confirmation before it acts on each qualifying item.

Examples

To submit the adhoc workflow included in the payroll folder on the site1 workstation stored in the myfolder folder, run the following command:
```
ocli plan submit sched = myfolder/site1#PAYROLL/adhoc
```
To submit the fox4 workflow with a task limit of 2 and an until time of midnight, run the following command:
```
ocli plan sbs = fox4;limit=2;until=0000
```
To submit the sched3 workflow on all workstations with names that start with site, run the following command:
```
ocli plan sbs = site@#sched3
```