GetWorkflowLog
Use this function to retrieve a history log for a specified Workflow process and step. The function will return an object with the following properties:
| Property | Description |
|---|---|
WFProcessName |
String indicating the name of the Workflow Process |
WFStepName |
String indicating the Workflow step name |
DimensionName |
String indicating the Approval Dimension, if applicable |
SymbolName |
String indicating the Symbol Name, for hierarchical steps |
History |
An object list containing a history of the status changes for the workflow step. The history object contains the following properties:
|
The return values for the status properties CurrentStatus and PreviousStatus:
| Property | Description |
|---|---|
-1 |
Failed Note: Failed indicates the Longview Application Framework function did not execute properly or encountered an issue. |
0 |
Not Started |
999 |
Rejected |
1000 |
In Progress |
2000 |
Submitted for Approval |
3000 |
Approved |
9999 |
No Previous Status Available |
Syntax:
GETWORKFLOWLOG TO FileName|ObjectListName Process Step[ Symbol]
where:
-
FileName is the name for the created ASCII file, containing the workflow log data. It can include a complete or partial folder path in the format C:\...\FileName1. If FileName1 includes spaces, enclose it in double quotation marks; for example:
@"C:\My Documents\WF_Log.json"
- ObjectListName is the name of the object list variable, containing the workflow log data.
- Process is the name of an active Workflow process. If the process name contains spaces, enclose it in double quotation marks (" ").
- Step is the name of the Longview Workflow step within the process. If the step name contains spaces, enclose it in double quotation marks (" ").
- Symbol is optional for hierarchical steps, and is the symbol for the hierarchical step. Symbol is not used for simple steps.
Syntax example:
CREATE VARIABLE WFLog[] AS Object
GETWORKFLOWLOG TO WFLog MonthEndProcess "ABC Canada" E10000