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

getworkflowdetails

getworkflowdetails

Returns the following information about a workflow:
  • Folder and workflow names
  • Workflow run status
  • First error code and error message
  • Start and end times
  • Log file name
  • Workflow run type
  • Name of user that last ran the workflow
  • Name of associated Integration Service
The getworkflowdetails command uses the following syntax in the command line mode:
pmcmd getworkflowdetails <<-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] [<-runinsname|-rin> runInsName] [-wfrunid workflowRunId] workflow
The getworkflowdetails command uses the following syntax in the interactive mode:
getworkflowdetails [<-folder|-f> folder] [<-runinsname|-rin> runInsName] [-wfrunid workflowRunId] workflow
The following table describes
pmcmd
getworkflowdetails 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.
-runinsname
-rin
runInsName
Name of the workflow run instance. Use this option if you are running concurrent workflows.
-wfrunid
workflowRunId
Run identifier number (Run ID) of the workflow run instance. Use this option if you are running concurrent workflows.
Use this option if the workflow does not have a unique run instance name.
-
workflow
Name of the workflow.
The following table describes the different statuses for workflows:
Status Name
Description
Aborted
You choose to abort the workflow or task in the Workflow Monitor or through
pmcmd
. The Integration Service kills the DTM process and aborts the task. You can recover an aborted workflow if you enable the workflow for recovery.
Aborting
The Integration Service is in the process of aborting the workflow.
Disabled
You select the Disabled option in the workflow properties. The Integration Service does not run the disabled workflow until you clear the Disabled option.
Failed
The Integration Service fails the workflow because it encountered errors. You cannot recover a failed workflow.
Preparing to Run
The Integration Service is waiting for an execution lock for the workflow.
Running
The Integration Service is running the workflow.
Scheduled
You schedule the workflow to run at a future date. The Integration Service runs the workflow for the duration of the schedule.
Stopped
You choose to stop the workflow or task in the Workflow Monitor or through
pmcmd
. The Integration Service stops processing the task and all other tasks in its path. The Integration Service continues running concurrent tasks. You can recover a stopped workflow if you enable the workflow for recovery.
Stopping
The Integration Service is in the process of stopping the workflow.
Succeeded
The Integration Service successfully completes the workflow.
Suspended
The Integration Service suspends the workflow because a task failed and no other tasks are running in the workflow. This status is available when you select the Suspend on Error option. You can recover a suspended workflow.
Suspending
A task fails in the workflow when other tasks are still running. The Integration Service stops running the failed task and continues running tasks in other paths. This status is available when you select the Suspend on Error option.
Terminated
The Integration Service shuts down unexpectedly when running this workflow or task. You can recover a terminated workflow if you enable the workflow for recovery.
Terminating
The Integration Service is in the process of terminating the workflow or task.
Unknown Status
This status displays in the following situations:
  • The Integration Service cannot determine the status of the workflow or task.
  • The Integration Service does not respond to a ping from the Workflow Monitor.
  • The Workflow Monitor cannot connect to the Integration Service within the resilience timeout period.
Unscheduled
You remove a workflow from the schedule.
Waiting
The Integration Service is waiting for available resources so it can run the workflow or task. For example, you may set the maximum number of running Session and Command tasks allowed for each Integration Service process on the node to 10. If the Integration Service is already running 10 concurrent sessions, all other workflows and tasks have the Waiting status until the Integration Service is free to run more tasks.
The getworkflowdetails command displays the last workflow run type details. Workflow run types refers to the method used to start the workflow.
The following table describes the different workflow run types with the getworkflowdetails command:
Workflow Run Types
Description
User Request
Manually started a workflow.
Schedule
Workflow runs at the scheduled time.


Updated April 15, 2019