This function is used to write numbers using a formatting pattern, which is a symbolic representation of some output format.

For example, if a case had an attribute WeightKg with value 1934, we might define a variable in a comment with the formula:

WeightKg * 2.204623 formatted as “###,###.00”

This would evaluate to 4,263.74

For more information on the available formatting patterns, please see the Java Decimal Format API, or contact PKS.

For formatting a value to some number of decimal places, you may want to use the formatted to … places syntax.