Screens

POS API with Touch

This provides information relating to the screens for POS API in Touch.

The content is targeted at Resellers and swiftpos Venue Administrators who have a sound knowledge of and experience with swiftpos. For further information or assistance, please contact your swiftpos Reseller or swiftpos Support.

 

---

Screens      ▼

• Web Server - POS API Settings

 

---

Web Server - POS API Settings      ▲ ▼

 

To access select the POS API option in the Server Type drop-down list. Used to configure the settings required for the POS API Interface. The POS API (POS.Gateway.Client.exe) interface is used to process OrderAway and TouchMini Orders/Sales.

 

 

• Port - Defaults to 33300.

 

 

• Return Receipt Text - It is recommended that this is always selected. Select to ensure that receipt information is retrieved from Touch and returned in the form of text.
  • Max Width - Default is 32 characters. Displays/Enter the maximum width in characters of the generated Receipt.

 

 

• Return Receipt Image - It is recommended that this is always selected. Select to ensure that receipt information is retrieved from Touch and returned in the form of an image file. Once selected, and the Receipt Peripheral:
  • If configured as non-graphical, then the POS API will return a Receipt Image with a default header and footer using the following variables:
    • Header Section
      • {DOCKET TYPE}
      • {TRADING NAME}
      • {ABNDescription}: {ABN}
      • --------------------------------------
    • Footer Section
      • Receipt #: {RECEIPT #}
      • Date: {LASTACTIVITYDATE} Time: {LASTACTIVITYTIME}
      • Clerk: {CLERK #} {CLERK NAME}
      • Terminal: {TERMINAL ID} {TERMINAL NAME}

 

An example of the default Receipt returned.

 

• Return Receipt Image continued ...
  • Is configured as Graphical and then changed to Non-Graphical, the POS API will still return a Receipt Image based on the previous Graphical configuration. To ensure it returns Receipt Image with a default header and footer (as per above), then temporarily select the Use Graphical Printing option and clear all content in the Header and Footer and save the changes. Then unselect the Use Graphical Printing option and save again. The POS API will now return a Receipt Image with a default header and footer.

 

 

• Existing Order Validation - Select to ensure validation of the Sales/Orders processed via POS API to ensure they are unique and that no duplicate orders can be posted to Touch.

 

 

 

• Unattended Mode - Select to ensure the Master Order terminal is not “Blocked” with error messages and their system dialog messages, and instead only log these to the Touch terminal's event logs. It is recommended that this setting should be selected  for all Master Order terminals, especially those that will never be attended to physically – e.g. Virtual Machine instances. Selecting it will increase the reliability of ordering processes for OA, TM and 3rd Party integrators. 
  Also, 

• Open Port for All Users - Select to ensure that all users regardless of their authorisation level (Admin rights) can run the selected Server Type. In this case POS API. Once selected the URLs field below should be populated automatically with a list of URLs. By selecting this option it ensures Apps are running with the highest authorisation level if required. For example, POS API requires Admin level authorisation, then make sure the required windows users are placed in the Administrative group. Application titles will append (Administrator) to the end to indicate the mode.

• URLs - Displays the URLs that need to be provided to the Client/Provider when configuring a new Web Server. This list is automatically populated by selecting the Open Port for All Users option above.

 

 

 

End of article.      ▲