Formatters

Version 24.1.8906


Formatters

Version 24.1.8906


Formatters support modifying or formatting values within a script or expression setting and operate by accepting input and producing output. Input is passed into formatters in the form of an attribute on an item or as a Function.

The formatters defined in this section are categorized based on the type of input they accept:

Functions, while used in the same way as formatters, produce output but do not require explicit input. See Functions for details.

Formatter Basics

Attributes (variables) are passed into formatters using vertical pipe characters: |

[item.attribute | formatter(parameters)]

where formatter is the name of the formatter and parameters is an optional set of parameters to control formatter output. Multiple formatters can be used by delimiting each formatter with a vertical pipe; the formatters will be evaluated from left to right and the output from one formatter will be “piped” into the next formatter:

[item.attribute | formatter(parameters)] | formatter(parameters) | ...]

Examples

  • In the following snippet any “*” character in the myid attribute’s value is replaced by “-“, and the resulting value is assigned to input1.id.

    <arc:set attr="input1.id" value="[myid | replace('*', '-')]"/>
    
  • Below, two value formatters are chained with the pipe (“|”) character. In the example, only .log files are pushed from the operation.
    <arc:call op="fileListDir">
      <arc:check attr="name" value="[filename| tolower | endswith('.log')]">
        <arc:push/>
      </arc:check>
    </arc:call>
    
  • The total cost for a purchase order line item may need to be calculated by multiplying the item quantity with the price-per-item.
    <arc:set attr="cost" value="[itemQuantity | multiply([itemPrice])]" />