###Expressions
We’ll use expressions to filter results returned by tags. If you are familiar with SQL, you can think these as Where sections.
For Example…
{REPORT PAYMENT TOTAL:}
This tag will display total of all payments that created inside reporting period. As it will total of all cash, credit card or other type of payments we’ll need a <expression> for more precise total. For reading a total of only Cash payments the syntax should be…
{REPORT PAYMENT TOTAL:(PT=Cash)}
###Syntax (<Field>=<Value>)
This syntax allows us to easily create filter expressions without thinking about common syntax features such as quotes, spaces, etc. <Field> value defines what we want to filter and <Value> part defines the filter value. Finally we’ll surround them with parenthesis to differ a value from other filters.
We can use multiple filters by using AND / OR keywords. For example
{REPORT PAYMENT TOTAL:(PT=Cash) OR (PT=Credit Card)}
… will display total of Cash + Credit Card payments.
We need to know what fields each tag type supports. For example Calculation related tags supports CT field.
{REPORT CALCULATION TOTAL:(CT=Discount)}
Some fields needs additional parameters. For example think about our Customers have a Customer Type Custom Field and I want to read total of all Cash payments VIP customers made.
{REPORT PAYMENT TOTAL:(PT=Cash) AND (EC.Customer.Customer Type=VIP)}
EC field needs an Entity Type Name and the name of the Custom Field.
###List of all possible expression fields
Supported by REPORT TICKET, ORDER, PAYMENT, CALCULATION and TICKET ORDER EXP tags.
TEN.<entity type> Ticket Entity Name Equals
TENC.<entity type> Ticket Entity Name Contains
TEC.<entity type>.<custom field> Ticket Entity Field Equals
TECC.<entity type>.<custom field> Ticket Entity Field Contains
TU Ticket User Name Equals
DE Ticket Department Name Equals
TE Ticket Terminal Name
TY Ticket Type
PA Ticket Contains a Payment
CA Ticket Contains a Calculation
TCET Ticket Contains an Entity Type
TT.<tag name> Ticket Tagged With
TS.<state name> Ticket is in State
Supported by REPORT ORDER tags
OT.<tag name> Order Tagged With
OS.<state name> Order is in State
OU Order User Name Equals
MT.<tag name> Order Menu Item Custom tag Equals
MG Order Menu Item Group Equals
Supported by ENTITY STATE tags.
ELN Entity State Log Name Equals
ELSN State Name Equals
ELSS Start State Equals
ELES End State Equals
ELEN Entity Name Equals
ELEC.<field name> Entity Custom Field Equals
ELSD Start Date Equals
ELED End Date Equals
ELCD.<field name> Custom Data Equals
Supported by REPORT PAYMENT tags
PT Payment Type Name Equals
Supported by REPORT CALCULATION tags
CT Calculation Type Name Equals
On next post I’ll explain how DETAILS tags works.