GetFormValue

Description

Add or update the value of a variable using the value of an input in a form object.

Parameters

Parameter Name	Description	Type	Resolved Type	Required
FormObjectName	The name of form object that contains the required input	String	String	Yes
InputName	The name of the required input	String	String	Yes
VariableName	The name of the variable to create or update	String	String	Yes
ContainsSecret	A boolean flag to indicate that the value may be a secret and should not be logged; default=false	Boolean	Boolean	No

Compatibility

This command was introduced in Safeguard 2.8

Examples

Example: Get the user email from the 'ExtractedUserForm' form

{
    "GetFormValue": {
        "FormObjectName": "ExtractedUserForm",
        "InputName": "user_email",
        "Variable": "UserEmail",
        "ContainsSecret": true
    }
}