WFGetProcessProperty

This call returns the properties of the Process specified. You can view the XML input and output parameters, which have to be passed for getting the process properties. There is a list of errors and warning that can occur in the execution.

 

Input Parameter description

 View Sample InputXML

Output Parameter description

 View Sample OutputXML

Errors and Warnings

View Sample Code

 

 

Input Parameter description

* implies for the mandatory parameter.

Name

Parent Tag

Description

Valid Value

Option *

Root

It refers to the case sensitive call name.

 case sensitive call name.

EngineName *

Root

It is the cabinet or database name, which has to be connected.

NA

SessionID *

Root

It is the logged in user session id

NA

ProcessDefID*

Root

It refers to the id of the process definition

NA

DataFlag

Root

Whether to fetch data or not

Y = Yes

N = No

 

Output Parameter description

Name

Parent Tag

Description

Option

Root

It refers to the case sensitive call name.

MainCode

Exception

Error code specified by WAPI.

VersionNo

Root

It is the version number of the process.

ProcessName

Root

It is the process name

ProcessState

Root

It is the process state. It can be Completed, Running, Suspended, Aborted, Not Started, Terminated

ProcessTurnAroundTime

Root

It is the time taken to complete the process

ActivityId

ActivityInfo

It is the activity index associated with the process

ActivityName

ActivityInfo

It is the activity name associated with the process

NoofInstances

ActivityInfo

It is the total number of instances associated with the process.

 

Errors and Warnings

Code

Constant Value

Message

18

WM_NO_MORE_DATA

No more records

11

WM_INVALID_SESSION_HANDLE

Invalid session

15

WM_INVALID_FILTER

The requested filter is invalid.