Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 17 Next »

Overview

This page explains the basics of writing expressions and scripts in PhixFlow. The instructions assume you are configuring a Stream Attribute unless otherwise stated.

When you are writing and expression or script, always check the relevant help page. This will have information about any restictions or special cases that apply.

Assigning a Literal Value to a Field

The most basic expressions simply assign a constant value to the field. For example these three expressions assign the integer 3, the floating point number 3.2 and the string "Hello" to the field:

ExpressionResult
33
3.23.2
"Hello""Hello"

Note that if you want to assign a string value (as in the last example) then the characters must be enclosed in either single 'Hello' or double "Hello" quotes.

Sections on this page

Parameter Types 

When writing expressions it is important to consider the type of the result. For example, if you have written a Stream Attribute expression to return the integer 3 but have defined the type of the Stream Attribute to be a String then PhixFlow will stop and report the error when the expression is evaluated. The full list of types handled by PhixFlow is shown below. It's not necessary to understand the meaning of the individual types at this stage, however just be aware that the different types exist.

TypeDescription
ArrayA list values, e.g. [1,2,3]. For details about what other values arrays can hold and Array handling in general see Arrays and Record Sets.
DateA date. For details about date manipulation functions go to Date Functions.
DatetimeA date and time. For details about date manipulation functions go to Date Functions.
FloatA floating point number, e.g. 3.2 or 3.0 or 0.0
IntegerAn integer, e.g. 3 or 0
NumberAn integer or floating point number
StringA string value, e.g. "Hello" or the empty string ""
BooleanA logical value of either true or false. Note that any non-null, non-zero value is treated as true
Regular ExpressionRegular Expressions allow string patterns to be expressed. See Regexp ToDelete for more details

Using $-variables in Calculations

In stream attribute expressions that have complex calculations, you may need a variable to hold the result of a calculation. You can then reference the variable later in the expression, or in other attribute expressions. In PhixFlow you can use a $-variable for this, by prefixing the variable name with the $ symbol.

It can be helpful to distinguish between $-variables that are:

  • only used in the current attribute: use a lower case variable name, for example $percent
  • also used in another attribute: use an initial capital letter, for example $Percent.
Simple $-variable example

The following expression sets 2 $-variables $A and$ B, then uses them in a simple calculation that returns 10. 

do(
   $A = 5,
   $B = 2,
   $A*$B
)

Another expression can reference the $A and $B variables in a different calculation. The following expressin returns 100.

do(
   $c = 10,
   $A*$B*$C
)

$-variables are not really needed in simple calculations. They are useful:

  • in forEach loops
  • when using look-up pipes
  • to store a value from a look-up pipe, when you need the value in multiple attributes.
    1. In the first attribute, look-up the value.
    2. Use a $-variable to store the value that is returned by the look-up.
    3. When you need the value in another attribute, reference the $-variable instead of repeating the look-up.
  • in complex expressions, to break up multiple consecutive functions into separate lines. In this case, use a $-variable to store the intermediate values; see Multiline Statements and $-variables, below.

Assigning Values From a Pipe

One of the most common type of expression is to fetch the value returned by a Pipe. This is simply done by suffixing the Pipe name with the name of the attribute to be returned. For example: 

  in.accountRef

This expression causes PhixFlow to look at the pipe named "in" and return the value in the field called "accountRef".

This expression can return multiple values; see Arrays and Record Sets.


If the name of the attribute whose value you want has to be calculated based on other factors then the attribute name can be assigned to a variable (see the section below on mulitline statements and $-variables) and the variable used in place of the attribute name itself e.g.

  in.$attrName

If the name of the attribute whose value you want contains characters that would otherwise be invalid you can either assign that name to a variable (see the section below on multiline statements and $-variables) and use the variable instead of the actual attribute as discussed above or simply enclose the name in quotes e.g.

  in.'account-ref'

Mathematical Operators (+, -, *, /)

Several values can be combined using the usual basic mathematical operators. For example when in.numProducts has the value 9:

ExpressionResult
in.numProducts + 312
in.numProducts - 36
in.numProducts * 327
in.numProducts / 33

The usual calculation precedences apply i.e. * and / operations are carried out before + and -. When the mathematical statements involve multiple calculations, brackets () can be used to force the correct processing order:

ExpressionResult
3 * 3 + 312
3 * (3 + 3)18

String Concatenation (+)

The + operator also serves as the string concatenation operator i.e. joins strings together. For example if in.customerName returns "Smith" and in.title returns "Mr"

ExpressionResult
"Hello" + " to " + "you""Hello to you"
"Dear " + in.title+ " " in.customerName + "," +"Dear Mr Smith,"

If you use + to concatenate a String and a numeric value, such as an Integer, then PhixFlow treats the number as if it is a string. For example:

ExpressionResult
"Hello" + 3"Hello3"
"4" + 3"43"

Multiline Statements and $-variables

Often there is a need to work out the result of a more complex expression which may require several different statements to be evaluated first. To group several statements together in this way, you should make use of the do() function. In nearly all multiline statements, it is also very convenient to assign the value of an expression to a $-variable which may then be used later in the expression. For example:

ExpressionResult
do ( $name = in.customerName, $title = in.title, $salutation = "Dear", $result = $salutation + ' ' + $title + $name )"Dear Mr Smith"

Every statement within the do() function (except the last) ends in a comma ",".

The value of an expression, that is the value that will be assigned into the stream attribute, is the value of the last statement to be evaluated. In the above example, the last statement to be evaluated is the last line. However, in Conditional Statements, the last statement evaluated is not always the last statement in the expression. For example:

Responsive
ExpressionResult
if ( in.customerName == "Smith", 45 , // else 36 )45 if the customer's name is "Smith" but otherwise the value 36.

Adding Comments

It is always a good idea to add comments to your scripts to explain its steps. These help anyone who needs to modify the script in future.

There are two ways to tell PhixFlow that a line is a comment, and can be ignored.

NotationUse for
//

 short comments up to 1 line

/* <comment> */multi-line comments

For example:

/* Get the discount rate that should apply to 
the calls that match the filter conditions */
$discountRate = discount.rate,

//
Now apply the discount
$value = $value * ( 1 - $discountRate)


See Also



  • No labels