The following is a list of predefined POS functions in Configurator.
Function Type ID and description |
Function specific parameters |
---|---|
Adjust Taxes Function — changes the tax amount for an entered item by changing its tax group assignment. It allows for adjustments when an item is incorrectly configured in the database. It can be applied to item, non-merchandise, and department lines. |
|
Apply Coupon — looks up a coupon configuration to determine the coupon value ($ off or % off). It triggers the Apply Discount UDF. |
|
Apply Discount — allows application of a selected discount to a transaction upon an expected response to a predefined confirmation prompt. The prompt collects information to determine the type of discount to apply. The options are a discount, which offsets the item’s cost price, level price, or an offset amount. Discount criteria and item eligibility rules are confirmed by the discount component before the apply discount function is executed. |
Apply Type — applies a discount to an item. Options include the following:
Grouping Rule — determines if discounts on the document (for example, receipt) appear with each transaction item or grouped together as a single entry at the bottom of the document. It applies to discounts that have the same discount code and there is no effect on the calculation of the total discount amount. Close Zero Balance Transaction — determines if a transaction can close automatically if a 100% transaction discount is applied. Active only for the Apply Type transaction |
Begin Transaction Re-Entry Mode — similar to the Training Mode. It allows the re-entry of transactions from business days other than the current business day. |
End re-entry mode — exits from re-entry mode automatically at the end of the transaction |
Cancel Pending — cancels an existing pending transaction and all pending items. All money paid (less fees and the cost of goods already picked up) is refunded to the customer. |
Add Fees — adds additional fees to pending transactions Cancel Fees — cancels fees previously applied to pending transactions |
Cancelable Operation |
Cancellation Request ID Process Request ID |
Change Salesperson — every line in a transaction can have a salesperson value attached to it to support sales tracking activity. This value refers to the cashier who originally logged on to the terminal. The change salesperson function allows a transaction to start using the logged on salesperson and then changed to a different salesperson in the middle of the transaction. The new salesperson can remain logged on for the rest of transaction, or until the change salesperson function is executed again. This function can only be performed inside a sale. |
|
Clock In — logs the start time of a store employee shift. Store employees are required to enter a logon ID and password. The POS terminal disallows a clock in attempt if a store employee is already clocked in. |
|
Clock Out — logs the end time of a store employee shift. Store employees are required to enter a logon ID and password. The POS terminal disallows a clock out attempt if a store employee is already clocked out. |
|
Create Customer — creates a new customer. If a customer lookup fails or the customer does not exist, this UDF is triggered for adding the customer to the database. |
Use Customer Service — enables or disables the use of: Customer Service Customer Service ID Request Time Out Behavior If Request Times Out Behavior If Declined If Customer Created Successfully, Trigger UDF Auto Close Behavior |
Department Memo |
Sub-Action Code Count Item |
Emergency Sign Off — allows cashiers to log off of the POS terminal |
|
Emergency Sign On — allows cashiers to logon to the POS terminal and process transactions when the head office is not available |
|
End Transaction Re-Entry Mode — exits transaction re-entry mode |
|
Enter Customer — records the customer information in a transaction |
Use Customer Service Customer Service ID Request Time Out Behavior If Request Times Out If No Customer Is Found, Trigger UDF If Update Is Required, Trigger UDF Behavior If Identified Customer |
Enter Document Editor — enters the document editor capture mode. Captures user transactions based on the selected document. The selected document is in the document editor ready for editing. For example, if you enter the document editor and select the customer receipt as a document, then the customer receipts for all the transactions that run in this mode are saved in the Document Editor tool for editing. The register stays in the document editor capture mode until you select the same function (start/stop document editor) again. Permissions are checked to ensure that you have the authority to perform this function. |
Edit Document Menu — a menu that determines which documents to edit. If no menu is specified, the default behavior is to capture all activated documents for editing Reset to Standard Document — within the document editor, under the Document Outline tab, there is a Set to Standard option. If you have a document specified for this parameter, then that document’s outline section is used as the standard outline. For example, that document’s outline section is copied to the document you are editing. If no document is specified, then a hard-coded standard outline is used Tool Tip Duration (sec.) — the length of time tool tips within the document editor are displayed. For example, when you hover over certain fields within the editor, a tool-tip is displayed; the setting controls how long the tool tip is displayed Barcode Image — specifies the name of the standard image file (used when a receipt has a bar code, an actual bar code in the Document Test Output section of the Document Editor is not generated) |
Enter Layout Editor — enters the layout edit mode. Permissions checks are done to ensure that you have the authority to perform this function. |
Enter Edit Layout Menu — performs modification and configuration of the user interface through the POS terminal configuration. When triggered, the layout of the POS user interface is in edit mode and each user interface component is surrounded by a selection border that allows you to perform different configuration. By double-clicking on the component, the Configurator launches for different modifications |
Exit Document Editor — exits the document editor capture mode and launches the Document Editor tool. When you are in the document editor capture mode and trigger (start/stop document editor) the function again, you exit the document editor capture mode. The Document Editor tool is launched with all the captured documents to be edited |
|
Exit Layout Editor — exits the layout editor mode. By triggering this function you are prompted to save the changes that you made to the user interface. If you choose to save, then all of the changes are saved to the layout.properties file and exit edit mode is triggered. Otherwise, the user interface remains in the same state as before entering the edit mode. |
Save UI — Saves changes and remains in edit mode |
Exit POS Client — triggers a POS terminal exit. Permissions are checked to ensure that you have the authority to perform this function. |
|
Fee Override — changes the amount of an existing transaction fee or applies an additional fee. |
|
Fetch and Display Customer Orders |
|
Force Cancel Pending — cancels a pending transaction when a customer is not present. All refundable money paid by the customer is forfeited |
Tender For Forfeited Amounts — tender type to which all forfeited amounts are added |
Get Store Till Type — the accountability type (by cashier or terminal) for the store tills |
|
Get Totals For Currency |
|
Item Inquiry — displays information about an item without initiating a sale transaction. The information displayed is the item key, description, base price, and pack quantity. If the item is not allowed for sale (flagged as Allow Sell= N in the item file), a message is displayed indicating so. An item inquiry can be performed in any POS state (logged on or off, store opened or closed, and terminal opened or closed.) |
Allow Auto Sell After Inquiry starts a sale transaction for the item that is scanned if you perform a price inquiry and this function is enabled. |
Item Memo — adds a merchandise item to a transaction without affecting totals. Sometimes referred to as a rain check. |
Sub Action Code — User-defined code that identifies an alternate use for item memo in the Item Memo Document Form Count Item — counts an item memo as an item |
Loan |
|
Lock Operator |
|
Maintain Customer — maintains customer information outside of a transaction |
Use Customer Service Customer Service ID Request Timeout Behavior If Request Times Out If No Customer Is Found, Trigger UDF If Update Is Required, Trigger UDF Behavior If Identified Customer |
Manual Tax Charge — increases a tax amount for a tax authority |
|
Manual Tax Refund — decreases a tax amount for a tax authority. |
|
Mark/Unmark all as Gift — marks a list of items as gifts to print on a gift receipt for all items as one receipt or by item. If the items are already marked as gifts, then triggering this function again unmarks them and marks the items as regular items |
Gift Group — changes the gift group by creating a new gift group and processing New Gift Group UDF. It must be selected from the available gift group |
No sale |
|
Non-Financial EFT — performs a credit inquiry before processing a credit transaction |
Authorization Type Set to Balance Inquiry Card Type Stored Value or Private Label Card Request Timeout — the number of seconds that the POS terminal waits for a response from the credit service before timing out |
Override Deposit — overrides a deposit that is precalculated by SAP Enterprise POS based on configuration settings. |
|
POS Browser — displays a browser window within the POS system that can be specified to automatically navigate to a defined URL. The POS Browser function can be selected in any POS state but the cashier who is logged on to the POS terminal when the function is triggered, must have the appropriate permission to activate the browser. If the cashier does not have the required permission level, an Invalid Session error message displays on the screen when the request is made. To use the UDF, you must define a menu, keypad, or POS keyboard configuration to access it. |
URL — the URL that the browser is directed to when the function is triggered. If additional prompt data is required from the cashier to launch the browser, the function must be specified to incorporate the prompt data to the URL. To use prompt responses in the URL, you must attach the appropriate Data Form to the Launch Browser function. For example, to include prompt data in the URL it must be specified in the following format: http:// plulocator.customer.com?it emid=%item number%, where %item number% is replaced by the response to the prompt that specified the variable as a type item number. Browser Menu — specifies the menu to display after the POS Browser function is triggered. The options displayed are all the menu definitions created under the Menu configuration component. When completed, trigger the UDF, for example, ProcessOrderUDF |
Payment Correction On Pending — corrects a payment previously made in a pending transaction. |
|
Payment On Pending — makes a payment in a pending transaction. |
|
Pending Merch — adds an item to a pending transaction. |
Maximum Sell Unit Price |
Pending NonMerch — adds a non-merchandise item to a pending transaction. |
|
Pending Bin Adjustment — adjusts bins previously defined for pending transactions. |
|
Pickup — picks up all pending items in a pending transaction. |
|
Pickup Pending — picks up one or more items in a pending transaction selected from a virtual receipt. |
Line Selection Method — picks up the item as follows:
|
Post Void Transactions — voids a transaction within a workflow that is fully tendered, closed, and recorded to the TLOG. This function supports no settings beyond the standard ones. To process a Post Void function, the cashier must be logged on, but the POS terminal must not be involved in any transactions. The cashier is prompted to identify the transaction to be post voided by providing the transaction number. The store and terminal number are restricted to the store/terminal that initiated the original transaction. Requests to void a transaction that is completed on another business day, or one that is not completed, are not allowed. Post voids can only be applied against UDTs that are variations on retail sales containing mainly items and tenders. They cannot be applied against other transaction types such as administrative transactions (Pickup, Paid Out, Sign Off). Once a transaction is post voided, it cannot be post voided again. If a transaction contains any lines that cannot be user voided, the transaction cannot be post voided. The post void feature reverses all lines of the original transaction by creating a matching void line for each. In some cases, such as tenders and stored value instruments, this may require that reversing requests be issued to an authorization service. |
|
Price Override — the price of an item in an item sale, a department sale, or a non-merchandise sale to be changed up to a limit defined in the Allowed Price Increase/Decrease Override Amount and Percent fields. For example, if the allowable price override increase amount is set to $1.00 and the price override decrease amount is set to $10.00, the POS terminal allows the price of a $20.00 item to be overridden to any value between $10.00 or $21.00. Special permissions must be set up to allow the defined thresholds to be exceeded if required. The POS validates the entered price against the defined permissions before executing the price override function. |
Allowed Price Override Increase Amount — the maximum amount above or below the file-based item price that the new price can be changed to Allowed Price Override Decrease Amount — the maximum amount below the file-based item price that the new price can be changed to Allowed Price Override Increase Percent — the maximum percentage above or below the file-based item price that the new price can be changed to Allowed Price Override Decrease Percent — the maximum percentage below the file-based item price that the new price can be changed to Allow Price Override to Regular Price — allows an override for a promotion item price to the regular price Receipt Price Modifier Line Grouping Rule — indicates how the price override should be shown on the screen and receipt
|
Process Customer Orders — allows an order sale transaction at the POS terminal. Triggered when returning from the Customer Order Management (COM) user interface or when the cashier selects Payment after scanning an order bar code. |
XI Order Read URL Triggered Cancelable UDF ID for Customer Order Type Triggered Cancelable UDF ID for Invoice Order Type Triggered Cancelable UDF ID for Credit Memo Order Type Down Payment Amount Changeable for Customer Order Type Payment Amount Changeable for Invoice Order Type Refund Amount Changeable for Credit Memo Order Type TE Internal Prefix for Sales Order TE Internal Prefix for Invoice TE Internal Prefix for Credit Memo TE Internal Prefix for Unknown External System Prefix for Sales Order External System Prefix for Invoice External System Prefix for Credit Memo TE Internal Barcode Length |
Reactivate Pending — reactivates a previously force canceled pending transaction |
|
Recall Transaction — recalls a transaction to its last state |
Use TLOG Service — asynchronously recalls and looks up transactions against the head office Request Timeout Maximum Result Per Query — limits the number of transactions to be returned for a single lookup request If Transaction Cannot Be Recalled, Trigger UDF — triggers UDF Within UDT — triggered within UDT If Transaction Was Found, Use UI Attributes of UDT Recall Transaction Types Allowed — limits transaction types that can be recalled |
Remove From Pending — removes an item selected from a virtual receipt from a pending transaction |
Selection Method — by line or key |
Reprint Image — reprints the receipt image of a sale transaction using data stored in the receipt archive |
Documents Allowed For Reprint — indicates which documents are allowed for reprint if the transaction contains multiple documents. The default option is Any Reprint Image Menu — menu that displays when in reprint image mode |
Reprint Transaction — reprints the last processed transaction. This function is only allowed when the POS terminal is in an open state. The default is to the last transaction, but it can optionally include selection of a specific transaction through a prompt for the site, device, and transaction number information. |
|
Resume Pending Transactions |
|
Resume Suspended Transactions — resumes a transaction that is suspended. Depending on the configuration of this function, the suspended transaction can be resumed only at a specific terminal within a store, at any terminal within a store, or in any store. When identifying the transaction to be resumed, the cashier can enter a partial value, or no value at all, for the information being prompted. The POS terminal returns a list of suspended transactions that qualify for the Resume Suspended Transaction — the cashier can select the required transaction from the list of transactions presented. |
Resume Type — defines where a suspended transaction can be resumed by specifying one of the following options:
|
Return All — returns all returnable items from a recalled transaction |
|
Return Department |
|
Return Item — processes an item return transaction. Two function-specific parameters (Max Amount and Max Percent) specify a maximum dollar or percentage variance to limit the value of the price that you enter in the return transaction. Override Allowable Item Return Amount and Override Allowable Return Percent permissions can be set to exceed the defined thresholds if required. The POS terminal validates the entered price against the defined permissions before executing the return function. |
Max Amount — the maximum dollar variance amount that can be accepted for the price of a returned item. This value can be overridden with appropriate permission settings Max Percent — the maximum percent variance that can be accepted for the price of a returned item. This value can be overridden with appropriate permission settings |
Return Lines — returns selected lines from a recalled transaction |
|
ReturnLinkedItem — processes bottle and box returns |
Pack Items — where pack is a box or case
|
Return Non-Merch — returns a non-merchandise line from a recalled transaction |
|
Safe Tenders |
|
Safe Transaction Tenders — tenders for a specific tender management transaction |
|
Safe Transfer Tenders — transferable tenders between 2 safes |
|
Save Pending Transactions |
|
Secure Data Access Form |
|
Secure Data Access Record |
|
Sell Department — permission required for Allow Under Minimum option |
|
Sell Item — records the sale of an item or quantity of a given item |
Maximum Sell Unit Price Inventory Lookup Time Out Authorization Type Authorizer User Exit Sequence Number Algorithm Delay Authorization Until End of Transaction Allow Manual Authorization Auto Authorize Max. Amount for Offline Type of Auto Authorize Number Algorithm Manual Authorization Data Form Request Time Out (Client to server) Pack Items: used for bottle and case deposit fees:
|
Sell Non-Merch — non-merchandise items are non-SKU or PLU-based items such as a fee, a service, a rental, or an item such as a stored value card. Unlike regular items, non-merchandise items are maintained through configuration (Non-Merchandise configuration component) instead of through the item file and are processed differently than regular items. They are sold at the POS terminal through menu or key selection. You can prevent modifying the preset amount through the configuration of a permission that prevents modification. |
If non-merchandise items require authorization for a transaction to complete, provide details for the following: Authorization Type — the authorization route for the sale of the item must be specified. Leave the default None value if your non-merchandise item does not require authorization. In this case, you do not need to specify anything further in the Auto Authorize Max Amount for Offline or the Allow Manual Authorization parameters. Allow Manual Authorization — allows manual authorization Auto Authorize Max. Amount for Offline — a maximum amount that the POS terminal automatically authorizes when offline Type of Auto Authorize Number Algorithm — selection of either an internal value supplied by the EFT authorizer, or one of the number generation algorithms found in the Auto Reference Numbers component. Auto Authorize Number Algorithm — generates a reference number for this UDF request Manual Authorization Data Form — data form to display a prompt for the details about the manual authorization must be specified Request Time Out (Client to server) — the number of seconds to wait for a response from the external system Return UDF To Use For Line Return — a function that processes the return of the line. Allows you to override the default line return |
Sign Off — closes the POS terminal upon validation of the operator ID number and password by changing the POS state from register open to close register. You can also exit the POS terminal with this function, go in to training mode, clock in, and clock out. |
User ID — a valid user ID is required to log off Password — a valid password is required to log off |
Sign On — allows use of the POS terminal upon validation of the operator ID number and password by changing the POS state from logged off to logged on. Because the logon state is assumed to be the default when the POS is in a logoff state, the cashier can logon by entering their logon information at a logged off terminal. Alternately, the cashier can also log on by selecting the Logon function key or menu option and then enter their information at the prompts. In the Terminal Operations window, set the following:
|
|
Start Loan |
|
Start Pickup — used for cash management |
|
Start Training Mode — puts the POS terminal into a training mode and any logged transactions do not update sales totals. The POS UI refreshes its background image so that it shows to be in training mode. Every document printed by the POS in training mode contains the text TRAINING. When training mode is exited, the background image reverts back to the original image. The drawer does not open during training mode. All till management functions do not affect the live till. These transactions can participate in post void or suspend and resume transactions, however all transactions are contained within the training mode shift and do not need to be resolved during the end of day process. |
|
Stop Training Mode — ends training mode. The POS terminal resumes its live state and reverts back to the original background image |
|
Store Close — closes the store when the Head Office is online |
|
Store Open — opens the store when the Head Office is online |
|
Suspend Transactions — suspends the current transaction to resume later |
|
Tender Eligible Inquiry — finds the total amount of the items in a transaction that can be tendered with a certain tender |
|
Tender Exchange — exchanges one tender for another (for example, check for cash) |
Exchange From Function Exchange From Function Parameter Exchange To Function Exchange To Function Parameter |
Tender Financial Function |
Till Paid In Till Paid Out Safe Paid In Safe Paid Out |
Tender Payment — the tender payment type. This function requires authorization parameters to be defined for credit type tender instruments and works with the Total function. Rounding rules validation is automatically built into this function type. Therefore, if using this UDF you do not have to set up validation rules. |
For all tender-related functions, the following parameters must be defined:
|
Tender Refund — the tender payment type for a return transaction. Rounding rules validation is automatically built into this function type. Therefore, if using the UDF you do not have to set up validation rules. |
This function requires an authorization service to provide authorization of the credit tender item. The options are: CEFT and None |
Terminal Close — sets the terminal to a closed state after all sales processing is completed for the current business date. The terminal can also be configured to close the current till during the close store function that makes it available for balancing in the POS Manager application. The system checks that all terminals are closed before performing the End of Day function. |
|
Terminal Open — opens the register for the current business day upon validation of the operator ID and password. |
User ID — a valid user ID Password — a valid password |
Terminal Open For Next Day — opens the register for the next business day upon validation of the operator ID and password. |
User ID — a valid user ID Password — a valid password Business Date — the valid date format is DDMMYYYY |
Till Paid In |
|
Till Paid Out |
|
Total — performs a tender out for customers. It is triggered when all of the items are scanned or entered in the system and the customer is ready to pay. |
|
Trigger Data Capture |
|
Trigger Document — triggers a document print request on demand at the POS terminal. For example some of these are: special receipts, and VAT receipts. This function can allow a second data form to be created and attached to the original specified document or initial data form. The trigger document function can also be configured with different source and trigger time settings so that the documents can be sent to different output sources at specified times. |
|
Unlock Operator — unlocks the register |
|
Update Customer — updates customer information |
|
Void Lines — voids a line |
|
Void Transactions — voids a transaction |
|
Pin Entry [PIN_ENTRY_REQUIRED]— used for debit and chip and pin credit card security. This data type is for internal use only. |
|
Pin Bypass [PIN_BYPASS] — allows chip and pin credit card security to be bypassed. |
|
POSBrowser [LAUNCH_POS_MANAGER]— connects to the POS Manager Electronic Journal Viewer (EJV) using a defined URL. The URL automatically logs on using the cashier’s ID and then redirects the browser to the EJV search screen allowing the cashier to view the electronic journal. It can be selected in any POS state but the cashier who is logged on to the POS terminal must have the appropriate permission to execute the journal viewer. If the cashier does not have the required permission level, an Invalid Session error message displays when the request is made. |
|
PriceChange [PRICE_CHANGE] — modifies the price of an item by changing the regular retail price of an item. If the percent margin difference is greater than a configurable percentage, an optional warning message displays and the cashier must confirm the price change. Price changes are also processed in the POS Manager. |
|
ReturnMerch [RETURN_ITEM_NOT_ON_FILE] — processes an item return transaction when the item is not found in the item file. Two function-specific parameters (Max Amount and Max Percent) allow a maximum dollar or percentage variance to be specified to limit the value of the price that is entered in the return transaction. Override Allowable Item Return Amount and Override Allowable Return Percent permissions can be set up to allow the defined thresholds to be exceeded if required. The POS validates the entered price against the defined permissions before executing the return function. Generates a prompt for additional information. |
|
SafeBalance [SAFE_BALANCE] [SAFE_PAID_IN] [SAFE_PAID_OUT] |
|
Safe Withdrawal Tenders[SAFE_WITHDRAWAL_TENDERS] |
|
SellMerch [SELL_ITEM_NOT_ON_FILE] — performs the sale of an item that is not found in the item file by presenting a prompt for the missing information. [ITEM_SELL_QUICK_KEY] |
|
Sell Non-Merch [SELL_NON_MERCH_DF_PRICE] — performs the same function as Sell NonMerch but uses a Price data form. [SELL_NON_MERCH_DF_QTY] — performs the same function as Sell NonMerch but uses a Quantity data form. [SELL_NON_MERCH_DF_BOTH] operates the same way as the Sell NonMerch UDF but uses the Price and Quantity data forms. |
|
[SELL_OPEN_DEPT_KEY] |
|
SignOff [PAXCustomerDataEntry] [TENDER_PAYMENT_DF_CHEQUE] — performs the same function as the Tender Payment function. Used for check payments |
For all tender-related functions, the following parameters must be defined:
|
[TENDER_PAYMENT_DF_CREDIT ] — performs the same function as the Tender Payment function |
For all tender-related functions, the following parameters must be defined:
|
[TENDER_PAYMENT_DF_NONE_ SPECIAL] — performs the same function as the Tender Payment function |
For all tender related functions, the following parameters must be defined:
|
[TENDER_REFUND_DF_CREDIT — performs the same function as Tender Refund but uses a credit data form |
You must specify an authorization service for authorization of a credit tender item. The options are:CEFT and None |