SetWorkflowStatus
Use this function to set the status of a specific step within a Longview Workflow process. A return value of 0 indicates the step was set successfully and a return value of -1 indicates the step failed to set.
Note: You must be an Owner or Approver to set the status of a step. For more information, see the Longview Workflow Designer Guide.
Syntax
where:
- Process is the name of the Longview Workflow process for which to return the status. 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 (" ").
- Status is a numeric value, is the status to which you want to set the step, and can be one of the following:
To set status to...
Use...
Rejected
999
In Progress
1000
Submitted for Approval
2000
Approved
3000
Note: Not Started is not a valid status option when using Longview Application Framework. Use Longview Workflow Designer to set the status of a step to Not Started. For more information, see the Longview Workflow Designer Guide.
- Comment is the comment to apply to the workflow log, enclosed in double quotation marks. Do not use double quotation marks (") or the line break character (\n) within the comment itself. Comments cannot be longer than 4000 characters.
- Symbol applies only to hierarchical steps and is optional. Review the following table for when to use the symbol parameter.
Note: Do not use the symbol parameter for simple steps.
To…
Use...
set the status for a dependent step only
the symbol parameter to specify the symbol for the dependent step for which you want to set the status.
set the status for the hierarchical step, including dependent steps
do not use the symbol parameter.
Syntax example
SetWorkflowStatus(MonthEndProcess, "ABC Canada", 1000, "Validating month end data", E11111)