Activate A Swiftpos Location

Back Office - How To

This outlines How To Activate A Swiftpos Location for the Cloud in Back Office.

 

---

Subjects      ▲ ▼

• About
• How To?
• Troubleshooting

 

---

About      ▲ ▼

• What Is It?
• What Is Required?
• What To Consider?
• When Is It Used?

 

What Is It?      ▲ ▼

Activating a Location ensures communication between the Venue's Swiftpos Location and Swiftpos Cloud is activated, allowing for the retrieval and submission of data between Swiftpos Back Office and the Cloud.

 

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.

 

 

What To Consider?      ▲ ▼

• 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). Refer HERE for more information.
• If an error is encountered as a result of attempting to activate a Location, then first view the logs. Refer to HERE 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 Swiftpos POS API. The same Terminal must be showing a Status of CONNECTED in Touch POS Terminals 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 menu option.

 

• The designated Orders Terminal for the selected Location needs to:
  • Be configured as both the Table Tracking Master and Order Master terminal.
  • Have had Touch started at least once in the past with the Run as Administrator (right click) option selected. This will ensure Touch has the appropriate permissions to launch the Gateway Client service and the Swiftpos POS API, as well as ensure log entries can be written to the Windows Event Log. Refer to HERE for troubleshooting information.
  • Have had the Open Port for All users option selected to ensure a URL reservation is added in Windows to allow Touch to be able to bind to the Swiftpos POS API configured Port. Refer to HERE for troubleshooting information.
• Only staff with the appropriate permissions to access to the Swiftpos Cloud Connectivity > Activate option and activate Swiftpos Locations. Permissions are granted via Swiftpos Clerk Security

 

 

When Is It Used?      ▲ ▼

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.

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 Orders 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.

 

---

How To?      ▲ ▼

• Activate A Swiftpos Location?

 

---

How To Activate A Swiftpos 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 Locations tab.
  • If it DOES NOT, then:
    • Select the Add option in the Locations tab to add the Swiftpos Location.
  • If it DOES or has just been added, then:
    • Select the Location's row in the grid and then select the Edit option to display the Web Location screen. Using this screen and the tabs available within it ensure the Location is configured appropriately. Refer HERE for more information.
• In the Swiftpos Cloud Connectivity screen, select the Activate option to display the Activation Wizard screen and configure appropriately. Refer HERE for more information.
• Select Finish to complete the activation process.
• If the process completes successfully, the following prompt will be displayed:

 

 

 

---

Troubleshooting      ▲ ▼

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

• Unable To Activate

 

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      ▲