Keywords & Methods

Flex Code Documentation

These keywords & methods are only available to use in the Logic Editor.

Default Modules

Method	Parameters
random	-	Create a random integer - capture the result with @@ (see the Keywords section below for more information).
pick	variable name	Pick a random item from an array.
validate	Regex test, text	Test a text against a given regex test. Example: validate [0-9]+,<integer here>; Returns: null if invalid, true if valid.
count	variable name	Count the items in an array or length of string.
replace	key, substring, text	Replace all occurrence of key in text with substring. RegEx key strings are supported.
pluck	key, text	Remove all occurrence of key in text. RegEx key string are supported.
split	separator, joiner, text	Perform split operation on a given string.
parse	JSON String	Parse a JSON string and return the object. The object returned can be assigned to a variable.
parsexml	XML String	Parse an XML string and return the object. The object return can be assigned to a variable.
encode	string	Encode URI string into escape sequences.
decode	string	Decode encoded URI strings.
access	key, JSON string	Access value of a key of an object. The method supports multi-level access i.e. key1.key2.key3 to access key3. Default: null
within	key, JSON string	Check if a key exists in an object. The method supports multi-level access i.e. key1.key2.key3 to access key3. A value will be returned if true, 'null' otherwise.
stringify	object	Convert object into JSON string.
interface	authentication key (optional), queue key.	Enable interface mode, set to authentication gated with an authentication - set to null to disable authentication. To manage queue process, define a queue key. A queue key is a key in the request body. Queue keys can point to multi-level keys in the object i.e. data.user.id.
switch	value, comparator, node line number or tag.	Switch context and hop to a node line if the evaluation of value and comparator is true. To use tags, refer to tags with # prefix e.g. #tagLine Multiple comparators can be composed by using | as a delimiter i.e.: switch <value>,<compare1>|<compare2>|<compare3>,<line number>
hop	node line number or tag	Hop context to the specified node line. To use tags, refer to tags with # prefix e.g. #tagLine
tag	tag name (string)	Tag a node line in the script which can be used in switch and hop for easy reference.
lowercase	string	Transform text to lowercase.
uppercase	string	Transform text to uppercase.
capitalize	string	Capitlize text.
fixed	number, decimals	Format a number to a certain number of decimals.
format	number, decimals, locale	Format a number to a certain locale and number of decimals.
varlog	string	Print a given string to the log.
note	string	Used for debugging. Print a system log - this message is not broadcasted to the interface user.
exit!	-	Stop the application.
app_sleep	milliseconds	Set the application to sleep for a given time.

Keywords

Method	Parameters
variable	variable, delimiter (optional)	Initialise a variable, if delimiter is provided, the values are treated as arrays i.e. variable arr , = 1,2,3;
varchange	variable	Transform or change the value of a given variable. See Variable Transform OperatorsVariable Transform Operators below for more information.
condition	operator, variable, value	Create a conditional statement using a Condition Statement Operator (seeCondition Statement Operators) Condition Statement Operator on a given variable against values. Value can be a string or a variable, or a combination of both - variables must be enclosed in variable container: {$variable}.
else_condition	-	Create an else statement.
end_if	-	End a conditional statement.
loop	variable	Initiate a loop with a variable as a truth indicator.
end_loop	-	Indicate which line is the end of a loop.
expect	test, text, response	Perform regex test check against text and respond to API request with response on failure.

Condition Statement Operators

Operator	Description
equal_to	Is variable equal to a given value in a condition statement.
not_equal	Is variable not equal to a given value in a condition statement.
equal_less	Is variable equal or less than a given value in a condition statement.
equal_more	Is variable equal or more than a given value in a condition statement.
more	Is variable more than a given value in a condition statement.
less	Is variable less than a given value in a condition statement.
find_in	Find value within the variable string in a condition statement. Regex can be used as a value.

Variable Transform Operators

Operator	Description
+=	Increment value of variable by a given number.
-=	Decrement value of variable by a given number.
*=	Multiply value of variable by a given number.
/=	Divide value of variable by a given number.
%	Perform modulus operation on a value of variable against a given number.
**=	Perform exponential operation on a value of variable by a given number.
^	Perform bitwise XOR on a value of variable by a given value.
&	Perform bitwise AND on a value of variable by a given value.
|	Perform bitwise OR on a value of variable by a given value.
~	Perform bitwise NOT on a value of variable.
<<	Perform bitwise zero fill left shit on a value of variable by a given value.
>>	Perform bitwise signed fill right shift on a value of variable by a given value.
>>>	Perform bitwise zero fill right shift on a value of variable by a given value.

System Variables

Variable	Desription
now_month	current month (1-12)
now_year	current year
now_day	current day of the month
now_hour	current hour
now_minute	current minute
now_seconds	current seconds
now_milliseconds	current millisecond
since_day	current time in days since epoch
since_hour	current time in hours since epoch
since_minute	current time in minutes since epoch
since_seconds	current time in seconds since epoch
since_milliseconds	current time in ms since epoch
dataset	The current dataset used.
prompt	The current prompt - used in interfaces.
app_url	The application's url (https://<node>.frames.sh/v/<app-public-id>)
app_url_tld	The applications relative root url (https://<node>.frames.sh)
@@	The last item in the log.
request	If the application interface is enabled, this variable provides the request type of the incoming request in the queue: GET, POST, DELETE, or PUT
resource	If the application interface is enabled, this variable provides the name of non-multimedia resources (html or text) being requested of the incoming request in the queue - default: index.html.

Questions?

Let us know on [e-mail].