jtrigger

manually submits a previously committed flow definition.

Synopsis

jtrigger [-u user_name] [-e version] [-v "var=value[;var1=value1;...]"] [-f variable_file] flow_name flow_name...

jtrigger -h|-V

Description

You use the jtrigger command to submit a committed flow definition, which creates a flow associated with that definition. Any events normally used to submit this definition are ignored at this time.

If no version is specified, submits the default version of a flow definition.

If the flow definition is on hold, you can use this command to submits a flow. If the flow definition is not on hold, this command submits an additional execution of the flow. If you want to submit a flow whose definition is not yet stored in Process Manager, use the jrun command.

Options

-u user_name

Specifies the name of the user who owns the flow definition. Use this option if you have administrator authority and you are triggering the flow on behalf of another user.

-e version

Specifies which version of the flow to submit. You can view versions for a flow definition with the command jdefs -v.

-v " var=value[;var1=value1;...]"
Specifies to pass variables and their values to the flow. To specify a list of variables, separate the variable and value pairs with a semi-colon (;). The value of the variable is available only within the scope of the flow itself (local variables only).
  • To specify a list of variables, separate the variable and value pairs with a semi-colon (;). For example: var1=1; var2=2;
  • Variable names:
    • Can only contain alphanumeric characters and underscores.
    • Cannot start with a number, cannot contain spaces, and cannot be empty.
    • Can have leading and trailing spaces. Leading and trailing spaces are trimmed.
  • Variable values can contain spaces and are kept as is.
-f variable_file

Specifies the path to a file that contains variables to pass to the flow.

Specify a relative path to indicate the file is located in the current working directory.

If both the -v and -f options are used to define variables, variables defined by both options are passed to the flow when triggering it. If the same variable is defined with the -v option and with the -f variable_file options, the variable specified with -v overrides the same variable specified in the variable file.

Example file:


# Example variable file
# Variables are delimited by semicolons. 
# The semicolon is not required for the last variable in a line

Var1=value1;Var2=value2Var3=value3;Var4=value4;

# Leading and trailing spaces in a variable name are trimmed
   Var5  = value5 ;    Var6=value6
Variable file format:
  • To specify a list of variables, separate the variable and value pairs with a semi-colon (;). For example: var1=1; var2=2;
  • Each line can contain one or more variables.
  • Blank lines are ignored.
  • Variable names:
    • Can only contain alphanumeric characters and underscores.
    • Cannot start with a number, cannot contain spaces, and cannot be empty.
    • Can have leading and trailing spaces. Leading and trailing spaces are trimmed.
  • Variable values can contain spaces and are kept as is.
  • Each comment line starts with # and ends with a line break.
flow_name

Specifies the name of the flow definition. To specify a list of flow definitions, separate the flow definition names with a space.

-h

Prints the command usage to stderr and exits.

-V

Prints the Process Manager release version to stderr and exits.

Examples

jtrigger myflow

Submit the flow definition myflow, which is owned by the current user.

jtrigger -u "user01" payupdt

Submit the flow definition payupdt, which is owned by user01.

jtrigger -v "PMONTH=October" payflow

Submit the flow definition payflow, which is owned by the current user, and passes it a value of October for the variable PMONTH.

See also

jrun