Cloud Connectivity

This menu option is used to configure swiftpos Locations that require a connection to the swiftpos Cloud for the purposes of supporting for Web based applications such as OrderAway, TouchMini and/or 3rd Party Ordering systems.

---

Subjects      ▼

• What Is Required?
• Cloud Connectivity Screen
• Web Location Screen

---

What Is Required?      ▲ ▼

• Ensure the Portal Location in the Global Preferences > Other tab is set correctly for the Venue being configured.

---

Cloud Connectivity Screen      ▲ ▼

This screen is accessed from the Administration menu.

Header      ▲ ▼

• SwiftAPI URL - Displays/Enter the WebAPI's URL. Ensure that this is set to the Venue's Web Api.

• Debug Logging - Select to enable.

• Environment - Displays the environment that OrderAway is connected to. This can be either a Production or Test swiftpos database. The Portal Location will only be displayed if the Location is something other than Australia and the database is live (Production) database. For example : Production UK.

The following tabs are available:

• Locations
• Delivery Charges
• Portal

---

Locations Tab      ▲ ▼

This tab as seen above displays the Locations that have already been configured.

• Location - Displays the Location ID and Name.

• Cloud Client ID - Displays the Client ID assigned to the selected Location once the Location has been activated. This is used to identify the Cloud Location for the purposes of Support assistance. Also, it can be selected to open the Portal tab to access the Configuration Menus for OrderAway in Venue Manager.

• Name - Displays the Location Name given to the OrderAway/TouchMini Location associated with the swiftpos Location above.

• Front of House Connection Method - Displays either one of the following methods in which Orders are submitted:
  • via Back Office API - This will be displayed when the Location has been activated with the Submit orders directly to POS terminal option is NOT SELECTED at the time of Activation.
  • Direct to POS Terminal - This will be displayed when the Location has been Activated with the Submit orders directly to POS terminal option IS SELECTED at the time of Activation.

• Terminal - Displays the Terminal selected when the Location was last Activated and to which all Orders will be sent.

---

Delivery Charges Tab      ▲ ▼

Used to configure Delivery Charges to be applied to Orders placed in OrderAway that require delivery to an address specified when then Delivery option is selected in the Checkout in OrderAway. Delivery charges can be set either as a Fixed Value or as a Percentage of the total value of the Order. Also, different charges can be applied depending on which value range (configured as shown in the grid above), the value of the Order falls in.

• Type - Select from the drop down list either one of the following:
  • Fixed Value - To ensure the value entered in the Delivery Fee column, is applied to the Order as a fixed value.
  • Percentage - To ensure the value entered in the Delivery Fee column, is used as a percentage to determine the Delivery Fee based on the total value of the Order.

• From/To Value - Displays/Enter the From/To values to determine the range of values for which the Delivery Charge is to be applied. An Order with a total value falling within this range will have the Delivery Charge applied to it.

• Delivery Charge PLU - Displays/Enter the PLU of the Delivery Charge Product to which the value charged to the Order will be assigned.

• Delivery Charge PLU - Displays/Enter the PLU of the Delivery Charge Product to which the value charged to the Order will be assigned.

---

Portal Tab      ▲ ▼

Grid Footer      ▲ ▼

• Add - Select to open the Search Location screen to select a Venue's Location, so that it can be added to the grid to enable connectivity to the swiftpos Cloud.

• Edit - Select to open the Web Location screen to edit the current settings for the selected OrderAway Location.

• Delete - Select to delete the selected Location.

Footer      ▲ ▼

• Save/Undo – Select to save/undo changes.

• Activate - Used to Activate a Venue's Location to ensure communication with the swiftpos Cloud. Refer toHow To Activate A swiftpos Location for more information.

• Images - Select from the drop down list to either Delete/Upload Images set against the Products in Back Office.
  • Delete - Select to delete all Images in OrderAway. Once deleted, ensure the browser's cache is cleared to ensure the deleted Images are no longer displayed.
  • Upload - Select to upload Images in swiftpos Back Office to OrderAway depending on one of the following:
    • In Keyboard Layout Menu Mode - This will upload the images associated POS Keys on all Keyboards in the selected Location. Also, it will upload images associated with Layout POS Keys, for the different Layout graphics in OrderAway.
    • In Product Families Menu Mode - This will upload images for ALL web enabled Family items.

• Close - Select to exit.

---

Web Location Screen      ▲ ▼

This screen is accessed by selecting the Edit button.

It is used to configure the selected swiftpos Location to ensure is can communicate with the swiftpos CLoud. The following tabs are available:

• General
• NetPOS
• Trading Hours

---

General Tab      ▲ ▼

General Section      ▲ ▼

• Location Name - MANDATORY. Displays/Enter the name that will be used to generate the OrderAway URL once the selected Location is activated. It is recommended to use a combination of the Venue and Location name. A maximum of 30 characters is allowed. For example, "{Venue Name} - {Location Name}"

• Terminal - MANDATORY. Select to open the Search Terminals screen to select the Terminal that will be assigned to all Orders placed via OrderAway, TouchMini devices and/or 3rd party Ordering systems. The Terminal selected here must be designated as the Orders Master Terminal for the swiftpos Location. Once set it can then be used to filter on when reporting.

• Clerk - MANDATORY. Select to open the Search Clerks screen to select a Clerk that will be used in:
  • OrderAway - As the default Clerk that will be associated with all Orders placed via OrderAway.
  • TouchMini - As the default Clerk that will be associated with all Orders, unless it is overridden by the device specific Clerk that is set against the No login required option found here.

Products Section      ▲ ▼

• Menu Mode - MANDATORY. Used to determined where the Menu and Item structure will be sourced from. The options available are:
  • Product Family - Select to ensure Families that have the Web option selected and which are also active for the Location Group (Venue), are used.
  • Keyboard Layout - RECOMMENDED. Select to ensure Keyboard Layouts are used. This is the recommended for the following reasons:
    • Layouts can be easily linked to or unlinked from the Menus.
    • Products can be easily added to and removed from Menus.
    • Menus and Products can easily be presented in their desired order.

• Stock Source - MANDATORY. Select from the drop down list the value that will be used to determine Out of Stock and Limited Stock notifications when The turn on quantity checks option is selected in OrderAway and TouchMini:
  • Stock on Hand - Select to ensure swiftpos SOH levels are retrieved and used to determine Stock Level notifications.
  • Available Servings - Select to ensure Available Servings are retrieved and used to determine Stock Level notifications. Available Servings values are set at the swiftpos Touch Terminal. Refer to Available Servings for more information.

• Allow Unmatched - Select to allow items to be ordered that cannot be matched with a Product in the swiftpos Back Office. The only requirement is that a description of the item is provided in the order request. Unmatched items will be assigned to the Comments PLU (19995). NOTE this is only applicable to order submitted through the Back Office API. Orders submitted to the POS API (direct to POS) behaves as this is always ENABLED.

---

NetPOS Tab      ▲ ▼

This screen is accessed by selecting the Edit button.

It is used to set where the NetPOS service is located and to configure the Interface that will be used to retrieve/validate Member/Account information.

• Host/IP - The machine name or IP address where the NetPOS service is installed for the Location. Ensure the Host/IP entered is accessible by the Back Office API (SwiftAPI).

• Port Number - the TCP port that the NetPOS service is assigned too. Default is 10101.

• Available Interfaces - Select the Get button to populate the drop-down with Interfaces that are available in NetPOS.
  • When prompted to Set NetPOS Interface for the swiftpos Back Office #1 interface, select Yes. Select No, if validation needs to occur against another interface.
  • Use the drop-down to select the interface that Members/Account validation should occur against.
  • When prompted to set Member Lookups, select Yes.

• Interface Type - Displays the unique NetPOS interface which has been previously set via the Available Interfaces drop-down above.

• Interface Id - Displays the unique ID for interfaces that support multiple configurations within the one NetPOS instance. Default is 1.

• Access Code - Displays/Enter the Access Code used to ensure access to the NetPOS Interface. The code is only required if the NetPOS interface selected above has been configured with an Access Code.

• Lookup Field - The context of this setting changes depending on the interface selected for validation:
  • SwiftPOS Back Office interface - displays/set the default field to be used when looking up a Member/Account via the Back Office API. Generally, this would be set to Member Number.
  • 3rd party interfaces - displays/set the field to be passed to a 3rd party system to validate a Member/Account. Generally, this would be set as follows:
    • For Gaming interfaces excluding Prime (Aristocrat), select Alternate ID.
      • Note - member data must be synced into the Back Office database as this configuration relies on the active card number being stored within the swiftpos Member Records (Alternate ID field).
    • For Prime (Aristocrat) interfaces, select Member Number.
    • For MSL Solutions Connect interface, select Member Number.

• Lookup Type - The context of this setting changes depending on the interface selected for validation:
  • SwiftPOS Back Office interface - displays/set the default type of lookup to be performed when looking up a Member/Account via the Back Office API. Generally, this would be set to Standard.
  • 3rd party interfaces - Displays/Set the type of lookup to be performed by the 3rd Party system to validate a Member/Account. Select from the options available as follows:
    • For Gaming interfaces excluding Prime (Aristocrat), select Standard.
    • For Prime (Aristocrat) interfaces, select Alternate.
    • For MSL Solutions Connect interface, select Standard.

• SwiftPOS Interface Id - Used to specify the swiftpos Back Office Interface instance when more than one Interface exists within the one NetPOS service. displays/set the ID found within the NetPOS Registration window. Default is 1.

• SwiftPOS Access Code - Displays/enter the Access Code used to access the Back Office NetPOS Interface specified above. The code is only required if the swiftpos Interface Id specified above has been configured with an Access Code.

• Use SSL - Select if the NetPOS service has Use SSL enabled (due to it being bound to an SSL certificate), otherwise leave unselected.

• Timeout (sec) - Displays/Set the length of time the Back Office API will wait for a response from the NetPOS service before returning a timeout error. This should be set greater than the NetPOS General timeout which is defaulted to 5 seconds.

---

Trading Hours Tab      ▲ ▼

This screen is accessed by selecting the Edit button.

It is used to configure the Trading Hours within which OrderAway will be available for trading.

• From swiftpos v10.34 onwards, this tab is ONLY USED to manage Trading Hours for the legacy swiftpos Web Store.

• For swiftpos Cloud applications such as OrderAway, TouchMini and 3rd Party Ordering systems configure Trading Hours here.

• Ensure the changes to the Web Location tabs are saved.

End of article.      ▲