Activate A swiftpos Location

This outlines How To Activate A swiftpos Location in Back Office.

---

Subjects      ▼

• What Is It?
• Why Is It Needed?
• Who Can Do It?
• When Is It Done?
• What Is Required?
• How to Activate A Location?
• To Be Considered Post Activation
• Troubleshooting

---

What Is It?      ▲ ▼

Activating a swiftpos Location is a process to ensure the communication between the Venue's Location and the swiftpos Cloud is activated to allow for retrieval and submission of data between the two.

---

Why Is It Needed?      ▲ ▼

It is required to ensure a Venue's swiftpos Location is able to communicate with the swiftpos Cloud in support of Web applications such as OrderAway, TouchMini and other 3rd Party Ordering systems.

---

Who Can Do It?      ▲ ▼

Any person that has the appropriate permissions to access to the swiftpos Cloud Connectivity > Activate function. Permissions are granted via swiftpos Clerk Security

---

When Is It Done?      ▲ ▼

The activation process should be done when one of the following scenarios occurs:

• If it is the FIRST time a Location requires a connection to be established with the swiftpos Cloud.

• Each time a Venue has been Cloud Onboarded.

• Where a swiftpos Location has been previously activated but configuration changes have occurred at a Venue such as:
  • The SwiftAPI URL in Back Office has been changed since previous activation.
  • The Order Master Terminal for a Location has been changed.
  • The Clerk which was used during previous activation has either had their ID and/or PIN changed.

---

What Is Required?      ▲ ▼

Before proceeding with activating a Location, these points should already be completed.

• The Cloud Onboarding process has previously been completed.

• The Authenticating to swiftpos at a Venue process has been completed.

• The swiftpos Back Office API is already setup in Microsoft IIS in the Venue's environment, and the SwiftAPI URL has been set to where this is.

• a NetPOS interface is configured to match the NetPOS configuration at the Master Order Terminal. it is required to ensure Member information is available for web applications. The location of where the NetPOS service is installed is known.

• An appropriate OrderAway Location Name has been set against the Location in Back Office.

---

How To Activate A Location?      ▲ ▼

To activate a swiftpos Location, do as follows:

• Access the swiftpos Cloud Connectivity screen.
• Confirm the swiftpos Location requiring activation/re-activation is listed in the grid.
  • If it DOES NOT, then:
    • Add the swiftpos Location to the grid of the Locations tab that is going to require a connection with the swiftpos Cloud.
  • If it DOES or has just been added, then:
    • Select the required Location in the grid and then select the Edit button to display the Web Location screen. Using this screen and the tabs available within it ensure the Location is configured appropriately. For more information click here.
• In the swiftpos Cloud Connectivity screen, select the Activate button to display the Activation Wizard.

• API Clerk Credentials - Used to enter the Clerk credentials required to ensure communication between the swiftpos Location and the swiftpos Cloud.
  • Clerk ID - Enter the ID of the Clerk that was created in the
  Authenticate A Venue With swiftpos Cloud step. For example, 888000001 - SwiftPOS API Cloud Clerk
  • PIN - Enter the PIN of the Clerk entered above.
  • PIN - Enter the PIN of the Clerk entered above.

• Order Submission - Used to configure settings in relation to the submission of Orders/Sales.
  • Submit orders directly to POS Terminal
    • Select to ensure that Orders/Sales submitted are submitted via the POS API (running on the designated Orders Terminal for the selected Location).
    • If left unselected, Orders/Sales will be submitted via the Back Office API, then use the swiftpos Connect Service to make their way down to the Order Master Terminal in that Location.

• Order Submission continued ...
  • Terminal - Select the swiftpos Touch Terminal that is designated as the Orders Terminal for the selected Location. This option will only be available when the Submit orders directly to POS Terminal option above is selected. The terminal being selected must be BOTH the "Table Tracking Master" & "Order Master" terminal so the necessary processes/interfaces are started on that terminal post-activation.

• Select Finish to complete the activation process.
• If the process completes successfully, the following prompt will be displayed:

---

To Be Considered Post Activation      ▲ ▼

• Once successfully activated for the FIRST time, a value will be generated and displayed in the Cloud Client ID column opposite the activated Location.

• Also, once activated the Gateway Client Service should automatically start (G is green). Failing that it can be started from Back Office here.
• If an error is encountered as a result of attempting to activate a Location, then first view the logs. Refer to How To Access Logs in Back Office for more information.
• If the Submit orders directly to POS Terminal option was selected, then the Terminal assigned to the activated Location will be sent information on how to connect to the POS API. The same Terminal must be showing a Status of ONLINE in the Touch POS Terminals screen in Back Office, in order to be able to receive this information.
  • Once received, the Terminal will have the following entries listed in the Tools > Terminal Settings > POS Interfaces screen.

• The designated Orders Terminal for the selected Location needs to:
  • Be both the "Table Tracking Master" and "Order Master" terminal.
  • Have had Touch started at least once in the past with the right click Run as Administrator option selected. This will ensure Touch has the appropriate permissions to launch the Gateway Client Service (Touch.Gateway.Client.exe) and the POS API Interface (POS.Gateway.Client.exe), as well as ensure log entries can be written to the Windows Event Log. Refer to Gateway Client Service Not Starting Successfully for more information.
  • Have had the POS API Port open for All users button selected to ensure a URI reservation is added in Windows to allow Touch to be able to bind to the POS API configured Port. Refer to Gateway Client Service Not Starting Successfully for more information.

---

Troubleshooting      ▲ ▼

One of the following issues may arise when attempting to Activate a Location:

---

Unable To Activate      ▲ ▼

Cause      ▲ ▼

• If access to DataDog is available, search it for any relevant information that may shed light on the cause.
• The Venue's registration may have expired.

Action To Be Taken      ▲ ▼

• Search DataDog using the Venue's Customer Number (NOT the Cloud Client ID).
• Ensure the Registration is still valid.

End of article.      ▲