To run a process flow from the command line, use the Process Flow Executor. You can install the Process Flow Executor from the Spectrum Technology Platform Welcome page (for example, http://myserver:8080).
Usage
java -jar pflowexecutor.jar -r ProcessFlowName -u UserID -p Password [Optional Arguments]| Required | Argument | Description |
|---|---|---|
| No | -? | Prints usage information. |
| No | -d DelimiterCharacter |
Sets a delimiter to use to separate the status information displayed in the command line when you run the command. The default is "|". For example, using the default character, the message below is displayed at the command line when you run a process flow named "MyProcessflow": MyProcessflow|1|Succeeded |
| No | -e | Use an HTTPS connection for communication with the Spectrum Technology Platform server. Note: If you specify any file overrides this
argument must not be the last argument specified.
|
| No | -f PropertyFile | Specifies a path to a property file. For more information on property files, see Using a Process Flow Property File. |
| No | -h HostName | Specifies the name or IP address of the Spectrum Technology Platform server. |
| No | -i PollInterval | Specifies how often to check for completed jobs, in seconds. The default is "5". |
| Yes | -p Password | The password of the user. Required. |
| Yes | -r ProcessFlowNames | A comma-separated list of process flows to run. Required. Note: If you
specify any file overrides this argument must not be the last argument
specified.
|
| No | -s Port | The socket (port) on which the Spectrum Technology Platform server is running. The default is 8080. |
| No | -t Timeout | This option is deprecated and will be ignored. |
| Yes | -u UserName | The login name of the user. Required. |
| No | -v Verbose | Return verbose output where Verbose is one of the following:
Note: If you specify any file overrides this argument must not be the last
argument specified.
|
| No | -w WaitToComplete | This option is deprecated and will be ignored. |
| No | StageName=FileName | Overrides the input or output file specified in the job. For more information, see Overriding Process Flow File Locations. |
Examples
This is a basic command-line entry, with a process flow name and user ID, and password:
java -jar pflowexecutor.jar -r MyFlow1 -u Bob1234 -p "mypassword1"This example shows the same information as above but with additional arguments:
java -jar pflowexecutor.jar -r Flow1 -u Bob1234 -p "mypassword1" -h spectrum.example.com -s 8080 -w -d "%" -i 1This example shows command line invocation and output.
D:\spectrum\pflow-executor>java -jar pflowexecutor.jar -u Bob1234 -p "mypassword1" -r
validateAddressFlow1 -h spectrum.example.com -s 8080 -w -d "%" -i
1 -t 9999
validateAddressJob1%111%succeededIn this example, the process flow named validateAddressFlow1 ran (with identifier 111). No errors occurred. Other possible results include "failed" or "running."