POS macros
Below is a list of all supported macros and their parameters if any.
pr
ADDLINKPLUTOSALE
Add this sale item as an linked PLU to the marked item or the last sold item
Parameter
Required
Description
ItemID=[some value]
Quantity=[some value]
Info=[some value]
QtyDesc=[some value]
PriceMultiply=[some value]
PriceLevel=[some value]
SpPrFg=[some value]
UnitPrice=[some value]
ADDPREFIXTOSALE
Add a prefix to the item number in the next sale macro
Parameter
Required
Description
String=[some value]
Message=[some value]
ADDSEAT
Add seat to table
Parameter
Required
Description
ALLVOID
Voids the whole transaction
Parameter
Required
Description
RcptId=[some value]
ALPHA
Alpha key
Parameter
Required
Description
String=[some value]
ATTRIB_SINGLE_ITEM
Add attribute to the last single item
Parameter
Required
Description
AttribNo=[some value]
Value=[some value]
BARCODE_ATTRIB_LOOKUP
Lookup and sell an barcode based on a barcode and an attribute in operator input
Parameter
Required
Description
Length=[some value]
Attribute=[some value]
CANCELKEY
Cancel key
Parameter
Required
Description
CHANGE_OPER_DRAWER
Change the operator drawer assignment
Parameter
Required
Description
DrawerLogName=[some value]
Permanent=[some value]
CHANGE_QUANTITY
Change the quantity of the selected line
Parameter
Required
Description
Quantity
No
If this parameter is set then the operation goes through without showing dialog, else dialog is shown to let the user enter new quantity.
Legacy
No
If set to true then older version of the dialog is used.
Note use of the older dialogs is deprecated.
CHANGE_WKST_SETTING
Change almost any workstation setting on the fly note: does not change permanently
Parameter
Required
Description
WrkstProperty=[some value]
Value=[some value]
CHANGEKPLOCATIONS
Change kitchen printer locations
Parameter
Required
Description
KPPrefix=[some value]
DESC=[some value]
ShowMessage=[some value]
CHANGESEAT
Move selected lines between seats
Parameter
Required
Description
CHECKZEROBALANCE
Finalizes the transaction if its balance is zero
Parameter
Required
Description
CLEAR_CUSTOMER
Clear a linked customer
Parameter
Required
Description
CLEARENTRYKEY
CLEARENTRY key
Parameter
Required
Description
CLEARKEY
Clear
Parameter
Required
Description
COPYFROMTRANS
Copies sales lines into current trans from older trans
Parameter
Required
Description
TrNo=[some value]
KeepPrcLvl=[some value]
CUSTOMER
Link a transaction to a customer
Parameter
Required
Description
Cust_Id=[some value]
CustLookupFrom=[some value]
CustLookupSearchBy=[some value]
SimpleFormat=[some value]
CUSTOMERDISPLAYONOFF
Turns the customer display on or off.
Parameter
Required
Description
On=[some value]
DECIMALKEY
DECIMAL key
Parameter
Required
Description
DELETEKEY
DELETE key
Parameter
Required
Description
DEPTITEMDISCOUNT
Department/item discount
Parameter
Required
Description
DeptItemDiscId=[some value]
DISC_MARKED_ITM_INFO
Discount selected or the last sold item and add a info code to the item
Parameter
Required
Description
DiscType=[some value]
InfoCd=[some value]
ApplyToLinkPLU=[some value]
DISCOUNT
General discount to the sale
Parameter
Required
Description
Prompt
No
Sets the initial state of the discount dialog. Valid values are: percentage, amount and price.
Percentage
No
Sets percentage discount and lets the operation go through without showing dialog.
Use the newer UseThisPercent parameter on new installations.
Amount
No
Sets amount discount and lets the operation go through without showing dialog.
Use the newer UseThisAmount parameter on new installations.
DiscType
No
Deprecated parameter.
Setting to 9000 will set initial state to percentage and 9001 to amount. On new setups us the Prompt parameter.
UseThisPercent
No
Deprecated parameter.
Sets percentage discount and lets the operation go through without showing dialog.
This parameter will only work if the DiscType parameter is used. On new setups use the Percentage parameter.
UseThisAmount
No
Deprecated parameter.
Sets amount discount and lets the operation go through without showing dialog.
This parameter will only work if the DiscType parameter is used. On new setups use the Amount parameter.
SelectedOnly
No
Makes discount only apply to selected items, generating error if nothing is selected. Valid values are 0 or 1.
OnLastValidLineOnly
No
If this is set then selection is ignored and last valid line is the one which the discount applies to.
Valid values are 0 or 1.
AmountInfoCode
No
Infocode to be applied on amount discount.
Default value if this parameter is skipped is sysdscmnamt
PercentageInfoCode
No
Infocode to be applied on percentage discount.
Default value if this parameter is skipped is sysdscmnpct
Legacy
No
If set to true then older version of the dialog is used.
Note use of the older dialogs is deprecated and some of the newer parameters above are not valid in legacy mode.
DO_NOTHING
Does nothing - similar to assembler NOOP
Parameter
Required
Description
EFT_COMMAND
Send a command to an External authorisation server
Parameter
Required
Description
ExternalAuth=[some value]
String=[some value]
ENDROUND
Order and end the round
Parameter
Required
Description
ENTERKEY
Enter key
Parameter
Required
Description
EXITWINDOWS
Exits the application and shuts down and reboots or logs off Windows
Parameter
Required
Description
LogOff=[some value]
PowerOff=[some value]
ReBoot=[some value]
ShutDown=[some value]
GETEXTERNALINFO
Runs an external program to get information
Parameter
Required
Description
ExPrgName=[some value]
ExPrgCmdLine=[some value]
DataExchFile=[some value]
ExClsName=[some value]
ExCaption=[some value]
SaveLastZInfo=[some value]
NeedMSRData=[some value]
NeedMSRDataCaption=[some value]
NeedMSRDataPrompt=[some value]
NeedMSRDataKeyb=[some value]
IsDLL=[some value]
FreeDll=[some value]
Tag=[some value]
RunAndForget=[some value]
Timout=[some value]
ExtPrgCreTrlFg=[some value]
ExtPrgCreTrVFg=[some value]
ExtPrgCreTrCFg=[some value]
ExtPrgCreCSVFg=[some value]
GOTOITEMMSMENU
Navigate to the Modify special menu defined on the items
Parameter
Required
Description
MenuLst=[some value]
HALFKEY
Selects PriceLevel and sets quantity in one operation
Parameter
Required
Description
QtyDesc=[some value]
QtyMultiply=[some value]
PriceMultiply=[some value]
PriceLevel=[some value]
HR_ENTRY
Human resource/Time attendance entry
Parameter
Required
Description
TimeAttType=[some value]
Info=[some value]
MustEnter=[some value]
INFO
Adds info entries to action
Parameter
Required
Description
Info=[some value]
INFOCODE
Info Code
Parameter
Required
Description
InfoCd=[some value]
NoRcpt=[some value]
OrderPrinter=[some value]
Info=[some value]
InfoCode.Add
Add the given infocode to the selected lines
Parameter
Required
Description
InfoCd=[some value]
InfoData=[some value]
Scope=[some value]
InfoCode.EnsureAbsent
Fails if the given infocode is present
Parameter
Required
Description
InfoCd=[some value]
Scope=[some value]
InfoCode.EnsurePresent
Fails if the given infocode is not present
Parameter
Required
Description
InfoCd=[some value]
Scope=[some value]
InfoCode.Remove
Remove the given infocode from the selected lines
Parameter
Required
Description
InfoCd=[some value]
Scope=[some value]
INFOCODE_ON_LAST_VALID_ITEM
Information code on last valid item in transaction
Parameter
Required
Description
InfoCd=[some value]
NoRcpt=[some value]
OrderPrinter=[some value]
Info=[some value]
INFOCODE_SINGLE_ITEM
Information code on a single selected or last item
Parameter
Required
Description
InfoCd=[some value]
NoRcpt=[some value]
OrderPrinter=[some value]
Info=[some value]
ApplyToLinkPLU=[some value]
Individual=[some value]
NextItem=[some value]
ITEM_INFOCODE
Information code on all selected items
Parameter
Required
Description
InfoCd=[some value]
NoRcpt=[some value]
ApplyToLinkPLU=[some value]
UnMarkAllItems=[some value]
JRNLDOWNLINE
JRNLDOWNLINE
Parameter
Required
Description
JRNLFIRSTLINE
JRNLFIRSTLINE
Parameter
Required
Description
JRNLHIDE
JRNLHIDE
Parameter
Required
Description
JRNLLASTLINE
JRNLLASTLINE
Parameter
Required
Description
JRNLMARKALL
JRNLMARKALL
Parameter
Required
Description
JRNLMARKLINE
JRNLMARKLINE
Parameter
Required
Description
JRNLPAYITEMS
JRNLPAYITEMS
Parameter
Required
Description
JRNLSPLITITEMS
Split Items key
Parameter
Required
Description
JRNLUNMARKALL
JRNLUNMARKALL
Parameter
Required
Description
JRNLUPLINE
JRNLUPLINE
Parameter
Required
Description
JRNLVOID
JRNLVOID
Parameter
Required
Description
JRNLXFERITEMS
JRNLXFERITEMS
Parameter
Required
Description
KDS_MANUAL_OVERRIDE
Manually override KDS quantities settings
Parameter
Required
Description
DisplayStation=[some value]
TmRstrctGrp=[some value]
KDS_MANUAL_OVERRIDE_OFF
Turn off Manually override KDS quantities settings
Parameter
Required
Description
DisplayStation=[some value]
KDS_SHOW_STATUS
Show and or change status of KDS
Parameter
Required
Description
KEYPAD
Show/hide keypad
Parameter
Required
Description
LASTVOID
Voids last item
Parameter
Required
Description
LEFTARROW
LEFTARROW key
Parameter
Required
Description
LINKOPERTRANSTONEWTABLE
Creates a new table and links the current operator transaction to it
Parameter
Required
Description
TableId=[some value]
Seats=[some value]
LOOKUPITEM
Searches the ITEM file according to users instrcutions
Parameter
Required
Description
ItemLookupSearchBy=[some value]
ItemLookupOnWhat=[some value]
SimpleFormat=[some value]
LOOKUPITEMINDEPT
Searches for items in a given department
Parameter
Required
Description
DeptId=[some value]
MAN_CHG_TAX_GROUP
Allows user to change tax group for all/selected items
Parameter
Required
Description
MARKTABLEWITHID
Mark the current table with an ID
Parameter
Required
Description
Id=[some value]
MENUBACK
MENUBACK key
Parameter
Required
Description
MenuControlId=[some value]
MENUBUTTON
MENUBUTTON key
Parameter
Required
Description
ButtonNo=[some value]
MENUCONTINUE
MENUCONTINUE key
Parameter
Required
Description
MENUDONE
MENUDONE key
Parameter
Required
Description
MENUOPEN
MENUOPEN key
Parameter
Required
Description
MenuControlId=[some value]
MenuId=[some value]
MENUOPEN(MenuControlId=root;MenuId=[menu-id];);
MENUTOP
MENUTOP key
Parameter
Required
Description
MenuControlId=[some value]
MODIFYSPECIAL
Modify sale items with the SPECIALMODIFY action
Parameter
Required
Description
NEW_OPER_PASSWORD
Enter a new password for an operator
Parameter
Required
Description
MustSupply=[some value]
MayBeSame=[some value]
NEWROUND
Order and starts a new round
Parameter
Required
Description
NOCURSOR
Hide/Show the cursor
Parameter
Required
Description
NRGT_REPORT
Create a report from NRGT
Parameter
Required
Description
ONESHOT_RES_REQUIRED
Next macro requires the operator to have this resource access
Parameter
Required
Description
ResId=[some value]
ONLY_TENDER_ALLOWED
Change the workstation state to only allow tenders
Parameter
Required
Description
On=[some value]
OPENDRAWER
Performs NOSALE
Parameter
Required
Description
OPERATOR
Operator key
Parameter
Required
Description
OpId=[some value]
Operator.ClockOut
Clocks-out the current operator
Parameter
Required
Description
OVERRIDE_ORDER_PRINTER
Send all selected items to a specific order printer
Parameter
Required
Description
OrderPrinter=[some value]
PARK-TRANS
Park/Resume a transaction
Parameter
Required
Description
ParkNo=[some value]
RcptId=[some value]
ParkTransType=[some value]
PAY_IN
Pay-in transaction
Parameter
Required
Description
RcptId=[some value]
PAY_INTO_ACCOUNT
Pay into a customer/house account
Parameter
Required
Description
RcptId=[some value]
PAY_OUT
Pay-out transaction
Parameter
Required
Description
RcptId=[some value]
PAYSELECTION
Starts a payment transaction to pay out selected items.
Parameter
Required
Description
POST_PRICEOVERRIDE
Override price for selected item or the last one if none is selected.
Parameter
Required
Description
POSTVOID
Voids an old transaction within the current period
Parameter
Required
Description
PRICELEVEL
Sets price level of this transaction.
Parameter
Required
Description
PriceLevel=[some value]
ReCalc=[some value]
PRICELOOKUP
Next scanned item is a price lookup not a sale
Parameter
Required
Description
PRICELOOKUPMODE
Puts the till in a special price lookup mode
Parameter
Required
Description
PRICELOOKUPMODEEND
Ends a price lookup mode with/without selling previous items
Parameter
Required
Description
MoveToActualTrans=[some value]
PRINTOVERVIEW
Print overview of table
Parameter
Required
Description
RcptId=[some value]
PRINTSEATOVERVIEW
Print seat overview of the table. If [Individual] is nonzero then separate overviews for all seats are printed.
Parameter
Required
Description
Individual=[some value]
(RcptId=[some value]
RCPTONOFF
Toggles receipt printing on and off
Parameter
Required
Description
OffOnToggle=[some value]
RCPTTYPE
Select type of receipt to use at till
Parameter
Required
Description
RcptId=[some value]
READONLY_MODE
Put the till in Readonly mode
Parameter
Required
Description
OffOnToggle=[some value]
IsSticky=[some value]
REFUNDITEM
Refunds an item (special inverse of SALE) - prefix to SALE
Parameter
Required
Description
IsSticky=[some value]
REMOVEANYLINKPLUFROMSALE
Brings up a dialog to allow the user to select a linked item to remove
Parameter
Required
Description
REMOVELINKPLUFROMSALE
Remove this sale item if it is linked to the marked item or the last sold item
Parameter
Required
Description
ItemID=[some value]
REPLACELINKPLUINSALE
Replace a Linked item with this one if it is in the same department as the marked or last item
Parameter
Required
Description
DeptId=[some value]
ItemID=[some value]
Quantity=[some value]
Info=[some value]
QtyDesc=[some value]
PriceMultiply=[some value]
PriceLevel=[some value]
SpPrFg=[some value]
UnitPrice=[some value]
REPORT
Run a workstation report
Parameter
Required
Description
ReportId=[some value]
ToScreen=[some value]
IsSticky=[some value]
REPRINTKITCHENORDER
Reprint the kitchen order for the current transaction
Parameter
Required
Description
RESET_OPOS_DEVICE
Resets an OPOS device
Parameter
Required
Description
DevClass=[some value]
LogicalName=[some value]
Level=[some value]
RETURN_RENTAL_ITEMS
Return items from rental
Parameter
Required
Description
RETURNITEM
Returns an item (inverse of SALE) - prefix to SALE.
Parameter
Required
Description
IsSticky=[some value]
RIGHTARROW
RIGHTARROW key
Parameter
Required
Description
RUNMACROFILE
Run macros from a file
Parameter
Required
Description
FileName=[some value]
SALE
Sells an item
Parameter
Required
Description
ItemID=[some value]
Quantity=[some value]
Info=[some value]
QtyDesc=[some value]
PriceMultiply=[some value]
PriceLevel=[some value]
SpPrFg=[some value]
UnitPrice=[some value]
SEAT
Seat key
Parameter
Required
Description
Selection.All
Select all lines
Parameter
Required
Description
Selection.EnsureAtLeastOneLine
Ensure at least one line is selected
Parameter
Required
Description
Selection.EnsureAtMostOneLine
Ensure that only zero or one lines are selected
Parameter
Required
Description
Selection.EnsureNotSales
Ensure that no sales lines are selected
Parameter
Required
Description
Selection.EnsureNotTender
Ensure that no tender lines are selected
Parameter
Required
Description
Selection.EnsureOnlySales
Ensure that only sales lines are selected
Parameter
Required
Description
Selection.EnsureOnlyTender
Ensure that only tender lines are selected
Parameter
Required
Description
Selection.LastLineByDefault
Select the last line if no others are selected
Parameter
Required
Description
Selection.LastSaleByDefault
Select the last sale line if no others are selected
Parameter
Required
Description
Selection.None
Clear all line selection
Parameter
Required
Description
SHOWACTIONS
Show the action menu
Parameter
Required
Description
SHOWALLROUNDS
Show all rounds on the journal
Parameter
Required
Description
SHOWBUILDBOX
Show buildbox on the journal
Parameter
Required
Description
SHOWFOREIGNCURR
Shows foreign currency tender exchange rate and calculates between tender types
Parameter
Required
Description
ToTender=[some value]
SHOWJOURNAL
Brings the Journal into view
Parameter
Required
Description
SHOWMENUS
Show the menu menu
Parameter
Required
Description
SHOWMESSAGE
Bring up a message dialog
Parameter
Required
Description
Message=[some value]
Caption=[some value]
DlgType=[some value]
SHOWROUNDS
Shows an overview of the rounds to the table
Parameter
Required
Description
SHOWTHISROUND
Show this round on the journal
Parameter
Required
Description
SIGNOFF
Signs the operator off
Parameter
Required
Description
STATUSOPOS
Shows status of OPOS-devices
Parameter
Required
Description
TABKEY
Tab key
Parameter
Required
Description
TABLE
Open/Resume a Table transaction
Parameter
Required
Description
TableId=[some value]
TABLE_ACTIONS
Opens the table actions dialog
Parameter
Required
Description
TABLELISTVIEW
Displays a list of open tables or customers
Parameter
Required
Description
TABLEVIEW
Opens the table viewer for watching
Parameter
Required
Description
TABREVERSEKEY
Reverse tab key
Parameter
Required
Description
TASKBAR
Brings the Windows taskbar into view
Parameter
Required
Description
TENDER
Adds tender line to the transaction
Parameter
Required
Description
Tender_Type
Yes
ID of the tender type to be used
Amount
No
Used to set predefined amount.
RcptId
No
Cust_Acct_Id
No
CustAcctLookupFrom
No
CustAcctLookupSearchBy
No
SimpleFormat
No
Confirm
No
If set to true then amount confirmation dialog is shown. This parameter is not supported when in Legacy mode.
SeatId
No
Allows setting seat ID when in hospitality. This parameter is not supported when in Legacy mode.
Legacy
No
If set to true then older version of the dialog is used.
Note use of the older dialogs is deprecated.
The functionality of the Tender macro is further affected by the amount entry behavioral control code (AMT_RQRD_CD) setting on the payment method as shown in the table bellow.
Amount entry type
AMT_RQRD_CD
Action
Confirm dialog shown
No entry
Allowed(0)
Show amount dialog with transaction balance.
When Confirm parameter is true.
Forbidden(1)
Pay remainder.
When confirm parameter is true then Confirm dialog is shown with input box disabled.
Required (2)
Show amount dialog with no amount.
Confirm dialog is always shown and
Confirm parameter has no effect.
Operator input before pressing tender button
Allowed(0)
Operator input is used for the tender amount.
When Confirm parameter is true.
Forbidden(1)
Error / Not valid
N/A
Required (2)
Operator input is used for the tender amount.
When Confirm parameter is true.
Amount parameter used
Allowed(0)
Amount parameter is used for the tender amount.
When confirm parameter is true then Confirm dialog is shown with input box disabled.
Forbidden(1)
Amount parameter is used for the tender amount.
When confirm parameter is true then Confirm dialog is shown with input box disabled.
Required (2)
Amount parameter is used for the tender amount.
When confirm parameter is true then Confirm dialog is shown with input box disabled.
Operator input and amount parameter
Error / Not valid
Error / Not valid
Error / Not valid
TENDER-CHANGE
Initiates a tender change transaction
Parameter
Required
Description
Tender_Type=[some value]
RcptId=[some value]
TENDER-DECL
Tender declaration at till
Parameter
Required
Description
PrintXrep=[some value]
RcptId=[some value]
MenuId=[some value]
MenuControlId=[some value]
TENDER-LOAN
Loan tender to till
Parameter
Required
Description
RcptId=[some value]
MenuId=[some value]
MenuControlId=[some value]
TENDER-PICKUP
Pickup tender from till
Parameter
Required
Description
RcptId=[some value]
TenderPickupReceiptOnly=[some value]
MenuId=[some value]
MenuControlId=[some value]
TENDERCARD
Adds tender line determined by MSR-card to the transaction
Parameter
Required
Description
ExternalAuth=[some value]
TOTALKEY
Totals the transaction and shows it in the cust.display
Parameter
Required
Description
TRAINING_MODE
Put till in training mode
Parameter
Required
Description
OffOnToggle=[some value]
RcptId=[some value]
IsSticky=[some value]
Blink=[some value]
Transaction.PrintCustomerSlipForLast
Prints an EFT customer slip for the last transaction
Parameter
Required
Description
receiptId=[some value]
Transaction.PrintMerchantSlipForLast
Prints an EFT merchant slip for the last transaction
Parameter
Required
Description
receiptId=[some value]
Transaction.PrintReceipt
Prints the current transaction with given receipt
Parameter
Required
Description
receiptId=[some value]
Transaction.PrintReceiptForLast
Prints a receipt for the last transaction
Parameter
Required
Description
receiptId=[some value]
Transaction.Store
Stores the current transaction
Parameter
Required
Description
Transaction.Suspend
Suspend the current transaction and prints a receipt
Parameter
Required
Description
receiptId=[some value]
Transaction.VoidAll
Voids the current transaction
Parameter
Required
Description
TRANSPARKVIEW
Parked transaction view
Parameter
Required
Description
ShowPreview=[some value]
TRANSVIEW
Shows a Finalized Transaction Search/View/Reprint form
Parameter
Required
Description
RePrintLastTrans=[some value]
RePrintLastWhichSlip=[some value]
ShowPreview=[some value]
ReprintInvoiceReceiptId=[some value]
ReprintSlipReceiptId=[some value]
PrinterId=[some value]
SimpleFormat=[some value]
AutoCharlestonPrint=[some value]
UNIQUEGROUPINFOCODE
Add or exchange an infocode to the transaction that is unique to a specific group
Parameter
Required
Description
InfoCdGroup=[some value]
InfoCd=[some value]
NoRcpt=[some value]
OrderPrinter=[some value]
Info=[some value]
VALITORPAYMENT
Request authorization via Valitor
Parameter
Required
Description
VALITORSENDBATCH
Send current batch to Valitor
Parameter
Required
Description
VOID
Void selected item
Parameter
Required
Description
VOIDNEXT
Next scanned item is a void not a sale
Parameter
Required
Description
VOIDSELDISCOUNT
Remove manual discount
Parameter
Required
Description
XFERSEAT
Transfer seat to another table
Parameter
Required
Description
XFERTABLE
Transfer selection to another table
Parameter
Required
Description
Z-SHIFTS
Do a workstation/operator shift Z
Parameter
Required
Description
Z-ShiftType=[some value]
Confirm=[some value]
Z-WRKST
Do a workstation-Z.
Example: Z-WRKST(Confirm=1;ReportId=301;);
Parameter
Required
Description
Confirm
No. Default false.
Asks for confirmation
DeleteSuspended
No. Default false.
Deletes suspended transactions
ReportId
No.
Report ID to print if needed
ZERO_ALL_ITEMPRICES
Set all items to zero price and remove all discounts
Parameter
Required
Description
Last updated
Was this helpful?