Field

Description

ID

ID of the record. Auto-assigned Identifier of the record. It can be used to use the API or external integrations.

It is displayed during the editing phase of existing data and not during the insertion of a new record.

Code

Code of the product.

Description

Multilingual description of the product. This description appears to the user during the purchase.

Warning! Authorize.net has problems with special characters. All special characters will be automatically removed from the product description during the purchase.

Policy

Select the policy to be associated with the product.

The policies are coloured in based on the belonging level they belong to. In specific, manager’s product policies are displayed in white, the reseller’s product policies are displayed in light blue and in yellow ochre the ones of the system.

Price List

The reference price of the product applied to resellers and managers. At this price, you can apply the discount defined in the “Discount” field at the management page of resellers and managers. For further details on the “discount”, please refer to the “ The Resellers” and “ The Managers” paragraphs.

The manager, declaring it in the domain, defines the selling price to the users.

For further details, please refer to “ The Domains“.

Available only if the user has permission to manage the products.

Recover Residual

At the recharge, it recovers the remaining time and data available (total and not daily and/or monthly) of the previous product.

Available values are:

• No: it does not recover data;
• Yes: it always recovers residuals;
• Yes, unless the product has expired: it recovers residuals only if the product has not expired.

In practice, if users have purchased a 60-minute product and they use only 40 minutes, if “Yes” was selected and users purchase a new 60-minute product, their new residual will be one hour and twenty minutes.

Not considered for “free” users automatically generated on domains with “Click & connect” and “Simple password” authentication modes.

Enable the injection

If activated, it allows the injection to the users to whom this product was assigned.

It can be useful for example, for not enabling the injection of advertising content to users who have paid products

External ERP/PMS Code

ERP/PMS external code. It is used to associate the product with an external ERP/PMS registry.

Field

Description

Total Time

Total maximum time in minutes of the connection If set, the guests that purchase the product will have access to the internet for the maximum time defined in this field. After consuming the time, they will be disconnected and will fail to connect until the purchase of a new product.

Not considered if the registration is not provided in the domain. For further details, please refer to the “Authentication Mode” in “ The Domains” paragraph.

A zero value indicates an infinite time.

Not considered for “free” users automatically generated on domains with “Click & connect” and “Simple password” authentication modes.

Daily Time

Maximum time, in minutes, of the daily connection assigned to the product. If set, the guests who purchase the product will have daily access to the internet for the maximum time defined in this field. After consuming the time, they will be disconnected and will fail to connect until the following day.

Daily time can also be defined in the policy, and if it is present on both sides, it will be considered the one defined in the policy.

Not considered if the registration is not provided in the domain. For further details, please refer to the “Authentication Mode” in “ The Domains” paragraph.

A zero value indicates an infinite time.

Not considered for “free” users automatically generated on domains with “Click & connect” and “Simple password” authentication modes.

Weekly Time

Maximum time, in minutes, of the weekly connection. If set, the guests who purchase the product will have weekly access to the internet for the maximum time defined in this field. After consuming the time, they will be disconnected and will fail to connect until the following week.

Weekly time can also be defined on the policies, and if it is present on both sides, it will be considered the one defined on the policy.

Not considered if the registration is not provided in the domain. For further details, please refer to the “Authentication Mode” in “ The Domains” paragraph.

A zero value indicates an infinite time.

Not considered for “free” users automatically generated on domains with “Click & connect” and “Simple password” authentication mode.

Monthly Time

Monthly maximum time in minutes of the connection.

If set, guests that purchase the product, will have access to the internet for the maximum monthly time defined in this field. After consuming the time, they will be disconnected and fail to connect until the following month.

Monthly time can also be defined in the policy, and if it is present on both sides, it will be considered the one defined in the policy.

Not considered if the registration is not provided in the domain. For further details, please refer to the “Authentication Mode” in “ The Domains” paragraph.

A zero value indicates an infinite time.

Not considered for “free” users automatically generated on domains with “Click & connect” and “Simple password” authentication mode.

Total Data Allowance

Megabytes of total data allowance assigned to the product.

If defined, the guests who purchase the product will have access to the internet for the maximum data allowance defined in this field. After the consumption of the data allowance, they will be disconnected and will need to purchase one of the payment products defined in the domain and with a price (“Products for the Users” group, in “ The Domains” paragraph).

Not considered if the registration is not provided in the domain. For further details, please refer to the “Authentication Mode” in “ The Domains” paragraph.

A zero value indicates an infinite data allowance.

Warning! If you want to provide users with 10GB of data allowance, you have to fill in this field with the value 10240 because of 1Kbyte = 1024 byte.

Warning! Cisco WLC, Cisco Meraki, CloudTrax, Ruckus Access Point, Ruckus Zone director, Ruckus VSCG, Ruckus VSZ, and Ubiquiti UniFi Controller/Dream Machine hardware types do not support automatic user disconnection upon reaching the defined data allowance limit. Wi5stars can handle the disconnection if the gateways are reachable and in the configuration of the same, “Send Disconnection Requests to the Gateway” has been activated.

Daily Data Allowance

Megabytes of daily data allowance assigned to the product.

If defined, guests who purchase the product will have access to the internet for the maximum daily data allowance defined in this field. After consuming the data allowance, they will be disconnected and fail to connect until the following day.

Daily data allowance can also be defined in the policy, and if it is present on both sides, it will be considered the one defined in the policy.

Not considered if the registration is not provided in the domain. For further details, please refer to the “Authentication Mode” in “ The Domains” paragraph.

A zero value indicates an infinite data allowance.

Not considered for “free” users automatically generated on domains with “Click & connect” and “Simple password” authentication modes.

Warning! If you want to provide users with 10GB of data allowance, you must fill in this field with the value 10240 because 1Kbyte = 1024 bytes.

Warning! Cisco WLC, Cisco Meraki, CloudTrax, Ruckus Access Point, Ruckus Zone director, Ruckus VSCG, Ruckus VSZ, and Ubiquiti UniFi Controller/Dream Machine hardware types do not support automatic user disconnection upon reaching the defined traffic limit. Wi5stars can handle the disconnection if the gateways are reachable and in the configuration of the same, “Send Disconnection Requests to the Gateway” has been activated.

Weekly Data Allowance

Megabytes of weekly data allowance assigned to the product.

If defined, the guests who purchase the product will have access to the internet for the maximum weekly data allowance defined in this field. After the consumption of the data allowance, they will be disconnected and will fail to connect until the following month.

Weekly data allowance can also be defined in the policy, and if it is present on both sides, it will be considered the one defined in the policy.

Not considered if the registration is not provided in the domain. For further details, please refer to the “Authentication Mode” in “ The Domains” paragraph.

A zero value indicates an infinite data allowance.

Not considered for “free” users automatically generated on domains with “Click & connect” and “Simple password” authentication modes.

Warning! If you want to provide users with 10GB of data allowance, you must fill in this field with the value 10240 because 1Kbyte = 1024 bytes.

Warning! The Cisco WLC, Cisco Meraki, CloudTrax, Ruckus Access Point, Ruckus Zone director, Ruckus VSCG, Ruckus VSZ and Ubiquiti UniFi Controller/Dream Machine hardware types do not support automatic user disconnection upon reaching the defined traffic limit. Wi5stars can handle the disconnection if the gateways are reachable and in the configuration of the same, “Send Disconnection Requests to the Gateway” has been activated.

Monthly Data Allowance

Megabytes of monthly data allowance are assigned to the product.

If defined, guests who purchase the product will have access to the internet for the maximum monthly data allowance defined in this field. After the consumption of the data allowance, they will be disconnected and will fail to connect until the following month.

Monthly data allowance can also be defined in the policy, and if it is present on both sides, it will be considered the one defined in the policy.

Not considered if the registration is not provided in the domain. For further details, please refer to the “Authentication Mode” in “ The Domains” paragraph.

A zero value indicates an infinite data allowance.

Not considered for “free” users automatically generated on domains with “Click & connect” and “Simple password” authentication modes.

Warning! If you want to provide users with 10GB of data allowance, you have to fill in this field with the value 10240 because of 1Kbyte = 1024 bytes.

Warning! The Cisco WLC, Cisco Meraki, CloudTrax, Ruckus Access Point, Ruckus Zone director, Ruckus VSCG, Ruckus VSZ and Ubiquiti UniFi Controller/Dream Machine hardware types do not support automatic user disconnection upon reaching the defined traffic limit. Wi5starscan handle the disconnection if the gateways are reachable and in the configuration of the same, “Send Disconnection Requests to the Gateway” has been activated.

First Day of the Week

State what the first day of the week is.

Possible values are:

• 1 = Monday;
• 2 = Tuesday;
• 3 = Wednesday;
• 4 = Thursday;
• 5 = Friday;
• 6 = Saturday;
• 7 = Sunday.

It is used to define the period of consumption calculation for the weekly limits.

Field

Description

MikroTik Profile

Associates the product to a “MikroTik HotSpot user’s profile”. It is used to import users and assign the related product automatically. This feature is used, for example, to automatically create users generated by printers, apps or external tools compatible with MikroTik.

For further details, please refer to the integration with “Printers or Apps compatible with MikroTik” paragraph.

Mikrotik Address List

If defined, it adds the IP address that will be assigned to users within the Address List of the Mikrotik gateway.

Useful if you have to enter some firewall rules by Address-List (i.e. IP groups) into the gateway and/or to make traffic prioritization always by Address-List.

You can also define it in the product policies, and the value entered at the policy level takes priority over any value entered in this field it.

Field

Description

Expiration Type

Defines the calculation method of the expiration date for the product assigned to users.

The possible options are:

• Unlimited (it does not define the expiration of the product );
• Days and Hours (it adds days and hours of the connection expiration starting from the date of the first connection);
• Days and Hours End-of-Day (it adds days and hours of the connection expiration starting from the date of the first connection and brings the expiration date to the end of the day;
• Days and Hours End-of-Month (it adds days and hours of the connection expiration starting from the date of the first connection and brings the expiration date to the end of the month;
• Months (it considers the expiration months of the connection starting from the date of the first connection);
• Months and End-of-Month (it considers the expiration months starting from the date of the first connection date and brings the expiration date to the end of the month). If you specify a 0 (zero) value in the Month to Expiration field, then the expiration date is calculated at the end of the current month. If you specify a 1 (one) value, the expiration date will be at the end of the following month;
• One login.

Warning! If you choose “Months and End-of-Month” as Expiration Type and you set a 0 (zero) value in the “Month to Expiration” field, the expiration date will be calculated at the end of the current month. If users connect on the 31st of the month, the expiration date will be on the 31^st at 23:59:00 (11:59 PM). It is recommended to enter an expiration date by using the field “Days and hours at the end of the month” and specify the number of days. In this way if the current date is near the last days of the month, the expiration date will be set at the end of the following month.

If you choose “One login”, the user will be able to log in only once. Further logins will require the assignment/purchase of a new product.

Days to Product Expiration

The number of days to the product’s expiration from the date/time of the first connection done by the user. After the defined number of days/hours, the account will no longer be valid, and the user will have to buy a new product to access the service.

In general, the product’s life is defined as 365 days (1 year) or 180 days (6 months).

It is also possible to enter decimals, so if, for example, you want to enter one day and a half, you have to enter 1.5.

If you enter a negative value, the product expires upon activation. It can be of use, for example, to assign a generic product at the creation of a user manually made by the reception. It can be useful also in the case of a generic product made via API. It forces the user to purchase or choose a product at the first login. If you choose “Months and End-of-Month” as Expiration Type, consider entering a negative value of at least 31 days otherwise, the product may not expire (current date – 1 day end-of-month could be later than the current date/time).

The field is visible only if the type of expiration is set on “Days and Hours” or “Days and Hours End- of-Month”.

Hours to Product Expiration

The number of hours to the product’s expiration from the date/time of the first connection done by the user.

It is also possible to enter decimals, so if, for example, you want to enter one hour and fifteen minutes, you have to enter 1.25.

As for the days, even for the hours, you can enter a negative value in order to make it expire upon activation.

The field is visible only if the Expiration Type field is set on “Days and Hours” or on “Days and Hours End-of-Month”.

Connection Expiration Months

The number of months of validity of the product from the date/hour of the first connection done by the user.

As for the days, even for the hours, you can enter a negative value to make it expire upon activation.

The field is visible only if the Expiration Type field is set to “Months” or “Months and end-of-month”.

Send Notification of Upcoming Expiration

Enables automatic sending of the notification of the pending expiry to users who have been assigned this product. The number of days’ notice and the message are defined in “ General Options“.

The field is not displayed if the expiration type is “One login”

Field

Description

Update the users

Updates all users who have been assigned the current product. The upgrade provides the rewriting of the radius attributes and updating the expiration date according to the values defined in the product.

If you also change the policy and you want to update the existing users, you have to press the “Update the policy to users already registered” button.

Update the policy to users already registered

Updates all users with data of the policy defined for the current product. The update provides the rewriting radius attributes according to the data defined in the policy

If you change the product policy or if you modify the data of the policy, you have to press this button to update all existing users to whom you have already assigned the current product.