SetFormValue

Description

Set the value of a named form input.

Parameters

Parameter Name	Description	Type	Resolved Type	Required
FormObjectName	The name of the form object	Value	String	Yes
CreateForm	Whether to create or update a form, see below for values; default= CreateIfNotFound	String	String	No
InputName	The name of the input to set or modify in he form	String	String	Yes
Value	The new value of the named input	Value	String	Yes
IsSecret	Set this to true if the value is a secret and should not be logged in this component	Boolean	Boolean	No

Types

CreateForm Values

The values that may be used for the CreateForm property are:

Value	Description
DoNotCreate	Modify the existing form identified by FormObjectName; if none is found then throw an error
CreateIfNotFound	If FormObjectName doesn't already contain a form, a form will be created. Otherwise, the existing form will be modified
CreateOrFail	Create a new form object; if one already exists at FormObjectName then throw an error
CreateOrReplace	Create a new form object; if one already exists at FormObjectName then replace it

Compatibility

This command was introduced in Safeguard 2.8

Examples

Example:

{
    "SetFormValue": {
        "FormObjectName": "LoginForm",
        "InputName": "user_email",
        "Value": "%AccountEmailAddress%"
    }
}