For the complete documentation index, see llms.txt. This page is also available as Markdown.
POScustom buttonsCustom Commands panetask padTask Pads paneinternal commandbatchchargescustomercustomer recorddiscountscash drawerline itemtaxsecuritywork orderback orderlayawayreason codereceiptssales reptenderingtime clocktransactionweb browserInternet screen

Commands reference guide

This topic describes commands that can be used to create custom buttons for the Custom Commands pane or the Task Pads pane.

The following commands can be used to program the functionality of both POS Task Pads and Custom POS Buttons. You must configure Task Pads and Custom Buttons in Store Manager.

Starting with release 3.11.0 you can program Task Pads or Custom Buttons to execute a chain of commands when the button is clicked by adding a semicolon (;) between commands. For example, you might create a chain of commands to discount a transaction (command 1) and then automatically select a discount reason code (command 2). There is no limit to the number of commands in a chain. However, the commands should be chained together to follow a logical transaction process.

BATCH COMMANDS

Use batch commands to perform various batch operations, such as entering opening and closing amounts, viewing the X report, printing X, Z, and ZZ reports, and performing a blind closeout.

Command
Description

Batch_CloseCommand

Closes the current batch. This is the same as a blind closeout. No parameters.

Batch_EnterClosingAmountsCommand

Invokes the Closing Amounts dialog. No parameters.

Batch_EnterOpeningAmountsCommand

Invokes the Opening Amounts dialog. No parameters.

Batch_PerformBlindCloseoutCommand

Performs a blind closeout. No parameters.

Batch_ViewXReportCommand

Displays the X report. No parameters.

CHARGE COMMANDS

Use charge commands to add charges to POS transactions.

Command
Description

Charge_AddNoTemplateCommand

Adds a charge without using a charge template (defined in Store Manager under Setup | Inventory/Purchasing | Charges).

The command takes the following optional parameters, separated by a pipe (|):

{Charge Code}|{Price}

If the {Charge Code} or {Price} parameters are not provided, the command invokes the Charge Lookup dialog and prompts for the price.

Example: Add charge code and price

Charge_AddNoTemplateCommand "CH|15.10"

Charge_AddCommand

Adds a charge to the transaction using a charge template (defined in Store Manager under Setup | Inventory/Purchasing | Charges).

The command takes the following optional parameters, separated by a pipe (|):

{Charge Code}|{Price}

If the {Charge Code} or {Price} parameters are not provided, the command invokes the Charge Lookup dialog and prompts for the price.

Example: Add charge code and price

Charge_AddCommand "CHARG1|15.10"

Example: Add charge code but prompt for the price

Charge_AddCommand "CHARG1"

CUSTOMER COMMANDS

Use customer commands to perform various customer-related operations.

Command
Description

Customer_AddCommand

Adds a customer to the transaction.

The command requires a mandatory parameter:

{Customer Account Number}

Example:

Customer_AddCommand "000005"

Customer_ClearCommand

Clears the current customer from the transaction. No parameters.

Customer_DisplayHistoryCommand

Displays a dialog with the current customer's purchase history. No parameters.

Customer_EditCommand

Invokes the Customer dialog where you can edit the customer. No parameters.

Customer_LookupCommand

Adds a customer to the transaction.

The command takes an optional parameter:

{Customer Account Number}

If a parameter is not provided, or the customer account number is not found, the command invokes the Customer Lookup dialog with a list of customers fitting the search criteria.

Example: Add a customer with account number “000005” to the transaction

Customer_LookupCommand "000005"

Example: Invoke the Customer Lookup dialog with the search criteria "Jon"

Customer_LookupCommand "Jon"

Customer_NewCommand

Invokes the Create New Customer Wizard dialog where you can create a new customer. No parameters.

Customer_PaymentOnAccountCommand

Invokes the Account Payment dialog for the selected accounts receivable customer. No parameters.

Customer_SelectShippingAddressCommand

Invokes the Select Shipping Address dialog where you can add a shipping address for the selected customer. No parameters.

DISCOUNT COMMANDS

Use discount commands to apply various discounts and price levels on the selected item, all items in the transaction, or the entire transaction.

Command
Description

Discount_InvokeDiscountMenuCommand

Invokes the Discount Menu dialog. No parameters.

The following commands apply a discount to all items that are currently in the transaction.

Note: Discounts are not applied to items that are added after an all items command is used.

DiscountAllItems_SetNoDiscountCommand

Removes any discount applied to all items currently in the transaction. No parameters.

DiscountAllItems_SetAmountFromCurrentPriceCommand

Applies a dollar amount discount from the current price to all items currently in the transaction.

The command takes the following optional parameters, separated by a pipe (|):

{Discount Amount}|{Reason Code}

If the {Discount Amount} parameter is not provided, the command invokes the Discount dialog and prompts for the dollar amount.

If the {Reason Code} parameter is provided, the reason code is applied automatically to the item or transaction.

Example: Apply a discount of $10 dollars to the current price for all items currently in the transaction

DiscountAllItems_SetAmountFromCurrentPriceCommand "10"

Example: Apply the RC01 reason code

DiscountAllItems_SetAmountFromCurrentPriceCommand "10|RC01"

DiscountAllItems_SetPercentFromCurrentPriceCommand

Applies a percentage discount from the current price to all items currently in the transaction.

The command takes the following optional parameters, separated by a pipe (|):

{Percentage Discount}|{Reason Code}

If the {Percentage Discount} parameter is not provided, the command invokes the Discount dialog and prompts for the percentage.

If the {Reason Code} parameter is provided, the reason code is applied automatically to the item or transaction.

Example: Apply a 10% discount to the current price for all items currently in the transaction

DiscountAllItems_SetPercentFromCurrentPriceCommand "10"

Example: Apply the RC01 reason code

DiscountAllItems_SetPercentFromCurrentPriceCommand "10|RC01"

DiscountAllItems_SetSubtotalAmountCommand

Sets the transaction subtotal amount by proportionally discounting the transaction items.

The command takes the following optional parameters, separated by a pipe (|):

{Target Subtotal Amount}|{Reason Code}

If the {Target Subtotal Amount} parameter is not provided, the command invokes the Discount dialog and prompts for the dollar amount.

If the {Reason Code} parameter is provided, the reason code is applied automatically to the item or transaction.

Example: Set the subtotal amount to $20 by discounting all items proportionally

DiscountAllItems_SetSubtotalAmountCommand "20"

Example: Apply the RC01 reason code

DiscountAllItems_SetSubtotalAmountCommand "20|RC01"

DiscountAllItems_SetPriceLevelACommand

Applies Price Level A to all items currently in the transaction. No parameters.

DiscountAllItems_SetPriceLevelBCommand

Applies Price Level B to all items currently in the transaction. No parameters.

DiscountAllItems_SetPriceLevelCCommand

Applies Price Level C to all items currently in the transaction. No parameters.

DiscountAllItems_SetPriceLevelDefaultCommand

Removes the price level from all items currently in the transaction. No parameters.

The following commands apply a discount to the currently selected item.

DiscountCurrentItem_SetAmountFromCurrentPriceCommand

Applies a dollar amount discount to the current price for the currently selected item.

The command takes the following optional parameters, separated by a pipe (|):

{Discount Amount}|{Reason Code}

If the {Discount Amount} parameter is not provided, the command invokes the Discount dialog and prompts for the dollar amount.

If the {Reason Code} parameter is provided, the reason code is applied automatically to the item or transaction.

Example: Apply a discount of $10 dollars to the current price for the currently selected item

DiscountCurrentItem_SetAmountFromCurrentPriceCommand "10"

Example: Apply the RC01 reason code

DiscountCurrentItem_SetAmountFromCurrentPriceCommand "10|RC01"

DiscountCurrentItem_SetNoDiscountCommand

Removes any applied discount from the selected item. No parameters.

DiscountCurrentItem_SetPercentFromCurrentPriceCommand

Applies a percentage discount to the current price for the currently selected item.

The command takes the following optional parameters, separated by a pipe (|):

{Discount Percentage}|{Reason Code}

If the {Discount Percentage} parameter is not provided, the command invokes the Discount dialog.

If the {Reason Code} parameter is provided, the reason code is applied automatically to the item or transaction.

Example: Apply a 10% discount to the current price for the currently selected item

DiscountCurrentItem_SetPercentFromCurrentPriceCommand "10"

Example: Apply the RC01 reason code

DiscountCurrentItem_SetPercentFromCurrentPriceCommand "10|RC01"

DiscountCurrentItem_SetPercentFromRetailPriceCommand

Applies a percentage discount to the retail price for currently selected item.

The command takes the following optional parameters, separated by a pipe (|):

{Discount Percentage}|{Reason Code}

If the {Discount Percentage} parameter is not provided, the command invokes the Discount dialog.

If the {Reason Code} parameter is provided, the reason code is applied automatically to the item or transaction.

Example: Apply a 10% discount to the retail price for the currently selected item

DiscountCurrentItem_SetPercentFromRetailPriceCommand "10"

Example: Apply the RC01 reason code

DiscountCurrentItem_SetPercentFromRetailPriceCommand "10|RC01"

DiscountCurrentItem_SetProfitMarginCommand

Sets the profit margin for the currently selected item.

The command takes the following optional parameters, separated by a pipe (|):

{Profit Margin Percentage}|{Reason Code}

If the {Profit Margin Percentage} parameter is not provided, the command invokes the Discount dialog.

If the {Reason Code} parameter is provided, the reason code is applied automatically to the item or transaction.

Example: Set a 10% profit margin for the currently selected item

DiscountCurrentItem_SetProfitMarginCommand "10"

Example: Apply the RC01 reason code

DiscountCurrentItem_SetProfitMarginCommand "10|RC01"

DiscountCurrentItem_SetPriceLevelACommand

Applies Price Level A to the currently selected item. No parameters.

DiscountCurrentItem_SetPriceLevelBCommand

Applies Price Level B to the currently selected item. No parameters.

DiscountCurrentItem_SetPriceLevelCCommand

Applies Price Level C to the currently selected item. No parameters.

DiscountCurrentItem_SetPriceLevelDefaultCommand

Removes any price level from the currently selected item. No parameters.

Use following commands to apply a discount to all items that are currently in the transaction or will be added later.

DiscountTransaction_SetNoDiscountCommand

Removes the transaction discount. No parameters.

DiscountTransaction_SetFromMinimumPriceCommand

Applies a percentage discount to the minimum price for the transaction.

The command takes the following optional parameters, separated by a pipe (|):

{Discount Percentage}|{Reason Code}

If the {Discount Percentage} parameter is not provided, the command invokes the Discount dialog.

If the {Reason Code} parameter is provided, the reason code is applied automatically to the item or transaction.

Example: Apply a 10% discount to the minimum price for the transaction

DiscountTransaction_SetFromMinimumPriceCommand "10"

Example: Apply the RC01 reason code

DiscountTransaction_SetFromMinimumPriceCommand "10|RC01"

DiscountTransaction_SetFromRetailPriceCommand

Applies a percentage discount to the retail price for the transaction.

The command takes the following optional parameters, separated by a pipe (|):

{Discount Percentage}|{Reason Code}

If the {Discount Percentage} parameter is not provided, the command invokes the Discount dialog.

If the {Reason Code} parameter is provided, the reason code is applied automatically to the item or transaction.

Example: Apply a 10% discount to the retail price for the transaction

DiscountTransaction_SetFromRetailPriceCommand "10"

Example: Apply the RC01 reason code

DiscountTransaction_SetFromRetailPriceCommand "10|RC01"

DiscountTransaction_SetMarkupFromCostCommand

Sets the transaction markup from cost.

The command takes the following optional parameters, separated by a pipe (|):

{Markup Percentage}|{Reason Code}

If the {Markup Percentage} parameter is not provided, the command invokes the Discount dialog.

If the {Reason Code} parameter is provided, the reason code is applied automatically to the item or transaction.

Example: Set a 10% markup from cost

DiscountTransaction_SetMarkupFromCostCommand "10"

Example: Apply the RC01 reason code

DiscountTransaction_SetMarkupFromCostCommand "10|RC01"

DiscountTransaction_SetProfitMarginCommand

Sets the transaction profit margin.

The command takes the following optional parameters, separated by a pipe (|):

{Profit Margin Percentage}|{Reason Code}

If the {Profit Margin Percentage} parameter is not provided, the command invokes the Discount dialog.

If the {Reason Code} parameter is provided, the reason code is applied automatically to the item or transaction.

Example: Set a 10% profit margin

DiscountTransaction_SetProfitMarginCommand "10"

Example: Apply the RC01 reason code

DiscountTransaction_SetProfitMarginCommand "10|RC01"

DiscountTransaction_SetPriceLevelACommand

Sets the transaction price level to Price Level A. No parameters.

DiscountTransaction_SetPriceLevelBCommand

Sets the transaction price level to Price Level B. No parameters.

DiscountTransaction_SetPriceLevelCCommand

Sets the transaction price level to Price Level C. No parameters.

DiscountTransaction_SetPriceLevelDefaultCommand

Removes the transaction price level. No parameters.

CASH DRAWER COMMANDS

Use the cash drawer commands to perform cash drops and pay outs from the cash drawer.

Command
Description

Drawer_CashDropCommand

Initiates a cash drop and invokes the Drop dialog. No parameters.

Drawer_CashPayOutCommand

Performs a pay out and invokes the Pay Out dialog. No parameters.

ITEM COMMANDS

Use item commands to perform various item functions, such as adding an item to a transaction, deleting an item from a transaction, and so on.

Command
Description

Item_AddCommand

Adds an item to a transaction.

The command takes the following parameter:

{Item Lookup Code}

Example: Add an item with the item lookup code 12345678 to the transaction

Item_AddCommand "12345678"

Item_AddCommentCommand

Adds a comment to the currently selected item.

The command takes the following optional parameter:

{Comment Text}

If the parameter is not provided, the command invokes the Item Comment dialog.

Example:

Item_AddCommentCommand "My comment on this item"

Item_ClearAllCommand

Clears all items in the transaction. No parameters.

Item_InvokeItemPriceCheckerDialogCommand

Invokes the Item Price Checker dialog.

Note: The Item Price Checker dialog can only be used to check prices for standard items. It cannot be used to check prices for matrix, lot matrix, or assembly items.

The command takes the following optional parameter:

{ON}

If the parameter is provided, the Item Price Checker dialog will display on net display if net display is enabled for the register. If the parameter is not provided, the dialog will not display on net display.

Example: Display the dialog on net display if net display is enabled for the register

Item_InvokeItemPriceCheckerDialogCommand ON

Item_LookupCommand

Invokes the Item Lookup dialog.

The command takes the following optional parameter:

{Search Criteria}

The {Search Criteria} parameter can be a combination of item lookup code, description etc. If a parameter is not provided, the command invokes the Item Lookup dialog without any search criteria.

Example: Invoke the Item Lookup dialog with search criteria "123 My"

Item_LookupCommand "123 My"

Item_LookupDepCatCommand

Initiates item department or category lookup.

The command takes the following optional parameter:

{Search Criteria}

The {Search Criteria} parameter can be a department or category name, or a combination of both. If both a department and category name are in search criteria, separate them with a forward slash (/).

Example: Initiate item search for department or category "Camping"

Item_LookupDepCatCommand "Camping"

Example: Initiate item search by department and category "Clothing/Boys"

Item_LookupDepCatCommand "Clothing/Boys"

ITEM TAX COMMANDS

Use item tax commands to change item taxes.

Command
Description

ItemTax_SetDestinationTaxCommand

Applies the destination tax based on the shipping address. No parameters.

ItemTax_SetNoItemTaxForTransactionCommand

Makes the transaction tax free. No parameters.

ItemTax_SetForCurrentItemCommand

Invokes the Select Tax dialog for the currently selected item. No parameters.

ItemTax_SetForTransactionCommand

Invokes the Select Tax for the transaction. No parameters.

ItemTax_ToggleForItemCommand

Toggles item tax on/off for the selected item(s). No parameters.

ItemTax_ToggleForTransactionCommand

Toggles the transaction item tax on/off. No parameters.

SECURITY COMMANDS

Use the security commands to perform a cashier override.

Command
Description

Security_CashierOverrideCommand

Invokes the Login dialog and initiates a cashier override. Takes no parameter.

Security_ChangeUserCommand

Logs out the current user and Invokes the Login dialog. Takes no parameter.

ORDER COMMANDS

Use the order commands for functionality related to work orders, back orders, layaways, and quotes.

Command
Description

Order_AddCommentCommand

Adds a comment to an order.

The command takes the following optional parameter:

{Comment Text}

If the parameter is not provided, the commend invokes the Order Comment dialog.

Example:

Order_AddCommentCommand "Order comment"

Order_DepositCommand

Invokes the Enter Deposit dialog. No parameters.

Order_OverrideDepositPercentageCommand

Overrides the order deposit with a percentage of the order total.

The command takes the following parameter:

{Deposit Percentage}

Example: Override the order deposit with 10% of order total

Order_OverrideDepositPercentageCommand "10"

Order_OverrideDepositAmounCommand

Overrides the order deposit with an amount.

The command takes the following parameter:

{Deposit Amount}

Example: Override the order deposit with an amount of $100

Order_OverrideDepositAmountCommand "100"

Order_ChangDueDateCommand

Invokes the Order Due Date dialog. No parameters.

WorkOrder_RecallCommand

Invokes the Recall Work Order dialog where you can select a work order. No parameters.

Quote_RecallCommand

Invokes the Recall Quote dialog where you can select a quote. No parameters.

BackOrder_RecallCommand

Invokes the Recall Back Order dialog where you can select a back order. No parameters.

Layaway_RecallCommand

Invokes the Recall Layaway dialog where you can select a layaway. No parameters.

Layaway_PaymentCommand

Initiates the payment on layaway process. No parameters.

REASON CODE COMMANDS

Use the reason code commands to apply reason codes to items and transactions.

Command
Description

ReasonCode_SetReasonCodeForCurrentItemCommand

Applies a reason code to the currently selected item.

The command takes the following parameter:

{Reason Code}

Example: Apply the RMI01 reason code to the selected item

ReasonCode_SetReasonCodeForCurrentItemCommand "RMI01"

ReasonCode_SetReasonCodeForItemCommand

Applies a reason code to an item, using the transaction item key and the reason code.

Example: Apply the RC01 reason code to an item with the item key "2"

ReasonCode_SetReasonCodeForItemCommand "2|RC01"

ReasonCode_SetReasonCodeForTransactionCommand

Applies a reason code to the transaction.

The command takes the following parameter:

{Reason Code}

Example: Apply the RMI01 reason code to the transaction

ReasonCode_SetReasonCodeForTransactionCommand "RMI01"

ReasonCode_SetReasonCodeForAllItemsCommand

Applies a reason code to all items in the transaction.

The command takes the following parameter:

{Reason Code}

Example: Apply the RMI01 reason code to all items in the transaction

ReasonCode_SetReasonCodeForAllItemsCommand "RMI01"

RECEIPT PRINTING COMMANDS

Use these commands for receipt printing.

Command
Description

Receipt_PrintXReportCommand

Prints the X Report. No parameters.

Receipt_PrintZReportCommand

Prints the Z Report. No parameters.

Receipt_PrintZZReportCommand

Prints the ZZ Report. No parameters.

Receipt_ReprintCommand

Reprints the last receipt. No parameters.

Receipt_ReprintGiftCommand

Reprints the last receipt as a gift receipt. The receipt template must be configured to contain a gift receipt section. No parameters.

Receipt_ReprintWithTemplateCommand

Initiates the process of reprinting the last receipt using a different template. No parameters.

Receipt_PreviewCommand

Previews the receipt.

The command takes the following parameters:

{"Printer1"}

{"Printer2"}

Use the parameters to select which printer to preview. The specified printer to be configured to use a receipt template.

Example: Preview the receipt for Printer1

Receipt_PreviewCommand "Printer1"

RECEIPT MESSAGE COMMANDS

Use receipt message commands to set or clear custom session variables used in the receipt template to print custom messages. Requires a customized receipt template which takes advantage of these functions.

Command
Description

ReceiptMessage_RemoveCustomMessageCommand

Clears custom message from a receipt session variable.

The command takes the following parameter:

{Session Variable Number}

Example: Clear session variable1

ReceiptMessage_RemoveCustomMessageCommand "1"

ReceiptMessage_SetCustomMessageCommand

Sets a custom message to a session variable for printing on the receipt.

The command takes the following parameters, separated by a pipe (|):

{Session Variable Number}|{Value}

Example: Set session variable 1 to "My Message"

ReceiptMessage_SetCustomMessageCommand "1|My message"

SALES REPRESENTATIVE COMMANDS

Use sales representative commands to set (or clear) sales representatives for items or transactions.

Command
Description

SalesRep_SetForCurrentItemCommand

Applies a sales representative to the currently selected item.

The command takes the following optional parameter:

{Sales Representative Number}

If the parameter is not provided, or the number is not found, the command Invokes the Sales Rep Lookup dialog where you can select a sales representative.

Example: Apply the sales representative “001” to the currently selected item

SalesRep_SetForCurrentItemCommand "001"

SalesRep_SetForTransactionCommand

Applies a sales representative to the transaction.

The command takes the following optional parameter:

{Sales Representative Number}

If the parameter is not provided, or the number is not found, the command Invokes the Sales Rep Lookup dialog where you can select a sales representative.

Example: Apply the sales representative “002” to the transaction

SalesRep_SetForTransactionCommand "002"

SalesRep_ClearFromCurrentItemCommand

Removes the assigned sales representative from the currently selected item. No parameters.

SalesRep_ClearFromTransactionCommand

Removes the assigned sales representative from the transaction. No parameters.

TENDERING COMMANDS

Use the tendering commands to initiate functions related to transaction tendering. Is used in the same way as Transaction_InvokeTenderDialogCommand.

Command
Description

Tender_BeginCommand

Initiates the tendering process.

Tender_FixedAmountCommand

Tenders a specific tender type (by tender code) with a specified amount.

The command takes the following parameters, separated by a pipe (|):

{Tender Code}|{Decimal Amount}

This command also executes the Loyalty program, if applicable, so customers can earn or redeem points on the transaction. The command opens the Tender Dialog because, at the time the command is executed, the amount of the Loyalty discount is not known.

Example: Tender a transaction using tender type CSH with an amount $10.25

Tender_FixedAmountCommand "CSH|10.25"

Transaction_ExactTenderAmountCommand

Tenders a specific tender type (by tender code) with the exact total amount.

The command takes the following parameter:

{TenderCode}

This command also executes the Loyalty program, if applicable, so customers can earn or redeem points on the transaction.

Example: Tender a transaction for the exact total amount using tender type CSH

Transaction_ExactTenderAmountCommand "CSH"

TIME CLOCK COMMAND

Use this command to display the Time Clock screen.

Command
Description

TimeClock_InvokeDialogCommand

Displays the Time Clock screen. No parameters.

TRANSACTION COMMANDS

Use these commands to manage the transaction flow.

Command
Description

Transaction_CancelTransactionCommand

Cancels the transaction and controls whether the application is closed or not.

The command takes the following optional parameters:

{Blank}

{True}

{False}

Example: Cancel the transaction and close the application

Transaction_CancelTransactionCommand "True"

Transaction_CancelTransactionCommand

Example: Cancel the transaction and do not close the application

Transaction_CancelTransactionCommand "False"

Transaction_ChangeToLayawayCommand

Changes the transaction to a layaway. No parameters.

Transaction_ChangeToQuoteCommand

Changes the transaction to quote. No parameters.

Transaction_ChangeToWorkOrderCommand

Changes the transaction to work order. No parameters.

Transaction_AddCommentCommand

Adds a comment to the transaction.

The command takes the following optional parameter:

{Comment Text}

If the parameter is not provided, the command invokes the Transaction Comment dialog.

Example:

Transaction_AddCommentCommand "Comment text"

Transaction_SetReturnModeCommand

Changes the transaction to return transaction. No parameters.

Transaction_SetSalesModeCommand

Changes the transaction from return to sale. No parameters.

Transaction_SetOnHoldCommand

Puts the current transaction on hold. No parameters.

Transaction_InvokeTenderDialogCommand

Invokes the Tender dialog and initiates the tendering process. No parameters. Similar to Tender_BeginCommand.

Transaction_NetDisplayCommand

Toggles net display on/off. Net display must be enabled in Store Manager.

The command takes the following parameters:

{ON}

{OFF}

If a parameter is not provided, the command toggles the net display on/off.

Example: Turn on net display

Transaction_NetDisplayCommand "ON"

Example: Turn off net display

Transaction_NetDisplayCommand "OFF"

Example: Toggle net display on/off

Transaction_NetDisplayCommand

Transaction_NoSaleCommand

Performs a no sale transaction. No parameters.

Transaction_RecallForReturnCommand

Initiates the recall for return process. No parameters.

Transaction_RecallForVoidCommand

Initiates the recall for void process. No parameters.

Transaction_RecallFromHoldCommand

Recalls a transaction from hold. No parameters.

Transaction_ToggleReturnModeCommand

Toggles the transaction return mode on/ff. No parameters.

Transaction_ViewJournalCommand

Displays the journal. No parameters.

WEB BROWSER COMMAND

Use this command to display a URL in the built-in web browser.

Command
Description

WebBrowser_NavigateCommand

Displays a URL (web page) in the built-in browser.

The command takes the following parameter:

{URL}

Example:

WebBrowser_NavigateCommand "http://www.rmhpos.com"

CUSTOM ACTION COMMAND

Use this command to enable custom functionality in a POS Extension using a custom button (or a task pad button).

Command
Description

CustomActionCommand

Example:

CustomActionCommand "param1|param2|param3"

Essentially, this command fires up an event in the POS, and passes a parameter to it. Your extension will listen to that event, and when it is fired, check the parameter to see if it is the "own" parameter (which will be processed) or a "foreign" one (which will be ignored). The command/event is available equally to all extensions, so it is important for the extension to distinguish by looking at the parameter.

Please review the demo project in the SDK: C:\Program Files (x86)\Retail Hero\RMH POS\RMH POS SDK\SDK_POS.ZIP\RMHDemoExtension-Native\RMHDemoExtension

(or the Telerik version). Check the area "Custom Button Handling".

The comment in the project reads:

// The custom buttons could use any string parameter (but only one per command - XAML allows only one command parameter)

// Multiple parameters could be passed as a single string with separators, such as: "parameter1|parameter2|parameter3"

// It is recommended to use GUIDs as parameter. That will make sure that different extensions don't mix-up handling

// the same custom action event

// In the CustomPanel xaml, the Custom Action 1 and 2 buttons use guids as parameters

// Each custom button raises the same even, but passes a different parameter

// That's how multiple extensions know which event is "their" and ignore all others.

//Guid for Custom Action 1 button: DEDE0403-5C7A-4A84-BB75-F1DD0D914F4D

//Guid for Custom Action 2 button: 71D09398-1A5C-4CB4-9738-1584B61483F1

Although this explanation is a bit outdated (it talks about CustomPanel.xaml while since RMH version 3.2 we handle the custom buttons by creating them in Store Manager, not via the XAML modification), it still applies in principle no matter how the button is created.

In fact, in your custom button you can use any "string" parameter with your command, but we recommend using generated GUIDs as that would prevent the possible extension "clash" if two or more extensions happen to use the same string parameter.

See also p.19 in RMH_SDKProjects_v1_CL.pdf (in the POS SDK folder).

Last updated