Each of the main phases support a number of standard UC prompts which can be reached by raising specific menu events. When these prompts are displayed, they can in turn invoke a specified set of UC function events to trigger various behaviours, or to navigate to the various phases of the POS. It is of course possible for the Retailer to add their own custom events, prompts and functions, and integrate them into the existing extension points - this is not covered in this document however.
The available prompts, which phases they can be called from, the menu event required to trigger them and their supported functions are summarised below. The functions themselves are listed in UC Functions in more detail where appropriate.
Each of these prompts will be supplied the global data described in the Introduction, however in place of the TransactionHandler, they will be provided the Transaction itself.
Order Collection
| Property | Value |
|---|
| Description | This prompt can be used to find an existing order and then add it to the basket for collection. |
| Supported Phases | Sale |
| Menu Event | enactor.uc.OrderCollection |
| Prompt URL | Pos/UnifiedCommerce/Order/OrderCollection |
Supported Function Events:
| Function Name | Summary |
|---|
enactor.uc.LoadOrder | This function is used to load an order from a remote system. Once the order has been retrieved, the items that form the order will be added to the basket. |
| enactor.uc.SellProduct | This function is used to "sell" a product, adding it to the basket. It is possible to supply a Price and Quantity, which will bypass those prompts should they normally be required by the product. |
| enactor.uc.UpdateQuantity | This function is used to update the quantity of an existing item in the basket. It is not possible to remove items from the basket (by setting the quantity to zero) using this function. |
| enactor.uc.VoidItem | This function is used to void an existing item in the basket. It will not be possible to void the transaction using this function, therefore this will not be able to void the last item in the basket. |
| enactor.uc.VoidTransaction | This function is used to void the basket. |
| enactor.uc.SetCustomer | This function is used to assign a customer to the basket. |
| enactor.uc.SetOrderNumber | This function is used to set an order number on the basket. |
| enactor.uc.AddNote | This function is used to add a note to the basket. |
| enactor.uc.UpdateNote | This function is used to update an existing note in the basket. |
| enactor.uc.Close | Close the prompt. If the prompt is displayed on the Launch phase, and the Basket now has items, the POS will navigate to the Sale phase. |
| enactor.uc.Tender | Close the prompt and navigate directly to the Tender phase. This will bypass the Sale phase if necessary. |
Find Order
| Property | Value |
|---|
| Description | This prompt can be used to find an existing order and then add it to the basket for payment. |
| Supported Phases | Launch, Sale |
| Menu Event | enactor.uc.FindOrder |
| Prompt URL | Pos/UnifiedCommerce/Order/FindOrder |
Supported Function Events:
| Function Name | Summary |
|---|
| enactor.uc.SellProduct | This function is used to "sell" a product, adding it to the basket. It is possible to supply a Price and Quantity, which will bypass those prompts should they normally be required by the product. |
| enactor.uc.SetCustomer | This function is used to assign a customer to the basket. |
| enactor.uc.SetOrderNumber | This function is used to set an order number on the basket. |
| enactor.uc.Close | Close the prompt. If the prompt is displayed on the Launch phase, and the Basket now has items, the POS will navigate to the Sale phase. |
| enactor.uc.Tender | Close the prompt and navigate directly to the Tender phase. This will bypass the Sale phase if necessary. |
Find Customer
| Property | Value |
|---|
| Description | This prompt can be used to find an existing customer and then associate them with the basket. |
| Supported Phases | Launch, Sale, Tender |
| Menu Event | enactor.uc.FindCustomer |
| Prompt URL | Pos/UnifiedCommerce/Customer/FindCustomer |
Supported Function Events:
Find Product
| Property | Value |
|---|
| Description | This prompt can be used to find an existing product. |
| Supported Phases | Sign On, Launch, Sale |
| Menu Event | enactor.uc.FindProduct |
| Prompt URL | Pos/UnifiedCommerce/Product/FindProduct |
Supported Function Events:
| Function Name | Summary |
|---|
| enactor.uc.ProductSearch | Triggers the default Enactor Product Search process. |
| enactor.uc.SellProduct | This function is used to "sell" a product, adding it to the basket. It is possible to supply a Price and Quantity, which will bypass those prompts should they normally be required by the product. This function cannot be called from the Sign On phase. |
| enactor.uc.Close | Close the prompt, re-displaying the main prompt for this phase. If this is the Launch phase and the basket now has items, the POS will automatically navigate to the Sale phase. |
Update Delivery Option
| Property | Value |
|---|
| Description | This prompt can be used to update delivery options on an existing item in the basket. |
| Supported Phases | Sale |
| Menu Event | enactor.uc.UpdateDeliveryOption |
| Prompt URL | Pos/UnifiedCommerce/Order/UpdateDeliveryOption |
Supported Function Events: