The following variables are common to all line-item elements and the following components: non-merchandise items, department items, price overrides, transaction discounts, taxation, and start transactions. The variables listed under the individual line-item headings are specific to that type of line-item.

%voidstatus%

Void status

%line%

The transaction line number

%action%

The literals.properties translated version of the function-specific action code

%rawaction%

The untranslated action for the given function type. For example, .lineitem has a raw action of SELL, RETURN, PENDING, MEMO, SELL_ATTEMPT or REMOVE_PENDING. Other function types have different action codes

%status%

Used in layout.form for the busy indicator

%date%

Used for the date form and TXN date in a transaction

%businessdate%

Business date

%time%

Used for the time form and transaction time in a transaction

%instruction%

Used for prompt instruction frame

%system%

System error messages for the system frame

%hardware%

Hardware error messages for the system frame

%prompterror%

Prompt level messages for the system frame

%SessionID%

Used to log in to POS Manager if you are logged in to the client

%usedrollupdata%

True, if you are working with rolled-up data

%instanceid%

Full version information

%inreprint%

True, if you are in a reprint

%storenumber%

Store number

%registernumber%

Register number

%cashiernumber%

Cashier number

%transactionnumber%

Transaction number

%priortrxnum%

Applies to a post void transaction

%postvoid%

This variable is true when applied a post void transaction

.startup

A form that is used to display version and device information upon startup of the POS terminal

%printers%

The number of printers

%scanners%

The number of scanners

%linedisplays%

The number of line display devices

%msrs%

The number of MSR devices

%poskeyboards%

The number of POS keyboards

%profileid%

The current Configurator profile ID deployed to the POS

%profileversion%

The current Configurator profile version deployed to the POS

%profileoverrideversion%

The current Configurator profile override version deployed to the POS

.header and .footer.

Forms that are used to display or print header and footer information

.body

Applies to pickups, loans, failed validation documents, and the change pop up document

.receiptsuspended

If the transaction is suspended, the .receiptsuspended form always executes before the receipt footer

.lineitem

Form that is used to display or print an item

%code%

PLU code

%description%

Item description

%grGroup%

Gift group number for gift receipts

%grDescription%

Gift group description for gift receipts

%price%

Extended price

%taxes%

Applicable tax code

%saletype%

The item type from the item maintenance import

%department%

Department number, if available

%quantity%

If the value of quantity is not 1, this variable contains that information

%unitprice%

Unextended price per unit

%discountable%

Flags items on the receipt that are not discountable when the Allow Discount flag is set to N

%notforsale%

Indicates that an item is not for sale. The value can be true or false

%crossRefKeyType%

Indicates the cross reference item key

%crossRefKey%

Cross reference key

%itemKeyType%

Item key type

.discountdetail

Form used to display or print the details of a discount

%discountableamount%

Discountable amount

%discountcode%

Discount ID

%applytype%

Transaction

%presetvalue%

Discount’s preset amount

%enteredvalue%

Discount’s entered value

%discountsymbol%

% or currency symbol

%standalone%

True, if set as standalone

.nonmerch

Form used to display or print the non-merchandise details

%description%

Non-merchandise description

%grGroup%

Gift group number for gift receipts

%grDescription%

Gift group description for gift receipts

%price%

Extended price

%taxes%

Applicable taxes

%quantity%

If the value of quantity is greater than 1, the same information is sent to a quantityline form

%unitprice%

Unextended price per unit

%discountable%

Flags items on the receipt that are not discountable when the Allow Discount flag is set to N

.detaileddiscount

Form used to display or print the details of a discount.

%discountcode%

Discount code

%amount%

Discount amount

.department

Form used to display or print the details of the department sale item

%department%

Department code

%description%

Department description

%grGroup%

Gift group number for gift receipts

%grDescription%

Gift group description for gift receipts

%rawaction%

Hard coded to DEPARTMENT, and NONMERCH %quantity%

%unitprice%

Unextended price; unit price

.price override & .linediscount

.price override is used if you want to display or print the override on a separate line from the item it affects. .linediscount is used for item or transaction price override discounts.

%previousPrice%

Previous price

%modifiedPrice%

Modified price

%rawaction%

This is hard coded to price_override.

%quantity%

If the value of quantity is not 1, this variable contains that information

%linediscount%

Line discount

%discounttype%

Discount type

%discountsource%

Discount source

%discountsymbol%

Discount symbol

%itemkey%

Item key

%discountcode%

Discount code

%showpricepaid%

Show price paid, true if the flag is set

%pricepaid%

Price paid

%modifiedextprice%

The actual price for the item after a particular discount

%rawaction%

PRICE_OVERRIDE or LINE_DISCOUNT

.inquiry

Used for a price inquiry

%code%

Code

%unitprice%

Unit price

%department%

Department

%saletype%

Sale type

%allowSell%

Allow sell

.transactiondiscount

Form used to display non-pro-rated transaction discounts

%price%

Price; extended price difference

%description%

Discount description

%msrp%

Manufacturers suggest retail price

.taxabilityoverride

Used to display a tax override

%description%

This is the reason for the tax override

%reprintdate%

Reprint date

%reprinttime%

Reprints time

%reprintsiteid%

Reprints site ID

%reprintregisternumber%

Reprints register number

%reprinttransactionnumber%

Reprints transaction number

%reprintcashiernumber%

Reprints cashier number

%reprintcashiersignon%

Reprints cashier logon

%reprintcashieremployeeid%

Reprints cashier employee ID

%reprintcashierlastname%

Reprints cashier last name

%reprintcashierfirstname%

Reprints cashier first name

%reprintcashiermiddleinitials%

Reprints cashier middle initials

%reprintcashierprintablename%

Reprints cashier printable name

%priorTransactionPrintCount%

In a recall of a transaction, represents the number of times this receipt has been printed in prior transactions.

.starttransaction

Form displayed or printed that indicates what kind of transaction this is. For example, Sale, Return, and so on

%description%

This currently refers to a sale or a return

%repositorytype%

Repository type

%repositoryid%

Repository ID

%tenderid%

Tender ID

%roundingamount%

Used for rounded amounts

%primaryroundingamount

The value of %roundingamount% converted into the primary currency

.tenderline

The variables for tenderline can also be applied to .exchangeline

%receiptline%

EFT service supplied message to print on the receipt

%cashback%

The tender amount entered by the customer or operator to be received as cash back

%sequencenumber%

EFT service authorization sequence number

%terminalid%

The register's number

%accountype%

The card type. Taken from the tender configuration. For example, Credit, Debit, Gift, and so on.

%description%

Tender description

%tender%

Tender amount

%tendernotzero%

Possible values are true or false

%exchangerate%

Local currency = 1

%primaryAmount%

Extended amount of the tender (used in transactions involving foreign exchange)

%code%

The authorization code if it exists

%totaldue%

The total due for the transaction

%action%

A possible translated version of the rawaction value. For example, on tender forms, if the rawaction was CHANGE, you have "CHANGE=Change" in literals.properties, and have "Change" displayed or printed instead of "CHANGE".

%cleantender%

Equivalent to the %tender% variable but stripped of all formatting which specifies the dollar sign, decimal point or comma

%cleanprimaryAmount%

Equivalent to the %primaryAmount% variable but stripped of all formatting which specifies the dollar sign, decimal point or comma

%tenderkey%

This is the tender ID

%tenderkey1%, %tenderkey2%, %tenderkey3%

Type of tender; available for the change line only and applies if multiple change is available

%description1%, %description2%, %description3%

Description of tender; available for the change line only. Applies if multiple change is available

%tender 1%, %tender 2%, %tender 3%

Value of tender. Available for the change line only. Applies if multiple change is available

%voidstatus%

This value is either blank, VOIDED, or VOID if this is a post void. The document checks for these so that no document is issued. Available for the change line only

%reference%

This is the only distinct variable for .referenceline. All other variables are the same as for .tenderline

%authorizationnum%

This is the only distinct variable for .authorizationline. All other variables are the same as .tenderline. This is the code generated by the authorizing agent

%authsource%

This is the only distinct variable for .authsource. All other variables are the same as .tenderline. This is the source that provided the authorization

subtotal

Form used to display or print subtotal information

%subtotal%

Sum of all sold items

%count%

The number of items

.taxline

Older form of tax information form generated from summary information. Not usable for VAT tax situations

%description%

Tax description

%taxdetail%

Manual tax detail

%taxCode%

Manual tax code for tax authority

%amount%

Manual tax amount

.owingline

An optional form available to update the amount due. Not required by most devices, but available for such devices as the customer line display if the store wants to display amount still due instead of the amount of the last payment

%amountowing%

The total amount due

.total

The form used to display or print total information

%count%

The number of items in the transaction

%totalsaved%

The difference between the default price and the discounted price

%totaldiscount%

The total amount of the discount

.amountdue

These values are only used for the line and screen display devices

%tax%

Tax amount; available under .taxdetailline indicating the amount of the tax, or under .total indicates the total tax, or under .taxline indicates the total of a type of tax.

%subtotal%

The subtotal of the transaction - the final total (taxes and fees)

%items%

The number of items in the current transaction

%total%

The total amount due. You can only use %total% or %totaldue%, but never both variables at the same time

%totaldue%

You can only use %total% or %totaldue%, but never both variables at the same time

%refunddue%

If the customer is due a refund, that amount is available on the screen summary screen

.eot

This is the end of the transaction. This event allows you to post extra displays to the line or screen display devices at the end of a transaction. There are no variables for this section

.choicelist

This exists in layout form only

%keyedaccess%

In a picklist (configured in UILayout document), "1" shows if the choice list configuration component allows keyed access by the 'code' value, or "2" if it is keyed by the 'value' value

%columns%

The number of columns in which to display the list

%line%

The line number of each transaction line. For example, on selling an item to start a transaction, the "starttransaction" line's %line% has a value of "1", the "lineitem" line's %line% hase a value of "2", and so on

%description%

A description of the choice in a list

%key%

In a pick list (configured in UILayout document), is the 'code' of each choice list line

%DATE%

For a pick list sent by the server, if there is a Calendar variable in a line, it is converted to a date and displayed here

%TIME%

For a pick list sent by the server, if there is a Calendar variable in a line, it is converted to a time and displayed here

.pageheader

Use when printing multipage documents. If you do not want a page header on the first page, add the qualifier notonfirst

%page%

Current page number. For example, .pageheader,notonfirst |Page %page%

%nextpage%

Next page number. For example, .pagefooter,notonlast ||Continued on page %nextpage%

%workflowstate%

Provides an advanced filtering of the lines based on their state in a transaction workflow depending on where they belong

%workflowmodifier%

Provides an advanced filtering of the lines based on their state in a transaction workflow depending on where they belong

.storeclosed

Displays a document in the on-screen receipt area during the store closed state when the ~graphics function is used. Gives the ability for on-screen slide shows

.terminalclosed

Displays a document in the on-screen receipt area during the terminal closed state when the ~graphics function is used. Gives the ability for on-screen slide shows

.signedoff

Displays a document in the on-screen receipt area during the POS logged-off state when the ~graphics function is used. Gives the ability for on-screen slide shows.

.notintransaction

Displays a document in the on-screen receipt area during the not-in-transaction state when the ~graphics function is used. Gives the ability for on-screen slide shows

.locked

Displays a document in the on-screen receipt area when the POS is in a closed state when the ~graphics function is used. Gives the ability for on-screen slide shows