Command Reference > pmcmd Command Reference > StartTask
  

StartTask

Starts a task.
The StartTask command uses the following syntax in the command line mode:
pmcmd StartTask

<<-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]

<-workflow|-w> workflow

[<-paramfile> paramfile]

[-wait|-nowait]

[<-recovery|-norecovery>]

[<-runinsname|-rin> runInsName]

taskInstancePath
The StartTask command uses the following syntax in the interactive mode:
pmcmd StartTask

[<-folder|-f> folder]

<-workflow|-w> workflow

<-paramfile> paramfile]

[-wait|-nowait]

[<-recovery|-norecovery>]

[<-runinsname|-rin> runInsName]

taskInstancePath
The following table describes pmcmd StartTask 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.
-workflow
-w
workflow
Required. Name of the workflow.
-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.
-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.
-recovery
-norecovery
-
Optional. If the task is a session, 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 Task 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 Task 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.
-runinsname
-rn
runInsName
Name of the workflow run instance that contains the task you want to start. Use this option if you are running concurrent workflows.
-
taskInstancePath
Required. Specifies a task name and where it appears within the workflow. 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.

Using Parameter Files with starttask

When you start a task, you can optionally enter the directory and name of a parameter file. The Integration Service runs the task using the parameters in the file you specify.
For UNIX shell users, enclose the parameter file name in single quotes:
-paramfile '$PMRootDir/myfile.txt'
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:
-paramfile "$PMRootDir\my file.txt"
When you write a pmcmd command that includes 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.
pmcmd starttask -sv MyIntService -d MyDomain -uv USERNAME -pv PASSWORD ‑f east -w wSalesAvg -paramfile '\$PMRootDir/myfile.txt' taskA