Show TOC

Object documentationUser-Defined Functions Locate this document in the navigation structure

 

This section describes a new POS function definition. It also provides a table that outlines any function-specific parameters that some functions require.

You cannot create a POS function to perform a new, undefined system task. You must create a new version of an existing POS function by choosing a different prompt, data form, or function-specific parameters than the ones specified in the original function. For example, you can use the reprint transaction function as a base for creating a new reprint transaction function that displays a different prompt for a different sales area.

For more information about predefined functions or function-specific parameters required for new functions, see Predefined POS Functions.

Note Note

After you create a new POS function definition, you must define permissions in the Permissions component. If no permissions are assigned, the cashiers see a message saying access denied when they try to execute the function.

End of the note.
General

Screen Element

Description

Confirmation Prompt

Prompts the cashier to confirm that they want to execute the selected function. Leave the default value as None if no confirmation is required

Confirmation Response

The expected response to the confirmation prompt. A valid response to the confirmation prompt is required to execute the selected function

Failed Confirmation Action

The action as a result of a failed confirmation

Send Cancel

Sends the UDF request to the server when the cashier chooses the ESC/Cancel key

Note Note

Cancel is a button configured with the label Cancel to use the function Clear. The label can say Clear, Cancel, or whatever you choose.

End of the note.

Date Eligibility ID

Sets a time frame for your function specifying the periods of time at which it should be allowed to be executed. Leave the default as None if no date eligibility rules apply. For more information about these rules, see Eligibility Rules

Enable Function Authorization

Performs function authorization. An authorization request message is generated for this function and sent to an external system

Function Authorization Request TimeOut

The number of seconds that must pass before the authorization request times out and stops the continuation of this function

TimeOut Action

The action that is taken at the POS terminal when the authorization request times out. It displays Stop, Continue, Trigger, Permission Check, and Void Transaction

Decline Response Action

Defines the behavior if a function is declined. It displays Stop, Restart, Trigger Permission Check, Void Transaction, and Continue options

Customer Profile ID

A predefined profile ID. For more information about profiles, see Customer Profiles

Auto Total

Automatically triggers the Total key on successfully completing the function

Resubmit Menu

Displays the menu for a resubmitted UDF

External System Authority Level

Type the authority level value that is used to perform a function that has an External System Authority level. When an external system logon is performed, the external system returns an authority level for the person performing the logon. If the level returned by the external system is less than the External System Authority Level value, you cannot perform the function

Printer Required To Process

Enables the printer to perform this function

Disabled for Off-Line Capable Client

Prevents performing a function during an offline situation

Only Available on Off-Line Capable Client

Specifies that the function is specific to POS terminals that are offline

Data Types that must be unique within a transaction

Set of data types for a given UDF that must be unique within the scope of a single transaction

Data Types that are required by this UDF

Set of data types for a given UDF that are required for a function

Function-specific parameters change according to the function type selected. The Tender Payment function type is used here as an example.

Function-Specific Parameters

Screen Element

Description

Authorization Type

Service that you use for credit authorization. Set this parameter to Balance Inquiry to configuring the Non-Financial EFT function type

Card Type

You can select Stored Value Card or Private Label Card

Auto Authorize Max. Amount for Online

You can choose the default value 0. If you enter a non-zero value, then this is the maximum amount at which a tender can be automatically authorized online. For example, if the value is 50.00, and the transaction is less than this amount, external authorization is not required

Allow Manual Authorization

Allows manual authorization for a credit tender payment or credit tender refund function. If this check box is left unchecked, Manual Authorization Limit is disabled

Auto Authorization Max. Amount for Offline

You can choose the default value 0. If you enter a non-zero value, then this is the maximum amount at which a tender can be automatically authorized offline. For example, if the value is 50.00, and the transaction is less than this amount, external authorization is not required

Auto Authorize Max. Amount for Referrals

Allows manual authorization if you select both an authorization service and the Allow Manual Authorization option. You can enter the maximum amount of a credit transaction to automatically authorize by SAP Enterprise POS. This is done when it cannot communicate with the authorization service when the customer is present/card swiped, keyed, or the customer is not present. For amounts above this limit, the POS terminal prompts the operator to obtain voice (manual) authorization

Auto Authorize Number Algorithm

Displays the maximum amount of a credit transaction that must be authorized by SAP Enterprise POS when the response from the authorization service is call for authorization

Manual Authorization Data Form

Triggers an additional data form when manual authorization of the tender is required. This form is only used to collect the authorization number and only if the main form does not contain a prompt for a manual authorization number

Signature Verification Required

Verifies the card holder’s signature, if required

Signature Verification Method

Method of signature. Signatures can be verified on a signature capture device or by comparing the signature on the receipt to that on the customer’s card

Request Time Out (Client to Server)

Specifies the amount of time that the POS waits for a response from the EFT Manager.

Note Note

The time-out specified in the Request Time Out (Client to server) field must exceed the time-out in the EFT Manager

End of the note.

Permission Check Required

Triggers a permission check on a referral response

Sub Action Code

Allows a merchandise item to be added to a transaction without affecting totals. If an Item Memo is used for more than just rain checks, it can be distinguished by the value in the %subaction% variable of the item memo document form.

A Rain Check can be configured for a store, and is used if an item is advertised on sale, but there are no more of this item available. A rain check is printed and lists the items with the sale price. The customer can return later when the item is in stock and, with the rain check, pay the sale price. Rain checks are implemented generically as the Department/Item Memo function type. This memo does not affect the transaction amounts and does not show up in that day's sales reports. The Department/Item Memo function is not limited to just rain check receipts, so if there are multiples you can differentiate between them. To do this, a value must be entered in the Sub Action Code field that is available to the receipts. The receipts can then show different kinds of item memos differently

Count Item

Specific to the Item Memo (rain check) function. You must select the check box to count the Item Memo as a merchandise item. Rain check receipts are printable and can also be viewed in the Electronic Journal Viewer

Allow Auto Sell After Inquiry

Allows you to specify the Item Inquiry function type that the cashier can sell or return immediately after the inquiry, without retyping the Item Key. The cashier only has to press Enter to automatically trigger the appropriate user-defined function

Non-Approval Alternates

Identifies if the authorization for a specified tender is unavailable

Pending Re-entry Begin

This function type has a function-specific parameter that releases the POS from the transaction reentry mode at the end of each transaction

End Re-entry Mode

Enables the re-entry function. This mode stops when the cashier logs off. If this parameter is not enabled, the POS remains in re-entry mode until the End Re-entry function is processed

Maximum Transaction Amount

The Tender Exchange function type allows the acceptance of one tender from a customer in exchange for another tender, for example exchanging a check for cash. You can set a limit to the amount of tender involved in this type of exchange transaction by setting this parameter in the UDT setting under Pricing Rules in the Configurator. It displays UDFs using the following parameters:

  • Exchange From Function — displays the UDF that represents the tender used for payment (that is, TenderCheck)

  • Exchange From Function Parameter — displays the tender (that is, Check)

  • Exchange To Function Parameter — displays UDF that represents the tender used for a refund (that is, TenderCash)

This section describes parameters for customer functions.

Customer Function

Screen Element

Description

Use Customer Service

Indicates that you are using a customer service to respond to customer lookups at the POS terminal.

Customer Service ID

The identification of the service that you are using. The ID must match the deployed ID of the customer service

Request Time Out

The amount of seconds you want the POS to wait for a response from the customer service before it times out

Behavior If Request Times Out

Defines what happens when the request to the customer service times out

If No Customer Is Found, Trigger UDF

Defines what UDF is triggered if the response from the customer service indicates that the customer is not found

If Update Is Required, Trigger UDF

Defines what UDF is triggered if the customer service returns a response indicating that customer information needs to be updated

Behavior If Identified Customer

Defines what happens when a specific customer is identified

This section describes data capture parameters.

Data Capture

Screen Element

Description

Data Form

Data form to capture all information required to execute the POS function. A data form consists of a prompt or a series of prompts that are designed to capture transaction information. For more information about Forms, see Forms

Off Thread Data Form

Allows partial completion of functions using a signature capture device. This data form is a subset of the main data form containing only those prompts that can be filled in using that device

Conditional Data Form If

You can choose one of the following options: Keyboard, MSR, Customer MSR, Scanner, or MICR

Auto Reference Number

Displays an auto reference number generation rule. For more information about these rules, see Auto Reference Numbers

This section describes permissions for group permissions.

Group Permissions

Screen Element

Description

Halo Key

Required for a store employee to manage permissions. This pertains to the POS application profile only

This section describes parameters for linking a document definition to your function.

Trigger Documents

Screen Elements

Description

Document

Document that the function triggers

Destination

Indicates to the POS, the printer or other output device

Timing

Determines when a document is printed

Archive

Archives the receipt for viewing on the POS Manager or for reprinting

Reprint to Previous

If for any reason a document that is part of a group of documents (for example, the front and back of a check that are on separate documents in the group) fails to print, you can configure document printing to reprint the group of documents beginning with the first one. In this case, if the front of the check prints but the document printing on the back of the check fails, the check is reprinted beginning on the front and then continues printing the second document on the back of the check

Count

When the document (for example, a receipt) prints, the system keeps track of the per document print count information. If you select Count, then in the case of a receipt document only one original receipt is printed —- if the POS prints others they are indicated as reprints. Since the system is counting the documents printed, it correctly issues an original or reprint receipt even after a transaction is complete and others are processed

Note Note

If the cash tender is configured not to print a customer receipt, and if a customer asks for a receipt after the transaction is complete, then the only way to issue the receipt is by executing Print Last Transaction from the menu. This menu can be tied to a document that does not print a reprint label on the customer receipt. In a different scenario, where the customer chooses to pay by split tender (that is cash and credit), a receipt is printed for the complete transaction. Now if the cashier executes Print Last Transaction from the menu, a receipt is printed without the reprint label. So there is a possibility in one scenario to have two original receipts for a transaction. The Count check box indicates that the print count for this document is maintained. This count is available at configuration and can be used to decide if a reprint label is added to the receipt.

End of the note.