WIPInfoGet
You can use the WIPInfoGet function to retrieve any column value from the FsActionWipSteps table.
This function allows workflows to access work-in-progress (WIP) task information and metadata during workflow execution.
When to use
You can use this function to:
- Retrieve task information from the FsActionWipSteps table.
- Access WIP data during workflow execution.
- Read task descriptions, status values, and other metadata.
- Debug or log workflow task information.
Syntax
- Syntax 1
-
Without Language Code.
string WIPInfoGet(string Parameter, int LineID = 0, int ActionWIPId = 0);
- Syntax 2
-
With Language Code.
string WIPInfoGet(string Parameter, string LanguageCode, int LineID = 0, int ActionWIPId = 0);
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| Parameter | string | Yes | The column name in the FsActionWipSteps table to retrieve, such as "DESCRIPTION", "STATUS", or "ASSIGNED_TO". |
| LanguageCode | string | Optional | The language code for multi-language columns, such as "EN-US", "FR-FR", or "DE-DE".
Note: Applicable only to Syntax 2.
|
| LineID | int | Optional | The LineID of a specific task in the FsActionWipSteps table.
Note: By default the value is 0.
|
| ActionWIPId | int | Optional | The ActionWIPId from which data is retrieved.
Note: By default the value is 0 (current ActionWIP).
|
Return Value
The application returns the value of the specified column from the FsActionWipSteps table as a string if the operation is successful.
Prerequisites
- The specified LineID must exist.
- The specified
ActionWIPIdmust exist. - The column name must be valid in the FsActionWipSteps table.
- The language code must be supported for multi-language columns.
Examples
- Example 1
-
Get Description from Current Task.
string rtnCap = WIPInfoGet("DESCRIPTION");
- Example 2
-
Retrieve the description in a specific language.
string rtnCap = WIPInfoGet("DESCRIPTION","EN-US");