WIPParamGet

You can use the WIPParamGet function to retrieve a parameter that was defined as user input in the Action Set form.

This function allows workflows to access input parameters that were configured when the workflow was initiated.

When to use

You can use this function to:

  • Retrieve user input parameters from workflow action sets.
  • Read parameters defined in the FSACTIONSETPARAM table.

Syntax

string WIPParamGet(string paramCode)

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.

Return Value

The application returns the value of the specified parameter as a string if the operation is successful.

Prerequisites

  • The parameter code must exist in the FSACTIONSETPARAM table.
  • The parameter must be defined in the Action Set form.

Examples

Example 1
Retrieve Permission Group Parameter. 
string permGroup = WIPParamGet("PERMGRP");
Example 2
This sample action starts an action set where a report name is passed in by the user as an input parameter. 
string sReportName = WipParamGet("REPORTNAME");
Example 3
In this Example, WipParamGet retrieves the value from the Input Parameter, NOTIFY, and stores it in the variable value. 
string sValue = "FSI";
sValue = WipParamGet("NOTIFY");
MessageList(sValue);
return 111;
Related topics