Table of Contents

Search

  1. Preface
  2. Command Line Programs and Utilities
  3. Installing and Configuring Command Line Utilities
  4. Using the Command Line Programs
  5. Environment Variables for Command Line Programs
  6. Using infacmd
  7. infacmd as Command Reference
  8. infacmd aud Command Reference
  9. Infacmd bg Command Reference
  10. infacmd cluster Command Reference
  11. infacmd cms Command Reference
  12. infacmd dis Command Reference
  13. Infacmd es Command Reference
  14. infacmd ihs Command Reference
  15. infacmd ipc Command Reference
  16. infacmd isp Command Reference
  17. infacmd ldm Command Reference
  18. infacmd mrs Command Reference
  19. infacmd ms Command Reference
  20. infacmd oie Command Reference
  21. infacmd ps Command Reference
  22. infacmd pwx Command Reference
  23. infacmd rms Command Reference
  24. infacmd rtm Command Reference
  25. infacmd sch Command Reference
  26. infacmd search Command Reference
  27. infacmd sql Command Reference
  28. infacmd tdm Command Reference
  29. infacmd wfs Command Reference
  30. infacmd ws Command Reference
  31. infacmd xrf Command Reference
  32. infacmd Control Files
  33. infasetup Command Reference
  34. pmcmd Command Reference
  35. pmrep Command Reference
  36. Working with pmrep Files

Command Reference

Command Reference

StartWorkflow

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.


Updated April 22, 2019