Overview

Parameters are the inputs of an Action type. They are the interface between the Rules and other apps on Foundry (such as Workshop, Slate, or Object Views). Parameters are treated like variables, that can be filled with values from the outside. Each parameter is defined by a type, which dictates what kind of values it can take. Beyond its type, parameters have a variety of other potential configurations. Each parameter can be individually configured as to whether they are exposed in the Form or not, or whether they can be changed by the user or not.

Parameters transport values across the Action type and can be referenced in Rules to pass the value back on an object, link, or side effect, in submission criteria, to check if an Action can be submitted, to access the current value of an object property before it is changed by the Action or in overrides to change the configuration of a following parameter.

Example

A parameter can take the form of an Ticket object type in an Action type which allows users to modify the status of a selected ticket. A Status parameter is defined as a string. When submitting the Action, the object type parameter will take the value of a selected Ticket object and the Status parameter contains the future status. The Action type then passes both parameter values to the Rules and executes them to edit the object.

Example

A variable in workshop, previous_status, can take the current value of the Status property of the selected Ticket object. This can be passed to a hidden parameter in the Action, Previous Status, and the Status parameter can contain the updated status. Upon submitting the Action, the Action type then passes both the Previous Stats and the Status values to the Rules and executes them to edit the object.