WIPInfoSet

You can use this function for Optiva Workflows.

Purpose

The function WIPInfoSet provides the ability to change the column value in the FsActionWipSteps table.

Syntax (without LanguageCode)


bool WIPInfoSet(string Parameter, string ParamValue, int LineID = 0, int ActionWIPId = 0)

Return Value

The script returns this value as a Boolean (Returns true/1 if success and false/0 if fails)

Arguments

Part Description
Parameter The properties of items, formulas and other objects that can be measured, calculated or stated.
Note: This matches a column name in the FsActionWipSteps table.
ParamValue The value which you insert into the FsActionWipSteps table.
Note: A failure occurs for the arguments that are read only in the FsValidationField.
LineID Optional. The LineID of a particular task in the FsActionWipSteps table. Optional.
Note: If no value is entered, then the current LineID is used from the context.
ActionWIPId Optional. The ActionWIPId that you are retrieving. This is used when you are using the WipInfoSet function from an object other than from an existing ActionWip (e.g., Pending Tasks or Gantt Chart).

Description

WIPInfoSet is used to change the value of the Description column in the FsActionWipSteps table.
WipInfoSet("DESCRIPTION","updated description").

bool rtnCap = WIPInfoSet("DESCRIPTION", "updated description");

Syntax (with LanguageCode)


bool WIPInfoSet(string Parameter, string ParamValue, string LanguageCode, int LineID = 0, int ActionWIPId = 0) 

Return Value

The script returns this value as a Boolean (Returns true/1 if success and false/0 if fails)

Arguments

Part Description
Parameter The properties of items, formulas and other objects that can be measured, calculated or stated.
Note: This matches a column name in the FsActionWipSteps table.
ParamValue The value which you insert into the FsActionWipSteps table.
Note: A failure occurs for the Arguments that are read only in the FsValidationField.
LineID Optional. The LineID of a particular task in the FsActionWipSteps table.Optional.
Note: If no value is entered, then the current LineID is used from the context.
ActionWIPId Optional. The ActionWIPId that you are retrieving. This is used when you are using the WipInfoSet function from an object other than from an existing ActionWip (e.g., Pending Tasks or Gantt Chart).

Example

bool rtnCap = WIPInfoSet("DESCRIPTION", "updated description", "En-US");

Description

WIPInfoSet is used to change the Language label for the Description column in the FsActionWipSteps table.
WipInfoSet("DESCRIPTION","updated description","En-US").
.

Syntax


bool WIPInfoSet(int LineID, int ActionWIPId, MultiLangData[] multiLangData)

Return Value

The script returns this value as a Boolean (Returns true/1 if success and false/0 if fails)

Arguments

Part Description
LineID Optional. The LineID of a particular task in the FsActionWipSteps table.Optional.
Note: If no value is entered, then the current LineID is used from the context.
ActionWIPId Optional. The ActionWIPId that you are retrieving. This is used when you are using the WipInfoSet function from an object other than from an existing ActionWip (e.g., Pending Tasks or Gantt Chart).
MultiLangdata

The array of multi-language fields in the FsActionWipStepstable.

MultiLangData contains these fields: LanguageCode, MultiLangField, Description.

bool rtnCap = WIPInfoSet(1, 2212, fieldsandValues);

Field Values: EN-US, DESCRIPTION

Description

WIPInfoSet is used to change the Langauge labels for the Description column in the FsActionWipSteps table.


dim fieldsandValues(1) As Optiva.ScriptProxy.MultiLangData

fieldsandValues(0) = new Optiva.ScriptProxy.MultiLangData()
fieldsandValues(0).languageCode = "EN-US"
fieldsandValues(0).multiLangField = "DESCRIPTION"
fieldsandValues(0).description = “EN-US description updated using WIPINFOSET”

fieldsandValues(1)= new Optiva.ScriptProxy.MultiLangData()
fieldsandValues(1).languageCode = "DE-DE"
fieldsandValues(1).multiLangField = "DESCRIPTION"
fieldsandValues(1).description = “DE-DE description updated using WIPINFOSET”
WIPInfoSet (0,0,fieldsandValues)