StartWorkflow
Starts a workflow.
The StartWorkflow command uses the following syntax in the command line mode:
pmcmd StartWorkflow
<<-service|-sv> service [<-domain|-d> domain] [<-timeout|-t> timeout]>
<<-user|-u> username|<-uservar|-uv> userEnvVar>
<<-password|-p> password|<-passwordvar|-pv> passwordEnvVar>
[<<-usersecuritydomain|-usd> usersecuritydomain|<-usersecuritydomainvar|-usdv> userSecuritydomainEnvVar>]
[<-folder|-f> folder]
[<-startfrom> taskInstancePath]
[<-recovery|-norecovery>]
[<-paramfile> paramfile]
[<-localparamfile|-lpf> localparamfile]
[<-osprofile|-o> OSUser]
[-wait|-nowait]
[<-runinsname|-rin> runInsName]
workflow
The StartWorkflow command uses the following syntax in the interactive mode:
pmcmd StartWorkflow
[<-folder|-f> folder]
[<-startfrom> taskInstancePath [<-recovery|-norecovery>]]
[<-paramfile> paramfile]
[<-localparamfile|-lpf> localparamfile]
[<-osprofile|-o> osProfile]
[-wait|-nowait]
[<-runinsname|-rin> runInsName]
workflow
The following table describes pmcmd StartWorkflow options and arguments:
Option | Argument | Description |
|---|
-service -sv | service | Required. Integration Service name. |
-domain -d | domain | Optional. Domain name. |
-timeout -t | timeout | Optional. Amount of time, in seconds, pmcmd attempts to connect to the Integration Service. If the -timeout option is omitted, pmcmd uses the timeout value specified in the environment variable INFA_CLIENT_RESILIENCE_TIMEOUT. If the environment variable is not set, pmcmd uses the default timeout value. Default is 180. |
-user -u | username | Required in command line mode if you do not specify the user name environment variable. User name. Not used in interactive mode. |
-uservar -uv | userEnvVar | Specifies the user name environment variable. Required in command line mode if you do not specify the user name. Not used in interactive mode. |
-password -p | password | Required in command line mode if you do not specify the password environment variable. Password. Not used in interactive mode. |
-passwordvar -pv | passwordEnvVar | Required in command line mode if you do not specify the password. Password environment variable. Not used in interactive mode. |
-usersecuritydomain -usd | usersecuritydomain | Optional in command line mode. Required if you use LDAP authentication. Name of the security domain that the user belongs to. Not used in interactive mode. Default is Native. |
-usersecuritydomainvar -usdv | userSecuritydomainEnvVar | Optional in command line mode. Security domain environment variable. Not used in interactive mode. |
-folder -f | folder | Required if the workflow name is not unique in the repository. Name of the folder containing the workflow. |
-startfrom | taskInstancePath | Optional. Starts a workflow from a specified task, taskInstancePath. If the task is within a workflow, enter the task name alone. If the task is within a worklet, enter WorkletName.TaskName. Enter the taskInstancePath as a fully qualified string. If you do not specify a starting point, the workflow starts at the Start task. If the task is a session, specify -recovery or -norecovery option to run the session based on the configured recovery strategy. |
-paramfile | paramfile | Optional. Determines which parameter file to use when a task or workflow runs. It overrides the configured parameter file for the workflow or task. |
-recovery -norecovery | - | Optional. The Integration Service runs the session based on the configured recovery strategy. - - recovery. For real-time sessions that are enabled for recovery, the Integration Service recovers the failed session and stops running the rest of the tasks in the workflow.
The recovery option is the same as the Recover Workflow option in the Workflow Manager. This option is not applicable for sessions that do not have recovery enabled. - - norecovery. For real-time sessions that are enabled for recovery, the Integration Service does not process recovery data. The Integration Service clears the state of operation and the recovery file or table before it restarts the task. For the sessions that do not have recovery enabled, the Integration Service clears the state of operation and restarts the task.
The norecovery option is the same as the Cold Start Workflow option in the Workflow Manager.
If you do not provide any option for recovery enabled sessions, the Integration Service runs the session in recovery mode. If you do not provide any option for the sessions that do not have recovery enabled, the Integration Service runs the session in norecovery mode. |
-localparamfile -lpf | localparamfile | Optional. Specifies the parameter file on a local machine that pmcmd uses when you start a workflow. |
-osprofile -o | osProfile | Optional. Specifies the operating system profile assigned to the workflow. |
-wait -nowait | - | Optional. Configures the wait mode: - - wait. You can enter a new pmcmd command only after the Integration Service completes the previous command.
- - nowait. You can enter a new pmcmd command after the Integration Service receives the previous command.
Default is nowait. |
-runinsname -rin | runInsName | Name of the workflow run instance you want to start. Use this option if you are running concurrent workflows. |
- | workflow | Required. Name of the workflow. |
Using Parameter Files with startworkflow
When you start a workflow, you can optionally enter the directory and name of a parameter file. The Integration Service runs the workflow using the parameters in the file you specify. For UNIX shell users, enclose the parameter file name in single quotes. For Windows command prompt users, the parameter file name cannot have beginning or trailing spaces. If the name includes spaces, enclose the file name in double quotes.
Use parameter files on the following machines:
- •Node running the Integration Service. When you use a parameter file located on the Integration Service machine, use the -paramfile option to indicate the location and name of the parameter file.
On UNIX, use the following syntax:
-paramfile '$PMRootDir/myfile.txt'
On Windows, use the following syntax:
-paramfile "$PMRootDir\my file.txt"
- •Local machine. When you use a parameter file located on the machine where pmcmd is invoked, pmcmd passes variables and values in the file to the Integration Service. When you list a local parameter file, specify the absolute path or relative path to the file. Use the -localparamfile or -lpf option to indicate the location and name of the local parameter file.
On UNIX, use the following syntax:
-lpf 'param_file.txt'
-lpf 'c:\Informatica\parameterfiles\param file.txt'
-localparamfile 'c:\Informatica\parameterfiles\param file.txt'
On Windows, use the following syntax:
-lpf param_file.txt
-lpf "c:\Informatica\parameterfiles\param file.txt”
-localparamfile param_file.txt
- •Shared network drives. When you use a parameter file located on another machine, use the backslash (\) with the dollar sign ($). This ensures that the machine where the variable is defined expands the process variable.
-paramfile '\$PMRootDir/myfile.txt'