WIPInfoSet

You can use the WIPInfoSet function to update the value of a column in the FsActionWipSteps table.

This function allows workflows to modify work-in-progress (WIP) task information and metadata during workflow execution.

When to use

You can use this function to:

  • Update task information in the FsActionWipSteps table.
  • Modify WIP data during workflow execution.

Syntax

Syntax 1
Without Language Code. 
bool WIPInfoSet(string Parameter, string ParamValue, int LineID = 0, int ActionWIPId = 0)
Syntax 2
With Language Code. 
bool WIPInfoSet(string Parameter, string ParamValue, string LanguageCode, int LineID = 0, int ActionWIPId = 0)
Syntax 3
Multi-Language Array. 
bool WIPInfoSet(int LineID, int ActionWIPId, MultiLangData[] multiLangData)

Parameters

Parameter Type Required Description
Parameter string Yes The column name in the FsActionWipSteps table to update. For example, "DESCRIPTION", "STATUS", "ASSIGNED_TO".
ParamValue string Yes The value to insert/update in the FsActionWipSteps table.
Note: Failure occurs for columns that are not modifiable in FsValidationField.
LanguageCode string Optional The language code for multi-language columns (e.g., "EN-US", "FR-FR", "DE-DE"). Only in Syntax 2.
LineID int Optional The LineID of a particular task in the FsActionWipSteps table.
Note: By default the value is 0.
ActionWIPId int No The ActionWIPId to update. This is used when you are using the WipInfoSet function from an object other than from an existing ActionWip. for example. Pending Tasks or Gantt Chart.
Note:  By default the value is 0 (current ActionWIP)
multiLangData MultiLangData[] Yes The array of multi-language fields to update.
Note: Each element contains: LanguageCode, MultiLangField, Description.

Return Value

The application returns true (1) if the operation is successful and false (0) if the operation fails.

Impact

The specified column or columns in the FsActionWipSteps table is updated.

Prerequisites

  • The specified LineID must exist.
  • The specified ActionWIPId must exist.
  • The column name must be valid and writable in the FsActionWipSteps table.

Examples

Example 1
Update Description for Current Task. 
bool rtnCap = WIPInfoSet("DESCRIPTION", "updated description");
Example 2
Update Description in Specific Language. 
bool rtnCap = WIPInfoSet("DESCRIPTION", "updated description", "En-US");
Example 3
Update Multiple Languages Using Array. 
bool rtnCap = WIPInfoSet(1, 2212, fieldsandValues);
Field Values : EN-US, DESCRIPTION

Example for WIPInfoGet and WIPInfoSet

using System;

public void Wf_Start()
{
        // Retrieve instruction text from the wizard/workflow parameters
        string instruction = WipParamGet("WIPINSTRUCTION");

        // Write the instruction into the INSTRUCTIONS column for pending tasks
        bool success = WIPInfoSet("INSTRUCTIONS", instruction);
}
Description

This example shows how WIPInfoGet and WIPInfoSet work together. A description is retrieved from the Wizard and added to the Instructions field in the Pending Tasks grid.

Related topics