Multi Site/Venue Management

 

C:\Program Files (x86)\Samford Software\SwiftPOS.BackOffice.Management.exe

 

Description

 

The Multi-Site Management App provides the ability to centrally manage multiple Sites/Venues (SwiftPOS Back Office databases) as well as provide the option to configure a single Port for the connectivity of Services (Connect, Sales and End of Day) for all Databases. Generally recommended for sites that have numerous installs of SwiftPOS Back Office.

 

Using the SwiftPOS Back Office Multi-Site Management tool available, a site will then be able to:

 

  1. Add/Edit/Group and/or Remove databases as required. Once a database has been added and enabled, it will be considered a multi-tenanted site and will then be subject to the use of a single set of services.
  2. For all listed and enabled databases, the following will be available:
     
    1. Upgrade databases from one central point.
    2. If required, databases can be grouped to ensure easier and quicker visual identification of specific databases.
    3. Issue Install/Uninstall/Start/Stop/Pause/Restart or Execute operations for the single Connect, Sales and End of Day services.
    4. Configure Global Settings.

 

Pre-Requisites

 

  1. The SwiftPOS Back Office Multi-Site Management tool can be invoked by running the C:\Program Files (x86)\Samford Software\SwiftPOS.BackOffice.Management.exe. Note : It is recommended to right click the SwiftPOS.BackOffice.Management.exe and select the Run as administrator option.
  2. Once the tool has been invoked, add all databases that will comprise the list of Multi-Tenanted sites.
  3. If required, add Groups. Groups can be used to group databases together, making it quicker and easier to identify. Databases can be dragged and dropped between Groups.
  4. In Global Settings, set the Connect Service Port. This Port # will function as the single port for connectivity through which all connections will be established between the SwiftPOS Touch terminals and their respective sites (Back Office Databases).
  5. In Global Settings, select the Migration Mode option to ensure the continuity of operations across all SwiftPOS Touch terminals while the migration/upgrading of terminals to the latest release/version (of SwiftPOS Touch software) takes place. While in this mode terminals will continue to use their original Port # until such time as they have been migrated/upgraded. Then and only then, will they automatically be switched to use of the single Port # specified above.

 

To Invoke

 

To invoke Multi-Tenanted operation, do as follows:

 

  1. Ensure the steps outlined in the Pre-Requisites above have been completed.
  2. Via the SwiftPOS Back Office > Administration > Services screen stop and uninstall all services on each of the enabled databases listed. Note : SwiftPOS Touch terminals will be temporarily disconnected.
  3. Right click the C:\Program Files (x86)\Samford Software\SwiftPOS.BackOffice.Management.exe to start the SwiftPOS Back Office Multi-Site Management tool. Note : If there is a requirement to Start/Stop/etc Services via the Multi-Site Management tool, then ensure the Run as administrator (right click) option is selected when open the tool.
  4. Via the Tools > Service Settings tab, install and start the services. Note : The SwiftPOS Touch terminals will reconnect automatically, if in Migration Mode, once the Connect service is up and running.
  5. In Touch terminals Settings the Tenant IDs and Access Codes will either be displayed (when in Migration Mode) or required to be entered (when NOT in Migration Mode). Connection between individual SwiftPOS Touch Terminals and their respective databases is maintained by the use of the following attributes:
     
    1. Tenant ID - Displays/Enter the Tenant ID. This is generally the name of the SwiftPOS Back Office database to which the terminal normally connects to.
    2. Access Code - Displays/Enter the Access Code (Database Reference ID) specific to the SwiftPOS Back Office database configured in Tenant ID above.
    3. Security Policy - Select from one of the options available the appropriate level of Security required.

 

Multi-Site Management - Summary Information

 

 

This screen is accessed from here and lists Groups and Databases (that have been added) and provides the ability to centrally manage these as appropriate. Generally, this tool is only recommended for sites the have multiple SwiftPOS Back Office databases.

 

Tree View

 

The Tree View on the left hand side provides a list of all Groups and Databases that have been added.

 

Summary Information

 

The Summary Information tab provides a list of all databases (and their attributes). Note : Databases that have been disabled are listed with a grey background.

 

Grid

 

The grid displays the: Name, Database, Company Name, Support Date, Licence Expiry, Version, Connect Port, Last Backup, Last Re-Index, Database ID, Total Terminals and Migrated Terminals. Note : The Port # listed here is ignored when single Port connectivity is in use.

 

Grid Footer

 

  • Refresh - Select to refresh the attributes of the Databases listed in the grid.
  • Export - Select to export the list Databases and their attributes listed in the grid.

 

Footer

 

  • Add - Select from the drop down list, one of the following:
     
  • Database - Select to add a Database. Note : Databases can be added to a Group by selecting the appropriate Group in the Tree View on the LHS, before adding a Database.
  • Groups - Select to add a Group.

 

Note : Ensure that either the default Sites Group is selected, or one of the other Groups listed in the Tree View on the LHS, before adding a Database or Group. If a Group is not selected prior to adding either a Database or Group, the following message will be displayed:

 

 

  • Edit - Select either a Database or Group in the Tree View on the LHS and then select Edit to open either one of the following:
     

 

  • Enabled - Toggle select to Enable/Disable the selected database. Note : Databases that have been disabled are listed with a grey background in the grid.
  • Edit - Select to edit/view the Database connection details

 

 

  • Delete - Select either a Database or Group in the left hand pane and then select Delete the selected Database/Group.
  • Save - Select to save any changes.
  • Tools - Select from the drop down list one of the following:
     

 

Global Settings

 

 

This screen is accessed from here and is used to configure the Global settings that are applicable to all SwiftPOS Touch terminals associated with all the enabled databases listed in the grid.

 

Services

 

  • Keep Services Running - Select to ensure that the SwiftPOS Back Office Multi-Site Management tool will check every 15 seconds all installed services . If they are not running and have automatic start mode selected, then they will be automatically started.
  • Port - Displays/Enter the Port # that will be used for single Port connectivity for all databases listed in the grid.
  • Migration Mode - Select to ensure the continuity of operations across all SwiftPOS Touch terminals while the upgrading of terminals to the latest release/version (of SwiftPOS Touch software) takes place. While in this mode terminals will continue to use their original Port # until such time as they have been migrated/upgraded. Then and only then, will they automatically be switched to use of the single Port # specified above.

 

TCP Logging

 

Select one of the options available to set the level of detail of TCP event logging required.  This is written to the database to populate the TCP Event Log (ADM008) report. Note : It is recommended that the TCP Event Log option is only selected when requested by SwiftPOS support.

 

Bandwidth Limiting 


  • Limit Outgoing Bandwidth - This setting can be used to limit the bandwidth and number of connections used to send files to SwiftPOS Touch Terminals.  This should only be used if you have a slow network / internet connection.  The minimum bandwidth required is 64Kbps per terminal. Note : This setting should remain off unless you have remote POS terminals connecting via a VPN or Internet network.
  • Local Subnet - This will limit to 255.255.255.0 unless this is changed. Anything outside the subnet is considered remote.

 

Local

 

  • Bandwidth - Set this as high as possible for a Local network. Because a VPN will look like a local network then you may need to limit this to your VPN Internet speed.
  • Uploads - Set this to something like 10-20 for a local network or limit for a VPN.

 

Remote

 

  • Bandwidth - For 64kbs per POS (minimum + overheads), you would need to set this to 1,000Kbs.
  • Uploads - If you only had a 1Mbs upload speed from the server then the maximum recommended POS would 5-10 uploads at the same time.

 

Service Alert Account Settings

 

  • Sender Name - Displays/Enter the name that will appear in the From field of an emailed Batch Report.
  • Email Address - Displays/Enter the email address that will appear as the return email address of an emailed Batch Report. This has to be a valid email address on the email server that is sending the emails.
  • To - Displays/Enter the email address(es) to which service emails will be sent.  Multiple addresses should be comma separated.
  • Cc - Displays/Enter the email address(es) to which service emails will be copied.  Multiple addresses should be comma separated.
  • Bcc - Displays/Enter the email address(es) to which service emails will be blind copied.  Multiple addresses should be comma separated.
  • Message - Displays/Enter the default message that will be sent out as part of the body of emails sent.
  • Email Errors - Select to ensure emails are sent whenever an error is encountered.
  • Email Warnings - Select to ensure emails are sent whenever a warnings is encountered.
  • Email Failure Audits - Select to ensure emails are sent whenever an audit failure is encountered.
  • Email to the Developers - Select to ensure a copy of all emails are sent to the SwiftPOS Developer team members. Note : This option will require a Daily Code to enable.
  • Limit per Hour - Set to limit the number of Service Alert emails generated. This can help to avoid a situation arising where hundreds of emails are generated as a result of an issue with services.

 

Email Server Account Settings

 

  • Outgoing mail server (SMTP) - Displays/Enter the domain name (host) or IP address of the Outgoing mail server (SMTP) that will email Batch Reports. For example : mail.swiftpos.com.au. or 192.168.1.100. A maximum of 100 characters can be entered.
  • User Name/Password - Displays/Enter the User Name and Password. If an Exchange Server is being used, then the Username entered must include the domain name and Username. For example: Samford\User1. Note : The Username/Password may not be required if the email server being used allows for anonymous logins. Check with your ISP.
  • Port - Displays/Enter the port number for the Outgoing mail server (SMTP) connection. Port 25 is generally the default SMTP port. If Gmail SSL is being used then SSL works on port 587 as the Gmail documentation recommends. In your Google gmail settings, you need to enable "Less secure app access" for this to work for external applications like SwiftPOS.
  • SSL Encryption - Select to ensure SSL encryption is to be used when sending emails. Note : From our testing, SSL works on port 25, not 465, as Gmail advertise in their info page.
  • Test eMail - Select to send a test email to a specified email address, using the settings configured above.

 

Secure Connections

 

Select from one of the following options:
 

  1. None
  2. Favour Secured*
  3. Force Secured (V10+ Only)*

 

 * Using the select button, select the appropriate Security Certificate.

 

Service Settings

 

 

This screen is accessed from here and is used to configure/install/uninstall and /or manage services for a Multi-Tenanted operation. Multi-Tenanted operation can be considered active once services have been installed and started from this screen. For more information ...

 

Sites Database Upgrade

 

 

This screen is accessed from here and is used to Upgrade Databases listed.

 

Grid

 

The grid displays the: Name, Status and Details.

 

Footer

 

  • Upgrade - Select from the drop down list one of the following:
     
    • Check and Upgrade - Select to Upgrade the selected Database from it's current version to the latest version.
    • Reset and Upgrade - Select to first reset the selected Database to a preselected version (baseline version) and then Upgrade it to the latest version. Generally used when Database are somehow compromised and there is a need to reset it.

 

Related Topics

 

  1. General

 

Published 28 Mar 2024