WIPParamSet

You can use the WIPParamSet function to set a parameter value in a workflow action step.

Note: The value can be stored temporarily and retrieved later by using WIPParamGet, allowing data to be passed between workflow steps.

When to use

You can use this function to:

  • Pass user input from one workflow step to another.
  • Share calculation results between workflow stages.
  • Create input parameters within scripts for script-only use.

Syntax

int WIPParamSet(string paramCode, string pvalue);

Parameters

Parameter Type Required Description
paramCode string Yes The input code that matches a parameter in the FSACTIONSETPARAM table.
Note: This corresponds to parameters defined in the Action Set forms Input tab.
pvalue string Yes The value to store in the parameter

Return Value

The application returns a value greater than zero (0) if the operation is successful.

Impact

The temporary workflow variables that persist across workflow steps are stored.

Prerequisites

  • The parameter code must exist in the FSACTIONSETPARAM table.
  • No additional permissions are typically required for WIP parameter operations.
  • This function is available only in workflow scripts and cannot be used in formulas, equations, or copy methods.

Examples

Example 1
This example assigns the value FSI to the Input Parameter, NOTIFY. 
string sValue = "FSI";
MessageList(sValue);
string sReturncode = WIPParamSet("NOTIFY", sValue);
Related topics