Wi5stars-Utility Functions
Administrator Manual
Utility Functions

It displays a page that allows you to execute the following utility functions:

Backup

Field Description
Run Backup

By clicking the “Run” button, you will immediately run the database backup, copying the ZIP via FTP.
Before running a backup, you should define the FTP options in “System Settings“.
Based on what you have set in the “ System Settings“.backup also runs in scheduled mode.

Run Log Backup

By clicking the “Run” button, you will immediately run the database backup of the logs of all the days that have not been saved yet, including the part of the current day, copying via FTP the ZIP file generated daily.
After running the backup, it also removes the oldest data of the days as defined in the “System Settings“.
Before running a backup, you should define the FTP options in “ System Settings.
Based on what you have set in the “System Settings“, backup also runs in scheduled mode.

Verify the backup success and/or any errors in the “.System Log”.

Available only for users who have the role of administrator.

Restoring

By clicking the “Run” button, you start to restore a backup of data on the current database.

Field Description
File Name

Enter the .zip file name specified in the FTP server indicated in “System Settings“.

Admin User Password

For security reasons, you need to enter the password of the Admin user to run the database restore.

Available only for users who have the role of administrator.

Restoring the Log Data

By clicking the “Run” button, you begin restoring a log backup file in a temporary area of the database as to allow the analysis of the “old” logs not present in the “On line” log archives.
You can always consult the uploaded logs at the “System Log” page, selecting in the command bar, in the “Source” field, the “Archive” option.

Field Description
File Name

Enter in this field the file name .ZIP specified in the FTP server specified in the “System Settings” in the section “Scheduling database backup”.
Uploaded logs can be accessed from the page “System Log“, selecting the field “Source” option “Archives”.

Available only for users who have the role of administrator.

Cache

Field

Description

Clear Cache

Clears the local cache to force the uploading of updated data. In some cases, it may be useful to run this utility.

Available only for users who have the role of administrator.

Data Compressing

By clicking the “Run” button, you start the log of the user connections, data of clicks, impressions and visits at the Welcome Portal in order to increase the system performances and free up disk space.

Data Restoring to Default Values

By clicking the “Run” button, you start the restore of the data in the database to default values.

Warning! All data stored in the database will be lost and replaced with default values!

Field Description
Admin User Password

For security reasons, in order to restore the default data, you must enter the password for the Admin user.

You may need to perform this procedure in the case of problems with the data in the database. It can happen for example if Wi5stars has been switched off due to power failure. In this case, you have to restore the data to the default values and then charge a data backup.

Available only for users who have the role of administrator.

Importing Data

Available only for users who have the role of administrator.

Selecting the file and clicking the “Run” button, you import users from an Excel file (XLSX).

Field Description
Excel (XLSX) File Path Name with the Users

Path and name of the Excel (XLSX) file containing users to import. The first row must contain the header with the filed names that are defined on the database. 
The names of the fields defined in the first header line must be:
“HsDomainsDataID”, “UserName”, “Password”,
“CompanyName”, “FirstName”, “LastName”, “FiscalCode”,
“EMailAddress”, “Phone”, “MobilePhone”, “Address”, “City”,
“State”, “Zip”, “Country”, “Gender”, “CreationDate”,
“RoomOrSite”, “Language”, “AcceptMkt”,“SMSConfirmed”,
“YearOfBirth”, “ExternalAuthType”, “ExternalAuthUserName”,
“Longitude”, “Latitude”, “IPAddress”, “HsProductID”, “ERPCode”.

HsProductID defines the product ID to assign to the user.
HsDomainsDataID defines the domain ID to assign to the user.
ExternalAuthType declares the type of external authentication used for the registration:

  • 0: None;
  • 1: Facebook;
  • 2: Twitter;
  • 3: Google;
  • 4: LinkedIn;
  • 5: Instagram;
  • 6: Amazon;
  • 7: VKontakte;
  • 8: Turkish Public Identification Login;
  • 50: LDAP;
  • 100: OAuth

ExternalAuthUserName contains the username derived from external authentication system.

Instagram has been maintained for compatibility with previuos versions where it was still possible to log in with this social network.

It is important to define a domain ID in the HsdomainsDataID field by specifying a value that belongs to the domains to which you have access permissions.

Minimum fields to be defined in the file are: “HsDomainsDataID”, “UserName”, “HsProductID”.

Sending an SMS Test Alert

It sends an SMS test alert to the indicated number with a defined text. Useful to understand if the configuration for SMS, set on the page “System Settings“, is correct and if the modem is working.

If you do not receive the test message, follow these steps:

  • Check that the USB modem is plugged into the correct USB port and that “System Settings“,page has the correct modem selected.
  • Check, at “System Information” page, the modem signal (a value less than -95 dbm could cause sending/receiving problems). We recommend you not to leave this page open for a while because in some cases it might block the modem
  • Make sure that you have credit in the SIM card and that it is properly inserted into the modem
  • Eventually try to disconnect the modem from the USB port and reconnect it. In extreme cases try also to restart Wi5stars using the appropriate button in the “System Toolbar
Field Description
Mobile phone number

Enter your mobile number to send SMS test alert.

Message Text

Enter the text of the test alert to be sent.

Available only for users who have the role of administrator.

Sending a Test E-mail

It sends a test email to the address indicated and with the object and the text defined. Useful to check if SMTP server settings defined in the page “System Settings” are correct and working.
Any errors in sending the email will be written in the “System Log“.

Field Description
Recipient Email Address

Enter the email address to send test message.

Object

Enter the subject of the test email.

Message Text

Insert the text of the test email.

Available only for users who have the role of administrator.

RouterOS Batch Commands

Function that allows you to:

  • Update MikroTik RouterOS installed in the gateways and Wi-Fi equipment assigned to the PPPoE users;
  • Run custom commands in the devices with RouterOS.

To update user’s devices, you have to configure the hardware type and the IP address assigned to the router on the “The Users” page.

Field Description
Command Type

Type of command to execute. Possible values are:
Upgrade RouterOS devices;
Custom commands execution.

Apply on

Defines on what kind of run commands. The choices are: 
Gateway hotspot; 
User’s devices.

FTP URL of the Update File

Defines the ftp URL from where to download the update file of RouterOS.

Visible only if you have chosen “Upgrade RouterOS devices”.

Version

Declare the RouterOS version that you are uploading. You will write in user data.

Visible only if you have chosen “Upgrade RouterOS devices”.

Architecture

Choose the type of architecture. The choices are: 

Mipsbe; 
PowerPC.

Visible only if you have chosen “Upgrade RouterOS devices”

FTP username

Ftp username. May not be necessary if you use HTTP.

Visible only if you have chosen “Upgrade RouterOS devices”.

FTP password

It may not be necessary if you use HTTP

Visible only if you have chosen “Upgrade RouterOS devices”.

Network or IP

Define the network IP/subnet mask (e.g. 192.168.0.0/24) or the IP address of the devices/device

Username

Username to access to the device with RouterOS.

Password

Password to access to the device with RouterOS.

Custom Commands to Execute

RouterOS commands to be executed.

Visible only if you have chosen “Custom commands execution”.

Available only for users who have the role of administrator.