FX DataGuide Expressions

Introduction

Expressions in the FX DataGuide Form Designer tool allow you to customize the flow, calculate variables, or automate the completion of FX DataGuide forms.

Prerequisites

To use the Form Designer, you need to:

Have these user licenses	Have these permissions	Complete these tasks and review these topics before continuing
FieldFX Base Package FieldFX E-Ticketing FX DataGuide	FX DataGuide minimum permissions for a Form Designer	To use the Form Designer, you must: Set up the FX DataGuide module

Have these user licenses

Have these permissions

Complete these tasks
and review these topics
before continuing

FX DataGuide minimum permissions for a Form Designer

To use the Form Designer, you must:
- Set up the FX DataGuide module

Getting There

Expressions are part of the FX DataGuide Form Designer tool in the Admin Portal.

Expressions are fields available in a number of options in the Properties Panel, depending on the currently selected form element.

How it Works

You can build expressions to:

take responses to questions and calculate new values
and change the visibility of questions or pages in the form
automate form actions, such as automatically completing a form

Expressions can be built declaratively using the Build fields in the Properties Panel.

Use the Edit option for an Expression to manually write the expression.

Creating an Expression

When creating an Expression, you can build a new expression or edit an existing expression.

Using the Expression Build Tab

When adding a Form Logic Action (called a Trigger in the Logic section of the Form’s Properties Panel), you can use the Expression Builder to create the rule.

The Builder is limited to comparison actions on the responses to questions and adjusts the fields and options depending on the selected action.

For example, if a selected question does not allow a user to make multiple selections, then the "Any of" and "All of" rule options cannot be selected.

Using the Expression Edit Tab

The Expression Editor is a text field.

To use Expression functions, you must use the editor.

Consider beginning with the Expression Builder, then editing the results of the builder.

Functions

Expression functions follow a standard format:
- functionName
- ( )
  
  Any function, whether or not it accepts parameters, must be followed by an open and close parenthesis
- ,
  
  For functions with parameters, each parameter is separated by a comma

Boolean Function Options

Examples of expressions where you desire to evaluate whether a condition is true or false.

Expression Description

Expression	Description
" >= 21"	Returns `true` if the question has a value of 21 or higher
"( + + ) > 21 and == ‘yes’"	Use `or` and `and` operators, squares and arithmetic operations
"!( == ‘yes’ and ( + + ) > 21)"	Use "!" or "not" to change the result on opposite
"notempty"	Returns `true` if `name` has a value
empty	Returns `true` if `name` has no value
" = [‘English’, ‘Spanish’]"	Returns `true`, if a user selects these two values in a question where these values are options. Typically used for checkbox question types.
"contains ‘Spanish’"	Returns `true`, if a user select 'Spanish' in checkbox. The user may or may not select other values in the question.
age() >= 21	Returns `true`, if function `age` returns 21 or greater. The function `age` is described below.

" >= 21"

Returns true if the question has a value of 21 or higher

"( + + ) > 21 and == ‘yes’"

Use or and and operators, squares and arithmetic operations

"!( == ‘yes’ and ( + + ) > 21)"

Use "!" or "not" to change the result on opposite

"notempty"

Returns true if name has a value

empty

Returns true if name has no value

" = [‘English’, ‘Spanish’]"

Returns true, if a user selects these two values in a question where these values are options. Typically used for checkbox question types.

"contains ‘Spanish’"

Returns true, if a user select 'Spanish' in checkbox. The user may or may not select other values in the question.

age() >= 21

Returns true, if function age returns 21 or greater. The function age is described below.

Matrix and Panel Questions

You can access values within a Panel of questions or a Matrix question type.
Use a "." to access child values
For matrix questions, use square brackets to indicate the position of the desired value, where the index begins at 0.

For example to access the first value of a matrix, use {matrix[0].property}, where property is the desired value to return.
To access questions nested inside panels, use this format:
{dynamicpanelname[index].questionname}

Function Types

You can use these functions when building an expression:

iif
isContainerReady
isDisplayMode
currentDate
today
getDate

age
diffDays
sum
max
avg
sumInArray

maxInArray
minInArray
avgInArray
countInArray

iif

Format

iif(condition: expression, valueIfTrue: any, valueIfFalse: any)

Result Type

Any

Description

Returns the value specified by valueIfTrue if the given condition is true and the value specified by valueIfFalse if the condition is false. The condition is an expression that can contain expression functions and references to question values (as question names in curly brackets).

Example

iif({question1} + {question2} > 20, 'high', 'low')

FX DataGuide Expressions

Introduction

Prerequisites

Getting There

How it Works

Creating an Expression

Using the Expression Build Tab

Using the Expression Edit Tab

Functions

Boolean Function Options

Matrix and Panel Questions

Function Types

iif

isContainerReady

isDisplayMode

currentDate

today

getDate

age

diffDays

sum

max

min

avg

sumInArray

maxInArray

minInArray

avgInArray

countInArray

Recommended Reading