LISA- Kloudspot Location Intelligence and Situational Awareness
The KloudManage, KloudInsights, KloudPortal, KloudDisplay, and KloudVision applications that are included in the LISA platform can be used to make spaces or locations more intelligently smart.
Strategic placement of these various applications is key to achieving this goal.
The KloudManage and KloudInsights applications contribute to this.
KloudManage
Here, KloudManage truly acts as a central command center. It supports the use of KloudPortal, KloudVision, and KloudDisplay. Additionally, KloudMange may be used to manage IOT devices, gateway devices, and access points.
Below are some additional KloudManage features.
Multi-Tenant Support
Audit Logging
Notification Logs
Reporting Capabilities
Account Settings
Venue Management
Multi-Tenant User Roles
For more information about KloudManage, refer to the KloudManage documentation.
KloudInsights
The purpose of KloudInsights is to transform the data received from KloudManage into information that facilitates the smooth functioning of a location or space.
KloudInsights facilitates the creation of various widgets, assign rules, and receive rules notifications.
If you want to know more about KloudInsights, please refer to the KloudInsights documentation.
KloudPortal
KloudPortal is Kloudspot’s tool for creating captive portals. It allows you to create location-specific captive portals.
Using the customizable KloudPortal templates, you can create the portal’s welcome page, welcome back page, choose authentication methods, and select languages to match your requirements.
Access the KloudPortal documentation for additional information.
Refer to the KloudOS Devices section for details on the KloudVision and KloudDisplay applications.
Subsections of Kloudspot LISA Platform
Kloud Manage
KloudManage is a comprehensive management platform within the Kloudspot ecosystem, designed to provide powerful control and configuration capabilities for a wide range of intelligent edge devices. This platform empowers users to efficiently oversee and optimize their network infrastructure, ensuring seamless operation and delivering a superior user experience.
Key Features:
Device Management:
KloudManage offers centralized control over various intelligent edge devices, including KloudDisplays, KloudVision, KloudPortal, KloudGateway, KloudSensors, and Access Points. This enables users to efficiently configure, monitor, and manage their entire device fleet from a unified interface.
Configuration and Control:
The platform facilitates essential configuration and control functionalities, including guest portal web pages and advertising control. This ensures a tailored and engaging experience for end-users while maintaining control over promotional content.
Multi-Tenant Support:
KloudManage introduces a hierarchical multi-tenant structure, that provides distinct account types:
Distributors: Empowered to create and manage customers and resellers.
Resellers: Capable of creating and managing customers, as well as overseeing their devices.
Customers: Equipped to manage devices specific to their account.
Both resellers and distributors can seamlessly access the portal on behalf of their customers for enhanced support.
Audit Logging:
The platform maintains detailed audit logs, offering records of all activities within the system. This includes device alerts, user interactions, configuration changes, and reports generated. This feature serves as a valuable tool for tracking system activity and ensuring security.
Notification Logs:
KloudManage provides a comprehensive log of all notification messages sent through various channels, including Email, Slack, and SMS. This log offers transparency and traceability for crucial system communications.
Reporting Capabilities:
Users can generate and schedule reports, allowing for both on-demand and automated reporting. Reports can be customized based on selected date ranges, providing valuable insights into system performance and user engagement.
Account Settings:
KloudManage’s Account Settings section empowers users to customize and fine-tune their account details. This includes basic information editing, integration with third-party services, configuration of notification mechanisms, and contact setup for notifications.
Venue Management:
The Venues feature enables users to create and organize physical locations or deployment areas. Devices can be assigned to specific venues, providing a location-based view for efficient management.
Multi-Tenant User Roles:
Depending on their assigned roles, users within the multi-tenant structure have varying levels of access to accounts and resources. This includes administrators, managers, and users, each with distinct privileges and responsibilities.
Find quick answers to common KloudManage queries in this informative FAQ resource.
Subsections of Kloud Manage
Admin Guide
This detailed admin guide will teach you everything you need to know about KloudManage, including how to login, how to add devices, audit log, notification log, and scheduling reports.
To access KloudManage, you’ll require a URL, username, and password. These details are provided at the time of product purchase. If you’re unsure about this process, refer to the “KloudSpot Product Purchase Options and Provisioning Process” section for a comprehensive guide on how to acquire a KloudSpot product. Then follow the steps outlined below:
Open your web browser.
In the address bar, type the URL provided to you upon purchase, and press Enter. This URL will lead you to the KloudManage login page.
On the login page, you will need to enter your username and password. These credentials should have been provided to you upon purchase. If you haven’t received them or have trouble logging in, please contact Kloudspot support for assistance.
Once you’ve entered your username and password, click the “Log In” button to access the KloudManage dashboard.
Dashboard Overview
Upon logging in, you will be directed to the KloudManage Home page. Here, you’ll find a menu bar on the left-hand side, providing navigation options.
In the top right corner, you’ll notice a profile button for accessing your account settings. Directly in the center, you’ll find the Dashboards section, which serves as the central hub for monitoring and managing various aspects of KloudManage.
Once you’ve familiarized yourself with the dashboard, head over to the account management section to explore multitenant management.
Account Management
Multi-Tenant Management
The platform provides full-featured multi-tenant support.
It provides three types of accounts:
Distributors can manage and support customers and resellers.
Resellers can manage and support customers.
Customers can manage devices.
Users created for each type can have different levels of access to accounts
and resources.
Distributor/Reseller
An Administrator user has full access to all accounts.
A Manager has full access to a subset of accounts.
A User has ‘view’ access to a subset of accounts.
Customer
An Administrator has full access to and control over the devices for the account.
A Manager has full access to and control over the devices for the account.
A User has read-only access to the system.
A distributor or reseller will typically:
Create and manage account users.
Create/Manage partner accounts.
Allocate devices to accounts.
Provide support.
A customer will :
Create and manage account users.
Manage devices.
User Roles and Permissions
Once logged in, you have the capability to add users and assign specific roles to them, granting them varying levels of responsibility based on their designated role.
To do this, navigate to Profile > User and Role Management.
In the ensuing user window, click on the “Add User” option.
In the subsequent Add/Edit User window, input the user’s name, email, and password, and select a role.
Here are the permissions associated with each role. Familiarize yourself with these options to appropriately select a role for your user:
ROLE_ACCOUNT_ADMIN: Individuals with this role possess both read and write permissions in KloudManage.
ROLE_ACCOUNT_MANAGER: Those with this role have limited write access to KloudManage, but retain full read privileges.
ROLE_ACCOUNT_USER: Holders of this role can read all information in KloudManage, but are unable to make edits.
ROLE_DISPLAY_AUTHOR: This role grants access to and editing capabilities for display terminals.
ROLE_DISPLAY_PUBLISHER: People with this role have the authority to approve changes made by authors.
ROLE_DISPLAY_AUTHOR&PUBLISHER: This dual role empowers you to perform the duties of both an author and publisher.
ROLE_CP_ADMIN: Individuals with this role possess comprehensive read and write permissions related to the captive portal.
ROLE_CP_USER: Those with this role have the authority to read and perform all tasks related to the captive portal, but lack editing privileges.
Modify, remove, reset password, and enable or disable a user account. Utilize the icons located in the action column to execute these operations.
Once a user is added, you can proceed to add your office venue. For further guidance, please refer to the Venue section.
Create Partner Accounts
The accounts screen (only available to distributors and resellers) lists the
accounts to which the currently active user has been active.
If the user has the appropriate permission, the Add Partner/Customer button will
be present. This allows a distributor or reseller to add new accounts.
Allocate Devices to Accounts
The devices screen shows the assigned and unassigned devices for the account.
They can be assigned to resellers or customers. A reseller could then reassign
the devices to their customers.
Resellers and distributors can add new devices to their accounts by using the
Add Network Device and Add Batch Network Device buttons. Refer to the
Assigning and Managing Network Devices section to learn how to add devices.
Creating and Editing Venues
By default, a KloudManage account will already have a venue associated with it. To add additional venues, click on the “Venues” button.
In the “Tabular View” tab of the window that opens, locate and click on the “Add Venue” button.
Enter the venue name, and optionally, add a logo. Also, provide the street address in the window that appears. Click “Save” to confirm. As soon as you enter the address, your location will be pinpointed on the map view.
If needed, you can incorporate a floor map for the location. Click on the “Floor Map” button found in the action column.
In the subsequent window, click “New” to add a new floor.
When adding a new floor, enter the floor name and floor number. To include a map, click on the “Floor Maps” button and upload the map.
You can use the “Draw a Shape” tool to define zones on the map for more level of detail.
All venues can be viewed in the Map View tab. Click on a specific location to access various insights presented in graph form.
Following the addition of users and venues, proceed to configure the settings menu according to your specific requirements. For more detailed information, refer to the Account Settings section.
Account Settings
In the Account Settings section, you will find comprehensive instructions on how to configure various aspects of KloudManage. This includes adding basic information, integrating third-party applications, incorporating contact details, setting up alert notifications, and configuring the application notification.
To configure the settings, navigate to the Settings menu.
In the Basic tab, you can edit the basic details of your profile.
Click the “Edit” button to make changes. Here, you can update your Name, Address, Country, Time Zone, Guest Roaming Policy, Passpoint Key, and Logo.
Click the “Save” button to confirm the changes.
Third-Party Integrations
In the Third-Party Integrations tab, you can connect various third-party applications to your KloudManage.
Add integrations as per your specific requirements. For example, to connect KloudDisplay or KloudVision with the KloudInsights application, utilize the “Analytics Platform Setup” option.
If you want to integrate Gateway devices with KloudManage, you can configure the Gateway support integration section.
Navigate to the Gateway Support Integration section.
Click on the Edit button to initiate the configuration process.
Provide the necessary information obtained from your Gateway provider:
Server URL
API Secret
API Key
After entering the required details, click on the Save Gateway Settings button to store the configured settings.
Merakki Dashboard Integration
KloudManage supports the integration of Meraki Access Points for comprehensive network management. Follow the steps below to integrate the Meraki dashboard seamlessly.
Navigate to the Meraki Dashboard Integration section.
Click on the Edit button to begin the integration process.
Check the Enable Meraki service checkbox to activate the integration.
Provide the following information sourced from the Meraki dashboard:
Base URL
API Key
SSID
Check the Use Radius accounting checkbox to track user login information and data usage.
Check the necessary settings related to stop accounting packets if required.
Click on the Fetch Organization button to retrieve organizational information.
Select the desired organization from the dropdown list.
After configuring the settings, click on the Save Meraki Settings button to store the integration details.
Mist Dashboard Integration
KloudManage supports the integration of Mist Access Points for comprehensive network management. Follow the steps below to integrate the Mist dashboard seamlessly.
Navigate to the Mist Dashboard Integration section.
Click on the Edit button to begin the integration process.
Check the Enable Mist service checkbox to activate the integration.
Provide the following information sourced from the Mist dashboard:
Base URL
API Key
SSID
Check the Use Radius accounting checkbox to track user login information and data usage.
Click on the Fetch Organization button to retrieve organizational information.
Select the desired organization from the dropdown list.
After configuring the settings, click on the Save Mist Settings button to store the integration details.
Engenius Dashboard Integration
KloudManage supports the integration of Engenius Access Points for comprehensive network management. Follow the steps below to integrate the Mist dashboard seamlessly.
Navigate to the Engenius Dashboard Integration section.
Click on the Edit button to begin the integration process.
Check the Enable Engenius service checkbox to activate the integration.
Provide the following information sourced from the Engenius dashboard:
Base URL
API Key
SSID
Check the Use Radius accounting checkbox to track user login information and data usage.
Click on the Fetch Organization button to retrieve organizational information.
Select the desired organization from the dropdown list.
After configuring the settings, click on the Save Engenius Settings button to store the integration details.
SMS Gateway Setup
Configure the SMS Gateway Setup in KloudPortal to enable the sending of OTPs and success messages to users. Follow the steps below to integrate your SMS provider details seamlessly.
Navigate to the SMS Gateway Setup section within KloudManage.
Click on the Edit button to start configuring the SMS Gateway Setup.
Check the Enable SMS service checkbox to activate the SMS integration.
Choose the OTP SMS provider’s name from the dropdown list.
Provide the necessary details from your SMS provider:
API Key
API Secret
OTP Validity
In the Message column, type the desired message to be sent with the OTP.
If needed, set up promotional SMS using the same procedure.
Click on the Save SMS Settings button to store the configured SMS Gateway settings.
Whatsapp Integration
To receive notifications, integrate WhatsApp with KloudManage. You can also activate WhatsApp authentication for the captive portal. To easily configure WhatsApp integration, follow these steps:
Navigate to the WhatsApp Integration Setup section.
Click on the Edit button to integrate WhatsApp.
Choose the WhatsApp provider’s name from the dropdown list. At present, there are two available providers: Chat API and Twilio WhatsApp API.
Provide the necessary details from your WhatsApp provider:
Click on the Save WhatsApp Settings button to store the configured WhatsApp settings.
TikTok Integration
To add TikTok as a resource in KloudDiaplay, you must first integrate TikTok with kloudManage. Refer to the TikTok Integration
document for details on how to do this. You will then be able to display the videos you have published to TikTok on KloudDisplay.
Social Autentication Setup
To integrate authentications in KloudPortal, use the Social Authentication Setup option.
a. Refer to the Facebook Authentication section to add Facebook authentication.
b. Refer to the Twitter authentication section to add Twitter authentication.
c. Refer to the LinkedIn Authentication section to add LinkedIn authentication.
d. Refer to the Microsoft Authentication section to add Microsoft/Azure authentication.
f. Refer to the Okta Authentication section to add Google authentication.
Email Setup
Configure email settings in KloudManage to receive alerts, OTPs, and enable captive portal authentication. You have the option to use KloudSpot’s Email service or integrate information from another third-party provider. Follow the steps below for a seamless Email Setup.
Navigate to the Email Setup section.
Click on the Edit button to start configuring the Email Setup.
Check the Enable Email checkbox to activate the Email setup.
If using KloudSpot’s Email service:
a. Check the Use Kloudspot Service checkbox.
b. Click on the Save button.
c. Enter a test email ID and verify functionality.
If using a third-party service
a. Uncheck the Use Kloudspot service checkbox.
b. Enter the following details from your service provider:
Host Name
Port
Username
Password
From Email
Email Sender Name
If not using SSL, uncheck the Use TLS/SSL checkbox.
Click on the Save button to store the configured Email settings.
Test the setup by entering a test email ID.
Display Setup
Player Cache Cleaner will be enabled by default in the Display Setup section. With this, your KloudDisplay player cache will be cleared in a certain time.
If you want to disable it, click on the edit button and uncheck it.
If you want to share your virtual display with a third-party IP, you can add that IP here.
Click on the Save Display Settings button to store the configured Display settings.
MYSQL Integration
Integrate KloudPortal with a MYSQL database to allow users to log in to the captive portal using their credentials stored in the MYSQL database. Follow the steps below to configure MYSQL integration in KloudManage:
Navigate to the MYSQL Integration section.
Click on the Edit button to start configuring MYSQL integration.
Provide the following MYSQL details:
MYSQL Username
MYSQL Password
JDBC URL
Configure Query:
In the Query column, enter the following SQL query:
SELECT * FROM radcheck WHERE username={uname} AND value={pass};
This query is used to retrieve user information based on the provided username and password.
Click on the Save mysql Settings button to store the configured MYSQL integration settings.
Payment Gateway Integration
Integrate the Cashfree Payment gateway with KloudManage to facilitate seamless payment transactions. Follow the steps below to configure Payment Gateway Integration:
Navigate to the Payment Gateway Integration section.
Click on the Edit button to start configuring Payment Gateway Integration.
Provide the following Cashfree Payment gateway details:
API Key
API Secret
Version
Click on the Save Payment Gateway Settings button to store the configured Payment Gateway settings.
KloudBackup Setup
KloudBackup Setup allows you to securely backup the settings and data of KloudManage, ensuring data protection and disaster recovery capabilities.
Click on the Edit button associated with KloudBackup.
Check the checkbox labeled Enable KloudBackup to activate this feature.
Choose the desired KloudBackup provider from the available options.
Enter the Secret Key, API ID, and Bucket Name required for authentication with the selected KloudBackup provider.
After entering the necessary credentials, click on the Save KloudBackup Settings button to apply the configuration.
GCash Integration
Integrate the GCash Payment gateway with KloudManage to facilitate seamless payment transactions. Follow the steps below to configure GCash Integration:
Navigate to the GCash Integration section.
Click on the Edit button to start configuring GCash Integration.
Provide the following GCash Payment gateway details:
API Key
API Secret
Merchant Account
Click on the Save GCash Payment Gateway Settings button to store the configured Payment Gateway settings.
OpenID Connect configuration
To access your KloudManage account via OpenID Connect, it is necessary to configure Okta OpenID Connect with KloudManage. Consult the OpenID Connect configuration section for detailed instructions on setting up this integration.
User Details Masking Configuration
The User Details Masking Configuration feature is designed to enhance privacy and security for captive portal users. By enabling this feature, sensitive information of captive portal users can be masked, providing an added layer of protection against unauthorized access.
To do so, click the Edit button, then select the Enable connected users status checkbox, and finally, click the Save configuration button.
Rate Limit Configuration
Rate Limit Configuration allows you to control the rate of incoming requests to specific APIs, thereby managing the traffic flow and preventing potential overload situations.
To configure. click on the Edit button associated with Rate Limiting.
Check the checkbox labeled Enable Rate Limiting to activate this feature.
After enabling Rate Limiting, click on the Add Entry button.
Select the API for which you want to add rate limit. (e.g., Contact, Test Email, Post API, Get API, Put API, Delete API)
For selected API, enter the desired maximum rate limit and the maximum duration (in minutes) for which this rate limit applies.
Once you have configured the rate limit for the desired API, click on the Save configuration button to apply the changes.
Note: Based on this example, only 5 test emails can be sent in 60 minutes.
Contact Setup
In the contact tab, you can add the contacts that need to receive notifications.
Available notification methods include Email, Slack, SMS, WhatsApp, FTP/SFTP, and UIP notifications.
Click on the +Add Contact button to include a new contact. Provide the Name, Type, and Contact information in the Add/Edit Contact popup window, and click on the Save button.
Check the Required OTP Verification checkbox if OTP verification is necessary to confirm the contact.
The contact field varies for each contact type. Enter the contact details according to the chosen type.
Alert Notifications
In the Alert Notifications tab, you can add various alerts as notifications. Through this, a certain alert will be sent as a notification to the selected contacts.
For this, navigate to Settings > Alert Notification > + Add Alert Notification.
Check the Active check box to activate the notification. Then, select the notification type from the drop-down list.
• Link Capacity: Stay informed about any fluctuations or anomalies in the capacity of established links, ensuring optimal performance and stability.
• Link Jitter: Receive alerts regarding variations in the time it takes for data packets to reach their destination, enabling swift response to potential disruptions.
• Link Latency: Get notified of delays in data transmission over links, empowering you to address latency-related concerns promptly.
• OTP Not Received: Instantly be alerted if a onetime password (OTP) fails to reach its intended recipient, allowing for swift corrective action to ensure secure access.
• Link Packet Loss Reachability: Stay ahead of issues related to packet loss and reachability, ensuring seamless and uninterrupted communication.
• Reboot: Receive timely notifications whenever a system or device undergoes a reboot, keeping you informed of critical system events.
• Remote Support: Be alerted when remote support is initiated, enabling you to monitor and coordinate assistance effectively.
• Vision Camera View Change: Stay in the loop about any alterations in the view of vision cameras, providing valuable insights into changes in visual monitoring.
• Vision Motion Alert: Receive immediate notifications of detected motion through vision-based sensors, enhancing security and situational awareness.
• Vision Rule Trigger: Get alerts when predefined rules or conditions are met within vision-based monitoring, ensuring you’re promptly informed of relevant events.
Then enter the notification, name and frequency and select Notification Context. Two types of notification context are available. Account and Custom.
If you select Account, then you will receive notifications on the account level. Enter the contacts to receive notifications, and click the Save button.
If you choose the “Custom” option, you have the ability to specify the locations for which you wish to receive notifications.
Application Notifications
Use the Application Notifications tab if you wish to receive application log alerts as notifications.
For this, navigate to Settings > Application Notification > +Add Application Notification.
Four notification types are available: Default, Email communication, SMS communication, and wrong SMS OTP.
Adding an “Application Notification” follows the same process as adding “Alert Notifications”.
Check the Active checkbox in the window that appears. Then, select the notification type. Provide Notification Type, Name, Frequency, No of Occurrence, Notification Context, and Contacts, in the window that opens, and click on the Save button.
Account Preferences
Account Preferences allow you to customize your account settings, including adding your company’s Dark and Light Logos and selecting a color theme. This step helps ensure that your logo is visible in both light and dark modes and allows you to personalize the appearance of your account.
To do so, Navigate to the Settings > Account Preferences.
To add logo click Edit button and upload your dark and light logo.
Choose the color theme that best suits your preferences or brand identity.
Once you’ve added the logos and selected the color theme, click on the Save Preferences button to apply the changes.
License
License Activation
The License Activation process allows you to manage your Kloudspot license, enabling you to utilize network devices and access various features within the system.
To activate license navigate to Settings > License.
In the License settings window, locate and click on the Push Account Information button.
Once you click on the Push Account Information button. Kloudspot team will verify your purchase and activate your account.
After activating your license, click on the Sync License Information button.
This action ensures that the license information is synchronized.
Note: You can add network devices up to the limit specified in your license. To increase your license limit, please reach out to the KloudSpot support team.
To obtain a report on device usage, click on the Download device usage report button.
This report provides valuable insights into the usage patterns of your network devices.
Certificate Manager
Add Certificate
Integrating an SSL certificate can prevent the issue of SSL certificate failure due to technical glitches, allowing you to effortlessly access camera feeds with ease.
Note: This feature is for KloudVision users. If you are not a KloudVision user, you do not need to add the certificate.
Navigate to the Settings > Certificate Manager.
Click on the Certificate tab to proceed with adding a new certificate.
Once you’re on the certificate management page, click on the Edit button.
Check the checkbox labeled Enable Certificate Manager to activate this feature.
Enter the necessary certificate details:
Certificate Domain Name: Enter the domain for which the SSL certificate is applicable.
Certificate: Paste the SSL certificate.
Certificate Key: Paste the SSL certificate key.
After entering the certificate details, click on the Save certificate manager button to save the configuration.
Api and Secret Keys
The Api and Secret Keys section allows you to generate an API ID and secret key, which are essential for accessing information about certificate values, domains, and keys within the system.
To do so, Navigate to the Api and Secret Key tab or section.
Within the Api and secret key tab, Click on the Generate API ID and secret key button to initiate the generation process.
Utilize the generated API ID and secret key to retrieve information about certificate values, domains, and keys within the system.
GET /public/certificate-details/certificate
GET /public/certificate-details/domain
GET /public/certificate-details/key
For more information on the API usage, Navigate to Profile > API-DOCS > Event Resource.
OpenID Connect Configuration
Overview
This document provides step-by-step instructions for configuring OpenID Connect with Okta for KloudManage integration. OpenID Connect is a secure authentication protocol that allows KloudManage to authenticate users through Okta. Follow the steps below to set up this integration.
Note: In the same way you can add Google authentication and Azure authentication.
Prerequisites
Before you begin, ensure you have the following:
KloudManage admin account credentials.
Okta developer account credentials.
Access to KloudManage settings as an administrator.
Configuration Steps
Open your web browser and navigate to KloudManage.
Log in to the KloudManage admin account using your credentials.
Navigate to Settings > Third Party Integration within the KloudManage admin interface.
Then, Scroll down to the OpenID Configuration section.
Here click on the edit button and add the Authentication URL, Token URL, User Info URL, ClientID, and Client secret.
Log in to your OKTA developer account to get this information.
In your Okta developer account, create a new app with the sign-in method OpenId Connect > Web Application.
Then fill the general settings section in the OKTA and configure as shown in the image.
Click on the +Add URI button in the Login section and add the Redirect URL. You can find the Redirect URL from KloudMange. Finaly, click the save button to save the changes.
Copy the Client ID and Client Secret from the Okta app.
Return to KloudManage.
Click on the Edit button in the OpenID Configuration section.
Paste the Okta Client ID and Client Secret.
Provide the Authentication URL, Token URL, and User Info URL in the following format, where ${baseUrl} represents the issuer URI of your OKTA account. For additional details, refer the OKTA developer documentation
Authorization URL: ${baseUrl}/oauth2/v1/authorize
Token URL: ${baseUrl}/oauth2/v1/token
User info URL: ${baseUrl}/oauth2/v1/userinfo
Click the Save button to save the changes in KloudManage.
Users can now log in to KloudManage using OpenID Connect. Refer to the User Roles and Permissions section to learn how to add a new user.
On the KloudManage login page, enter the user’s company email ID.
Click on the Login with OpenID Connect button.
Users will be redirected to the Okta login page.
Enter the Okta username and password and click on the Sign In button.
Assigning and managing Network Devices
Once you have configured the Settings menu according to your requirements, you can start adding devices to KloudManage.
Navigate to the “Network Devices” menu. You will be directed to the Network Devices page, which displays the devices you have added.
To add multiple devices simultaneously, you can use the “Add Batch Network Devices” option. It’s important to note that the device type should be the same when adding multiple devices together. Provide the Mac addresses of the devices you want to add, separating them with commas. For example: 00:1A:2B:3C:4D:5E, 00:6F:7G:8H:9I:0J, 11:2K:3L:4M:5N:6O.
Alternatively, you can use the “Add Network Device” option to add a device individually. Depending on the type of device you’re adding, refer to the respective sections for detailed instructions:
• Refer to the “NMS User Guide” to add a gateway device.
• Refer to the “Add a network device” section from the S10 Device Configuration guide to add the IOT device.
If you need to change the location of multiple devices, select those devices and click on the “Re-Assign Multiple Devices” button to modify their location.
To add an Android TV, click on the “Have a Code” button. In the popup window that appears, enter the Hosting Platform, Orientation, Rotation, TV Code, Name, Account, and Venues. Finally, click on the “Save Changes” button.
Note: The Android Studio application issues an 8-digit code called the TV Code during installation.
Reports
This report section tells you about reports and how to schedule them, make your own report types, and see the reports that have already been created. Different reports can be made based on the device you’re using. For instance, if you use KloudVision, you can make a report called “vision face overview.” This will give you the face analytics data report that was made at the time frame you choose.
Refer to the sections given below for more details.
In the window that opens, click on the + Add Report Schedule button.
Enter the required information in the window that appears.
Using this process, various report types, including access point/gateway, device, display, vision, captive portal, notification, and others, can be scheduled. For detailed instructions, please refer to the “Captive Portal Usage Report” document.
Create a Report Type
Apart from the default stock report types, you have the option to create a custom report type. Follow these steps:
Click on the Types button.
In the window that opens, click on the Add Report button.
Enter the Name, Description, Type, Support, and Duration in the Add/Edit Report window. Click on the “Save” button.
Next, customers can download the stock reports and customize them according to their needs.
Click on the download button in the action column to download.
After downloading, the customized reports can then be uploaded into the custom reports that the user has created.
Click on the upload button found in the action column of the custom report.
In the popup window that opens, click on the Content button and upload the zip file that you have downloaded.
Your custom report has been successfully added. You can now use this report type when scheduling a report.
View Report History
If you wish to review the history of reports that have been created thus far, follow these steps:
Click on the History menu.
This action will open the Report Audit Logs window, where you can access information about previously generated reports.
In the Report Audit Logs window, you will find a list of reports that have been generated. To download any of these reports, click on the link provided in the Report Files column.
Audit Logs
The Audit Logs page offers comprehensive insights into every activity within the system. This includes a detailed record of various operations and interactions, providing a transparent view of system-wide actions. The logs encompass a wide range of events, such as:
Alert logs
The Alert Log function serves as a vigilant sentinel, promptly notifying users of critical events and potential issues within specified categories. This invaluable feature provides real-time alerts for the following scenarios:
• Link Capacity, Link Jitter, Link Latency, OTP Not Received, Link Packet Loss Reachability, Reboot, Remote Support, Vision Camera View Change, Vision Motion Alert, Vision Rule Trigger. Refer to the Alert Notifications section to learn more about these.
Application logs
The application log function is a crucial component of your system’s monitoring and alerting capabilities. It specializes in providing timely alerts for specific types of issues that pertain to essential communication channels. Here are the key categories for which you can expect alerts:
• Email Communication: This feature ensures you stay informed about any anomalies or disruptions in your email communication system. Whether it’s a delay in delivery, failed transmissions, or other email-related issues, the Application Log function will promptly alert you.
• SMS Communication: Receive instant notifications regarding any irregularities in your SMS communication channels. This includes alerts for failed message deliveries, delays, or other SMS-related concerns, allowing for swift resolution and minimal disruption.
• Wrong SMS OTP: Stay ahead of security concerns with immediate alerts for instances where an incorrect One-Time Password (OTP) is provided. This crucial notification enables you to take rapid action to rectify the situation and ensure secure access.
Device configuration logs
The Device Configuration Audit Logs function stands as a cornerstone in ensuring the integrity and security of your system’s settings and configurations. This vital feature meticulously records and reports changes made to device settings, providing you with a detailed account of system adjustments over time.
General logs
The General Audit Logs function serves as a comprehensive record-keeping mechanism for all critical actions performed within Kloudmanage. This indispensable feature meticulously captures and reports any additions, updates, deletions, and changes in location that occur within the platform.
Login logs
The Login Logs function is a critical component in tracking user interactions and system access within your platform. This feature provides a detailed record of user logins and their engagements with the system, ensuring comprehensive visibility into user activities.
Report logs
The Report Audit Logs function is a valuable resource for information about the creation and management of reports in your system. This feature keeps a detailed record of different aspects, such as report types, formats, status, start times, and last update times.
Notification Logs
The Notification Log screen serves as a comprehensive repository of all outgoing notification messages dispatched by the system. These notifications are transmitted through various communication channels, ensuring timely and efficient delivery. The supported notification mediums encompass:
This feature offers users an invaluable resource to track and review every notification communication, providing a clear record of all outgoing messages.
S10 device configuration
This document explains how to configure an S-10 device to Kloud management
account. This is an IoT (Internet of Things) device. This allows for Bluetooth
and WiFi probing.
Add a network device
1. The first step in configuring the S-10 device is to add a network device. To do so follow the steps below.
2. Log in to your Kloud manage account and then navigate to NETWORK DEVICES > Add Network Device.
3. Enter the required information in the Add/Edit Network Device window
that opens.
Device Type: Select the IoT device from the drop-down menu.
Model: Kloudspot S10.
Mac Address: Enter your device’s Mac address.
Name: Enter a name for your network device.
Account: Select your account and venues.
4. Click the Save Changes button to save the device.
5. After you’ve added a network device, click the IoT DEVICE menu button
to see if it’s online. If you see a green dot in the status column of the
device you have added, the device is online. But if you see a red dot, it
means that the device is offline.
Assign a network device to an IoT group
1. After adding the network device, the next step is to assign it to an IoT group.
2. To do so, navigate to IOT DEVICES > CONFIGURATIONS. and select the IOT group from the drop-down list.
3. Then go to the Assigned IoT Devices tab.
4. Select the network device you added from the Assign this Configuration
to drop-down list.
5. Then click on the Assign button.
6. Network device is added to an IoT group.
How to create an IoT group
1. Navigate to IOT DEVICES > CONFIGURATIONS > Create New.
2. In the window that opens, enter the Name, Iot Model, and Country then
click the Save button.
3. In the window that opens, click the Edit button to configure Probing
Services and Self Organized Network on the Services tab. Then an
editable window will open.
4. Check the checkboxes you want to enable and click the Save button.
Note:Bluetooth probing is only possible if the Bluetoothproximity/awareness check box is enabled. Similarly, wifiprobing
is only possible if Wifi proximity/awareness check box is enabled.
Bluetooth proximity/awareness: Decides whether to send data received via
Bluetooth to kloudInsights.
Scan Type
Active: Information is updated frequently and sent immediately.
Passive: Information is provided only when we ask for it.
I-Beacon Only: This is for I-Beacon devices.
Wifi proximity/awareness: Decides whether to send data received via Wi-Fi
to kloudInsights.
Bluetooth probing: Decides whether to send Bluetooth data from
KloudInsights to NMS.
WiFi Probing: Decides whether to send Wi-Fi data from KloudInsights to
NMS.
5. Then go to the System Profile tab and click on the Edit button. An
editable window will open.
6. Make the necessary changes and click on the Save button.
7. Next, go to the WLAN Profile tab and click on the Edit button. It
helps to decide which network the device should connect to.
8. Check the Enabled check box. And enter your SSID name. Then select the
Type as WPA2 Personal.
9. Then enter the key (password) and click on the Save button.
10. Finally, go to the Assigned IoT devices tab, select the network
devices to be added from the drop-down list, and click the Assign button.
11. A new IoT group has been added successfully. As mentioned in step 10,
other network groups can be added to this group.
Kloud Manage FAQs
What is the KloudsManage application?
The Kloudspot Edge Device Management application is a powerful tool designed to efficiently monitor, configure, and manage edge devices within the Kloudspot ecosystem. It enables seamless control over devices such as access points, sensors, displays, and more.
How do I access KloudsManage?
You can access the KloudsManage application through a web-based interface. Simply enter the provided URL in your web browser and log in using your credentials.
What types of devices can be managed using this application?
This supports various edge devices, including access points, sensors, display controllers, vision controllers, captive portals, and IoT devices. It provides a centralized platform to monitor and configure these devices.
Can I schedule reports for device performance?
Yes, you can schedule and generate reports on device performance. KloudManage offers a versatile reporting platform where you can select specific date ranges for tailored data analysis.
How can I add multiple devices at once?
You can use the “Add Batch Network Devices” option to add multiple devices simultaneously. Ensure that the devices have the same type when adding them together.
What if I need to add a device individually?
For individual device addition, you can use the “Add Network Device” option. Depending on the type of device, refer to the corresponding section in the user manual for detailed instructions.
How do I change the location of multiple devices?
To change the location of multiple devices, select the desired devices and click on the “Re-Assign Multiple Devices” button. This allows for easy and efficient management.
How can I add an Android TV to the system?
Click on the “Have a Code” button and enter relevant details like Hosting Platform, Orientation, Rotation, TV Code, Name, Account, and Venues. Ensure to use a unique 8-digit TV Code provided by Android Studio.
What is the purpose of the Audit Logs?
The Audit Logs provide a detailed record of all activities within the system, including device alerts, user interactions, configuration changes, and more. It serves as a tool for monitoring system performance and ensuring accountability.
How can I review the history of generated reports?
Navigate to the “History” menu to access the Report Audit Logs. Here, you can find a list of previously generated reports and download them for review.
Can I customize and create my own report types?
Yes, you have the option to create custom report types. Simply click on the “Types” menu and follow the steps outlined in the user manual to add and upload custom reports.
How do I receive notifications from the system?
You can set up contacts to receive notifications via various channels, such as Email, Slack, SMS, WhatsApp, SFTP, and UIP. Refer to the Account Settings section for detailed instructions.
How does the KloudManage ensure security and accountability?
The Audit Logs and Notification Logs play a crucial role in maintaining security and accountability. They provide transparent records of system activities and outgoing notifications, ensuring a secure and well-functioning environment.
Where can I find additional resources and support?
For additional resources and support, refer to the Kloudspot documentation or contact Kloudspot support for assistance.
How can I integrate third-party applications with the Kloudspot Edge Device Management application?
You can seamlessly integrate third-party applications by navigating to the “Third-Party Integrations” section in the Account Settings. Here, you’ll find options to connect various applications and authentication setups.
What are the different user roles and permissions in the Kloudspot Edge Device Management application?
The kloudManage provides distinct user roles, each with specific access levels:
ROLE_ACCOUNT_ADMIN: Full read and write permissions.
ROLE_ACCOUNT_MANAGER: Limited write access, with full read permissions.
ROLE_ACCOUNT_USER: Read-only access.
ROLE_DISPLAY_AUTHOR: Access and edit capabilities for display terminals.
ROLE_DISPLAY_PUBLISHER: Authorization for changes made by authors.
ROLE_DISPLAY_AUTHOR&PUBLISHER: Dual roles of author and publisher.
ROLE_CP_ADMIN: Full read and write permissions for the captive portal.
ROLE_CP_USER: Only read permissions for the captive portal.
Can I create multiple venues and assign devices to them?
Absolutely. The “Venues” section allows you to create and manage various locations. Once created, you can easily assign devices to specific venues, providing a location-based view of managed devices.
How does multi-tenant management work in the Kloudspot Edge Device Management application?
The KloudManage supports three types of accounts: Distributors, Resellers, and Customers. Each type has varying levels of access and responsibilities. Distributors manage and support both customers and resellers, while resellers manage and support customers. Customers have the ability to manage their devices.
What is the purpose of the Notification Logs?
The Notification Logs serve as a centralized record of all outgoing notification messages, sent via different channels including Email, Slack, SMS, SFTP, WhatsApp, and UIP. This feature provides a comprehensive overview of all communication from the system.
How can I schedule and run reports in KloudManage?
You can easily schedule and run reports in KloudManage. Navigate to the “Reports” section, where you have the option to schedule reports or run them on demand. When running reports on demand, you can select a specific date range to customize the data according to your requirements.
The Kloudspot Analytics Platform provides a high-speed scalable stream
processing focused on analysis streams of BLE/WiFi client location and
presence data, IoT sensors including CO2, humidity, temperature, in
combination with other data sources such as guest portal registrations.
The main flow is as follows:
The Event Receivers take in event data from the configured Kloudspot or third-party data sources. The received events are transformed from the, normally, proprietary formats used to a consistent internal format that is then sent to the stream processing Job.
The Stream Processing Job is where all the high-performance processing in our system is performed. We use Apache Flink due to its ability to scale to handle massive loads. The job does the following main things:
Convert the events into a set of ‘sessions’ - one per client.
Locate each client in real-time using one of several techniques:
Presence, where the client is located in a zone based on single strength to nearby Access Points.
Trilateration, where multiple signal strength measurements are used to locate a client to a specific X/Y or geo coordinate.
Aggregate the client information to provide time series counts based on various attributes.
Perform path-movement analysis on the clients.
Look for matches against the rules.
The main application provides
Flexible data presentation.
Rule creation and editing.
Sending notifications (for example SMS, or Email).
Unlock the full potential of KloudInsight, from login to third-party integration, action template creation, rule setup, and dashboard design, with this comprehensive Admin guide.
This comprehensive manual will teach you how to gain valuable insights from your data. Whether you’re familiar with KloudInsights or new to the platform, this guide has everything you need: from the platform’s features and functionalities to its best practices. This will help you make informed decisions based on your data.
Here, you’ll find step-by-step instructions, tips, and detailed explanations to help you navigate through KloudInsights effortlessly. From creating customized dashboards to setting up powerful rules and generating reports, we’ve got you covered.
To access KloudInsights, you’ll need a URL, username, and password. These details are provided at the time of product purchase. If you’re unsure about this process, refer to the “Kloudspot Product Purchase Options and Provisioning Process” section for a comprehensive guide on how to acquire a Kloudspot product. Then follow the steps outlined below:
Open your web browser.
In the address bar, type the URL provided to you upon purchase, and press Enter. This URL will lead you to the KloudManage login page.
On the login page, you will need to enter your username and password. These credentials should have been provided to you upon purchase. If you haven’t received them or have trouble logging in, please contact Kloudspot support for assistance.
Once you’ve entered your username and password, click the “Log In” button to access the KloudInsights dashboard.
Home Page Overview
Immediately after logging in, you will reach the home page of KloudInsights. Here you can see different dashboards and menu buttons.
The KloudInsights Dashboard provides a centralized hub for accessing and managing key features of the platform. The user interface is designed for intuitive navigation, with an expandable menu on the left and essential buttons at the top-right corner of the screen.
Top Menu Buttons
Access to Online Documentation
Provides direct access to the web-based documentation for KloudInsights. This resource offers detailed information, guides, and tutorials to help users navigate the platform effectively.
Feedback to Product Team
Allows users to provide direct feedback to the product team regarding any encountered bugs or suggested features. This feature promotes user involvement in the ongoing development and improvement of the platform.
User Settings
Enables users to manage their account settings, including updating their email address and password. This section ensures that users have control over their account information.
REST API Documentation and Access Keys
Offers access to the documentation and access keys for the platform’s RESTful API. This feature allows for integration with external systems and custom development.
Notification
Enables instant alerts and updates for critical events.
Side Menu Features
Home
The main overview page provides a snapshot of essential information and statistics. This page serves as a starting point for users to get an instant overview of the platform’s current status.
Dashboards
Allows users to create and customize their own data views. Dashboards can be configured to display specific information and metrics tailored to individual preferences and needs.
Rules and Actions
It enables users to configure rules that trigger specific actions within the platform. For instance, setting up a rule to send an SMS notification when an unknown user is detected.
Reports
Facilitates the generation and scheduling of reports in both PDF and CSV formats. Reports provide valuable insights and summaries of platform data for further analysis and decision-making.
Configuration
Provides access to system configuration settings. This section allows users to customize and fine-tune the platform to suit their specific requirements and preferences.
Information
Offers access to system information, including audit logs and other pertinent details. This section provides transparency and visibility into system activities and events.
Next, you can integrate other applications to Kloud Insights as per your needs. Check out the Integrations section to learn how to do this.
Integrations
This section provides a detailed guide on how to integrate a range of technologies, from WiFi and BLE devices to IoT sensors and management applications, ensuring a cohesive and efficient ecosystem for your organization. Explore the integration options available and unlock the full potential of KloudInsights for optimizing your network performance and data analysis.
Once you’ve logged into KloudInsights, the next step is to integrate it with KloudManage. To do this, please refer to the Integrating with Kloudmanage section.
Please refer to the API documentation to understand how to create a new API for integration.
KloudInsights provides an easy way to connect with third-party applications through its Application Programming Interface (API). This documentation will guide you through the process of creating and testing APIs in KloudInsights.
Create a new API key on KloudInsights.
Log in to the KloudInsights.
Navigate to Settings > API keys
To create a new API key, click on the +New API Key button and enter
a description in the ensuing popup window. Next, select the appropriate roles
and click on the Add key button to finalize the process.
Test your API
Click on the API Docs button located in the API section.
In the window that opens, you can test the API you have created using the relevant tag.
You have successfully created and tested an API in KloudInsights. This API can now be used to connect KloudInsights with other third-party applications, enhancing its functionality and integration capabilities.
Integrating with KloudManage
Step 1: Create a new API key on KloudInsights.
Refer the API document to know how to create and test an API.
Step 2: Integrate KloudInsights into the KloudManage
Log in to KloudManage.
Navigate to Settings > Third Party Integration.
In the window that opens, click on the edit button next to Analytics Platform Setup. Then fill in the following.
Platform Base URL: Enter your company’s KloudInsights URL here.
Platform Probe URL: Enter your company’s KloudInsights URL and port code.
The port code is available from the admin.
Authentication ID: The authentication ID can be obtained from the
Insights API key section.
Authentication Secret: The authentication secret also be obtained
from the Insights API key section.
4. In the event of a successful connection, you will receive a notification
confirming the same. However, if the connection is not successful, please
recheck Step 3 for verification.
5. Finally, click the Save Analytics Settings button to save the changes.
Step 3: Integrate KoludManage into the KloudInsights
1. Log in to KloudInsights.
2. Navigate to Configuration > Integration > Application.
3. Then scroll down and find the Kloudspot Device Management Settings
section.
4. Then check the Enable button and enter the following:
Portal Base URL: Enter your company’s KloudManage URL here.
API ID: The API ID can be obtained from the Vision’s “ Third Party Integration” tab.
API Secret Key: The API Secret Key can also be obtained from the Vision’s “ Third Party Integration” tab.
5. To get an API ID and Secret Key follow the steps below.
Log into KloudManage.
Then navigate to Settings > Third Party Integration. Here you can find the API ID and API Secret Key.
6. Finally, click the Save and Test button to save and test the
connection.
7. In the event of a successful connection, you will receive a notification
confirming the same. However, if the connection is not successful, please
recheck Step 4 for verification.
Meraki Integration
About this Document
The purpose of this document is to display how these various solutions offered
by Kloudspot can be integrated with Meraki.
It covers the following Kloudspot solutions that can be integrated.
KloudPortal - Wi-Fi Guest Portal
KloudCampaign - Campaign management
KloudVision- Camera Integration
KloudInsights - Event Wi-Fi & BLE receivers
Guest Portal and Campaign Management
Guest Portal
Captive Portals or Guest Portal is a multi-channel platform that enables you
to connect and engage with visitors on your premises.
Guest portal screen page allows to create and design a customizable portal
from scratch.
A sample of templates will be given as an option to choose to create a portal,
layout will be available as a part of the template.
Following are the steps to configure the Guest Portal.
Captive Guest Portal Configuration
The captive portal is designed with following terms that are described below:
Social Authentication
Needs authentication using social platforms as Facebook, Twitter, Linked,
Google and Instagram.
Email Authentication
It will ask the user for their Name and Email address to be able to
Authenticate.
SMS Authentication
It asks the user for their contact number and authenticate over a SMS.
Multi device Token
A token is generated by the admin. User can use this token for authentication.
One or multiple devices can be configured to use a single token.
Username/Password
A guest user can be created by generating a unique username and password which
is used for authentication. One or multiple devices can be configured using
individual username/password combination.
Third party
Kloudspot can integrate with various third-party applications such as,
ERP
PMS
POS
Enter ‘Wireless’ à ‘Access Control’
Choose the SSID to which the Captive portal will be configured.
In Network Access, Association requirement, Select ‘Open (no encryption)’.
In Network Access, Splash page, Select ‘Click-through’.
In Network Access, Captive portal strength, Select ‘Block all access until sign-on is complete’
In Network Access, Walled garden ranges, Enter the following domains:
Kloudspot has a powerful workflow and policy driven campaign management
solution centered mostly around Wi-Fi which offers both online and offline
campaigns. These online campaigns can be created and managed using Captive
Guest Portals. Creation of Captive guest portals is extremely easy using one
of many templates supported by KloudCampaign Editor. KloudCampaign Editor can
help guide the user to create a captive portal for the hardware they have
deployed on the network.
For more details on how to create Campaigns, resources and configure dynamic
policies and workflows, please refer to relevant Kloudspot documentation.
Meraki WiFi and BLE Event Receivers
The Kloudspot Analytics Engine can receive events from many types of Meraki
Wi-Fi network.
One or more of event sources can be configured in the ‘Configuration - >
System -> System Configuration’ screen.
Validate the Receiver URLs
Most of the receivers below ‘push’ to a specific URL. The protocol
(HTTP/HTTPS) used varies depending on the source. We support both HTTP and
HTTPS protocols using port 48082 and 48083. Refer to the specific data source
below to determine the correct one to use.
If you have set a SSL certificate for the UI, that will be used instead of the
self-signed one.
You can check access to both the HTTP and HTTPS urls with a ‘ping’:
Meraki Location Scanning API
To enable, the Meraki scanning API feed, follow the following steps:
When enabling the API, set the following parameters:
API Version : 2
Post URL : https://{server}:48083/meraki/{name}
Secret : for example - kloudspot12345678
For ‘{name}’ use a friendly alphanumeric label for the account.
Next go to the Kloudspot Web UI and select ‘Cisco Meraki’ source in the Event Sources.
Add an entry for each account (one is enabled by default) by clicking the ‘+’ sign.
Enter the ’name’, ‘validation’ and secret’ from above for each account and click ‘Save’.
Restart the stream processing job.
Integrating Meraki Cameras
Kloudspot supports integration with both RTSP (MV*2 cameras only) and MV Sense
APIs. RTSP video stream from Meraki second generation camera’s can be streamed
on-prem to Kloudspot vision controller for complex actionable use cases
including Object detection, PPE, Mask, Social distancing, capacity counts and
management, demographics, and fingerprinting.
Insights inferred from RTSP stream
For more details on KloudVision __ please check out the KloudVision document.
RTSP Integration
Please refer to Meraki documentation on how to setup Meraki RTSP configuration
to stream live video
Step 1: Port number 6666(TCP) should be exposed to send Meraki camera payloads
to the Insights.
Step 2: On UI, go to configurations and click on locations. Add the location
(Region/site) where the cameras need to be deployed. Then navigate to the
‘Cameras’ section.
Step 3: Click on the ‘Cameras’, select the floor and the zone to which you
want to add the camera and click on ‘add/edit a camera’ and then click on “Add
a Camera” as shown in figure below.
Step 4: ‘Add/Update Cameras’ dialogue box needs to be filled with following
information.
Choose the vendor as ‘Third Party Camera’.
Enter the Unique Id of the Meraki Camera in ‘camera name’ section.
Upload the image that is seen by the camera in “PNG” format in the “camera Image” section (Image size less than 2MB).
Choose the grid resolution for the camera through the slider (default value is 50px) in the advance settings.
Click on ‘Save’ to add the camera.
NOTE: Grid resolution is the resolution of each grid in pixels the image would
be divided for heatmap calculations.
Adding widgets which use Meraki payloads to the dashboard
Step 1: On the homepage, navigate to ‘My Dashboards’ and select an existing
dashboard or create a new dashboard.
Step 2: On the selected dashboard scroll down to the bottom and click on the
‘+’ symbol to add widgets to the dashboard.
‘Live Movement on a Camera Image’ Widget
Step 1: To add the ‘Live Movement on a Camera Image’ widget navigate to the
‘Camera’ section and select ‘Live Movement on a Camera Image’ widget.
Step 2: Select the location in which the camera is configured through the
‘Settings’ option by clicking on the gear symbol.
Step 3: Select the camera for which you want to see the live movements.
Step 4: Once the camera is selected the live movements of the objects are seen
on the camera image in the form of rectangles. User can hover over the
rectangle to get more details of the object.
NOTE: User can Zoom in and out using the ‘+’ and ‘-‘symbols respectively.
‘Live user heatmap on floor camera image’ Widget
Step 1: To add the ‘Live User Heatmap On Floor Camera Image’ widget navigate
to the ’Maps’ section and select ‘Live User Heatmap On Floor Camera Image’
widget.
Step 2: Select the location in which the camera is configured through the
“Settings” option.
Step 3: Select the camera for which you want to see the heatmap.
Step 4: Clicking on the “Live Option” enables the user to view the live
heatmap.
Step 5: Clicking on ‘history’, allows the user to view the heatmap for a
specific day. The user can choose/pick any day from the date-picker.
Step 6: Clicking on the “Show Hour” checkbox enables the user to view the
heatmap data for any hour of the day.
Step 7: A tooltip with the ‘count and dwell time’ can be seen when the user
just hovers over the heatmap.
NOTE: User can Zoom in and out using the “+” and “-” symbol, respectively.
Mist Integration
On the mist cloud, navigate to Organization -> Site Configuration
Enable Webhooks and provide the URL – (KloudInsight deployment team should be able to provide this). It will be of format https://<host :[port]>/mist
Connected client webhook information (client-join)
To enable connected client data to be reported on KloudInsights, we need to
enable “client-join” events on the Mist platform. One can get the Mist support
team to enable this on the Mist platform or following instructions can be
followed:
Please refer to the below document for further information: https://api.mist.com/api/v1/docs/Site#webhooks
1. Please navigate to the below API to check the webhook id /api/v1/sites/:site_id/webhooks
Add the “client-join” topic using the PUT operations for the below API: /api/v1/sites/:site_id/webhooks/:webhook_id/
API payload:
{
“topics”: [
“client-join”, ….
]
}
KloudInsights configuration
Configure floor maps on the Insights using the same floor map image that is
used on the Mist floor configuration. Make sure that the dimensions of the
floor map match the dimensions of the floor map configured on the
KloudInsights. To measure the dimensions of the floor map on Mist, you can use
the Ruler (as show below).Configure floor maps on the Insights using the same
floor map image that is used on the Mist floor configuration. Make sure that
the dimensions of the floor map match the dimensions of the floor
Location -> Live view
Click on the floor and select ruler and draw line using the mouse
On each floor on Kloudspot you need to update Floor ID with the map Id of the
floor on the Mist system. The map Id can be obtained from the URL in the live
view (Location -> Live view) of the floor on Mist system.
Ex: below is the live view url and the highlighted one is the map Id.
Then map Id is 1960172f-09e0-4658-95c2-11837a409f07, it should be updated on
KloudInsights floor as below:
Also enable Mist data processing on the WIFI as below:
Navigate to Configuration -> Event Processing -> WFI and make sure “Mist” is enabled as below
Kontakt.IO IOT Sensor Integration
Overview:
Kontakt.io are a provider of ‘smart’ BLE tags/sensors.
They provide two main types of device:
“Smart Badge A mobile tag, typically used for people tracking. The tag has 2 buttons and an IR sensor able to sense a room number transmitted by Portal Beams in rooms.
‘Portal Beam’ A static typically attached to ceilings, able to report:
Counts/locations of IR sensed occupancy data
Environmental information (light intensity, air quality, temperature, pressure …)
It also has an IR transmitter able to send a room number to smart badges
In addition, they can provide dedicated asset tags and WiFi - BLE ‘gateways’
called Portal Lights.
The BLE devices can all be used with their own BLE gateways or also with BLE
gateways on Meraki and Cisco APs.
Regardless of the gateway type used the data arrives in the Kontakt.IO cloud
and is then available for processing/forwarding.
The main functions they provide are:
Occupancy – de-duplicated counts of devices and/or people in rooms using the IR sensors. They provide functionality to deduplicate counts between multiple Portal Beams and can track down to seat occupancy with suitable setup.
Position – location of BLE tags based on trilateration. One extra function they provide is the ability to determine which room a badge is in based on the IR sensor on the badge ‘seeing’ a portal beam and getting a room number. Since this information is available from the Telemetry feed and we do our our trilateration, we don’t need this feed setup.
Data feeds containing this information along with a raw BLE tag telemetry
stream can be sent from the Kontakt.io cloud to AWS Kinesis. Our integration
sets up and subscribes to this Kinesis feed
Integration
We have integrated the following features, based on the Kinesis data streams:
BLE tag presence and trilateration (similar to existing functionality).
‘Smart Tag` button and room number reporting support
Portal Beam environmental data reporting.
In addition, we will follow up with IR based room occupancy reporting.
Configuration:
The following needs to be configured:
AWS:
Create an AWS Kinesis stream.
Create an AWS User with Access Key access and the following permission policy:
Note that the Resource ARN needs to specified for both Consumers and the
stream itself.
The BLE and IOT stream processing jobs need to be running on KloudInsights
Configure the integration in Configuration -> Event Processing -> IOT/Rules
You will need the AWS information, as well as your Kontakt.IO API key. When
configurated the integration will set up the Kinesis channel in Kontakt.IO and
configure it to send data.
Setup
The final step is to configure the badges, sensors etc in Kloudinsights:
Note that you can download lists of Kontakt.IO devices, smart badges and
locations to help with this task:
Upload BLE Tag information in the ‘Devices’ screen – you can assign user names, emails etc.
Add the Portal Beams as environment sensors in Configuration -> Locations. Note that use the ‘name’ of the beam as the name of the EnvSensor.
Add the gateways as ‘APs’, using there MAC addresses.
For each mapped zone, add the ‘roomNumber’ from the location.csv as an external identifier.
Teams Application Setup
This document outlines the steps required to set up and install Kloudspot App
for Microsoft Teams.
Login to Kloudspot Analytics Platform
Navigate to “API Keys” section accessible from the top menubar under the gears icon
Create a new Key. Make a note of the API Client Key and API Client Secret. You will need this later
Navigate to “Configuration => System” in the left navigation bar
Click on “External Integrations” tab
Scroll to the “Teams App Settings” section
Click on “Add Bot”
Make a note of the URL that is displayed on the form. The next few steps are performed on Microsoft Teams and you will return to Kloudspot Analytics Platform to enter the rest of the form fields
Open Microsoft Teams app on your desktop and Navigate to “Apps”
Search for “App Studio” and proceed to install it
Once installed, navigate to “Manifest Editor” tab on the app
Click on “Create a new app”
Jump directly to the “Capabilities” section and click on “Bots”
Click “Setup” to create a new bot
Provide any meaningful name for your Bot
Check all the options under “Scope” and click on “Create bot”
The newly created bot shows up displaying an ID under the name. Please make a note of the ID. You will need this later
Click on “Generate new password” and make a note of the Password. You will need this later
Under “Messaging Endpoint”, please enter the URL noted from the Kloudspot Analytics Platform and tab out. This will save the URL and display a green checkmark to confirm that the URL is saved
Head back to Kloudspot Analytics Platform to the Teams App Settings section
Provide a meaningful name for the App
Enter the Bot ID and Bot Password noted in earlier sections
Enter the API Client Key and API Client Secret
Check the “Enabled” checkbox to enable this bot
Choose one or more services that the Bot and click on “Save”
The Kloudspot Analytics App for Microsoft Teams is now complete
Click on “Download App” button to download the app (as a zip file)
To install the app, Navigate to “Apps” on your Teams client and click on “Upload a custom app”
Use the downloaded zip file
The app can be installed for the current user or for an entire team. If choosing to install for an entire team, select “Add to a team” option and choose the team
The app is successfully installed and ready to use
Type “hello” to test. The bot should respond back with a welcome message.
Aruba IoT Integration
OVERVIEW
This guide describes steps necessary to set-up an IoT information feed from
Aruba Instant or ArubaOS to KloudInsights.
RELATED DOCUMENTS
Aruba Instant documentation
Aruba Instant User Guide.pdf (chapter “BLE IoT for Data Communication”)
Aruba access points with integrated Bluetooth radios, or Aruba access points
equipped with an Aruba USB Bluetooth radio (LS-BT1USB, JW315A orJW316A), are
required for integration with KloudInsights.
Software
The integration uses the Aruba IoT Telemetry Interface to forward Bluetooth
device information that is collected by the access points to KloudInsights.The
Aruba IoT Telemetry Interface is available in Aruba Instant/ArubaOS 8.4.0.0 or
higher.
Configuration of the Aruba IoT Telemetry Interface is achieved via IoT
profiles. The full configuration of IoT profiles is currently supported via
CLI on Aruba Instant (partly configurable via GUI) and ArubaOS and is
described in detail in the referenced product documentation within the chapter
“Related Documents.".
REQUIRED INFORMATION
Ask your Kloudspot support contact for the following information:
endpointUrl : the URL to send data to. It will be of the form https:// :/aruba-iot
endpointToken : A token to validate the payload.
ARUBA INSTANT
This chapter describes the configuration and verification steps necessary to
setup Aruba Instant for KloudInsights/
Set-up
Enter ‘config mode’:
config
Enable the Bluetooth radio on an Aruba Instant AP in standalone mode or on all APs in an Aruba Instant cluster.
ble mode beaconing
Add a new IoT transport profile using the set-up information collected in chapter “REQUIRED INFORMATION”
Apply the new configuration to the Aruba Instant AP/Cluster
exit
commit apply
Verification and Troubleshooting
Once the IoT profile has been configured and enabled, Aruba Instant
immediately connects to the backend server and starts sending telemetry
information.The commands below can be used to validate and troubleshoot the
IoT configuration and connectivity to the backend server.
Note: please ensure that access points’ Bluetooth radios have been enabled,
and that the access points receive data from the Bluetooth devices.
The “show ap debug ble-config” command should show the BLE Operation Mode as
“Beaconing,” and the configured IoT profile should be shown.
d0:d3:e0:c3:3b:e0# show ap debug ble-config
-----------------------------------------------
---------- IOT Radio Profiles -----------------
-----------------------------------------------
Profile Name : ble
Radio Instance : Internal
Radio Mode : BLE
BLE Mode : beaconing scanning
BLE Console : On
BLE Tx Power (dBm) : 0
-----------------------------------------------
Note: No Zigbee service profiles configured.
Radio Configuration
-------------------
Radio Information TI ONBOARD Internal BLE
----------------- ------------------------
Radio Profile Type --
Zigbee Supported No
APB MAC Address b4:52:a9:34:07:53
Operational Mode Persistent Console (APB: Persistent Console)
Bundled BluOS Images Bank A(/aruba/bin/UpgradeImage_AP_OAD-A_1.2-37.bin) Bank B(/aruba/bin/Beacon_AP_OAD-B_1.2-37.bin)
-----------------
Miscellaneous Configuration
---------------------------
Item Value
---- -----
FIPS Mode No
Master IP 127.0.0.1
BLE Ready Yes
APB Info Update Intvl (in sec) 88 (1763/1716)
BLE debug log Enabled
Message Selector 0xffff (APB: 0xffff)
AP USB Power Override Disabled (-1)
Uplink Status Up (APB: -NA-)
APB Connection Status 0
Time Last Message to APB 1970-01-01 00:00:00
Log Levels Available { All(0xfffff), Info(0x04), Warning(0x02), Error(0x01), Ageout(0x08), BMReq(0x10), FW-Upgrade(0x20), FW-UpgradeErr(0x40), CfgUpdate(0x80), CfgUpdateErr(0x100), Beacon(0x200), BcnTLV(0x400), BcnErr(0x800), APB(0x1000), Tags(0x2000), ZF(0x4000), AMON(0x8000), IOT-GW(0x10000), AT-HTTPS-JSON(0x20000), AT-WEBSOCKET-PROTOBUF(0x40000), DevMgmt(0x80000), None(0x00) }
Current Log Level { 0x901e1 : Error(0x0001), FW-Upgrade(0x0020), FW-UpgradeErr(0x0040), CfgUpdate(0x0080), CfgUpdateErr(0x0100), IOT-GW(0x10000), DevMgmt(0x80000) }
Log Mac Filter None
Bundled BluOS Upgrade Enabled (-1)
OTA FW BluOS Upgrade Disabled
-----------------
BLE IoT Transport Context Config ID: 1
Last Sync Time: 2020-07-08 21:50:00
BLE IoT Profile List
--------------------
Profile Name EndpointType Interval Content Filter Attribute Cell Size Att Threshold Out Range Ageout NamespaceFilter URLFilter Last Update RssiReporting environmentType customFadingFactor deviceCountsOnly rtlsDestMAC vendorFilter
------------ ------------ -------- ------- ---------------- --------- ------------- ---------------- --------------- --------- ----------- ------------- --------------- ------------------ ---------------- ----------- ------------
kloudspot (51) Telemetry Https 10 second iBeacon(8),Eddystone(10) NA NA NA NA NA NA 2020-07-08 21:57:31 Average office NA FALSE 00:00:00:00:00:00
-----------------
Note: Uplink status is applicable only for Controller with Dynamic Console operational mode.
For APBs of type LS-BT1USB, applied operational mode is Beaconing if ap system profile setting is either Persistent or Dynamic.
Note: Setting Message Selector value to 0x0 will cause the APB to function improperly. Use the knob with caution.
Note: Message Selector Bits: All(0xffff), V0 Scan (0x01), V1 Scan (0x02), UI Scan (0x04), Proximity Advert (0x08), IBeacon (0x10), Heartbeat-1 (0x20), Heartbeat-UI (0x40), Upg Ack (0x80), Heartbeat-2 (0x200), Generic Scan (0x400), Generic Advert (0x800), Tag V1 Scan (0x1000), Tag V1 Advert (0x2000)
Use the “show ap debug ble-table all” command to verify if - and which -
Bluetooth devices can be seen by the AP.
d0:d3:e0:c3:3b:e0# show ap debug ble-table all
BLE Device Table [Aruba Beacons]
--------------------------------
MAC HW_Type FW_Ver Flags Status Batt(%) RSSI Major# Minor# UUID Meas. Pow. Tx_Power Last Update Uptime
--- ------- ------ ----- ------ ------- ---- ------ ------ ---- ---------- -------- ----------- ------
b4:52:a9:34:07:53 BT-AP303 OAD B 1.2-37 0x01a3 LIA ONBOARD -- 0 0 4152554E-F99B-4A3B-86D0-947070693A78 -56 14 I:4s 1h:40m:0s
BLE Device Table [Generic]
---------------------------
MAC Address Type RSSI Last Update Device Class
--- ------------ ---- ----------- ------------
5f:a3:0d:7c:fe:17 Private R -56 I:0s --
63:15:26:e9:98:1a Private R -50 I:1390s --
58:cb:c4:25:90:2d Private R -42 I:338s --
7b:67:2f:f0:46:4e Private R -42 I:1545s --
01:5e:6a:46:34:79 Private NR -87 I:0s --
47:ad:f8:ff:2e:7c Private R -57 I:1s --
d9:93:af:72:2e:8c Static -74 I:1s --
60:81:33:46:98:91 Private R -51 I:1390s --
67:85:77:bb:9a:e8 Private R -42 I:0s --
46:b9:a9:5d:ca:eb Private R -53 I:0s --
4e:0d:d5:6e:1c:fd Private R -52 I:901s --
79:27:3f:15:ef:23 Private R -84 I:0s --
a4:83:e7:9c:39:2c Public -53 I:0s --
7d:3c:66:1a:37:36 Private R -94 I:1843s --
44:54:ed:3a:b3:37 Private R -51 I:1801s --
74:5b:84:08:b7:64 Private R -54 I:901s --
5a:a9:82:c3:81:69 Private R -66 I:244s --
5c:9c:95:47:c5:a0 Private R -52 I:1801s --
cc:04:b4:02:51:af Public -89 I:0s --
24:67:63:23:53:d5 Private NR -83 I:589s --
46:33:09:75:eb:ee Private R -57 I:1s --
48:da:99:74:83:f4 Private R -56 I:0s --
ac:23:3f:5e:67:ff Public -41 I:0s iBeacon, eddystone
Beacons:1
Generic BLE devices:23
Total BLE devices:24
Note: Battery level for LS-BT1USB devices is indicated as USB.
Note: Uptime is shown as Days hour:minute:second.
Note: Last Update is time in seconds since last heard update.
Note: Meas. Pow. is the averaged RSSI (in dBm) when the iBeacon is calibrated.
Status Flags:L:AP's local beacon; I:iBeacon; A:Beacon management capable
:H:High power beacon; T:Asset Tag Beacon; U:Upgrade of firmware pending
:u:Beacon management update received
The commands “show ap debug ble-relay iot-profile” can be used to check the
IoT profile configuration and server connection status of the IoT profile. The
state should be displayed as “Ready.”
d0:d3:e0:c3:3b:e0# show ap debug ble-relay iot-profile
ConfigID : 1
---------------------------Profile[kloudspot]---------------------------
serverURL : https://smoke.kloudspot.com:48083/aruba-iot
serverType : Telemetry Https
deviceClassFilter : iBeacon,Eddystone
reportingInterval : 10 second
accessToken : 12345
clientID : kloudspot
rssiReporting : Average
environmentType : office
accessID : kloudspot
Server Connection State
--------------------------
TransportContext : Ready
Last Data Update : 2020-07-08 22:01:42
Last Send Time : 2020-07-08 22:01:43
Last Receive Time : 2020-07-08 22:01:43
TransType : Https
If the server connection status does not show “Ready,” use the command “show
ap debug ble-relay report ” for more detailed connection logs for
troubleshooting purposes.
d0:d3:e0:c3:3b:e0# show ap debug ble-relay report kloudspot
---------------------------Profile[kloudspot]---------------------------
Last Send Time: 2020-07-08 22:03:03
Sent report to Endpoint server (6s) ago: success 84, failed 0, last curl result code 200
Timeout(-1):20 Jobs added: 84
Server: https://<server>/aruba-iot with proxy: NA
Proxy username: NA, password: NA
Vlan Interface : Not Configured
Request to Server:
{"meta": {"version": 1}, "reporter": {"name": "d0:d3:e0:c3:3b:e0", "mac": "D0:D3:E0:C3:3B:E0", "ipv4": "10.90.37.235", "hwType": "AP-303", "swVersion": "8.6.0.4-8.6.0.4", "swBuild": "74969", "time": 1594245782}, "reported": [{"deviceClass": ["iBeacon", "eddystone"], "model": "iBeacon", "vendorName": "Apple", "mac": "AC:23:3F:5E:67:FF", "stats": {"adv_cnt": 7641266, "frame_cnt": 12, "uptime": 78288870}, "beacons": [{"eddystone": {"uid": {"nid": "00112233445566778899", "bid": "ABCDE23A00E1"}, "url": {"prefix": 1, "urlBytes": "6D696E65770012"}, "power": -24}}, {"ibeacon": {"uuid": "E2C56DB5-DFFB-48D2-B060-D0F5A71096E0", "major": 0, "minor": 0, "power": -59}}], "rssi": {"avg": -41}, "BeaconEvent": {"event": "update"}, "lastSeen": 7, "sensors": {"voltage": 3.12, "temperatureC": 25.0}}]}
Last Curl logs:
....
Host: <server>
Content-Type: application/json
Authorization: Bearer 12345
Accept: application/json
Content-Length: 792
* upload completely sent off: 792 out of 792 bytes
< HTTP/1.1 200 OK
< Server: nginx/1.14.0 (Ubuntu)
< Date: Wed, 08 Jul 2020 22:03:03 GMT
< Transfer-Encoding: chunked
< Connection: keep-alive
< Keep-Alive: timeout=5
< Vary: Accept-Encoding, User-Agent
<
* Curl_http_done: called premature == 0
* Connection #0 to host smoke.kloudspot.com left intact
ARUBAOS
This chapter describes the configuration and verification steps necessary to
set-up the IoT feed to KloudInsights on controller-based installations running
ArubaOS.
In controller based set-ups the BLE radios and IoT profiles have to be enabled per AP groups.
Mobility Master vs. Standalone ControllerThe configuration steps for IoT profiles in a mobility master and a standalone controller set-up are the same except that in a mobility master scenario the configuration is done on the mobility master using the configuration hierarchy.
Set-up
Enable the Bluetooth radio on the desired AP groups by setting the ble-op-mode to Beaconing in the corresponding AP system profile.
The deviceClassFilter all is enabled by default. The deviceClassFilter all has to be explicitly set to disable-dIn to send only telemetry updates for ibeacon and eddystone devices to the backed.
Add a new IoT transport profile using the set-up information collected in chapter “REQUIRED INFORMATION”.
Enable the configured IoT profile.
Apply the new configuration to the Aruba controller/mobility master.
Verification and Troubleshooting
Mobility Master vs. Standalone ControllerThe verification and troubleshooting
steps for IoT profiles in a mobility master and a standalone controller set-up
are the same except that in a mobility master scenario the verification and
troubleshooting is done on the managed devices.
After the IoT profile has been configured and enabled the Aruba controller
will immediately connect to the backend server and start sending telemetry
information.
The commands below can used be to validate and troubleshoot the IoT
configuration and connectivity to the backend server.
Check first to ensure that the access points’ BLE radios have been enabled and
if the APs can receive data form the BLE devices. The show ap debug ble-
config [ap-name|ip-addr|ip6-addr] command should show the BLE Operation Mode
as “Beaconing” and the configured IoT profile should be displayed.
Using the show ap debug ble-table [ap-name|ip-addr|ip6-addr] all command
verify if - and which - Bluetooth devices are seen by the access points.
Use the command show ble_relay iot-profile to check the IoT profile
configuration and server connection status of the IoT profile. The state of
the response should show “Ready.”
If the server connection status does not show “Ready,” use the command show
ble_relay report report [] to obtain more detailed connection logs for
troubleshooting.
EnGenius Configuration
Introduction
Services such as CRM tools, presence analytics, or location-aware services
need to constantly collect data. EnGenius Cloud Access Points are sufficient
for this. EnGenius Presence Service, continuously gathers data and sends the
data to KloudInsights.
For this, the device needs to be registered on the EnGenius portal and
KloudInsights. This document describes how to do this.
Step 1: Register a device in the EnGenius portal
Before adding the access point to KloudInsights, the device needs to be
registered in the Engenius portal. Refer to the Engenius help files to learn
how to register a new device.
The server location requested during registration will be in the given format.
https:/engenius/events
Step 2: Add a new AP to the Insights location
After configuring the device in the EnGenius portal, the next step is to add the device to Insights. To do so Log in to KloudInsights.
2. Then navigate to Configuration > Location > (Select location) > Access
Points.
3. Select the floor and zone to which you want to add the access point from
the newly opened window.
4. Then click the Add AP button from the Add/Edit an AP dropdown
menu.
5. In the popup window that appears, add the Name, Mac address and Logo.
Note: In Mac address field, you must enter the radio Mac address.
6. Then click the Save button to save the changes.
Note: To learn more about adding an access point, check the Insights
admin manual.
Step 3: Enable Engenius in KloudInsights
Data analysis is only possible if EnGenius data processing is enabled. To do so, follow the steps below.
Navigate to Configuration > Event Processing > Wi-Fi tab.
Enable EnGenius under Event sources and click the Save button.
Once enabled, you can use the information received from the Access point to create a variety of widgets.
Note: Check the Insights Admin guide for more information about widgets.
Milesight MQTT Broker Settings
This document provides a detailed guide on configuring Milesight MQTT Broker settings for IoT event processing. The setup involves defining crucial parameters such as the MQTT host, port, username, password, and protocol, as well as specifying uplink topics for sensor data transmission.
Overview
In this configuration, sensors transmit data in the form of payloads on specific topics. These topics are identified and set up in the Milesight platform. Subsequently, they are integrated into the user interface for data visualization.
To learn more about Milesight MQTT, click on the links provided in the References section.
Accessing MQTT Broker Settings
Navigate to the Configuration > Event Processing > Iot/Rules > Milesight MQTT Broker Settings.
Then scroll down and find the section called Milesight MQTT Broker Settings. Add the following parameters to it.
Configure Parameters
Host: Enter the MQTT Host Name provided by your MQTT broker service.
Port: Specify the MQTT Port Number.
Username: Provide the MQTT Username associated with your account.
Protocol: Enter the protocol used for MQTT communication.
Password: Input the MQTT Password corresponding to the provided username.
Uplink Topics: In this section, define the uplink topics through which the sensor transmits data to MQTT. These topics play a crucial role in the data transmission process.
Kloudspot currently supports various Milesight sensors, which capture data across diverse environments and use cases. Below is a list of the supported sensors along with their models.
Enter template name and sample message in the window that opens and save the template.
Note: Provide the exact name that has been approved by Meta and enter the payload information.
Setting up Action Templates
Refer to the Action Templates section to learn how to add an action template.
Choose “WhatsApp” as the template type. Additionally, tick the template checkbox and select the WhatsApp template you previously generated.
If you wish to send a personalized message, select the “Text” checkbox.
Options for Cisco WLC Connections
The Kloudspot Analytics platform can be configured to request and receive
client session data from Cisco Wireless Lan Controllers (WLC).
In order to do this, the platform needs to be able to connect to the WLC on
port 16113. This is easy to achieve in an on-premises installation where the
WLC and the Kloudspot Analytics platform are on the same network. The data
receiver (‘Rcv’) in the Kloudspot Analytics platform connects directly to the
WLC using port 16113 to subscribe for a data feed.
However, it can be difficult to set up this configuration when using Amazon
Web Services or another cloud provider for the following reasons:
It can be difficult to persuade network administration to implement the necessary firewall rules:
It opens an attack surface whereby a 3rd party might potentially be able to disable the WLC with a Denial Of Service attack. Often this clashes with companies cyber security rules.
For this reason, it is possible to reconfigure the Kloudspot Analytics
platform so that the data receiver (‘Rcv’) is positioned on-premises in a
small VM and acts as a ‘proxy’ with all connections outbound from the company
to AWS:
In this configuration, the receiver, inside the customer’s DMZ or data center
connects to the WLC on port 16113 and then sends the received data to AWS on
port 9092 using an TLS secured connection.
High Availability/Scalability
For scalability and high availability, the receiver can be configured in a N+1
configuration whereby the load can be shared across multiple receiver
instances, with the ability to rebalance the workload on failure.
In order to use this functionality an Apache Zookeeper cluster needs to be
setup. This is then used to elect a ‘leader’ of the available Receiver
instances. The leader shares out the work to the group of available receivers.
If the leader fails, a new leader is elected. If any member of the group
fails, the leader will rebalance the work across the remaining members.
An existing zookeeper cluster can be used or the same VMs used for the
receivers can also be used to provide the zookeeper functionality.
To set up a zookeeper cluster at least three VM instances on physically
separate hardware are required. So, if the same VMs are used as receivers,
this is the minimum configuration.
Receiver VM System Requirements
Each VM instance has the following hardware requirements:
The Kloudspot Analytics Engine can receive events from many types of WiFi
network.
One or more of event sources can be configured in the Configuration - >Event Processing- >Wi-Fi screen.
Validate the Receiver URLs
The protocol (HTTP/HTTPS) used varies depending on the source. We support both
HTTP and HTTPS protocols using port 48082 and 48083. Refer to the specific
data source below to determine the correct one to use.
If you have set a SSL certificate for the UI, that will be used instead of the
self signed one.
You can check access to both the HTTP and HTTPS urls with a ‘ping’:
$ curl http://{server}:48082/ping
hi from http receiver
$ curl -k https://{server}:48083/ping
hi from https receiver
Aruba ALE
Refer to the ‘Analytics and Location Engine 2.0 - User Guide’. This will give
the necessary information to set up the connection and/or the Websocket
tunnel. Here are the Aruba
docs.
Three parameters need to be entered into the Kloudspot Analytics configuration
screen:
Hostname: of the ALE Websocket Proxy
REST API Port: Typically 8700
Pub/Sub API Port: The port used for the ZMQ connection. This is the port mapped to port 7779 on the ALE (typically 12000).
In summary:
The Analytics Engine can either access the ALE Engine directly or make use of the supplied Websocket Tunnel. In either case enter the required port details into the configuration screen and click save.
The ALE Engine should be configured to not anonymize Mac addresses.
At present only presence (Context Mode) is support for this source.
The Aruba websocket endpont can be set up anywhere, which can help with
firewall issues. Depending on the circumstances, the endpoint could be
installed on the Kloudspot Analytics server itself (with a localhost
connection).
Check Event Reception
Login to the Analytics Engine via SSH and run the kafka-listen command:
You will be able to see the ‘raw’ event feed going into the stream processing.
Aruba RTLS
Overview
The Kloudspot Analytics Engine can receive events from many types of WiFi
network.
One or more of event sources can be configured in the ‘Configuration - >Event Processing - > Wi-Fi’ screen.
Validate the Receiver URLs
The protocol (HTTP/HTTPS) used varies depending on the source. We support both
HTTP and HTTPS protocols using port 48082 and 48083. Refer to the specific
data source below to determine the correct one to use.
If you have set a SSL certificate for the UI, that will be used instead of the
self signed one.
You can check access to both the HTTP and HTTPS urls with a ‘ping’:
$ curl http://{server}:48082/ping
hi from http receiver
$ curl -k https://{server}:48083/ping
hi from https receiver
Aruba RTLS Feed
In addition to a feed from the Aruba Location Engine, we can also take a feed
direct from the APs. This can be set up either on individual APs or for groups
of APs via Airwave or Aruba Central.
In order for this work, the APs must be able to access port 3333 on the
Kloudspot server using the UDP protocol. Depending on firewall requirements,
it should be possible to use a [standalone proxy data
receiver](https://documentation.kloudspot.com/help/standalone-receiver-setup-
for-cisco-wlc “Standalone Receiver Setup for Cisco WLC”).
The setup is similar regardless of the approach:
Enable the event type in the KloudInsights configuration screen and set a passphrase to use:
In the Aruba dashboard, enable the RTLS feed in the Services menu for the AP or Group, using the passphrase you created above and port 3333
See these references in the Aruba documentation for information:
You will be able to see the ‘raw’ event feed going into the stream processing.
Related Articles
[template(“related”)]
Cambium
Overview
The Kloudspot Analytics Engine can receive events from many types of WiFi
network.
One or more of event sources can be configured in the ‘Configuration - >Event Processing - > Wi-Fi’ screen.
Validate the Receiver URLs
The protocol (HTTP/HTTPS) used varies depending on the source. We support both
HTTP and HTTPS protocols using port 48082 and 48083. Refer to the specific
data source below to determine the correct one to use.
If you have set a SSL certificate for the UI, that will be used instead of the
self signed one.
You can check access to both the HTTP and HTTPS urls with a ‘ping’:
$ curl http://{server}:48082/ping
hi from http receiver
$ curl -k https://{server}:48083/ping
hi from https receiver
Cambium cnPilot
Kloudspot Analytics support the WiFi Location API provided by Cambium cnPilot
Enterprise APs. The API can be setup either on standalone APs or via the
cnMeastro Wireless Controller/Network Manager.
In either case the setup is the same:
Go to the Radio options and enable Off Channel scan and Auto RF and save.
Then to the Services options and enable the Location API and save.
The default Server URL will be: https://<server>:48083/cambium. The Interval
should be ~30 seconds.
Go the the event sources screen in the Kloudspot Analytics Engine, enable the ‘Cambium Location API’ source and then restart the Stream Processing job.
Cambium cnMaestro
For cnMaestro, the steps to be taken are the same as with cnPilot, however to
navigate to the radio & service settings please follow the steps in the below
screenshot:
If BLE is also being scanned for, make sure to enable the Bluetooth API on the
services page, and enter in the same information entered for WiFi.
Check Event Reception
Login to the Analytics Engine via SSH and run the kafka-listen command:
You will be able to see the ‘raw’ event feed going into the stream processing.
Related Articles
[template(“related”)]
Cisco CMX
Overview
The Kloudspot Analytics Engine can receive events from many types of WiFi
network.
One or more of event sources can be configured in the ‘Configuration - >
**Event Processing - > Wi-Fi’**screen.
Validate the Receiver URLs
The protocol (HTTP/HTTPS) used varies depending on the source. We support both
HTTP and HTTPS protocols using port 48082 and 48083. Refer to the specific
data source below to determine the correct one to use.
If you have set a SSL certificate for the UI, that will be used instead of the
self signed one.
You can check access to both the HTTP and HTTPS urls with a ‘ping’:
$ curl http://{server}:48082/ping
hi from http receiver
$ curl -k https://{server}:48083/ping
hi from https receiver
Cisco CMX/MSE
The Kloudspot Location Engine supports Notifications from the Cisco CMX v10.X
operating in ‘presence’ mode.
On Kloudspot Location Engine, select the ‘Cisco MSE’ Event source and click
‘save’.
Then login to Cisco CMX and configure the following notification types:
You will be able to see the ‘raw’ event feed going into the stream processing.
Cisco Meraki
Overview
The Kloudspot Analytics Engine can receive events from many types of WiFi
network.
One or more of event sources can be configured in the ‘Configuration - >Event Processing - > Wi-Fi’ screen.
Validate the Receiver URLs
The protocol (HTTP/HTTPS) used varies depending on the source. We support both
HTTP and HTTPS protocols using port 48082 and 48083. Refer to the specific
data source below to determine the correct one to use.
If you have set a SSL certificate for the UI, that will be used instead of the
self signed one.
You can check access to both the HTTP and HTTPS urls with a ‘ping’:
$ curl http://{server}:48082/ping
hi from http receiver
$ curl -k https://{server}:48083/ping
hi from https receiver
Meraki MV Sense
Follow the instructions provided on the link to configure MQTT broker in the
Meraki Dashboard:
You will be able to see the ‘raw’ event feed going into the stream processing.
Cisco WLC
Overview
The Kloudspot Analytics Engine can receive events from many types of WiFi
network.
One or more of event sources can be configured in the ‘Configuration - >Event Processing - > Wi-Fi’ screen.
Validate the Receiver URLs
The protocol (HTTP/HTTPS) used varies depending on the source. We support both
HTTP and HTTPS protocols using port 48082 and 48083. Refer to the specific
data source below to determine the correct one to use.
If you have set a SSL certificate for the UI, that will be used instead of the
self signed one.
You can check access to both the HTTP and HTTPS urls with a ‘ping’:
$ curl http://{server}:48082/ping
hi from http receiver
$ curl -k https://{server}:48083/ping
hi from https receiver
Cisco Wireless Lan Controller
To configure a Cisco Wireless WAN Controller to send events, follow the
following steps.
Ensure that the Kloudspot Analytics Engine can access port 16113 on the WLC.
Enable the Cisco WLC Event source in the Kloudspot Analytics Engine.
Copy the command from the Kloudspot UI and run on the WLC. This will allow the Analytics Engine to connect and subscribe for events.
Add the IP address for WLC to the list of WLC Addresses in the Analytics Engine UI and click ‘Save’.
Check Event Reception
Login to the Analytics Engine via SSH and run the kafka-listen command:
You will be able to see the ‘raw’ event feed going into the stream processing.
Huawei
Overview
The Kloudspot Analytics Engine can receive events from many types of WiFi
network.
One or more of event sources can be configured in the **‘Configuration - >
****Event Processing** **- > ****Wi-Fi** ’ screen.
Validate the Receiver URLs
The protocol (HTTP/HTTPS) used varies depending on the source. We support both
HTTP and HTTPS protocols using port 48082 and 48083. Refer to the specific
data source below to determine the correct one to use.
If you have set a SSL certificate for the UI, that will be used instead of the
self signed one.
You can check access to both the HTTP and HTTPS urls with a ‘ping’:
$ curl http://{abc}-rcv.apps.kloudspot.com/{xyz}
hi from http receiver
$ curl -k https://{abc}-rcv.apps.kloudspot.com/{xyz}
hi from https receiver
Use port 443
{abc} = customer vanity URL
{xyz} = type of receiver used
Huawei
To configure a Huawei AP, select ‘Huawei’ from the event sources available.
Enable location Services
To enable location services for Huawei APs please follow the steps below.
Open 7777/ UDP port for collecting Wi-Fi data
Open 7778/UDP port for collecting BLE data.
Accuracy: The accuracy provided for Huawei AP is approximately between 3-5
meters for WiFi and 1-3 meters for BLE.
You will be able to see the ‘raw’ event feed going into the stream processing.
Kloudspot Event Receiver
Overview
The Kloudspot Analytics Engine can receive events from many types of WiFi
network.
One or more of event sources can be configured in the **‘Configuration - >
****Event Processing** **- > ****Wi-Fi** ’ screen.
Validate the Receiver URLs
The protocol (HTTP/HTTPS) used varies depending on the source. We support both
HTTP and HTTPS protocols using port 48082 and 48083. Refer to the specific
data source below to determine the correct one to use.
If you have set a SSL certificate for the UI, that will be used instead of the
self signed one.
You can check access to both the HTTP and HTTPS urls with a ‘ping’:
$ curl http://{server}:48082/ping
hi from http receiver
$ curl -k https://{server}:48083/ping
hi from https receiver
Kloudspot
The following steps are needed to configure Kloudspot APs to send events:
Login to Kloudspot AP Management and edit the account configuration. Set the Platform Probe URL to point to the Analytics Engine HTTPS port (48083).
Then edit the appropriate network groups to enable ‘Guest Proximity/Awareness’
Finally, select ‘Kloudspot APs’ in the Event sources in the Analytics Engine and click ‘Save’
Check Event Reception
Login to the Analytics Engine via SSH and run the kafka-listen command:
You will be able to see the ‘raw’ event feed going into the stream processing.
NEC QX
Overview
The Kloudspot Analytics Engine can receive events from many types of WiFi
network.
One or more of event sources can be configured in the ‘Configuration - >Event Processing - > Wi-Fi’ screen.
Validate the Receiver URLs
The protocol (HTTP/HTTPS) used varies depending on the source. We support both
HTTP and HTTPS protocols using port 48082 and 48083. Refer to the specific
data source below to determine the correct one to use.
If you have set a SSL certificate for the UI, that will be used instead of the
self signed one.
You can check access to both the HTTP and HTTPS urls with a ‘ping’:
$ curl http://{server}:48082/ping
hi from http receiver
$ curl -k https://{server}:48083/ping
hi from https receiver
NEC QX
To configure a NEC QX AP, select ‘NEC QX’ from the event sources
available.
Enable location Services: To enable location services for NEC QX APs we need
to open 5555/UDP port.
Check Event Reception
Login to the Analytics Engine via SSH and run the kafka-listen command:
You will be able to see the ‘raw’ event feed going into the stream processing.
Ruckus virtual SmartZone
Overview
The Kloudspot Analytics Engine can receive events from many types of WiFi
network.
One or more of event sources can be configured in the ‘Configuration - >Event Processing - > Wi-Fi’ screen.
Validate the Receiver URLs
The protocol (HTTP/HTTPS) used varies depending on the source. We support both
HTTP and HTTPS protocols using port 48082 and 48083. Refer to the specific
data source below to determine the correct one to use.
If you have set a SSL certificate for the UI, that will be used instead of the
self signed one.
You can check access to both the HTTP and HTTPS urls with a ‘ping’:
$ curl http://{server}:48082/ping
hi from http receiver
$ curl -k https://{server}:48083/ping
hi from https receiver
Ruckus virtual SmartZone
Port 8883 must be open from the Ruckus controller and APs to the Kloudspot
Analytics server. [See the Ruckus Zone Director instructions for
details](https://documentation.kloudspot.com/analytics/web-
ui/configuration/event-receivers#ruckus-zone-director).
Ruckus APs can send event data directly to the Kloudspot Analytics Engine. The
following steps set this up.
Go the the event sources screen in the Kloudspot Analytics Engine and enable the ‘Ruckus virtual SmartZone’ source.
Click the ‘+’ sign to add a virtual SmartZone contoller.
Enter the server address and credentials.
Once the server, username and password fields are valid, the Kloudspot Analytics Engine will contact the Ruckus server and download a list of zones. Select one or more zones from the dropdown.
Click ‘Save’
At this point, the Kloudspot Analytics engine will contact the Ruckus virtual
SmartZone controller and set up all the required Location Based Services
configuration.
Check Event Reception
Login to the Analytics Engine via SSH and run the kafka-listen command:
You will be able to see the ‘raw’ event feed going into the stream processing.
Ruckus Zone Director
Overview
The Kloudspot Analytics Engine can receive events from many types of WiFi
network.
One or more of event sources can be configured in the ‘Configuration - >Event Processing - > Wi-Fi’ screen.
Validate the Receiver URLs
The protocol (HTTP/HTTPS) used varies depending on the source. We support both
HTTP and HTTPS protocols using port 48082 and 48083. Refer to the specific
data source below to determine the correct one to use.
If you have set a SSL certificate for the UI, that will be used instead of the
self signed one.
You can check access to both the HTTP and HTTPS urls with a ‘ping’:
$ curl http://{server}:48082/ping
hi from http receiver
$ curl -k https://{server}:48083/ping
hi from https receiver
Ruckus Zone Director
The Ruckus APs use the MQTT protocol to
communicate with the Kloudspot Analytics server. For this to work Port 8883
must be open from the Ruckus controller and APs to the Kloudspot Analytics
server:
Ruckus APs can send event data directly to the Kloudspot Analytics Engine. The
following steps set this up.
Go the the event sources screen in the Kloudspot Analytics Engine and enable the ‘Ruckus Zone Director’ source. Note the secret key and then restart the Stream Processing job.
Click ‘Save’
Go to the Ruckus Zone Director. Login and select the Services & Profiles -> Location Services menu entry.
Click ‘Create New’
Enter the required information including the secret key from above and click OK.
Then select the Access Points menu entry. Select the access point group for which you want to send events. Click configure.
Scroll down to Location Services and enable the venue we just set up. Click ‘OK’.
Finally select the Services & Profiles -> Location Services menu entry. You now see the director and the APs all showing connected status.
Check Event Reception
Login to the Analytics Engine via SSH and run the kafka-listen command:
You will be able to see the ‘raw’ event feed going into the stream processing.
Xirrus XPS
Overview
The Kloudspot Analytics Engine can receive events from many types of WiFi
network.
One or more of event sources can be configured in the ‘Configuration - >Event Processing - > Wi-Fi’ screen.
Validate the Receiver URLs
Most of the receivers below ‘push’ to a specific URL. The protocol
(HTTP/HTTPS) used varies depending on the source. We support both HTTP and
HTTPS protocols using port 48082 and 48083. Refer to the specific data source
below to determine the correct one to use.
If you have set a SSL certificate for the UI, that will be used instead of the
self signed one.
You can check access to both the HTTP and HTTPS urls with a ‘ping’:
$ curl http://{server}:48082/ping
hi from http receiver
$ curl -k https://{server}:48083/ping
hi from https receiver
Xirrus XPS
The Kloudspot Analytics Engine can receive location update events from the
Xirrus Positioning System (XPS) as follows:
Enable the Xirrus Event source in the Kloudspot Analytics Engine.
Next login to XPS, click on API Docs
Then add a new forwarding job with the following URL:
http://{server}:48082/xirrus
You should immediately start receiving
events from the XPS.
The feed sent from the XPS doesn’t include information about APs. In order to
deal with this, some special configuration (including setting an External
Reference ID) is needed when setting up the location configuration in the
Analytics Engine. Please ask your Klouspot contact with help setting this up.
Check Event Reception
Login to the Analytics Engine via SSH and run the kafka-listen command:
You will be able to see the ‘raw’ event feed going into the stream processing.
User Roles and Permissions
After the integration part you can add users with different roles to KloudInsights, for that refer to the User & Permission Management section from the KloudHybrid Admin Guide.
Location Configuration
The next step is to add a location to KloudInsights, see the Create your office in Kloudhybrid section in the Kloudhybrid admin guide.
Action Templates
After completing the above steps, KloudInsights is ready to create rules, build dashboards, and create reports.
As part of creating a rule, an action template should be created to send it. Follow the next steps to know how.
If you have already created an Action template, learn to the Creating Rules section to learn how to create a rule.
A rule must be associated with one or more actions. This screen lists all the
templates defined in the system. The following action types are currently
supported:
SMS: Send an SMS to a specified telephone number.
Email: Send an email to a list of email addresses.
Voice: Kloudspot is integrated with Plivo to allow text to voice translation.
Web Hook: This allows simple integration with other systems. For example, this can be used to send events to a Slack channel.
Display Terminal: Trigger a change to a KloudDisplay terminal.
API Action: Add/remove/replace tags.
WhatsApp:Enable notifications and message sending via Meta authentication.
Most of the formats support the use of templated messages where information
from the event can be used to construct the sent message. The template editing
page includes information on the available template variables, more
information on the template language is available
here.
Configure an Action Template
Action templates are the actions performed by the system when a particular
rule is met. To configure an action template, click on Action Template in
the left-hand side menu.
Click on +New Template to create an action template.
2. A Create or Edit an Action Template appears.
3. Enter the name of the template in Action Template Name.
4. Select the type of action you want from the drop-down under Template Type. In this example, we select Email.
5. Specify the subject of the template in Subject.
6. To receive the notification as HTML, check Send an HTML box.
7. Select Use contact provided on device registration to use the contact
preset when the device was registered.
8. Enter the email address in the Contact Email section.
9. Finally, enter the content of the email in the Email Content section.
Creating Rules
The rule editor is an easy way to create automated policies that trigger
actions once a condition is met. The rule editor is where you combine the
three key elements of a rule:
Schedule: When does the rule run?
Action: What happens when the rule is triggered?
Condition: Under what circumstances should the rule be triggered?
To create a rule, you first need to create an action template. If you haven’t created an action template yet, refer to the Action Templates section to create one.
Creating a Rule
To initiate the rule creation process, navigate to Rules > Rules. Look for the Create a Rule button in the top-right corner of the page. Clicking on it will reveal three rule options:
Create a rule (Legacy)
Advanced Editor (Legacy)
Create a rule (V2)
For this guide, we’ll focus on the latest and most advanced option – “Create a Rule (V2).”
Click on Create a Rule (V2), and a new page will appear.
In the Rule Name section, enter a descriptive name for your rule.
Decide the rule’s status by checking the “Active” or “Inactive” box.
Set the Rate Limit Period and severity level of the rule.
Rate Limit Period: By configuring the Rate Limit Period appropriately, you can strike a balance between staying informed about potential security breaches and avoiding notification overload, thus enhancing the effectiveness of your Rule.
Limit: When setting a Rate Limit, you are defining the maximum allowable number of notifications that can be generated within a specific Rate Limit Period.
Severity level: You can select the impact of the rule. Three Severity Levels are available, Low, medium, and High.
Choose the time zone, specifying the days and hours the rule should run.
For example: If you want this rule to run from Monday to Friday from 9 am to 5 pm then check the days from Monday to Friday. Then select 9 to 5 in the time selection bar.
Optionally, set a date range for the rule’s activation.
For example: If you want this rule to run from December 21 to January 21, check the “from date” check box and select December 21. Then check the To Date checkbox and select January 21. This way you can run this rule for one month.
Select the frequency of notifications to stay informed about triggered rules.
Add a pre-prepared template using the Add Template section.
Optionally, enable the media capture feature to receive captured media when vision or camera rules are triggered.
Specify the location where the rule will apply.
Add rules (WiFi, BLE, Camera, Air Quality, WiFi Density Condition, Vision Entity Condition) by clicking the corresponding icons.
For a camera rule, click on the Camera Icon.
Note: This is an example, you can create rules like WiFi, BLE, Air Quality, WiFi Density Condition, Vision Entity Condition etc, in the same way.
In the rule filter section that opens, click on the Rule button.
Select the main condition from the dropdown list.
Choose the secondary condition and add a value.
Example: “Number of people entering” is “equal to” 200.
Optionally, add more demographic filters by clicking the Add Demographics Filter button.
Click the Save button to preserve your configured rule.
Classifiers
Classifiers, with their incredible abilities, serve as powerful tools to
categorize and arrange various forms of data. They excel at recognizing and
labeling feature tags, device attributes, human characteristics, vehicle
traits, parking spaces, vehicle occupancy in parking areas, and even tracking
tools in a toolbox. By employing classifiers, we can efficiently arrange and
group data according to pre-established criteria. This process allows us to
extract valuable insights and create meaningful visual representations, such
as interactive dashboards, that present the classified data in a structured
manner. Whether we are analyzing patterns, tracking trends, or making data-informed decisions, classifiers play a pivotal role in organizing information
and simplifying complex datasets.
Types of ‘classifiers’
1. Tag: Tags are used to label and classify data based on specific keywords or descriptors. They help in organizing information and making it easily searchable and retrievable.
2. Device Attribute: Device attributes refer to the characteristics and properties associated with electronic devices or hardware components. Classifying device attributes helps in categorizing devices based on the following conditions:
MacAddress, Zone, Floor, site, Zone Tag, Associated, SSID, RandomizedMac,
Returned User, Session zone dwell (in milliseconds), Session floor dwell (in
milliseconds), Session site dwell (in milliseconds), Tags, Number of days
seen, Signal strength (RSSI in dbm), Probe Count, Time Of The Day, Day Of The
Week
3. Human Feature: Human features encompass the distinct characteristics
and traits of individuals. Classifying human features helps in categorizing
humans based on the following conditions:
Gender, Area Of Interest, Tracking state, Face Mask, Medical Gown, Medical
Eye Glass, Medical Cap, Medical Gloves, Zone By Center, Zone By maximum Area,
Zones intersected, Dwell in camera view (in milliseconds), Age, Emotion,
Direction (entry/exit), Time Of The Day, Day Of The Week
4. Vehicle Feature: Vehicle features involve the attributes associated
with automobiles and other modes of transportation. Classifying vehicle
features helps in categorizing vehicles based on the following conditions:
Type, Tracking state, Dwell in camera view (in milliseconds), Time Of The
Day, Day Of The Week, First slot parking, EE, First parking occupancy
(percent), Second parking occupancy (percent), Is First slot parking zone, Is
Second slot parking zone, Is Multi Slot adjacent two vehicle parking.
5. Parking Slot: Parking slots are designated areas where vehicles can
be parked. Classifying parking slots helps in categorizing parking slots based
on the following conditions:
Tracking state, Dwell in camera view (in milliseconds), Is A Parking Zone,
Time Of The Day, Day Of The Week.
6. Vehicle Parking Occupancy: Vehicle parking occupancy refers to the
state of whether a parking slot is occupied by a vehicle or not. Classifying
vehicle parking occupancy involves the following conditions:
Vehicle Type, Tracking state, Dwell in camera view (in milliseconds), Time
Of The Day, Day Of The Week, Multi slot parking, Main Parking Occupancy
(percent), Secondary Parking Occupancy (percent), Is Main Slot A Parking Zone,
Is Adjacent slot a parking zone, Is Multi Slot Adjacent Two Vehicle Parking.
7. Parking Slot Occupancy: Parking slot occupancy refers to the state of
whether a parking slot is occupied or not. Classifying parking slot occupancy
involves the following conditions:
Tracking state, Dwell in camera view (in milliseconds), Time of the day,
Day Of The Week, Multi-Vehicle Parking, Main Vehicle Parking Occupancy
(percent), Second Vehicle Parking Occupancy (percent), Is A Parking Zone.
8. Toolbox: This condition is used to classify changes in the toolbox.
Classifying Toolbox involves the Area condition.
How to add a classifier
Adding classifiers to the KloudInsights platform allows you to categorize and
organize data effectively.
Login to the KloudInsights platform.
Once logged in, locate and click on the “Rules” option in the navigation menu.
From the drop-down menu, select “Classifiers.” This action will open the classifier window, displaying the currently available classifiers.
To create a new classifier, click on the "+New Classifier" button located at the top right corner of the classifier window.
5. In the “Create or Edit a Classifier” popup window that appears, choose
the desired classifier type from the “Type” dropdown list.
6. In the “Name” section, provide a suitable name for the classifier.
7. Specify additional details about the classifier in the “Details”
section.
8. Then select the purpose from the drop-down list.
9. If desired, select an icon for the classifier by either clicking on the
“Icon” section or dropping an image onto it.
Note: only PNG format images are supported, and the recommended size for
the icon is 64px * 64px.
10. Each classifier has its own set of conditions. In the “Conditions”
section, choose the relevant condition(s) for your classifier.
11. You can join multiple conditions using logical connectors like “AND,”
“OR,” etc.
Example: To create a classifier for people wearing face masks, select
“EntryExit” from the “Purpose” dropdown list.
Choose the “AND” connection in the “Condition on presence” section.
Click the “Rule” button to add conditions.
Select the condition “facemask > equal to > True.”
According to this condition, if someone enters with a mask, they will be
classified accordingly.
Utilize the information in this classifier by using the dashboard for various
purposes.
12. Finally, click on the “Save” button to save the newly created
classifier.
Devices & Device Groups
Devices
The Device section within KloudInsights provides a centralized hub for managing devices. This functionality is crucial for creating device-based rules and dashboards. This guide outlines the steps to add, edit, and delete devices efficiently.
Add new devices.
Navigate to Devices > Devices.
In the window that opens, click on the New Device button.
A popup window will appear; enter the following details in the Create tab:
MAC address
Tags
First Name
Last Name
Email
Phone number
Navigate to the Icon tab.
Optionally, add an icon corresponding to the MAC address.
Click on the Location tab and select the relevant location information.
Click the Save button to store the device information.
Uploading Multiple MAC Addresses
To add multiple MAC addresses simultaneously, create a CSV file containing the MAC address list.
Click on the Upload button to refer to the instructions in the popup window to format the CSV file correctly.
If you have a pre-existing CSV file, select it and click the Upload button.
To download the currently added MAC addresses, click on the Download button.
To remove all added devices, click the Delete All button.
Device Groups
The Device Groups feature allows you to organize devices based on a variety of parameters such as MAC address, SSID, and tags. This segmentation enables the creation of device-specific rules as well as dashboards.
Creating Device Groups
Navigate to the Devices > Device Groups.
Click on the New Device Groups button to begin the process.
Choose the type of group based on your criteria:
User Group: For grouping devices based on MAC addresses.
SSID Group: For grouping devices based on SSID.
Tag Group: For grouping devices based on tags.
Enter your group name.
Add Devices to the Group depending on the group type selected:
If User Group is selected: Enter the MAC addresses of the devices to be included in this group.
If SSID Group is selected: Choose the relevant SSID for grouping devices.
If Tag Group is selected: Select the tags associated with grouping devices.
Click the Save button to confirm and save the newly created device group.
Rule Notifications
Rule Notifications provide a centralized view of triggered rules within the system. When a rule is activated, users can review the relevant information on the Rule Notification page. This section outlines the steps to access, filter, refresh, and clear Rule Notifications.
To access the Rule Notifications page, navigate to Rules > Notifications.
The Rule Notification page provides a summary of all triggered rules. The following information is displayed for each rule:
Rule Name
MAC Address
Location
Trigger
Action
TimeStamp
To simplify the process of finding specific rules, users can utilize the filter option. Follow these steps to filter rules:
a. Click on the Show Filter button.
b. Specify filter criteria for MAC Address, Rule Names, Location, Action, and Date.
c. Enter the required information.
d. Click on the Apply Filter button.
Users can refresh the Rule Notification page by clicking on the Refresh button.
To clear the Rule Notification page and remove all displayed entries, click on the Delete All button.
Creating dashboards
One of the key features of the Kloudspot Analytics platform is the ‘dashboards’ feature, which allows users to gather and present the data they are interested in using a flexible widget-based interface.
1. To add a new dashboard, click on the New Dashboard button at the bottom of the menu bar.
2. Enter the dashboard name and description in the popup window that opens and click on the Save button.
3. Then click on the Add widget button on the dashboard.
4. In the widget list that opens, Here we are adding a camera widget, but the process is essentially the same for all the widgets. Click on the camera tab, and add the
widgets you want.
5. If you want to change the location of the widget, click on the
settings button and change the location.
6. Click the Save button to save the location.
7. Refer to the Dashboards section to learn more about the various dashboards available.
Dashboards
Overview
To see the dashboard you made, simply click on “My Dashboard” in the menu. If you’d like to create a new dashboard, check out the Creating Dashboards section for guidance.
Widgets
Kloudspot Analytics offers a wide variety of widgets that users can pick and
choose from to create a dashboard.
Analytics (1)
Footfall Density
A floor-by-floor statistical view of device density across a site
Footfall: The total number of devices that enter a physical space or location over
a given period of time.
Avarage density is calculated per square area. These are further color-coded based on
the density on the area or floormap. In configuration, we can predefine the color
code (based on numerical measure) for Avarage density.
Here, density is divided into ranges and on the basis of those ranges, it is
given tags like A , B, C , D , E .
Calendar (5)
Bluetooth timeline
This widget is available only for Bluetooth devices.
This widget gives a timeline view of user dwell times at a given location.
We can search for devices (using a Mac address or name) connected via Bluetooth.
You can select a date range (duration of 7 days) to monitor and analyze the
user engagement in different zones on a site.
User timeline
This widget is available for Wi-Fi devices.
We can search for devices connected via Wi-Fi. You can select a date range
(duration of 7 days) to monitor and analyze the user engagement in different
zones on a site.
This widget gives the timeline view of user dwell times at a given location.
Here we can add maximum 25 devices.
User Footfall
No. of unique devices seen on the site per day in given period of time for the
selected location. This calendar also shows the weather information.
In the settings menu, we have options of selection between 2 devices that are
Wi-Fi device and Bluetooth device.
In setting, we also have option “Attributes” selection functionality which
basically filters users/ client on the basis of field selected.
User Dwell Time
This shows the Avarage dwell time spent by unique devices on the site per day
along with weather information shown in the calendar view.
Here in settings, we have the option of “Dwell type” that has “Average Dwell
Time” and “Average Visit Length” (please select one).
Average Visit Length: it shows average of the amount of time user spends in a
given location in given time interval divided by Number of times user visit a
location in given interval.
In the settings,
there are options available to select the device type in the settings options, i.e either a Wi-Fi device or a Bluetooth device.
Option available for “Attributes” selection functionality, which basically filters users or client on the basis of field selected.
User Calendar
This widget gives information about both the “User Footfall” and “User Dwell
Time” per day.
This widget shows the calendar view of both “User Footfall” and “User Dwell
Time”.
In the settings,
There are options available to select the device type in the settings option, i.e either WIFI Device or Bluetooth device.
Option available for “Attributes” selection functionality, which basically filters users or client on the basis of the field selected.
Maps (20)
User Distribution FloorMap With Statistics
The widgets show the users present in different zones on the floormap. It also
shows additional data w.r.t the total visitors per day, as shown in figure
below.
Live User Heatmap
The presented widget is designed to visualize user footfall and density at a specific location. It includes various options to enhance the user experience and analysis:
Heat Map: This feature illustrates the density of users on the map, with high-density areas shown in red.
Zone Capacity: The floor map can be segmented into different zones, allowing users to examine footfall within specific areas.
Zone Capacity Key: This section provides percentage ranges (A, B, C, D, E, F) along with corresponding colors, representing different levels of user density in the zones.
Refresh Interval (sec): Users can set a time interval to automatically update the widget’s data, ensuring real-time information on user footfall.
Include Tags: This filtering option enables users to view footfall data for specific user groups based on tags, such as VIPs, staff, or students.
Exclude Tags: Similarly, this option allows users to filter out data for certain user groups, providing more focused footfall analysis.
Floor Switching: In case the location has multiple floors configured, users can easily switch between floors to analyze footfall on different levels of the building.
Overall, this versatile widget provides valuable insights into user footfall and density across the location while offering flexible customization options to cater to various analysis needs.
User TreeMap
In settings, select options for either Wi-Fi device or a Bluetooth device.
The user treemap shows the user count on each zone configured across the
floormap and its children on the basis of date we select.
We can see the user count of all divisions if we have more divisions on the floormap.
In settings, we also have the option “Attributes” selection functionality, which
basically filters users or client on the basis of the field selected.
User Distribution FloorMap
This is a view of different users present on the floormap based on different
parameters available in the search functionality options on this widget like
floormap, zones, heat map, access points, connected users, probing users,
bluetooth users, geolocated users only, group zone users, exclude passerbys.
In setting, we have option of “Refresh Interval(sec),” which refreshes the widget
on the basis of given time interval.
We also have the option of “include tags”, that filters on the basis of some tags
and also other option for “exclude tags”, that filters on the basis of the same
tags that are in the include tags.
User Counts By Location
In settings, select options for either a Wi-Fi device or a Bluetooth device.
This table shows the number of users seen at every zone on a selected date. You
can also select the time range to get more detailed information on the
footfall count.
Here are options available for “from date” and “to date” which takes dates
input in the range of 7 days for which we want to see the user counts.
The “Filter Zones” dropdown allows us to filter locations for which we want to
see user counts. The selection of “hours” gives user counts for particular
hour range. However, by default, it gives user counts for whole day (24 hours).
In settings, we also have the option “Attributes” selection functionality, which
basically filters users or client on the basis of field selected.
Location Occupancy Chart
The “Location Occupancy Chart” is a representation that provides an overview of the occupancy status of each zone within a specific location. This chart displays the occupancy on an hourly basis as a percentage of the total capacity for each zone, giving users a quick and clear understanding of how full each area is.
Important Features of the Location Occupancy Chart:
Zones: Each zone within the location is listed on the chart, along with their respective capacities. This information allows users to know the maximum number of users that can be accommodated in each area.
Occupancy Percentage: The chart shows the current occupancy of each zone as a percentage of its total capacity. This percentage is calculated by dividing the number of current users in the zone by its maximum capacity and then multiplying by 100.
Color Indicators: To provide a visual cue, the zones may be color-coded based on their occupancy status. For example, 0% indicates with no occupancy, and as percentage increase the color become darker. Making it easy to identify areas that are approaching or have reached their capacity.
By using the Location Occupancy Chart, users can make informed decisions regarding crowd management, resource allocation, and overall safety measures. It allows them to proactively address any potential issues related to overcrowding or underutilization in different zones, ensuring a smooth and optimized experience for all users within the location.
User Distribution Heatmap
This is a user distribution information, where you can view the user movements
from one to another throughout the day.
Zone Traffic On Floor Map
This widget shows the user flow/ traffic from one zone to another.
Site Traffic On Geo Map
The widget show the movement of users between different sites. It provides valuable insights into the flow of users from one site to another and allows users to monitor real-time traffic as well as view traffic data for specific dates using the “Live traffic” and “Custom” options.
Features of the Traffic Visualization Widget:
Traffic Flow between Sites: The widget presents a graphical representation of user traffic, showing the paths users take as they move from one site to another. This flow may be represented as arrows or lines connecting the sites.
Live Traffic: The “Live traffic” option enables users to view real-time data on user movement between sites. This provides an up-to-date and dynamic view of the current traffic patterns.
Custom Date Option: The “Custom” option allows users to select a specific date and view the traffic data for that particular day. This feature enables the historical analysis and comparison of traffic trends on different dates.
By using this Traffic Visualization Widget, users can gain valuable insights into user behavior, identify popular routes between sites, and make informed decisions regarding resource allocation and traffic management. The ability to view both real-time and historical data provides a comprehensive understanding of user movement patterns, helping to optimize operations and enhance the overall user experience.
Live User Movements on Floor Map
The live user widget shows the live movement of a user on the entire floormap.
Live User Movements Between Zone
The widgets shows the count of user footfall in each zone on the floormap.
Live User Heatmap On A Floor
Multi Sensor heatmap
The Multi-Sensor HeatMap widget in the side panel is a powerful tool that allows users to gain a comprehensive overview of various environmental and occupancy metrics within a particular area or building. Here’s a breakdown of the features and information provided by the widget:
Occupancy: This shows the real-time or historical data on the number of people present in the monitored space. It helps in understanding the occupancy patterns and trends.
Air Quality Index: This displays information about the air quality index within the zone.
Temperature: This presents the current temperature in the monitored space. Temperature levels can affect comfort and energy efficiency, making it essential to keep track of them.
Humidity: This indicates the humidity levels in the area. Monitoring humidity is crucial for maintaining a healthy indoor environment and preventing issues like mold growth.
Illuminance: This refers to the measurement of light intensity in the monitored space. It helps in understanding the lighting conditions and may be important for tasks that require specific lighting levels.
Meeting Room Availability: This feature shows the availability status of meeting rooms, indicating whether they are vacant or booked. It helps in finding available rooms quickly.
Top Busy Zone: This heatmap highlights the areas within the space that are most occupied or frequently used. Identifying the most busy zones can aid in space planning and resource allocation.
Sensor Information: This section provides detailed information from individual sensors placed in various locations within the monitored area. The information may include:
Occupancy: Sensor data on the number of people in specific zones or rooms.
Dwell Time: The average time people spend in specific areas, helping analyze user behavior and space utilization.
Users: Information about individuals present in the space, possibly linked to their profiles or devices.
Room Heatmaps: Visual representations of occupancy patterns and heatmaps for different rooms, indicating popular or less-used areas.
Temperature and Humidity: Detailed readings of temperature and humidity from individual sensors.
Illuminance: Specific light intensity measurements from sensors.
Live User Movements
Visualization displays user movements on a floor map in real-time on the
basis of different parameters present in the search functionality for this
widget, like zones, access points, probing users, Bluetooth users, exclude
passerby, show movements, and heatmap.
This widget allows searching for particular user movements on the basis of a Mac
address, name or tag.
The widget also consists of an option to “include tags” that filters on the
basis of some tags and another
Option, which is “exclude tags” that filters on the basis of same tags that are
in include tags.
Live User Path Movements
The live user path movement visualization widget is used for tracking and analyzing user activity on a floor map. It offers various features for customizing and filtering the displayed data. Let’s break down the main features of this widget. You can use filters like Zones, Probing Users, Bluetooth Users, and Exclude Passerby. Also, inside the bar you can filter the user as well.
Site Device Density Map
A consolidated view of device density across a site.
Live User Movements Between Zone Tags
In settings, select options for either a Wi-Fi device or a Bluetooth device.
This is a real-time visualization of user movement (in percentage) between zone tags on a selected location. Here we give some custom tags on zones and can view the user’s movements.
In this widget, we have the search filter “Filter Zones By Tags” and “Display Metric”.
Last Known Location on FloorMap
Locate any wi-fi or bluetooth device by displaying the last known location on a
floormap.
Here, we have “search user” functionality that allows to search a user by its
name or just entering Mac address of the device to be looked for on the
floormap.
Floormap Device Density
(..need to attach widget image)
A consolidated view of device density on a floormap
Dwell Time Map
This widget displays a map that shows users according to their dwell time on
the basis of time intervals and shows the users on the map with different
colours on the basis the given time intervals.
Dwell time is the amount of time that user spends in a particular location.
Allows you to select from “Map” view or “Satellite” view and in “Duration” we
can select the options like “Today”, “Yesterday” and “Custom” to show users
data accordingly. In “Custom” we can select date range (max upto 7 days) for
users.
On filling in all the required details, click on “load users” which gives all
users according to given time interval on the widget and on selected fields.
Matrix (2)
Multi-day Location Counts
Tabular representation of user distribution in different zones for the
selected date range.
Others (7)
RSS Feed
Add any RSS Feed to your dashboard with ease.
Site Reporting Dashboard
Site Reporting Dashboard with Key Elements
Rule Alarm
Display an alarm when a specified rule is triggered.
Cisco meraki Logs
(…need to attach widget image)
List of the each access points logs
Webpage
Add any external gadget/webpage to your dashboard with ease
Cisco Meraki clients details
List of the connected client devices for a specific network based on the SSID
that was chosen.
KPI
Display a list of KPIs for selected zones.
Path (7)
Path Distribution
Outbound User Traffic Flow
Path Distribution Matrix
Inter-Site Path Distribution
Inbound User Traffic Flow
Inbound User Traffic Flow
Outbound User Traffic Flow
Time (3)
Dwell Time Chart
Dwell time information for each zone on the site.
Dwell Time Chart By Attribute
(…Need to attach widget image)
A bar chart that displays a distribution of all the venues with respective
user dwell times.
Live Floor/Site Device Density
(…Need to attach widget image)
A Live Streaming Density of given Floor/Site
User (12)
Multi-Location Repeat Users
Zone wise user count information for the selected date range and zones.
User Overview
Select a zone for information on the Connected users and Probing users.
User 360
Every detail about the specific user registered in the system.
Heap Map
For a zone, shows the footfall in for every hour for the last 7 days. The
color code represents, darker the color, higher usercount.
User Details
Based on the users type selected, here, ‘Probing users’. Select a user to see
it’s more details like days seen, Last seen and the session summary as shown
in figure below.
User counts by presence attributes
This bar graph is a combined information of the probing users and associated
users in a zone for the selected time period.
Bluetooth Device Details
Similar to user details, shows summary of selected user.
User Demographics
More detailed information of the user such as contact details, login details,
etc as shown in figure below.
Inter-Site User Movements
Probing/Associated Users Chart
Graphical representation of the probing and associated users for a specific
zone.
Repeat Users
Graphical representation of the no. of repeated users in each zone.
Queue Wait Times
Coming Soon!
Camera (14)
Gender Demographics Calendar
This widget provides businesses with a calendar view of user gender data as
detected by cameras at a given location. By analyzing this data, businesses
can gain insights into the gender distribution of their customers and adjust
their marketing strategies accordingly.
Live User Heatmap From Camera On Floor Map
The widget produces a heatmap that illustrates the density of people in a
specific region, with darker colors indicating higher density and lighter
colors indicating lower density. The heatmap is updated in real-time, and the
widget also offers historical data. If desired, it is possible to obtain an
animated representation as well.
Note: To get this, an ROI (region of interest) needs to be drawn at the
point where the camera is added. Refer to the insights user manual to know how
to draw it.
Inbound Entity Traffic Flow
1. The “Inbound Entity Traffic Flow” widget is a powerful tool for visualizing the flow of entities from different zones into a specific zone. This widget generates a flow chart that illustrates the movement of entities, such as people, or vehicles, from their origin zones to selected zone.
2. Select Entity Type from the dropdown list then select Zones, Depth, and Date.
Path Distribution
The Path Distribution widget provides businesses with a chord diagram to
visualize the most common paths taken by users from and to any given location.
By analyzing this data, businesses can optimize product placements and signage
to increase sales.
Path Distribution Matrix
This widget shows the movement of an entity from one zone to another in the
form of a square chart and displays the entity count.
Outbound Entity Traffic Flow
The “Outbound Entity Traffic Flow” widget is a powerful tool for visualizing
the flow of entities from one specific zone to another zones. This widget
creates a flow chart depicting the movement of entities such as people, or
vehicles from a selected zone to another zone.
Camera Footfall Calendar
The Camera Footfall Calendar provides businesses with a calendar view of user
footfall at a given location. By analyzing this data, businesses can identify
peak traffic times and optimize staffing schedules accordingly.
Live User Movements From Camera On Floor Map
The Live User Movements From Camera On Floor Map widget displays a
visualization of user movements on a floor map in real-time. This widget can
help businesses optimize store layouts and staffing schedules to ensure that
customers have a positive shopping experience.
Camera Footfall Analytics
The Camera Footfall Analytics widget is a robust tool for businesses that
captures data on entry/exit count, and occupancy. The widget also generates a
bar chart that displays footfall information. You can select different cameras
from the dropdown list.
Live Video Stream with Analytics
The Live Video Stream with Analytics widget displays analytics from a selected
camera. It captures data on entry, exit, and occupancy, and providing insights
into how many people are entering and leaving a specific location, as well as
how many people are in the area at any given time.
Camera Characteristics Trends
The Camera Characteristics Trend widget is a powerful tool for businesses and
organizations looking to better understand the demographics of their customer
base or audience. By selecting specific demographic categories such as male,
female, mask, no mask, smile, or angry, the widget will generate a line chart
that displays trends in those characteristics over time.
Note: If you choose additional demographic categories, the X-axis will
expand to accommodate them.
Live Video Stream
The Live Video Stream widget displays a smooth live video stream from a
selected camera. This widget can help businesses monitor customer behavior in
real-time and make adjustments to their operations as needed.
Live Video Stream with Heatmap
The Live Video Stream with Heatmap widget displays a live video stream and
heatmap from a selected camera. This widget can help businesses monitor
customer behavior in real-time and make adjustments to their operations as
needed.
Camera Demographics Trends
The Camera Demographics Trends widget displays a timeseries chart showing the
trend of user demographics and camera feature analytics over a given time
period. This widget can help businesses identify trends and make data-driven
decisions.
Camera Occupancy Trends Over Time
This widget is a powerful tool that uses data from Kloudvision cameras to
track the occupancy levels of a queue over a given period of time. This widget
provides valuable insights about the overall efficiency of the queue
management system.
Live Camera Count Heat Map
The Live Camera Count Heat Map widget is a powerful tool that uses Kloudvision
cameras to display the total number of people in a zone. This shows how many
people were in a zone in the form of a heat map.
Live User Heatmap On A Floor Camera Image
The Live User Heatmap On A Floor Camera Image widget displays a visualization
of user movements on a camera image in real-time displayed in the form of a
heatmap. This widget can help businesses optimize store layouts and signage to
increase sales.
Entity Demographics
Entity Demographics widget provides a visualization of the distribution of
entities at a given location, including a brief summary of each entity’s
information. This widget can help businesses gain insights into the
demographics of their customers and adjust their marketing strategies
accordingly.
Outbound User Traffic Flow
The “Outbound User Traffic Flow” widget is a powerful tool for visualizing the
flow of entities from one specific zone to another zones. This widget creates
a dot chart depicting the movement of entities such as people, or vehicles
from a selected zone to another zone.
Inbound User Traffic Flow
The “Inbound User Traffic Flow” widget is a powerful tool for visualizing the flow of entities from different zones into a specific zone. This widget generates a dot chart that illustrates the movement of entities, such as people, or vehicles, from their origin zones to selected zone.
Select Entity Type from the dropdown list then select Zones, Depth, and Date.
Environmental Sensors (1)
Environmental Sensor Trends
A timeseries chart displaying a trend of air quality measurements of an
environmental sensor in a given time period
Reports
Overview
The reporting system allows report creation jobs to be scheduled for regular
execution with the results emailed to a set of recipients, and also has a file
transfer feature.
Reports display the essential findings of the platform in human-readable
manner. Reports can also be exported and printed for further use.
To generate a report, click on Report in the left-hand side menu.
To find out the types of reports generated, click on Report Types under
Reports.
Report Types
To generate a report, click on the Play button to the right of the
specific report type. We can run and generate the custom reports even by
uploading report definitions in the format of json or yaml by clicking on the
bottom left.
Select the parameters (e.g. Site ) under Report Parameters tab.
Click on Run Report to generate the report.
To find the history of generated reports, simply click on History under
Reports.
History
You can download the report by clicking the download button to the right
of the specific report. The report is downloaded in the PDF format. A sample
report is below:
You can also delete a specific report by clicking the delete button to the
right of the specific report.
Generating reports can be automated by scheduling them. To schedule a report,
click on Scheduled under the Report section.
Scheduled
To schedule a new report, click on + New Report in the top right of the page.
Enter the description of the report in Description field.
To enter the recipient’s details, click on Recipients.
Enter the email address (where the report will be sent) in the Email Recipients section.
Select the files to be sent in File Transfer.
To customize the schedule settings, go to the Schedule tab.
You can configure to run a report on weekly and monthly basis under Run
Report.
Alternatively, you can also schedule your reports to run on specific weekdays.
Simply check the boxes adjacent to the days when you want the report to run.
Specify the time when the report will run in the time section.
Report types
We have various report types within Insights currently shipped by default with
the system.
Below is a list of all the report types and the sample report for each.
Bluetooth Usage Report:
(for Bluetooth devices only)
This report contains details of devices connected via Bluetooth for the
selected date range and locations.
This report contains the details of devices connected via Bluetooth for the
selected locations and date range.
The report can be exported in CSV format. A sample Bluetooth Usage Report
looks like:
Select ‘run report’ and fill in the details below to run this report.
To run a report:
Click on the play button at the right end of the report row.
A pop-up appears.
Select the locations in the Locations dropdown.
Choose the period for which the report is generated by selecting DATERANGE i.e. f rom and t o- dates .
Check the TAGGED box if you want to run a tagged report.
Click on Run Report to generate the report.
Devices by day
(for Wi-Fi devices only)
This report contains the information of wi-fi devices seen for the selected
dates in CSV format.
To run a report:
Click on the play button at the right end of the report row.
A pop-up appears.
Check the Date Range under Report Parameters.
Select f rom and t o- dates.
To include only the data for known devices, check the KnownDevicesOnly.
Click on Run Report to generate the report.
Here is how a sample report looks like.
Devices Daily History
( for WiFi devices only )
This report generates a CSV containing information about device history by day
for selected locations and a date range.
To run a report:
Click on the play button at the right end of the report row.
A pop-up appears.
Check the Date Range under Report Parameters.
Select the starting time of the day in the START OF THE DAY section.
Select the locations by clicking on the drop-down menu under LOCATIONS.
Click on Run Report to generate the report.
Here is how a sample report looks like.
Devices in specific time and location
( for Wi-Fi devices only )
This report generates a CSV containing information of devices seen by day for
a date range and time on a selected site.
To run a report:
Click on the play button at the right end of the report row.
A pop-up appears.
To select the date range for which the report is needed, enter the From and To dates under Report Parameters.
To get the report for only the registered users, check the box next to Registered User.
To get the report for only the known devices, check the box next to Known Devices Only.
Select the location by clicking at the drop-down menu below Locations.
To get the report for users with email, check the box next to User With Email.
Click on Run Report to generate the report.
Here is how a sample report looks like.
Footfall and dwell
( For WiFi devices only )
This report will generate a CSV containing information of footfall and dwell
of devices for selected locations on a daily and an hourly basis.
To run a report:
Click on the play button at the right end of the report row.
A pop-up appears.
Select the location from the the drop-down options below LOCATIONS under Report Parameters.
To show the dwell report, check the box adjacent to SHOWDWELL.
Check the box before Select Date Range. Enter the date range by choosing the From and To dates below DATERANGE.
Select the tags that the report should include by choosing from the drop-down menu under INCLUDETAGS.
Select the tags that the report should exclude by choosing from the drop-down menu under EXCLUDETAGS.
Click on Run Report to generate the report.
Here is how a sample report looks like.
Footfall and dwell by day
Footfall and dwell by hour
Highs and lows by footfall and dwell
( For WiFi devices only )
Report of locations having highest and lowest footfall and dwell based on the
selected zone limit.
The following figure is a sample of the 4 different types of reports generated
as follows:
Bottom zones of the day by dwell
Bottom zones of the day by footfall
Top zones of the day by dwell
Top zones of the day by footfall
Monthly site report
(For WiFi devices only)
This report contains Information about the selected site for the entire
month.
To run a report:
Click on the play button at the right end of the report row.
A pop-up appears.
Select the site for the monthly report by clicking on the drop-down menu under Report Parameters.
Click on Run Report to generate the report.
Here is how a sample report looks like.
NOTE: Will provide a link to the entire sample PDF report.
Movement CSV report
(For WiFi devices only)
This report contains a report showing top movements into and out of zones
for a list of selected zones.
To run a report:
Click on the play button at the right end of the report row.
A pop-up appears.
Check the Select Date box under Report Parameters to enable selecting the date. Choose the date by
clicking at the calendar icon, or
Entering the date manually in YYYY-MM-DD format.
Click on Run Report to generate the report.
Here is how a sample report looks like.
Movement CSV report- 30 minutes
(For WiFi devices only)
This report contains a report showing top movements into and out of zone for
a list of zones every 30 minutes.
Sample Movement CSV report for 30 minutes: Need to attach figure below showing
a sample Movement CSV report.
Image…
Movement report
(For WiFi devices only)
This report contains the PDF Report showing top movements into and out of
zones for a list of selected zones.
To run a report:
Click on the play button at the right end of the report row.
A pop-up appears.
Select the type of report by clicking at the Report Template drop-down options.
Select the locations for which the report is to be generated by clicking at the LOCATIONS drop-down menu.
Select the date range under Report Parameters by
Clicking on the calendar icon, or
Entering the date manually in YYYY-MM-DD format.
Click on Run Report to generate the report.
Here is how a sample report looks like.
Overview Report
(For WiFi devices only)
This report contains a Report showing device information for the selected day
and the previous week.
To run a report:
Click on the play button at the right end of the report row.
A pop-up appears.
Select the type of report by clicking on the Report Template drop-down options.
Select the locations for which the report is to be generated by clicking at the LOCATIONS drop-down menu.
If you want to generate the report for each location, check Each Location under Report Parameter.
Choose the date of the report under Report Date by
Clicking at the calendar icon, or
Entering the date manually in YYYY-MM-DD format.
Click on Run Report to generate the report.
Sample Overview report
The figure below shows a sample overview report in a PDF format.
NOTE: Will provide link the entire sample PDF report.
Overview (previous day)
(For Wi-Fi devices only)
This report shows device information for the previous day
and week.
To run a report:
Click on the play button at the right end of the report row.
A pop-up appears.
Click on Run Report to generate the report.
Sample Overview report: The device information for this report is the same as
the Overview report, except that it has Overview information for the previous day.
Overview and Social
(For Wi-Fi devices only)
Report showing overview of user and social data for the selected day and the
previous week.
To run a report:
Click on the play button at the right end of the report row.
A pop-up appears.
Select the desired template from the drop-down options below Report Template.
Select the locations for which the report is to be generated by clicking at the LOCATIONS drop-down menu.
If you want to generate the report for each location, check Each Location under Report Parameter.
Select the tags that the report should include by choosing from the drop-down menu under INCLUDETAGS.
Select the tags that the report should exclude by choosing from the drop-down menu under EXCLUDETAGS.
Choose the date of the report under Report Date by
clicking at the calendar icon, or
Entering the date manually in YYYY-MM-DD format.
Click on Run Report to generate the report.
Sample Overview and Social Report: The figure below shows a sample Overview
and Social Report in a PDF format, there are different reports generated for
various zones within the site. Following is a sample report in pdf format.
NOTE: Will provide a link to the entire sample PDF report.
Overview- Period
(For WiFi devices only)
This report contains the Reports showing overview of device and user data for
the selected period.
To run a report:
Click on the play button at the right end of the report row.
A pop-up appears.
Click on Run Report to generate the report.
Sample Overview-Period Report: The report for Overview-period report in a PDF
format is same as that of the ‘Overview’ report as shown above.
Other Information
The other information section provides valuable insights into areas such as the audit log system and the overall health status of KloudInsights.
All security related operations are logged to the database.
Logging
This screen provides control over the application log levels.
System Health
This screen provides an overview of the ‘heath’ of the system including:
Health of the main components.
Version of the application
License Status
Face Recognition System (FRS)
Overview
The Face Recognition System (FRS) is a powerful feature integrated with KloudVision that enables seamless entry and exit to premises using facial recognition technology. This document provides an overview of the registration and instructions on how to customize and utilize it effectively within your system.
It consists of six key steps that ensure optimal performance and functionality.
Step 1: Configure FRS Camera
Before setting up the Facial Recognition System (FRS) in KloudInsights, it’s essential to configure the camera intended for FRS integration. This process is facilitated through KloudVision, enabling seamless setup and alignment of your chosen camera for optimal FRS functionality.
Step 2: Customize FRS Workspace Settings to Suit Your Needs
To make the FRS align with your specific requirements, it is essential to customize the workspace settings. This step allows you to configure various options and features, tailoring the system to your desired specifications. By accessing the FRS workspace settings, you can enable or disable specific functionalities.
Step 3: User Management and Invitation
Efficient user management is critical for the smooth operation of the FRS. This step provides instructions on how to manage users effectively and send invitations for FRS registration. Additionally, the document explains two methods for user invitation:
Bulk FRS Registration: This method allows you to send registration links to multiple users simultaneously. It is particularly useful when onboarding a large number of users.
Individual User Invitation: With this method, you can send personalized invitation links to specific individuals, enabling a more targeted approach to user registration.
Step 4: Face Registration Process for Users
At this stage, users have the opportunity to register their faces using the unique link received in the email invitation. Following the instructions provided, users can seamlessly provide the necessary images for registration. By adhering to these instructions, users can ensure the successful enrollment of their facial data, enabling a smooth and reliable check-in and check-out process within the system.
Step 5: Human Management
As users successfully complete their registration in the FRS (Facial Recognition System), they are automatically added to the Human section. This section serves as a comprehensive repository of all registered users, providing essential information about each individual, including their identity, first name, last name, email ID, tags, namespace, image, ID image, and status.
Step 6: User Check-in and Check-out
During this stage, when a user enters or exits a designated location, their face is automatically detected and matched with the entries in the FRS database. The system records the exact entry and exit times for each user, ensuring accurate check-in and check-out data is maintained. This seamless process not only enhances security measures but also enables efficient monitoring and management of user movements within the specified area.
Step 7: Tracking Check-In and Check-Out Status with the Widget
To efficiently monitor the check-in and check-out activities of users, the FRS provides a widget that displays summarized information. This step guides you on how to utilize the widget effectively. By using the widget, you can track the real-time status of users, view their check-in and check-out times, and quickly identify any discrepancies or unusual patterns. The widget serves as a convenient tool for monitoring and managing user activity, ensuring the smooth operation of the FRS.
To know the camera specifications suitable for face recognition, refer to the System Requirements document.
Step 1: Configure FRS Camera
Facial Recognition System (FRS) functionality within KloudInsights requires configuration of the FRS cameras.
If you’re already a KloudVision user, proceed to log in using your credentials.
If you do not have KloudVision access, contact Kloudspot’s support
team to obtain the necessary access credentials.
Once logged into KloudVision, refer to the FRS configuration document. This document provides detailed instructions on configure the FRS cameras.
Step 2: Customize FRS Workspace Settings to Suit Your Needs
Note: To proceed with these steps, make sure you have access to your KloudInsights account.
Once logged in, navigate to the Configuration menu. You can find it in the menu bar of the KloudInsights dashboard.
From the Configuration menu, select “FRS Settings.” This will open the FRS Workspace Settings page.
On the FRS Settings page, you will see a General Settings section. This section contains six customizable options. Let’s go through each option:
a. Approval needed for Employee Registrations: Enable this option if you want the admin to approve newly registered employees before activating their face ID. If this option is disabled, employee registrations will be automatically activated.
b. Approval needed for Guest Registrations: Enable this option if you want the admin to approve newly registered guests before activating their face ID. If this option is disabled, guest registrations will be automatically activated.
c. ID Card upload needed: If you enable this option, registered users will be prompted to upload their ID card during the face registration process. Face registration will only be activated if the user provides the ID card.
d. Auto check-in: Enable this option if you want registered users to be able to check in to a premise using their face without any physical contact. Enabling this feature allows for a touchless check-in process.
e. Send FRS Self-Registration email for new users: By enabling this option, the FRS Self-Registration email will be automatically sent to newly added users. This email contains instructions and a registration link for users to complete their face registration process.
f. Send Notifications on Face Match: Enabling this option allows you to receive notifications whenever there is a face match in the FRS. This can help you stay informed about potential security events or user activities. Provide the email address in the corresponding field where you want to receive these notifications.
After configuring the desired settings, click on the “Save” button to save the changes you made to the FRS Workspace Settings.
Step 3: User Management and Invitation
Note: Before proceeding, ensure that you have configured the FRS Workspace Settings as per your requirements.
From the menu bar, go to Configuration and select “Users”. This will redirect you to the User Management page.
On the User Management page, you have two options to send the FRS registration links: Bulk FRS Registration and Individual User Invitation.
a. Bulk FRS Registration:
Locate the “Bulk FRS Registration” option on the User Management page.
Click on the option to initiate the process of sending invitation links to all users simultaneously.
This method is useful when you want to send registration links to multiple users at once.
b. Individual User Invitation:
On the User Management page, find the user whom you want to invite for FRS registration.
Locate the FRS registration icon (usually represented by a human symbol) located on the left side of the user’s profile.
Click on the FRS registration icon to access the individual user invitation option.
This method allows you to send personalized invitation links to specific individuals.
Step 4: Face Registration Process for Users
By following below steps, users can successfully complete the face registration process. The provided information and captured images will be used for check-in and Check-out purposes within the system. This enhances the accuracy and reliability of the face recognition system.
Note: Users should have received an invitation email with a registration link before proceeding with the face registration process.
Once users receive the invitation email with the registration link, they should click on the provided link. This will redirect them to the registration page.
On the registration page, users need to provide their personal details. Typically, this includes entering their name and any additional information specified by the system. Fill in the required fields accordingly.
Users may also have the option to add tags that describe their profile or interests. This is an optional step to enhance their profile information.
After providing the required information, users can proceed to the next step by clicking on the “Next” button.
In the registration process, users may be prompted to capture a series of pictures for further verification or identification purposes. Look for a camera icon or similar indication.
Click on the camera icon to initiate the image capture process. Users should take 5 pictures of good quality, ensuring clear and well-lit images.
Once the user has given the images as per the given instructions, they can proceed to the next step by clicking on the “Next” button.
To finalize their registration, users should click on the “Submit” button.
Step 5: Human Management
As users successfully complete their FRS (Facial Recognition System) registration, they are added to the Human section. The Human page serves as a comprehensive repository of registered users, providing essential information about each individual. This includes their identity, first name, last name, email ID, tags, namespace, image, ID image, and status. The Human section plays a vital role in maintaining and organizing user profiles within the FRS. By accessing this page, administrators can effectively manage and monitor registered users, ensuring accurate identification and facilitating seamless interactions within the system.
Human Activation and Deactivation
To activate a user, navigate to “Human” page from the KloudInsights application.
Then, find the corresponding user in the list and click on the Activate button.
To deactivate a user, find the corresponding user in the list and click on the deactivate button.
Activation grants access to the system and its functionalities, while deactivation temporarily restricts access.
Add a New Human
An admin can manually register a user’s face other than through the registration link.
Navigate to the Human page within the KloudInsights.
On the Human page, locate the “New Human” button and click on it. This will open the “Create or edit a Human” popup window.
In the “Create or edit a Human” window, provide the necessary information about the new user. This typically includes identity details, such as first name, last name, and email ID. Fill in the required fields accordingly.
Next, you need to upload images of the user’s face. Click on the “Upload Image” button within the “Create or edit a Human” window. This will open a file selection dialog.
Select the images you want to upload for the user’s face. It is recommended to capture images from at least five different angles to ensure accurate facial recognition. These angles may include front-facing, left profile, right profile, top, and bottom views.
Once you have selected the images, click on the “Save” button to save the new human profile with the associated images.
The system will process the uploaded images and add the new human to the FRS database. The user will now be available for identification and verification through facial recognition.
Human Bulk Upload
This section provides detailed steps to efficiently perform a bulk upload of human profiles in the FRS
(Facial Recognition System). This feature streamlines the registration of multiple users, enhancing the
effectiveness of the FRS within your system. The process consists of three main steps.
Step 1: Collect the User Image
Before initiating the bulk upload process, ensure you have images of individuals from five
different angles for accurate facial recognition.
Save these images in separate folders, with each folder containing images of a specific person.
Consider naming each folder according to the person added to it (e.g., name of the user, email
ID, employee ID, etc.).
Create a common folder where you will consolidate these individual folders.
Step 2: Upload Images to FRS Human Page
Log in to your KloudInsights account and navigate to the Humans page.
On the Humans page, locate the “Upload” button and click on it to open the “Upload Images”
popup window.
In the “Upload Images” popup window, click on the “Choose file” button and navigate to the
common folder where you have saved the individual image folders.
Select the common folder, which contains the individual folders named after the respective
individuals.
In addition to image upload, provide additional details for the bulk upload. Select the
appropriate “namespace” and “tag” that you want to assign to the uploaded human profiles.
In the “Type” field, select the “Known Humans” option to indicate that these individuals are
already known, and their profiles should be created based on the uploaded images.
Click on the “Upload” button to initiate the bulk upload process. The system will process the
images and create individual human profiles.
Step 3: Upload a CSV File with Information
After adding the required images to FRS, proceed to upload the CSV file containing additional
metadata.
Click on the “Upload CSV” button from the Humans page. In the Upload Metadata popup
window that opens, click the “Download a sample CSV” button to download the sample CSV
file.
Populate the CSV file with the required information:
a. Add first name, last name, full name, email Address, tags, and namespace in their
respective columns.
b. Enter the unique folder name (where the user’s image has been added) in the identity
column.
Save this CSV file. Upload the CSV file by clicking the “Choose File” button in the Upload
Metadata popup window.
The information provided in the CSV file will be associated with the uploaded images.
The FRS will utilize this information for recognition. When individuals in the uploaded images are
detected by the camera, their entry and exit will be recorded.
Step 6: User Check-in and Check-out
There are three methods available for users to perform check-in and check-out. To know the camera specifications suitable for face recognition, refer to the System Requirements document.
Check-in and check-out using the kiosk.
Check-in and check-out using the camera.
Seamless entry and exit.
Check-in and check-out using the kiosk.
Note: Ensure that the kiosk or tablet is properly set up and connected to the FRS system before proceeding with the check-in and check-out process.
Position the kiosk or tablet at the entry gate where users will perform the check-in and check-out process.
Prompt the user to stand in front of the kiosk or tablet, ensuring that their face is properly positioned within the camera’s view.
The FRS system will automatically scan the user’s face and compare it with the faces in the FRS database to find a match.
If the user’s face matches a face in the FRS database, it indicates a successful match, and the check-in process can proceed. If there is no match, the user may not be registered in the system or may need further verification.
To perform the check-in process, instruct the user to tap on the check-in button displayed on the kiosk or tablet’s interface.
Once the user taps the check-in button, the system will record the check-in time and update the user’s check-in status accordingly.
For the check-out process, instruct the user to tap on the check-out button displayed on the kiosk or tablet’s interface.
When the user taps the check-out button, the system will record the check-out time and update the user’s check-out status accordingly.
Check-in and check-out using the camera.
Users can easily perform check-in and check-out using a camera installed at the entry gate, integrated with the FRS.
Install the camera at the entry gate in a position that allows it to capture the faces of users as they approach.
Ensure that the camera is connected to the FRS system and properly configured to perform facial recognition.
When a user comes in front of the camera, the camera will automatically scan their face.
The FRS system will compare the scanned face with the faces stored in the FRS database to find a match.
If the user’s face matches a face in the FRS database, it indicates a successful match, and the check-in process can proceed. If there is no match, the user may not be registered in the system or may need further verification.
If an auto-open door or other security system is installed, it can be triggered at this point to allow access for the checked-in user.
The FRS system will record the check-in time and update the user’s check-in status accordingly in the system.
Similarly, for the check-out process, instruct the user to approach the camera again to have their face scanned.
Once the user’s face has been scanned, the FRS system will compare it with the faces stored in the FRS database to find a match.
The FRS system will record the check-out time and update the user’s check-out status accordingly in the system.
Seamless entry and exit.
Users can achieve seamless entry and exit using cameras placed at the entry gate and exit gate.
Place cameras at both the entry gate and exit gate in positions that allow users to capture their faces as they approach.
Ensure that the cameras are connected to the FRS system and properly configured for facial recognition.
As a user approaches the entry gate, the camera placed there will automatically scan their face.
The FRS system will compare the scanned face with the faces stored in the FRS database to find a match.
If the user’s face matches a face in the FRS database, it indicates a successful match, and the check-in process can continue.
In this case, there is no need for a security check or any other obstacles. The user can check in seamlessly.
The FRS system will record the check-in time and update the user’s check-in status accordingly in the system.
Similarly, when the user approaches the exit gate, the camera placed at the exit gate will automatically scan their face.
The FRS system will compare the scanned face with the faces stored in the FRS database to find a match.
If a match is found, it indicates a successful match for check-out.
The FRS system will record the check-out time and update the user’s check-out status accordingly in the system.
Step 7: Tracking Check-In and Check-Out Status with the Widget
To efficiently monitor and view the check-in and check-out status of all users, a dedicated widget is available. The widget offers a convenient and summarized display of users’ check-in and check-out information. Below is an example of how the widget might appear:
For guidance on creating a dashboard and adding a widget to it, refer to the “Creating Dashboards” document.
The widget showcases essential details, such as usernames, identity, direction, Time, and location. With this simplified presentation, administrators can easily track user movements and identify any anomalies or discrepancies.
KloudBot
KloudBot, the latest addition to our suite of tools, revolutionizes how you access and interact with Kloudspot’s advanced analytics and insights. Seamlessly integrated with Microsoft Teams, KloudBot brings real-time information about device locations, points of interest, footfall summaries, and dwell time directly to your fingertips. Whether you’re a team manager, project overseer, or simply need to stay in the loop with your organization’s operations, KloudBot empowers you to make informed decisions swiftly and efficiently. Discover a new level of efficiency and clarity in your workflows with KloudBot.
1. Once logged in to Microsoft Azure. Search for Azure Bot in the search bar on the home page.
2. Select the Azure Bot option from the search result.
3. Then fill in the information in the window that opens as shown in the
picture and click the Review + create button.
4. You can select a resource group location according to your location.
5. On the next page, make sure the information entered is correct and click
the Create button.
6. After a short loading, you will get the message your deployment is
complete.
7. Then click on Go to resource button to open the resource.
8. Then add an Icon in the Bot profile menu and click Apply button.
9. Then go to the Configuration menu and fill in all the information.
Messaging endpoint: This is the URL from Kloud insights. Now leave it
blank. Check the Configure the KloudBot in KloudInsights. section to know more
about this.
10. Then click on the Manage button. It will guide you to the
certificates and secret page. Here you can create a new client secret.
11. The App ID will be generated automatically in the Microsoft App ID
column.
Note: The App ID will need to be entered into KloudInsights later, so
copy and paste it somewhere for later use.
12. Create a new client secret by clicking on the +New Client secret
button.
13. Then enter a description and choose an expiry month. Then press
the Add button.
14. New client secret is created successfully.
15. Then copy the Value from the new client secret and paste it somewhere
else for later use.
16. Next click on the Add OAth Connection Settings.
17. On the new connection settings page that opens, enter the Name and
select Azure Active Directory v2 as the service provider.
18. Copy and paste the Client ID and Client secret received while
registering the app here. Client ID and Client secret are obtained from the
App. Check the Register an App section to know how to get it.
19. Tenant Id will be common.
20. Copy and paste the following scopes in the scope column.
5. Application (Client) ID can be obtained from the window that opens
immediately after registration. Copy it and paste it somewhere for later use.
Create a new client secret
1. Next, we need the client secret, for that, navigate to Certificates and secrets > + New client secret.
2. Then enter a description and choose an expiry month. Then press
the Add button.
3. Then copy the Value from the window that opens and paste it somewhere
else for later use. This is the secret key.
Add an API permission
1. Next, API permissions should be given to the application by navigating to API permissions > +Add a permission > Microsoft graph.
2. Under the Delegated permissions window, allow all the permissions in the
OpenId permissions, calendars, chat, and contacts sections as shown in the
figure.
3. Then click on the Add permissions button.
Set App Id URI
1. Click the Set button from the Expose an API window to generate the App ID URI.
2. Click the Save button to save the Application ID URI.
Add a scope
1. Navigate to Expose an API > +Add Scope to add a new Scope. Then fill the Add a scope window as shown in the figure. Then click the add scope button to save the scope.
Configure the KloudBot in KloudInsights.
1. log in to KloudInsights and Navigate to settings >API Keys.
2. In the API Keys window that opens, click on the +New API Key button.
3. In the popup window, select Administrator from the Role list and click
the Add Key button.
4. New ID and Secret key are created. Then copy the ID and Secretkey from the API Keys and paste it somewhere else for later use.
5. Then navigate to Configuration > Integrations > Applications.
6. Scroll down and find the Teams App Settings.
7. Enter the Name, Language, and connection name and select the
capabilities.
8. You can select capabilities based on requirements.
9. Enter the Microsoft App ID and secret ID obtained when the Azure bot
was created in the Bot Id and Bot password columns. Refer Create an Azure
bot section for more details
10. Enter the ID and secret Key obtained from the API Keys in the API
Client ID and API client Secret columns.
11. Finally click on the Save button to save changes.
12. Immediately you will get the messaging endpoint URL.
13. Return to the Azure portal and paste the messaging endpoint URL into the
Messaging endpoint column.
14. Click the Apply button to save the changes.
15. Then go to the Test In Web Chat menu and check that the app is
working properly.
16. If the app is working properly, the next step is to integrate it into the
teams app.
17. To do so, navigate to Channels menu and Select the Web Chat
option from the channel list that opens.
Note: If you are opening the Channel menu for the first time, the Web
Chat Channel will be in the Available channels list.
18. Select the Default Site option. Then, in the new window, check the
Enable Preview and Block attachment upload from user checkboxes then
click the Apply button.
19. Return to the Channel menu and click on the Microsoft Teams
channel.
20. Immediately the terms of service popup window will open, check the
checkbox, and click the Agree button.
21. In the window that opens, on the Messaging tab, check the Microsoft
Teams commercial(most common) check box and click the Apply button.
22. Your application is successfully integrated into Teams App.
Add KloudBot to Teams App
1. First, download the app from KloudInsights. For that. Login to the KloudInsights.
2. Then navigate to Configuration > Integrations > Applications.
3. Scroll down and find the Teams App Settings.
4. Download the App by clicking the Download App button.
5. Then open teams App and navigate to Apps > Manage your apps > Upload an
app.
6. Select Upload a custom app option and then upload the App downloaded
from Insights.
7. Your app has been successfully added to Teams
KloudBot User Guide
Introduction
With Kloudspot, you can now easily access real-time information about device
locations, points of interest, footfall summaries, and dwell time summaries
through your Microsoft Teams app, whether you are using it on your mobile
device or on the web. This integration allows you to interact with Kloudspot’s
advanced analytics and insights directly from your Teams platform, enabling
you to make informed decisions quickly and efficiently. Whether you’re
managing a team, overseeing a project, or simply need to stay up-to-date with
your organization’s operations, this integration offers a seamless way to
access valuable data and insights.
Find My Kloudspot
1. Open the Teams app.
2. Click the more button from the menu bar.
3. The Popup window will open with the search bar.
4. Search for My Kloudspot and click on It.
5. My Kloudspot window will open.
6. Click Add button to add the My Kloudspot.
7. My Kloudspot Analytics Bot is successfully added to the Teams app.
Getting started
1. As soon as you add KloudBot, a window will open with the key information.
2. You can click on each button to learn about what are the keywords under the function.
Note:User search and Upcoming Meetings are not clickable, check
the Get information about a User and Get Upcoming Meetings details sections
for how to use this.
Find
1. Click on the Find Button.
2. A popup button will open with more information. The find command is used to find someone with the help of the Device he uses.
Commands
Use
Find < Name>
You can locate a device on a map for example: find john : Gives the last known location of the devices that match the keyword ‘john’
AP Status
1. Click AP Status.
2. A popup button will open with more information. This gives you a list of currently available APs and their status.
Commands
Use
apstatus
Gives a list of all APs along with their statuses
apstatus up
Gives a list of all APs that are currently up
apstatus down
Gives a list of all APs that are currently down
apstatus
Gives the status of a particular AP
Location
1. Click on Location.
2. This gives you information about Location List, Footfall, Dwell time, heatmap, user chat, footfall calendar, path distribution, outbound traffic, inbound traffic, dwell time chart, repeat user chart, camera demographics chart, camera occupancy chart, live feed, and the rest.
Commands
Use
location
Gives a list of all locations in the system
location list
Gives a list of all locations in the system
location show
Gives a list of all locations in the system
location print
Gives a list of all locations in the system
location 1
Gets information about the 1st location in the list
location 1 footfall
Get the last 5 mins footfall information for the 1st location in the list
location 3 dwelltime
Get today’s average dwell time for the 3rd location in the list
location 3 heatmap
Get the heatmap for the given location (typically used for floors)
location 3 userchart
Displays a chart that shows the guest and connected device counts at the location
location 3 footfallcalendar
Displays a calendar view of the device counts by day
location 3 pathdistribution
Displays the traffic flow from each zone to all the other zones at a given location
location 3 outboundtraffic
Displays the outbound traffic flow at a given location
location 3 inboundtraffic
Displays the inbound traffic flow at a given location
location 3 dwelltimechart
Displays a chart that shows the average dwell times of all the zones within the selected location
location 3 repeatuserchart
Displays a chart displaying the count of repeat users on a per-zone basis at any location
location 3 camerademographicschart
Displays a chart of demographics captured by KloudVision Cameras
location 3 cameraoccupancychart
Displays camera-based occupancy metrics at a given location
location 3 livefeed
Shows a real-time snapshot of the feed from the camera at the given location
Find a device
1. In the chat box, type the keyword of the device you want to find along with the find command. Waite for some seconds.
For example: Find Ravi
2. The last active location of the device with the keyword we entered will be
displayed in the chat as a map.
3. Click on the More Details button to get more details about the
location.
4. To find out who is likely to come into contact with that person, click the
Contact Tracing button.
Get AP Status
Find AP list with the status
1. To get the full list and status of available APs, enter the command apstatus in the chat box and hit the enter key.
2. A list of current APs will be sent in reply.
3. Click on the Ap status up button to get a list of APs that are
currently Up.
4. Click on the Ap status Down button to get a list of APs that are currently
down.
Find AP list with the UP status.
1. To get information about the APs currently in UP status, type the command apstatus up in the Chat box and hit enter key.
2. A list of APs in up status will be sent in reply.
3. Click on the Ap Status Up button to get a list of APs that are
currently Up.
4. A popup window will appear with the MAC number of the currently active
access points and the last time the information was collected.
Find AP list with the Down status
1. To get information about the APs currently in down status, type the command apstatus down in the Chat box and hit enter key.
2. A list of APs in down status will be sent in reply.
3. Click on the Ap Status down button to get a list of APs that are
currently down.
4. A popup window will appear with the MAC number of the currently inactive
access points and the last time the information was collected.
Find the status of a specific AP.
1. To know the status of a particular access point, enter the command ( apstatus )> MAC address in the chat box and hit the enter key.
For example:apstatus 00:04:56:a6:5c:25
2. status will be sent in reply.
3. Click on the Ap Status Up button to get the MAC number and the last
time the information was collected.
Get information about a Location.
Get location list.
1. To get a list of available locations, enter any of the following commands in the chat box and hit Enter key.
location
location List
location show
location print
2. Available locations and their number will be available as a replay for the
chat.
Get information about a specific location.
1. Type location > location number to get information about a specific location.
For example:- location 1 (In this case, to get information about Sunnyvale
location, use its serial number 1)
2. Location information will be available as a replay for the chat.
Get footfall information.
1. Type location > location number> footfall to get Footfall information about a specific location.
For example:- location 1 footfall
Note: Provides footfall information for the last 5 min at a specific
location.
2. Information will be available as a replay for the chat.
Get dwell time information
1. Type location > location number>dwelltime to get dwell time information about a specific location.
For example: - location 3 dwelltime
Note: Get today’s average dwell time for the 3rd location in the list.
2. Information will be available as a replay for the chat.
Get heatmap
1. Type location > location number>heatmap to get heatmap for a specific location.
For example: - location 1 heatmap
Note: Get the heatmap for the given location (typically used for floors).
2. Information will be available as a replay for the chat.
3. Click the More Detail button for more information.
4. To display information to the nearest display terminal, click on the
Publish on Display Terminal button in the popup window that opens.
5. Then select the display.
Get user chart
1. Type location > location number>userchart to get a user chart for a specific location.
For example: - location 1 userchart
Note: Displays a chart that shows the guest and connected device counts
at the location.
2. Information will be available as a replay for the chat.
3. Click the More Detail button for more information.
4. To display information to the nearest display terminal, click on the
Publish on Display Terminal button in the popup window that opens.
5. Then select the display.
Get footfall calendar
1. Type location > location number>footfallcalendar to get footfall calendar for a specific location.
For example: - location 1 footfallcalendar
Note: Displays a calendar view of the device counts by day.
2. Information will be available as a replay for the chat.
3. Click the More Detail button for more information.
4. To display information to the nearest display terminal, click on the
Publish on Display Terminal button in the popup window that opens.
5. Then select the display.
Get path distribution
1. Type location > location number>pathdistribution to get path distribution for a specific location.
For example: - location 1 pathdistribution
Note: Displays the traffic flow from each zone to all the other zones at
a given location.
2. Information will be available as a replay for the chat.
3. Click the More Detail button for more information.
4. To display information to the nearest display terminal, click on the
Publish on Display Terminal button in the popup window that opens.
5. Then select the display
Get outbound traffic
1. Type location > location number>outboundtraffic to get outbound traffic for a specific location.
For example: - location 1 outboundtraffic
Note: Displays the outbound traffic flow at a given location.
2. Information will be available as a replay for the chat.
3. Click the More Detail button for more information.
4. To display information to the nearest display terminal, click on the
Publish on Display Terminal button in the popup window that opens.
5. Then select the display.
Get inbound traffic
1. Type location > location number>inboundtraffic to get inbound traffic for a specific location.
For example: - location 1 inboundtraffic
Note: Displays the inbound traffic flow at a given location.
2. Information will be available as a replay for the chat.
3. Click the More Detail button for more information.
4. To display information to the nearest display terminal, click on the
Publish on Display Terminal button in the popup window that opens.
5. Then select the display.
Get dwell time chart
1. Type location > location number>dwelltimechart to get dwell time chart for a specific location.
For example: - location 1 dwelltimechart
Note: Displays a chart that shows the average dwelltimes of all the zones
within the selected location.
2. Information will be available as a replay for the chat.
3. Click the More Detail button for more information.
4. To display information to the nearest display terminal, click on the
Publish on Display Terminal button in the popup window that opens.
5. Then select the display.
Get repeat user chart
1. Type location > location number>repeatuserchart to get repeat user chart for a specific location.
For example: - location 1 repeatuserchart
Note: Displays a chart showing the number of repeat users per zone at any
location.
2. Information will be available as a replay for the chat.
3. Click the More Detail button for more information.
4. To display information to the nearest display terminal, click on the
Publish on Display Terminal button in the popup window that opens.
5. Then select the display.
Get camera demographics chart
1. Type location > location number>camerademographicschart to get camera demographics chart for a specific location.
For example: - location 1 camerademographicschart
Note: Displays a chart of demographics captured by KloudVision Cameras.
2. Information will be available as a replay for the chat.
3. Click the More Detail button for more information.
4. To display information to the nearest display terminal, click on the
Publish on Display Terminal button in the popup window that opens.
5. Then select the display.
Get camera occupancy chart
1. Type location > location number>cameraoccupancychart to get camera occupancy chart for a specific location.
For example: - location 1 cameraoccupancychart
Note: Displays camera-based occupancy metrics at a given location.
2. Information will be available as a replay for the chat.
3. Click the More Detail button for more information.
4. To display information to the nearest display terminal, click on the
Publish on Display Terminal button in the popup window that opens.
5. Then select the display.
Get live feed
1. Type location > location number>livefeed to get live feed for a specific location.
For example: - location 1 livefeed
Note: Shows a real-time snapshot of the feed from the camera at the given
location.
2. Information will be available as a replay for the chat.
3. Click the More Detail button for more information.
4. To display information to the nearest display terminal, click on the
Publish on Display Terminal button in the popup window that opens.
5. Then select the display.
Get information about a User
1. If you want to search for a user’s information, type the user’s name in the chat box and hit enter key.
2. The user card with the user’s information will be available as a replay for the chat immediately.
3. You can also contact that person by clicking on the call or chat button.
4. Click on the More Details button to know the user’s mail Id and
location.
Get Upcoming Meetings details
1. To get the details about upcoming meetings, enter the command upcoming meetings the chat box and hit the enter key.
2. Upcoming meeting details will be sent as the replay for the chat.
3. Click the Join Meeting button to join the meeting.
Kloud Insights FAQs
What is KloudInsights?
KloudInsights is a powerful platform that provides real-time insights and analytics for various data sources, enabling users to make informed decisions based on the gathered information.
How can I access KloudInsights?
You can access KloudInsights through a web browser by logging into your account.
What are Dashboards in KloudInsights?
Dashboards in KloudInsights are customizable data views that allow users to visualize and analyze data in a way that is most meaningful to them.
How do I create a Dashboard?
To create a Dashboard, navigate to the side menu section and click on the ‘+’ icon. Enter the name and customize it according to your preferences.
What are Rules and Actions in KloudInsights?
Rules in KloudInsights allow you to set conditions that trigger specific actions. For example, sending a notification when a certain event occurs.
How can I set up a Rule in KloudInsights?
To set up a Rule, go to the Rules section, click on ‘Create a rule’, and define the conditions, actions, and triggers for the rule.
What types of Reports can I generate in KloudInsights?
KloudInsights allows you to generate PDF or CSV Reports. These reports can provide detailed insights into various aspects of your data.
How do I schedule a Report in KloudInsights?
To schedule a Report, go to the Reports section, click on ‘Scheduled’, then ‘New Report’. Define the parameters, recipients, and schedule for the report.
Can I customize my User Settings in KloudInsights?
Yes, you can customize your User Settings, including your email address and password, to tailor your experience on the platform.
How do I provide feedback or report bugs in KloudInsights?
You can provide feedback or report bugs directly to the product team through the platform. Use the dedicated button at the top right of the screen.
Where can I find documentation and access keys for the REST API in KloudInsights?
You can find documentation and access keys for the REST API in the User Settings section under ‘API Documentation’.
How do I log out of my KloudInsights account?
To log out, simply click on the ‘Logout’ button located at the top right corner of the screen.
What information can I access in the Information section of KloudInsights?
The Information section provides access to system-related data, such as audit logs and other relevant information about the platform.
What can I do in the Configuration section of KloudInsights?
In the Configuration section, you can customize various settings related to your KloudInsights account, including system preferences and data sources.
How do I navigate back to the main overview page in KloudInsights?
To return to the main overview page, simply click on the ‘Home’ option in the side menu.
Can I access online documentation for KloudInsights?
Yes, you can access the online documentation by clicking on the ‘Access to on-line documentation’ button at the top right of the screen.
What does the Notification button do in KloudInsights?
The Notification button allows you to receive timely alerts and updates based on the rules and conditions you’ve set up in the platform.
Is there a way to view the history of generated reports in KloudInsights?
Yes, you can view the history of generated reports in the Reports section. This provides a record of all previously generated reports.
What are Classifiers in KloudInsights and how do they work?
Classifiers help categorize datasets based on specific conditions. They can be configured to identify and label data for easier analysis.
Can I customize the widgets on my Dashboard in KloudInsights?
Yes, you have the ability to add, edit, and arrange widgets on your Dashboard to display the information that is most relevant to you.
How do I access system information, such as audit logs, in KloudInsights?
You can access system information, including audit logs, in the Information section. This provides transparency into platform activities and events.
Events Management
Step 1: Creating a User for Kloudspot Event Management.
Make sure you’ve completed KloudInsights Setup before continuing to this
section. In order to enable event management, we first need to create an admin
user under your account. To do this, follow the steps found at
https://documentation.kloudspot.com/help/user-management and create your
user hierarchy.
Step 2: Creating an event
Once you have created a user, head to your event management URL and login with
that admin users credentials. If you login successfully, you’ll be brought to
a screen resembling the one below.
Click on the “Event Management” icon to be taken to the management dashboard.
It should take you to a dashboard similar to the one below. Here, you will see
a list of your past events, current events, and future events. It will also
display their location, along with some actions that we will go over in the
Step 3: Actions with an event.
To create an event, we want to click on the “create event” option on the
bottom right corner of the screen.
Name: Name of the event, such as “Frankfurt Motor Show”. This is visible to clients.
Notes: Notes about the event, these are not visible to clients.
Users: Allows you to define users that have administrative access to the event.
Site: Select the site, floor, and timezone that the event is taking place.
We will then proceed to the “Dates” tab.
Select a start date, as well as how many days you would like to record data
at the event.
Select each date of the event, as well as a timeframe that you’d like to
collect data. The green section defines the timeframe where data will be
collected
We will then proceed to the “Customers” tab.
Give each of your customers a name (this is visible to the customer), notes
about them (this is not visible to the customer), and select the ‘zones’ that
you would like data to be collected and reported on to that customer. Zones
can be used for multiple customers if they have shared spaces.
Finally, we will proceed to the “Settings” tab.
Minimum Dwell time: Minimum time a person must remain within a given zone to be recorded as an “interested” client.
Maximum Dwell: Maximum time a person can remain within a given zone to be recorded as an “interested” client. This is used to filter out employees/event staff.
Analysis Period: The intervals for which analysis of given zones will be completed and recorded upon. A shorter analysis period means more specific data, but much longer spreadsheets.
Multiplier: Multiplies all data read by this amount, useful if we have blind spots or some other issue causing a minor loss of persons.
After clicking “Submit” at the end of this step, our event will show up on the
dashboard and it will begin collecting and reporting data.
Step 3: Actions with an event
The first option, the blue graph, will take you to a live dashboard view of
the event site.
This event site dashboard will show you all cameras on a specific site and
floor, along with their status. You can also select the “Live View” tab to be
brought to a live view of the site and floors data.
The next button simply generates a report for the given event, or recreates
the event report should one already exist.
The final button simply deletes an event, AND ALL DATA ASSOCIATED WITH THAT
EVENT. Make sure to generate a report before deleting an event.
You may also click on any event to open a dropdown displaying all of the
customers and their unique event token that they may use to access their event
report if it has been generated.
Step 4: Event reporting
At the event dashboard, there is also an “Event Reports” tab. Selecting that
tab will bring you to the event report dashboard.
Here you will see a list of all reports, along with the start date, duration,
and location that the event took place. You also have 2 options along with it.
The red trashcan deletes the report, and the blue button creates a copy of the
report.
To access the data within a report and to give your clients a dashboard of
their own, simply click on the respective event report. This will open a
dropdown containing all of the data.
Here, you will see a list of all customers, their unique event token, the last
time their event dashboard was accessed, the amount of times they have
accessed it, as well as the option to open their dashboard as an admin, copy
the link address to their dashboard, and view their event report spreadsheet.
Step 5: Understanding the customer dashboard
Once your customer receives their unique event token, they may go to your
event url and put that token into the access token login option.
Upon entering a proper event token, they will be taken to the customer
dashboard.
The “Live view” tab offers them a live view of their event space, along with
all of the data associated with it.
The “Summary” tab gives a full historical summary of the event space, along
with all data associated with it. It also has the option to directly download
their respective spreadsheet.
The “Statistics” tab offers a comprehensive view of all relevant statistics
regarding their event space and the data associated with it across any
combination of days and cameras.
The “Zone Density” tab shows the population density of each zone across the
entire event, by day, or an animation showing density across 15 minute or hour
long intervals over a specific day.
The final tab, the “Movement” tab, shows the movement of persons’ across the
given time period, with the option to filer out areas of less movement.
Access to the internet is a necessity in this day and age. KloudPortal has become the leader in network management, giving you a binding solution that provides secure and uninterrupted access to the internet via public WiFi networks. With an immense array of features, KloudPortal gives you a premium user experience while adhering to strict security standards.
KloudPortal works as the bridge between businesses and their customers, redefining how their network access is managed. With KloudPortal, you can also customize your captive portal with templates, allowing you to design your introductory pages according to your preference, and also offers a variety of authentication methods. It also provides multilingual support so you can view the Portal in your preferred language.
Whether you run a café, manage a hotel, organize events, or provide public Wi-Fi, KloudPortal simplifies the user journey on the internet, while strictly following the terms of use and strong security protocols. This translates into a smooth user experience for individuals seeking on-the-go internet access. Security and privacy take center stage, with KloudPortal protecting user data without compromising efficiency.
If you are new to KloudPortal, please refer to the Installation Guide to ensure a hassle-free purchase. To explore KloudPortal and unlock its full potential, check out our User Guide for an in-detail description of every feature KloudPortal has to offer. Still confused? Our extensive FAQ page gives you the answers you need.
Unlock the power of KloudPortal with our User Guide, covering 3rd party access point integration, KloudManage connection, template creation, and advanced features like Campaign and Guest Management.
Get quick answers to common KloudPortal questions with our informative FAQ resource.
Subsections of Kloud Portal
Installation
To embark on the journey of configuring KloudPortal to align precisely with your requirements, you’ll need Kloudspot’s web-based software, KloudManage. KloudManage serves as the central hub for tailoring your KloudPortal experience to perfection. Additionally, it’s imperative to configure the splash page of your access point to ensure seamless integration.
When it comes to acquiring Kloudspot’s products, we offer a variety of purchase options to suit you. For a detailed overview of the available purchase methods and to determine which one best fits your requirements, please refer to the comprehensive “KloudSpot Product Purchase Options and Provisioning Process” guide.
For a step-by-step guide on configuring KloudPortal with a 3rd-party access point, please consult the document titled “Configure Kloud Portal With 3rd Party Access Point” This document will provide you with valuable insights into the integration process, ensuring a smooth and successful setup.
Upon the successful completion of your purchase, you will receive the following essential details:
The URL for accessing the KloudManage software.
Your designated username.
Your confidential password.
The URL for your splash page.
These credentials will grant you access to the full suite of KloudPortal management tools and ensure a smooth configuration process.
Refer the User Manual for comprehensive guidance on configuring KloudPortal’s user management, portal customization, and guest management features.
User Guide
This user manual serves as your comprehensive guide to navigating and utilizing the features of KloudPortal. Whether you’re a network administrator, an IT professional, a business owner, or a user seeking internet access, this manual will walk you through the process of getting started, understanding authentication methods, troubleshooting common issues, and making the most of the advanced capabilities KloudPortal offers.
Explore the possibilities that KloudPortal presents and unlock the potential of seamless and secure internet connectivity for your users. With KloudPortal, you can offer a sophisticated and reliable Wi-Fi experience that aligns with the needs of today’s digitally connected world.
Configure Kloud portal with 3rd party Access point.
If you’re utilizing a third-party access point, this step is mandatory; however, it’s unnecessary if you’re utilizing a Kloudspot gateway. In this section, we’ll guide you through the process of configuring a captive portal with various third-party access point platforms, ensuring that your users can seamlessly access the internet while adhering to your network’s terms and security protocols.
There are three available access points: Cisco Wireless LAN Controller, EnGenius Platform, and Meraki. Let’s explore how to configure them in the upcoming sections.
It necessitates a splash page URL, which will be provided upon the successful completion of your purchase. For detailed information on the different purchase options available, please refer to the Installation section.
Subsections of Configure Kloud portal with 3rd party Access point.
Cisco Wireless Lan Controller
In this section, we will guide you through the process of configuring captive portal with the Cisco Wireless LAN Controller access point, ensuring seamless and secure internet access for your users.
1. Configure Virtual Interface.
2. Configure the External Guest portal URL and redirection page.
3. Enable AccessControls for the external guest portal.
4. Guest WLAN settings.
Configure Virtual Interface ( if doesn’t exist already )
Configure the External Guest portal URL and redirection page
1. Select ‘External (redirect to external server)’
2. Enter redirect URL and External Webauth URL with IP ’52.0.190.110’.
Enable AccessControls for external guest portal.
1. Select the created Access Control to add access Rules.
2. Create Outbound Rule to allow 52.0.190.110 access.
3. Similarly, create rule for Inbound access.
4. Both Inbound and outbound rules should like below.
Guest WLAN settings
EnGenius Platform
Welcome to the configuration guide for setting up a Captive Portal with the EnGenius Platform access point. This step-by-step walkthrough will enable you to provide secure and user-friendly internet access to your network users.
Step 1: Register a device in the EnGenius portal
1. Log in to the EnGenius portal to register a new device. Log in with your company credentials.
2. From the Home page that opens, Navigate to ORGANIZATION > Inventory &
License.
3. On the Inventory & License page that opens, click the + Register
Device button and enter the serial number of the device in the popup window
that opens.
Note: The serial number can be found on the back of the device.
4. Finally click the Register button to register the device. the device
has been registered successfully. Other information related to the device is
automatically obtained while registering with the serial number.
Step 2: Add a new SSID
1. After registering the new device, you need to add a new SSID. For that, navigate to CONFIGURE > Access Point > SSID> +Add SSID.
2. Then, as needed, enter the SSID name and security settings. Save the
changes by clicking the Apply button. New SSID added successfully.
Step 3: Setup Captive Portal with EnGenius platform
1. After adding the SSID, the next step is to set up the Captive portal, for that, open the newly created SSID.
2. Then open the Captive Portal tab and enable the captive portal in the window that opens.
3. In Authentication type select a Custom RADIUS and enter the IP Address, Port, and Secret.
4. Then scroll down and under the Accounting Server , enter the IP
address, Port, and Secret.
5. Scroll down again and enter the Redirect URL.
6. Next click on the Splash Page tab and enter the splash page URL.
Note: This is the URL that KloudSpot gives you.
7. Then click on Apply button to save the changes.
8. Captive portal successfully added to EnGenius platform.
Meraki
Welcome to the configuration guide for setting up a Captive Portal with the Meraki access point. This comprehensive guide will walk you through the process, ensuring that you can seamlessly manage and enhance your users’ internet experience while maintaining top-notch security and compliance.
Guest Portal
Captive Portals or Guest Portal is a multi-channel platform that enables you
to connect and engage with visitors on your premises.
Guest portal screen page allows to create and design a customizable portal
from scratch.
A sample of templates will be given as an option to choose to create a portal,
layout will be available as a part of the template.
Following are the steps to configure the Guest Portal.
Captive Guest Portal Configuration
The captive portal is designed with following terms that are described below:
Social Authentication: Needs authentication using social platforms as Facebook, Twitter, Linked and it will ask user to authenticate with a valid account.
Email Authentication : It will ask the user for their Name and Email address to be able to Authenticate.
SMS Authentication: It asks the user for their contact number and authenticate over a SMS.
Token Based: A token is generated by the admin. The users get this token when they register and on entering the token as an authentication, they get access to the internet.
Username/Password
Third party
The following are for custom development and can be integrated as per
requirement.
Third party ERP
Third party PMS
Third party POS
Enter ‘Wireless’ , ‘Access Control’
Choose the SSID to which the Captive portal will be configured.
In Network Access, Association requirement, Select ‘Open (no encryption)’.
In Network Access, Splash page, Select ‘Click-through’.
In Network Access, Captive portal strength, Select ‘Block all access until sign-on is complete’
In Network Access, Walled garden ranges, Enter the following domains:
Kloudspot has a powerful workflow and policy driven campaign management
solution centered mostly around Wi-Fi which offers both online and offline
campaigns. These online campaigns can be created and managed using Captive
Guest Portals. Creation of Captive guest portals is extremely easy using one
of many templates supported by KloudCampaign Editor. KloudCampaign Editor can
help guide the user to create a captive portal for the hardware they have
deployed on the network.
For more details on how to create Campaigns, resources and configure dynamic
policies and workflows, please refer to relevant Kloudspot documentation.
Log in to Kloud Manage
After configuring KloudPortal with your third-party access point, the next step is to log in to KloudManage. KloudManage is the web-based software provided by Kloudspot that allows you to manage and customize your KloudPortal settings according to your specific needs. Here’s how to log in:
Step 1: Open your web browser.
Step 2: In the address bar, type the URL provided to you upon purchase, and press Enter. This URL will lead you to the KloudManage login page.
Step 3: On the login page, you will need to enter your username and password. These credentials should have been provided to you upon purchase. If you haven’t received them or have trouble logging in, please contact Kloudspot support for assistance.
Step 4: Once you’ve entered your username and password, click the “Log In” button to access the KloudManage dashboard.
You are now logged in to KloudManage, where you can further customize and manage your KloudPortal settings, user management, portal customization, and guest management. If you need guidance on how to use KloudManage effectively, please refer to the following sections for detailed instructions.
Dashboard overview
In this Dashboard Overview, we will walk you through the key features and functionalities of KloudManage. Whether you’re a network administrator, an IT professional, or a business owner, this guide will help you navigate the dashboard with confidence, allowing you to tailor your KloudPortal experience to meet your organization’s unique needs.
There are 2 types of dashboards available.
Main account level
Venue level
Main account level dashboard.
1. The captive portal main account level dashboard is a powerful tool that enables you to collect and view information from all venues using the captive portal. This dashboard is designed to provide you with an overview of your entire network and allows you to view data from all locations in one place. By collecting information from the captive portal of all venues, the dashboard provides you with valuable insights into the performance of your network and helps you make informed decisions to improve user experience.
2. To access the Main account level dashboards, follow these simple steps:
Step 3: The main account level dashboard will immediately open.
3. Once you have access to the Captive portal menu, you will see several dashboards that contain important information.
4. The information displayed in this section pertains to the main account level. In other words, the dashboard data shown here are based on information collected from all locations.
5. Here is a brief explanation of each section:
Hits: This section shows you how many people have connected to the
captive portal today and how many people have connected to the portal so far.
This information is updated in real-time, so you can track the number of hits
as they happen.
Media: This section shows you how many media campaigns are currently
running and how many media campaigns have been run so far. This information
can help you understand the effectiveness of your media campaigns and make
improvements where necessary.
Popular Zone: This section shows you which venue has the most people
using the captive portal. This information can help you optimize your network
and ensure that you are providing the best possible experience to your users.
Devices: This section shows you how many devices are currently connected
to the captive portal. This information can help you monitor your network and
ensure that it is running smoothly.
Top Campaigns: This section shows you which campaigns have been viewed by
the most people. This information can help you understand which campaigns are
most effective and make improvements where necessary.
Top APs by Impression: This section shows you the most used access points
in the form of a pie chart. This information can help you optimize your
network and ensure that your users are getting the best possible experience.
Top Locations: This section shows you the location of the hits in pie
chart form according to their usage.
Top Hits: Top Hits: This section shows you the most popular hits in the
form of a pie chart. Hits refer to the number of times users tried to access
the captive portal, including how many successfully connected, how many used
authentication methods, and how many visited the landing page. This
information can help you understand what your users are most interested in and
make improvements where necessary.
Hits by Time: This section shows you the number of hits in the form of a
line chart according to time. This information can help you understand when
your network is busiest and make necessary adjustments.
Top Guest Devices: This section shows you the devices used by guests in
pie chart form. This information can help you optimize your network and ensure
that your users are getting the best possible experience.
Top Guest Browsers: This section shows you the browsers used by guests in
pie chart form.
Top Guest OS: This section shows you the operating systems used by guests
in pie chart form.
Top APs: This section shows you the most used access points in the form
of a pie chart.
Guest by Time: This section shows you the number of guests in the form of
a bar chart according to time. This information can help you understand when
your network is busiest and make necessary adjustments.
Venue level Dashboard
1. Venue-level dashboards provide specific information about the captive portal usage and performance of a particular location. These dashboards are designed to provide a detailed view of the captive portal activity at the individual venue level. By analysing this information, venue owners and administrators can gain insights into how their captive portal is being used, identify potential issues or areas for improvement, and make informed decisions about how to optimize their network performance.
2. To access the Venue level dashboards, follow these simple steps:
Step 2: Then navigate to the Captive Portal > Venue Summary.
Step 3: The Venue level dashboard will immediately open.
3. Once you have access to the Venue Summary, you will see several dashboards
that contain important information. From here you can filter the dashboard by
venue. For that select your desired venue from the venue dropdown list.
4. Then, choose the desired time frame to obtain the requested data. The
available time intervals include options such as “today,” “24 hours,” “7
days,” and “1 month.”
5. Here is a brief explanation of each section:
Hits: This section shows you how many people have connected to the
captive portal today and how many people have connected to the portal so far.
This information is updated in real-time, so you can track the number of hits
as they happen.
Media: This section shows you how many media campaigns are currently
running and how many media campaigns have been run so far. This information
can help you understand the effectiveness of your media campaigns and make
improvements where necessary.
Devices: This section shows you how many devices are currently connected
to the captive portal. This information can help you monitor your network and
ensure that it is running smoothly.
Top Campaigns: This section shows you which campaigns have been viewed by
the most people. This information can help you understand which campaigns are
most effective and make improvements where necessary.
Top APs: This section shows you the most used access points in the form
of a pie chart. This information can help you optimize your network and ensure
that your users are getting the best possible experience.
Top Hits: Top Hits: This section shows you the most popular hits in the
form of a pie chart. Hits refer to the number of times users tried to access
the captive portal, including how many successfully connected, how many used
authentication methods, and how many visited the landing page. This
information can help you understand what your users are most interested in and
make improvements where necessary.
Hits by Time: This section shows you the number of hits in the form of a
line chart according to time.
Top Guest Devices: This section shows you the devices used by guests in
pie chart form. This information can help you optimize your network and ensure
that your users are getting the best possible experience.
Top Guest Browsers: This section shows you the browsers used by guests in
pie chart form.
Top Guest OS: This section shows you the operating systems used by guests
in pie chart form.
Guest by Time: This section shows you the number of guests in the form of
a bar chart according to time. This information can help you understand when
your network is busiest and make necessary adjustments.
Add KloudPortal to KloudManage
1. Once you have obtained your login credentials from Kloudspot, you can proceed to the next step, which involves adding the captive portal’s controller to KloudSpot’s Device management system.
3. Navigate to NETWORK DEVICES > Add Network Devices.
4. Enter the following in the window that opens and click the Save
Changes button.
Device Type: Select the Access Point or Gateway device from the
dropdown list depending on the controller you are using. Select Access
point if you are using a third-party controller.
Model: Select your controller model from the dropdown list.
Note: If you are using a third-party controller, select the option “Third
Party Aps (Meraki, Cisco, Aruba etc)” from the model list.
Vendor: If you are selected a third party device, select the vendor name
from the vendor list.
MAC address: Enter the MAC address of your controller.
Name: Give a name for the controller.
Account: Kloudspot provides this information during account creation, and
it is advised to keep it as is.
Venues: During the account creation process, KloudSpot provides
information about the venue.
5. Click the Save Changes button to save the controller.
User and Role management
In this guide, we will walk you through the process of creating and managing user accounts, defining roles and permissions, and ensuring that your network remains secure and compliant with your organization’s policies. Regardless of your level of expertise, this section will provide valuable insights and instructions to help you navigate the user and role management features of KloudPortal.
2. Click on the user profile button from the top right corner. After login.
3. Then click on the User & Role Management button from the dropdown list that opens.
4. From the User window that opens, click the Add User button.
5. Then enter the information of the user and select the user role.
6. ROLE_CP_ADMIN or ROLE_CP_USER can be chosen depending on the role of the
user being added.
7. Click the Save button to save the changes.
8. New user has been added successfully.
Configure 3rd Party Authentications
In today’s digital landscape, securing online interactions and managing user identities are paramount. Kloud Portal understands the importance of providing flexible authentication options for your network users. In this section, “Configure 3rd Party Authentication,” we will explore a range of authentication methods that extend beyond traditional username and password combinations.
By integrating third-party authentication services like Facebook, Google Workspace, LinkedIn, Microsoft, and Twitter into your Kloud Portal setup, you can enhance user convenience, streamline the login process, and bolster security measures. These authentication methods allow users to leverage their existing social media or corporate credentials, simplifying access to your network while ensuring a secure and seamless experience.
In this guide, we will take you through the steps required to configure these third-party authentication options within Kloud Portal. Whether you’re operating a small café, managing a hotel’s Wi-Fi network, or overseeing a large-scale enterprise, these authentication methods offer the flexibility and security needed to meet your unique requirements.
Subsections of Configure 3rd Party Authentications
Okta Authentication
Overview
Okta Authentication integration allows Captive Portal users to log in using their Okta account credentials. This document provides a step-by-step guide on how to integrate Okta Authentication into the KloudManage.
Prerequisites
Before starting the integration process, ensure that you have the following credentials:
KloudManage admin account credentials.
Okta developer account credentials.
Integration Steps
Obtaining Okta ID, Secret and Issuer
Visit Okta Developer site and log in to your Okta developer account. If you don’t have an account yet, you have the option to sign up and create one.
Create a new App Integration by navigating to Application > Create App Integration > OIDC-OpenID Connect > Web Application.
Click on the Next button.
Enter the following details in the New Web App Integration window:
App Integration Name: Enter a name for your app.
Sign-in Redirect-URI: This is the URL of the Captive Portal. To obtain this, log in to KloudManage and navigate to Captive Portal > Guest Portal. Copy the URL of the portal you want to add Okta SSO.
Scroll down, check the Allow everyone in your organization to access checkbox, and click on the Save button. This is an optional step and can be selected as per your requirement.
Once saved, the App you created will open. Copy the Client ID, Client Secret, and Issuer from this page.
Scroll down to the Social Authentication Setup section.
Click on the Edit button.
Paste the Okta Client ID, Client Secret, and Issuer copied from the Okta App into their respective places.
Click on the Save Social Settings button to save the changes.
Logging in with Okta SSO
After completing the integration steps, users can log in to the Captive Portal using Okta Single Sign-On (SSO). The Okta SSO option should now be available on the Captive Portal login page.
Facebook Authentication
By adding Facebook Social Authentication, Captive Portal users can log in using their Facebook account credentials.
Step 1: Accessing Third-Party Integrations in KloudManage
To begin, log in to your KloudManage account and navigate to the Settings page. Look for ‘Third-party Integrations,’ and within it, find the ‘Social Authentication Setup.’
Step 2: Obtaining Facebook App Credentials
Before diving into KloudManage settings, you’ll need a Facebook App ID and App Secret. Follow these steps:
Sign up for a developer account using your company credentials.
After signing up, click on “Create App.”
Choose “Other” in the opening window and click “Next.”
Enable consumer, and proceed to the next step.
Provide a Display Name for your app (visible to users on the Kloudspot Guest Portal) and click “Create app.”
In the ‘My Apps’ section, locate and enter your newly created app.
Go to the ‘basic’ option in the settings menu.
Copy the App ID and App Secret; these will be needed in KloudManage.
Scroll down, click “Add Platform,” choose “Website,” and enter your KloudPortal URL.
Save the changes.
Open the Advanced menu and enable “Allow Cross Domain Share Redirects” in the “Share Redirect Allow List” section.
Save the changes.
Click “Add Product” in the navigation menu and choose “Facebook Login.”
Select the Web platform and enter your Site URL.
Follow the subsequent steps and click “Save and Continue.”
Click on “Settings” under ‘Facebook Login.’
Enter the guest page URL under ‘Valid OAuth Redirect URIs.’
Save Changes.
Step 3: Integration in KloudManage
Back in KloudManage, paste the copied App ID and App Secret.
Click “Save Social Settings.”
Instagram Authentication
Integrate Instagram authentication with the Captive Portal
By adding Instagram Social Authentication, Captive Portal users can log in using their Instagram account credentials.
Step 1: Accessing Third-Party Integrations in KloudManage
To begin, log in to your KloudManage account and navigate to the Settings page. Look for Third-party Integrations, and within it, find the Social Authentication Setup.
Step 2: Obtaining Instagram App Credentials
Before diving into KloudManage settings, you’ll need an Instagram App Secret and Instagram App ID. Follow these steps:
Sign up for a developer account using your company credentials.
After signing up, click on Create App.
Choose Other in the opening window and click Next.
Enable the consumer, and proceed to the next step.
Provide a Display Name for your app (visible to users on the Kloudspot Guest Portal) and click Create app.
After creating the app, navigate to Add Product in the menu, and choose Instagram Basic Display.
Click Create new app, enter the App name, and then click Create App.
Scroll down in the basic display window, copy the Instagram App Secret and Instagram App ID, and save them for later use.
Add Valid OAuth Redirect URIs, Deauthorize callback URL, Data Deletion Request URL, and click Save changes.
Navigate to App roles > Roles to add App roles.
Click Add people, select Instagram Tester, and enter your Instagram username. Click Add.
The status will be pending.
To approve, log in to your Instagram account, and go to More > Settings > Website Permissions > Apps and Permissions. In Tester Invites, click Accept.
Step 3: Integration in KloudManage
Back in KloudManage, paste the copied App ID and App Secret.
Click Save Social Settings.
Google Workspace Oauth 2.0 Authentication
1. By adding Google Authentication, Captive Portal users can log in using their Google account credentials. Click the link given below to access the login page.
3. Now select the project or create a project by clicking on the dropdown at
the top right corner.
4. This popup will contain all your projects and also gives you the
flexibility to create a new project.
5. After selecting an existing or a new project the below window will open.
6. Next, you need to enable the Google Workspace Marketplace SDK. For
that navigate to Enabled APIs and Services.
7. Then search for Google Workspace Marketplace SDK and enable it.
8. Then navigate to Credentials to create Client ID and Secret.
9. In the window that appears, there are several login options.
10. In this case, the captive portal supports OAuth2.0.
11. To configure OAuth you need to create a Client ID and Secret.
12. Click on CREATE CREDENTIALS button at the top and select the OAuth
Client Id from the dropdown list.
13. Then Create your Client ID. The screen below will be displayed once it
has been created.
14. This screen contains the Client Id and Secret. Copy it and paste it
somewhere else for later use.
15. Next you have to copy the captive portal URL, for that login to the
captive portal and open the guest portal section.
16. Copy the URL by clicking on the yellow icon from the Captive portal’s
Last Published column.
17. Then click on The +Add URI button and add the Captive Portal URI.
Then click the Save button.
18. Log in to Captive Portal and navigate to NMS settings- >Third party
Integrations ->Social Authentication Setup.
19. Here, pastes the Client Id and Secret that you copied earlier.
20. OAuth2.0 has been integrated successfully.
21. People within the organization or in the same domain can then use it.
LinkedIn Authentication
1. By adding LinkedIn Social Authentication, Captive Portal users can log in using their LinkedIn account credentials.
2. To integrate LinkedIn into the Captive Portal , a LinkedIn APP ID and LinkedIn APP Secret key are required.
3. To add it, Log in to the kloudManage account and navigate to the Settings page, then to ‘Third-party Integrations’ then scroll down and find the Social Authentication Setup.
4. To obtain the credentials, follow the instructions below.
5. Log in to the LinkedIn developer account with company credentials. To
access the login page, click on the link provided below.
7. Click on the Create App button from the My App window.
8. Then ‘Create an app’ window that will open. Fill in all the
required fields in this window.
App Name: The name you’d like to give the app.
LinkedIn Page: Search for your company’s LinkedIn account and add it.
App Logo: Upload a logo suitable for your App.
9. Check the acknowledgment checkbox and Click Create App button.
10. Then, on the Test App page that opens, click the Request Access
button next to the Sign in with LinkedIn.
11. Check the acknowledgment checkbox that appears and click on the Request
Access button.
12. As soon as you get access, you will be able to see the product, ‘Sign
in with LinkedIn’ in the ‘Added product’ section.
13. To get application credentials Click on the Auth Tab.
14. Then, from the page that opens, you will obtain the Client ID, and
Client Secret. Copy it and paste it into the ‘Third-party
Integrations’ settings and click on the Save Social Settings button.
15. Copy the Captive portal Index page URL and paste it into the authorized
redirect URL text box.
Note: It is useful to specify which page the user should be directed to
after logging in with LinkedIn.
16. LinkedIn authentication is done successfully.
Microsoft Authentication
You can access your captive portal with your Microsoft account credentials. To
use this service, the KloudManage tool must be linked to a Microsoft Azure
account. This document explains how to do so.
To Get Microsoft Credentials
1. To integrate Microsoft Azure into Captive Portal, you need 3 credentials.
Microsoft Client ID
Tenant ID
Microsoft Client secret
2. To get the credentials, click on the link given below and log in to
Microsoft Azure.
3. Click the App registration button on the Microsoft Azure Home page that
appears.
4. This will direct you to the App registration page. Here you click on the
New registration button.
5. Enter the App name , Select the Supported account type as a single
tenant. Then click the Register button.
6. The new app has been successfully registered. Copy the Application ID
and tenet ID from the overview window and paste them somewhere else for
later use
7. Then click on the Add a certificate or secret button to create a
client secret.
8. Click the New Client Secret button in the Certificates and Secrets
window that appears.
9. Enter the description in the popup that appears and click the Add
button.
10. New Client secret created successfully. Copy it and paste it
somewhere else for later use.
Add credentials to the KloudManage tool
1. Log in to the KloudSpot network management tool. Then navigate to Settings > Third-party Integration.
2. Then scroll down to the Social Authentication Setup section. Paste the
Microsoft Client ID, Tenant ID, and Microsoft Client Secret in the
respective text boxes. Then click on the Save Social Settings button.
3. Microsoft Azure credentials have been successfully added.
Authenticate the App.
1. After generating the app, you need to grant the necessary permissions to it. For that, navigate to API permissions > Microsoft graph.
2. Then in the request API permissions window that opens, select the required permissions, and click the Update permissions button. Required permissions are listed below.
Email
Offline Access
Open Id
Profile
User Read
User ReadBasic All
Add redirect URI
1. The final step of Microsoft Azure integration is to add the redirect URI. To do so, Navigate to Overview > Add a Redirect URI > Add platform > Web.
2. On the configuration web page that appears, enter the captive portal’s URI
and check the ID tokens checkbox, then click on the configure button
to configure.
3. If you want to add more captive portal URIs, you can add them by clicking
the Add URI button.
Twitter Authentication
1. By adding Twitter Social Authentication, Captive Portal users can log in using their Twitter account credentials.
2. To integrate Twitter into the Captive Portal , a TwitterAPP ID and TwitterAPP Secret key are required.
3. To add it, Log in to the kloud Manage account and navigate to the Settings page, then to ‘Third-party Integrations’ then scroll down and find the Social Authentication Setup.
4. To obtain the credentials, follow the instructions below.
5. Log in to the Twitter developer account with company credentials.
6. To access the login page, click on the link provided below.
7. After signing up and logging in, a window will appear as shown below.
Enter your App name in it and click on the Get Keys button.
8. Then in the window that opens, click on the Dashboard button, and
enter the dashboard of the created app.
9. Copy the API key and API key secret found on this screen and paste it
somewhere else for later use.
10. Select the app we created from the Projects & Apps menu in the
dashboard.
11. Then click on the Set up button to configure User authenticationsettings.
12. Then select Web app in the ‘Type of App’. Enter the Redirect
URL and Website URL in the ‘App Info’ section and click the Save
button.
Redirect URL: It is useful to specify which page the user should be
directed to after logging in with Twitter.
Website URL: Enter your company website URL.
13. Then a window containing Client ID and Client secret will open.
Then click the Done button.
14. Then go to ‘Third-party Integrations’ settings, paste the previously
copied API key and API key secret, and click the Save Social Settings
button.
15. Twitter authentication has been integrated successfully.
WhatsApp Integration
Integrating WhatsApp with KloudManage using Twilio Provider
Introduction
Integrating WhatsApp with KloudManage provides the capability to receive WhatsApp notifications within the KloudManage and enables authentication for the Captive Portal. This document outlines the steps to integrate WhatsApp using the Twilio provider.
Prerequisites
Access to a Twilio developer account.
Access to KloudManage with administrative privileges.
If you don’t have a Twilio developer account, you can create a new one by providing your Email ID and Phone Number.
Upon first login, configure your settings as seen in the welcome page screenshot below.
Click on the Get Started With Twilio button.
When prompted with the terms and conditions popup, acknowledge by checking the checkbox and click Confirm.
First, set up the WhatsApp sandbox and message template within Twilio. Following this, you will receive the Account SID, Auth Token, and Twilio phone number. Refer to the Twilio documentation for instructions on how to complete this process.
When creating the message template, make sure it is similar with the hardcoded template in KloudMange. Use the template provided below.
{{code}} is your verification code. For your security, do not share this code.
Integrate Twilio Credentials into KloudManage
Access KloudManage and navigate to Settings > Third-party Integration.
Under the Whatsapp Integration section, select Twilio as the provider.
Enter the Account SID, Auth Token, and Phone Number received from Twilio.
Click on the Save Whatsapp settings button to save the integration settings.
Following the outlined steps, you have successfully integrated WhatsApp with KloudManage using the Twilio provider.
This integration enables the seamless flow of WhatsApp notifications and facilitates Captive Portal authentication within the KloudManage.
Customizing Captive Portal Templates
Your network’s welcome page, often the first point of interaction between users and your brand, can leave a lasting impression. To ensure this impression is a positive one, Kloud Portal offers robust customization options for your captive portal templates.
Continuing from our exploration of third-party authentications, where we enabled a range of options for user login, we now delve into the realm of customizing captive portal templates. This crucial step allows you to tailor the welcome page that users encounter when they connect to your network. Whether you’re operating a bustling coffee shop, a boutique hotel, or a corporate enterprise, this customization process empowers you to create an immersive and brand-consistent experience.
Through the following sections, we will guide you through the process of fine-tuning your captive portal templates. This includes adjusting text, images, colors, and layout to align with your brand identity and messaging.
To discover the hardware options supported by the Captive Portal and explore the templates compatible with each hardware, please refer to the “Hardware and Templates " guide. This guide will also provide insights into which templates are designed to support various authentication methods.
2. Then Navigate to CAPTIVE PORTAL > GUEST PORTAL > Create New.
3. Enter a name for the portal in the popup window that appears and click the
Create button.
4. In the features dropdown menu, select the features you want. Then select
Hardware from the hardware dropdown list.
5. Then select your desired template from the template list. Click on the
Details button to preview the template. Click on the Select button to
edit.
6. The selected template can be edited in the following steps. We can change
it to suit your needs.
7. To do so, select the page you want to edit. the click on the CONFIGURE
TEMPLATE.
Note: The portal can be saved only if all the pages shown in the
configure template page have been edited.
Edit Welcome Page
1. Click on the welcome page button.
2. In the window that opens, click on the Settings button. Here you can edit
the following.
Logo
Title text
Form field
Authentication Types
Social login
Background image
Company
3. Once edited, click on the Save changes button.
Enable Authentication Type
1. Click on the Settings button from the welcome page.
2. Scroll down and find the Authentication Types. Here you can find the 6
Authentication types.
Email Authentication: You will receive a link to the registered email ID,
and by clicking on it, you will be able to log in.
SMS Authentication: This can be verified by receiving an OTP to the phone
number from which you intend to log in.
Whatsapp Authentication: This can be verified by receiving an OTP to the
Whatsapp number from which you intend to log in.
Token Based Authentication: This enables you to log in using a token
generated by the administrator.
Password Authentication: This allows you to log in with the username and
password provided by the organisation.
Admin Authentication : This allows you to check and approve each user
manually. Each new user is notified, and the admin can manually approve or
decline it.
No Authentication: Allows the user to use the portal without any
restrictions.
3. Apart from these 6 authentication methods, there are two other methods. It
is not available in all templates.
DB Authentication: Upon the user logging in, the system prompts them to
provide their username and password. The credentials are subsequently verified
against those stored in the database. If there is a match between the provided
credentials and the existing ones, the user is then directed to a success
page.
Sponsor Email : A staff can sponsor users. Users can request permission
to use the captive portal by providing the sponsor’s email id.
Edit Email Verification Page
1. If the Email is selected as the authentication type on the welcome page, this page can be edited.
2. Click on Email verification page button.
3. In the window that opens, click on the Settings button. Here you can edit
the following.
Logo Image
Title text
Success message
Redirect url
Background image
4. Once edited, click on the Save Changes button.
Edit SMS Verification Page
1. If the SMS is selected as the Authentication type on the welcome page, this page can be edited.
2. Click on the SMS verification page button.
3. In the window that opens, click on the Settings button. Here you can edit
the following
Logo Image
Title text
Text message
Footer Image
Background image
4. Once edited, click on the Save Changes button.
Edit Email Design
1. This is a confirmation email informing the user that their registration was successful. It can be customize as needed.
2. Click on the Email Design button.
3. In the window that opens, click on the Settings button. Here you can
edit the following
Title text
Email body
Company Name
4. Once edited, click on the SaveChanges button.
re
Edit Admin Authentication Page
1. If the Admin Authentication is selected as the Authentication type on the welcome page, this page can be edited. To learn more about admin authentication, see Approve or decline the user request section.
2. Click on Admin Authentication Page button.
3. In the window that opens, click on the Settings button. Here you can
edit the following.
Logo
Success Message
Redirection URL
API Interval (in sec): Helps to determine the waiting time after admin approval. Default It will be 30 sec. maximum- 120 sec.
Sponsored Content
Background Image
4. Once edited, click on the Save Changes button.
Edit Final Success Page
1. If you want to make changes to the Final Success Page, click on the Final Success Page button.
2. In the window that opens, click on the Settings button. Here you can edit
the following.
“In addition to the basic configurations, this section provides detailed insights into the finer aspects of captive portal customization. It offers a comprehensive exploration of the diverse settings that allow you to fine-tune your portal according to specific requirements. By delving into these additional settings, you can maximize the potential of your captive portal customization.”
Subsections of Other authentications for captive portal
Two-factor authentication with MAC address
Introduction
This document describes how to create a two-factor authentication system that uses MAC address identification along with OTP, email, or token-based authentication methods. By incorporating MAC authentication into the login process, this method improves security and access control in captive portal systems.
Mac address and SMS authentication - This is a two-step verification process. First, it verifies the device’s MAC address, then sends an OTP via SMS to authenticate the user’s mobile phone number.
Mac address and Email authentication - This is a two-step verification process. Initially, it authenticates the device’s MAC address and subsequently sends an authentication email to verify the user’s email address.
Mac address and token authentication - This is a two-step verification process. It starts by authenticating the device’s MAC address, followed by the use of a token for further authentication.
Getting Started
This feature is specifically designed for use with the Scorpio template on EnGenius hardware. For detailed instructions on customizing templates, refer to the “Customizing Captive Portal Templates” section.
Begin by selecting the Scorpio template using the designated button.
On the “Configure Template” page, navigate to the “Index Page” section.
Click on the settings button to customize the Index page.
The form fields to select will vary based on the two-factor authentication method you wish to use..
For SMS authentication, select the Phone field.
For email authentication, select the Email field.
For token-based authentication, select the Access Code field.
In the “Enable First Step MAC Authentication” section, ensure that both the Enable and Bind Strictly checkboxes are checked.
Enable: Activates First Step MAC Authentication.
Bind Strictly: Enabling this option associates a specific MAC address with a second-step authentication method. Then, the user can only log in using the information provided in the two-factor authentication settings.
Then select the Second Step of Authentication. Select SMS, Email, or Token Based authentication as per your requirement.
Adjust any additional configurations as needed, then click “Save Changes” to apply the settings.
Navigate to Captive Portals > Captive Portal Settings > Two Factor Authentication Settings > Group.
Click on Create Group and define a new group. In the “Assign Captive Portal” column, select the previously configured captive portal.
Once the group is created, proceed to add user details. Click on the User Details tab and then click on the Create New User button to add a new user.
In the popup window that open, Enable the user by checking the Enable checkbox and provide the required information.
When adding a user, ensure to provide relevant information based on the configured two-factor authentication method:
Name: User’s name.
MAC Address: MAC address of the user’s device.
Enable Token Authentication: Enable this option for token-based authentication.
Access Token: Upon enabling token authentication, an access token will be generated. This token is linked to the associated MAC address and grants access to the captive portal.
Email: User’s email address for email authentication.
Phone: User’s phone number for OTP authentication.
Assigned Group: Select the group created earlier from the dropdown list.
Expiry Time: Set the duration for which the user can access the internet via the captive portal.
Click Save to save the user.
Conduct thorough testing of the captive portal to ensure proper functionality of MAC Authentication. In case of any issues, refer back to the outlined steps for troubleshooting.
Azure Authentication for Captive Portal
Overview
This technical documentation guides you through the process of configuring Azure authentication for a Captive Portal using the Soul template on Meraki hardware. Follow the steps outlined below to seamlessly integrate Azure for social login on your captive portal.
Template Customization with Soul Template
This feature is compatible with the Soul template on Meraki hardware.
To start the configuration, “Azure” should be integrated with Kloud Manage, and refer to the Microsoft Authentication section to know how to do it.
In this case, proceed by selecting the Soul template using the designated button.
On the “Configure Template” page, click on the Welcome Page button.
Click on the settings button to customize the Index page.
In the settings window, select Azure as the form of social login. If second step mac authentication is needed, please check enable second step mac authentication checkbox.
Add the redirect URL of your captive portal to the Azure portal. Refer to the Add Redirect URI section in the Microsoft Authentication documentation for detailed instructions.
Creating a Two-Factor Authentication Group
In case of a MAC address not found error, create a group.
Only adding the MAC address is necessary for this Azure authentication.
Assign the user to the created group. Also, you can add expiry time also.
Save the changes.
Multiple MAC addresses can be added in this manner.
Once the above steps are completed, users can log in to the captive portal using Azure authentication.
Okta Authentication for Captive Portal
Overview
This technical documentation guides you through the process of configuring Okta authentication for a Captive Portal using the Pine template on EnGenius hardware. Follow the steps outlined below to seamlessly integrate Okta for social login on your captive portal.
Template Customization with Pine Template
This feature is compatible with the Pine template on EnGenius hardware.
To start the configuration, Okta should be integrated with KloudManage, refer to the Okta Authentication section to know how to do it.
For detailed instructions on customizing templates, refer to the Customizing Captive Portal Templates section.
In this case, proceed by selecting the Pine template using the designated button.
On the Configure Template page, click on the Index Page.
Click on the settings button to customize the Index page.
In the settings window, select Okta as the form of social login.
Add the redirect URL of your captive portal to the Okta App. Refer to the Okta Authentication document for detailed instructions.
Once the above steps are completed, users can log in to the captive portal using Okta.
Sponsor Authentication with OTP
Introduction
One method of authentication within captive portals is sponsor-based authentication, where users are granted access by a sponsor. In this document, we will discuss the setup and configuration of sponsor authentication with one-time passwords (OTPs) using the Flora template in Meraki hardware or the Raga template in Kloudspot Gateway hardware.
Template Customization
Choose the Flora template for Meraki hardware or the Raga template for Kloudspot Gateway hardware. For a detailed walkthrough on customizing templates, please refer to the “Customizing Captive Portal Templates” section.
Access the welcome page in the template configuration section.
Click on the settings button.
Select the following form fields: Name, Phone, Email, Sponsor Email, and WI-FI Access Period.
Note: WI-FI Access Period is optional but recommended for better control over access duration.
Scroll down and check the Sponsor Based Authentication checkbox.
Check the Enable Sponsor authentication with OTP option.
Note: If you only want Sponsor Based Authentication, you do not need to check the Sponsor authentication with the OTP.
Note: The captive portal’s expiration time will coincide with the access point’s expiration time if the WI-FI Access Period check box is not checked.
Add Sponsored Email or Domain
Access captive portal settings.
Go to Sponsor Authentication Settings tab.
Click on the Create new button.
Select the previously created template.
Choose one of the following options:
a. Enter the sponsor’s email address directly:
Check the Set Sponsor Emails checkbox.
Click on the Add email address button.
Enter sponsor name and email.
b. Provide Sponsor’s Email Domains:
Enter email domains, separating multiple domains with commas.
Set the timeout duration for sponsor requests.
Click the Save button to save the changes.
Testing
Now that the captive portal is configured, it’s essential to test it to ensure proper functionality. Test the captive portal by accessing the network and initiating the sponsor authentication process.
On the captive portal login page, enter the user’s email ID, phone number, sponsor’s email, name, Wi-Fi expiration time and click on the Request Access button.
Note: The Wi-Fi expiration time dropdown is only available if the WI-FI Access Period field is checked.
Authentication mail will be sent to the sponsor immediately.
The sponsor can approve or decline it.
Once approved, the user can use the internet.
MAC Authentication
Introduction
This technical document provides step-by-step instructions for configuring Captive Portal MAC Authentication using EnGenius hardware and Block template. Captive Portal MAC Authentication allows access to the internet only to users whose MAC addresses are whitelisted.
Template Configuration
Navigate to Captive Portal > Guest Portals > Create New.
Enter captive portal name and click on Create.
Choose the Block Template from EnGenius Hardware.
Navigate to the Access Blocked Page within the template configuration section.
Click on the settings button.
Configure the following parameters as per your requirements:
Logo
Title Text
Warning Text
Redirect URL
Background Image
Once configured, click on the Save Changes button to apply the settings.
Finally, click the Save All button to save the template.
Assigning the Captive Portal to Access Point
After creating and configuring the template, the next step is to assign it to an access point.
Check the Select Group checkbox and choose the group created in the previous step.
Add the MAC addresses of the users who should have direct access to the captive portal.
Once the above steps are completed, users whose MAC addresses are whitelisted will have access to the internet via the configured Captive Portal.
Assign a guest portal to the access point
Assigning a guest portal to your access point is a crucial step in ensuring that users connecting to your network have a seamless and branded experience. In this section, we’ll walk you through the process of linking your customized captive portal templates to your access points, making it easy for users to access your network while enjoying a cohesive and user-friendly interface.
1. You must first publish the newly created guest portal before adding it to the access point. To do so, navigate to the guest portal and press the publish button.
2. Navigate to ACCESS POINTS > NETWORK GROUPS. Select the Network groups
from the drop-down list.
3. After adding the network group, go to the Network profile tab and click
the edit button.
4. Then, in the edit window that appears, check the Published template box,
and select the guest portal to which you want to assign it. Click Save.
5. Then, on the Assigned APs tab, navigate to Sync All APs > Captive
Portal. You will receive a successful message notification immediately.
6. The guest portal has been added to the access point successfully. To test
the guest portal, connect with the wifi. The guest portal you created can be
found here. If not, repeat steps 1–5.
Log into the guest portal
Once you’ve successfully integrated the guest portal with your access point, the next step is to log in and explore its functionalities. This section will guide you through the login process, allowing you to harness the full potential of your guest portal’s features and user management capabilities.
1. When you connect to Wi-Fi, the login page will appear.
2. Fill in the form field information. This will differ depending on the portal you enter.
Note: Email information is requested in this case. Depending on the
portal you are entering, you may be asked for your name, username, phone Etc.
3. Then click Verify by Admin Authentication button.
Note: There are many types of authentications. Here admin authentication
is used. In addition, other authentication methods are used depending on the
convenience of the provider.
4. As soon as the guest user clicks on the Verify by Admin Authentication
button, the CP_ADMIN and CP_USER will receive an email, informing them that a
new guest user request has arrived.
5. After the authentication process, the connection will be activated.
Guest Management
With your guest portal seamlessly integrated into your access point, it’s time to dive into effective guest management. This section provides you with an in-depth understanding of how to efficiently manage guest users, ensuring a secure and streamlined experience for both you and your guests. From creating guest accounts to approving or declining user requests, setting up user whitelists and blacklists, and even creating guest tokens, this comprehensive guide empowers you to make the most of your guest management capabilities.
1. In this section, we delve into the crucial process of generating guest user accounts within your captive portal. Creating guest users is a fundamental step with multifaceted benefits.
By crafting individualized guest accounts, you gain control over access, ensuring that only authorized individuals can connect to your network. This level of control enhances security and provides a more personalized experience for your guests.
Moreover, guest user creation empowers you with the ability to monitor and track network usage, fostering accountability and compliance. Additionally, this feature streamlines the authentication process for your guests, ensuring a seamless and secure connection.
2. To facilitate this process, it’s necessary to include fields for entering a user ID and password on the guest portal’s welcome page. To learn how to design a welcome page with these elements, please consult the “Customizing Captive Portal Templates”
section for detailed instructions.
4. Then Navigate to CAPTIVE PORTAL > GUEST USERS > Add Guest user.
5. Fill in the following in the window that opens.
User ID: Enter the User ID that will help the user to log in.
Name: Enter the User’s name.
Email: Enter the User’s Email address.
Allowed Number of Devices: Enter the limit on how many devices this token
can be used on.
Additional User Info: Enter any additional information about the user
here. This is optional.
Max Bandwidth per Device in MBs (0 for unlimited): Enter the maximum
bandwidth available with this token.
Max Upload Speed per Device in MBPS (0 for unlimited): Enter the maximum
Upload Speed available with this token.
Max Download Speed per Device in MBPS (0 for unlimited): Enter the
maximum Download Speed available with this token.
Start DateTime: Select the date from when this token should be activated.
Expiry DateTime: Select the last date for which the token should be
active.
Password: Enter the password required to login to the user.
Re-enter Password: Re-enter the password.
6. Click on the Save button to save the guest user.
7. If you want to add multiple users together, you can use the Bulk Upload
Multi-Users option.
8. You can do more with the buttons below the action field.
1. Edit User details
2. Credit details
3. device details
4. Change the password
5. Delete the user
Approve or decline the user request
In cases where the chosen authentication method is “Verify by Admin Authentication,” guests entering the portal are required to provide their email ID and send an authentication request. In this section, we’ll explore the steps to either APPROVE or DECLINE these authentication requests.
1. When you connect to Wi-Fi, the login page will appear.
2. Fill in the form field information. This will differ depending on the portal you enter.
Note: Email information is requested in this case. Depending on the
portal you are entering, you may be asked for your name, username, phone Etc.
3. Then click Verify by Admin Authentication button.
Note: There are many types of authentications. Here admin authentication
is used. In addition, other authentication methods are used depending on the
convenience of the provider.
4. As soon as the user logs in, the CP_ADMIN and CP_USER will receive an
email, informing them that a new user request has arrived.
5. After the authentication process, the connection will be activated.
Approve a new user request.
1. If Admin Authentication is enabled in the authentication type. Each new user must be approved by the CP_ADMIN/CP_USER. Follow the steps described below to accomplish this.
3. Then Navigate to CAPTIVE PORTAL > USER AUTHENTICATION.
4. The next window displays a list of all authentication requests. Here admin
can approve or decline as required.
5. After you approve, enter the user’s allotted time in the popup window that
appears and click the Save button. By default, one day is permitted. You
can edit it if you want to make changes.
6. The user will receive an approve/decline message after 1 minute of
approval/decline.
Note: This is decided by the admin. Default it is 30 sec, it can be made
up to 120 sec according to the requirement of admin.
7. Then ‘ Click here to continue’ button and access the portal.
Create a user whitelist
1. This feature is particularly useful for scenarios where certain users, such as staff or trusted individuals, should have uninterrupted internet access without the need to authenticate through the captive portal. By creating a User Whitelist, you can streamline their connectivity experience while ensuring that others still go through the necessary authentication steps.
In this section, we will explore how to set up and manage a User Whitelist within your KloudPortal configuration.
2. To create a user whitelist, Log in to your Kloud Manage account.
3. Then Navigate to CAPTIVE PORTAL > USER WHITELIST > Create User.
4. Enter all the necessary information and click the Save button.
5. There are two choices available: either include this device in an existing
group or specify a custom expiration date. Choose any of these as per your
requirement.
Create a user blacklist
1. Creating a User Blacklist is a crucial aspect of network management, especially when you need to restrict specific users’ access to your network. Unlike the User Whitelist, which grants certain individuals uninterrupted internet access, the User Blacklist allows you to block or suspend access for specific users or devices.
In this section, we will delve into the process of setting up and managing a User Blacklist within your Kloud Portal configuration.
3. Then Navigate to CAPTIVE PORTAL > USER BLACKLIST > Create New.
4. Enter all the necessary information and click the Create button.
Create a Group Whitelist
The group whitelist feature is a way to allow a specific group of users to
bypass the captive portal login process and access the internet directly. This
feature can be useful in situations where certain users, such as employees or
trusted partners, need to have immediate access to the internet without having
to log in every time they connect to the network.
2. Then Navigate to CAPTIVE PORTAL > GROUP WHITELIST > Create Group
3. Fill in all the details and click the Save button.
4. Then click on the Upload Bulk Users CSV icon from the action column.
5. In the window that opens, you can upload the CSV file.
6. Click on the " Click here to download the sample file " button to get
a sample of the CSV file.
7. You can add the required information in the downloaded .csv file. Things
to keep in mind while adding information are given in the CSV file.
8. Once the CSV file is ready, click on the question mark symbol in the popup
window. Then select the CSV file you saved and click on the Save Changes
button.
Create a guest token
1. A guest token serves as an exclusive identifier designed for individuals using a captive portal for their initial network access. It eliminates the necessity of entering a username and password, as the guest token serves as the primary login credential for users.
Furthermore, guest tokens can be customized to automatically expire either after a defined duration or when the user logs out. This functionality plays a vital role in enhancing network security by guaranteeing that access is restricted exclusively to authorized users, thereby safeguarding the network from unauthorized entry.
3. Then Navigate to CAPTIVE PORTAL > GUEST TOKENS > Add Multi-Device
Tokens.
4. Fill the following in the window that opens.
Check the Active checkbox to activate the token.
Token: Enter the token you want to create here. The user will log in
using this.
Allowed Number of Devices: Enter the limit on how many devices this token
can be used on.
Max Bandwidth per Device in MBs (0 for unlimited): Enter the maximum
bandwidth available with this token.
Max Upload Speed per Device in MBPS (0 for unlimited): Enter the maximum
Upload Speed available with this token.
Max Download Speed per Device in MBPS (0 for unlimited): Enter the
maximum Download Speed available with this token.
Start DateTime: Select the date from when this token should be activated.
Expiry DateTime: Select the last date for which the token should be
active.
5. Click the Save button to save the changes.
6. You can download a CSV file that contains all the registered tokens by
clicking on the ‘ Export as CSV ’ button.
7. You can print all the tokens by clicking on the ‘ Print Token ’
button.
8. You can filter tokens on the basis of their status, Token Group Name, and
Start Date Time.
9. If you want to generate tokens automatically then you can use the Generate Multi-Device Token option.
10. If you want to import multi-device tokens then you can use the Bulk Upload Multi-Device Token option.
Authenticate or decline a sponsored user
When utilizing Sponsor Email authentication in your portal, users are required to provide their email addresses, along with their sponsor’s email address, and then submit a request. Following this, both the administrator and the sponsor will expeditiously receive an email containing the authentication request. This section will provide comprehensive guidance on efficiently managing and responding to these authentication requests.
1. When a user enters the captive portal, they will be asked to enter the sponsor’s email id on the welcome page.
2. Enter the sponsor’s email address and click on the Request Access button.
3. The sponsor will receive the requested information via email immediately.
Click on the CLICK HERE button to access the approval page.
4. Sponsor can give his response by clicking on the Approve/Decline
button in the window that opens.
5. Once a response has been provided, the confirmation window will appear.
6. If it is approved, the user will get an email informing about it.
7. Then the user can use the internet by clicking the Click here to
continue button from the success page.
Campaign Management
In the area of campaign management, you get the ability to display sponsored content on the success page of your captive portal. This section will guide you through the process of creating and executing these engaging campaigns that will allow you to leverage the full potential of your captive portal’s success page.
Media resources serve as the fundamental building blocks. These resources encompass a variety of content types, from static images and slideshows to dynamic elements like YouTube videos, Twitter feeds, Google ads, and even Survey Monkey surveys. This section will guide you through the process of seamlessly integrating these diverse media resources into your campaigns, ensuring your content engages and captivates your captive portal’s audience effectively.
1. Resources to run in a campaign can be called as media resources.
3. Then Navigate to CAPTIVE PORTAL > MEDIA RESOURCES > Add Media
Resources.
4. Enter the resource name and select the media type from the drop-down.
5. Media types supporting Images, slideshows, and videos are static content
and YouTube, Twitter, google ads, and survey monkey are external content.
6. Custom content can also be included on the web page and will be presented
on the campaign.
7. Select the type, add the content, and click on the Save button.
8. New added media resources will display on the table with some actions.
Edit icon: allows the user to edit the resource.
Delete icon: allows the s user to delete the added resource.
Preview icon: allows the user to view the resource.
Media Campaigns
1. After adding your media resources, the next step is creating media campaigns. In this section, we’ll guide you through crafting effective campaigns that make the most of your resources. You’ll learn how to create engaging campaigns that leave a strong impression on your captive portal’s audience.
2. To set up a media campaign, it’s essential to begin by adding a media resource. You can find instructions on how to create a media resource in the “Media Resource” section.
4. Then Navigate to CAPTIVE PORTAL > MEDIA CAMPAIGN > Add Media Campaign.
Basic
1. Add a media name and select type, two types of media campaign options are provided which are online and offline.
2. Online campaign is referred to as the Kloud portal, and it runs only when the user is connected.
3. Offline type campaign runs after the user is logged in and got out of
network, so it is scheduled
4. Trigger condition and Campaign frequency can be selected depending upon
the user’s choice to run a campaign.
5. Select a weight to prioritize the run time of the campaign.
Content
1. Select Content Type and media Resources then click the Next button.
2. Content Type: it will only have static content images, slideshows, and
videos.
Filter
1. Filters to run a campaign based on some attributes such as tags.
2. Enabled access points with some tags, so that campaign run on users who are connected to those ap’s and devices.
3. User can add more demographic options to run campaigns for specific users such as gender, age group, browser, devices, OS.
Schedule Campaign
1. Users can schedule a campaign by selecting the day and time to run a campaign and can also opt for the always option.
2. The campaign will be different depending on when the user logs in
Location
1. Campaigns will run on a selected location; the user can also select the zone and the particular devices for a campaign to run.
2. Click the Save button to save the campaign.
3. Once the campaign is created, it will be shown in the campaign list.
Edit icon: Allows to edit the campaign.
Delete icon: allows to delete the added campaign.
Captive Portal Usage report
You can access a variety of tools to analyze your portal’s usage. In this section, we’ll show you how to create an SMS count report as an example. You can use a similar process to generate other useful reports. Let’s get started and explore the valuable insights available in your Captive Portal Usage Reports.
Schedule SMS count report
1. Log in to your KloudManage account. Then navigate to Report > Schedule > +Add Report Schedule.
2. In the window that opens, enable the Active checkbox. It helps to
activate and deactivate the report.
3. Select the SMS count report (CSV) from the Report Type dropdown
list.
4. In the Schedule Name text box, give your report a name.
5. Then, choose SMS Frequency. There are three frequency options available.
Daily, weekly, and monthly.
6. The report for that period will be generated based on the frequency you
specify. For example, if you choose the daily frequency, you will receive a
daily report of SMS sent.
7. Then select the period for which this report should be generated from the
dropdown list.
8. Report visibility can be customized. Check All check box if you
want this report to be visible to everyone. If the report is only visible to a
small number of people, users can be added by checking the Users check
box.
9. Then, choose the report context. Check the Account checkbox if you
want the report at the account level. If you want a report on a specific
venue, check the Venue check box and choose the desired location.
10. Then enable notify contact and select contacts from the dropdown list.
Info
Contacts will be shown in the list only if they are present in the system.
To add a contact, navigate to Settings > Contacts > +Add contact.
13. If you want to generate your report immediately, click the Run
button.
14. Select the start and expiry dates in the popup window that appears, then
click the Run Now button. The report will be generated immediately.
15. To view the generated report, go to the History menu. Then, click on
the report, The CSV file of the report will download immediately.
Multilingual Support
Multilanguage support in captive portals allows users to select their
preferred language from the dropdown menu. Once a language is selected, the
captive portal login page is displayed in that language.
Create a guest portal with the Siara template.
1. Login into the NMS portal.
2. From the left side panel, go to Captive Portals - > Guest Portals.
3. Click on create new to create a new portal. Give a name to the portal
and click on Create.
4. The majority of hardware also supports Multiple Language. You can select the Multiple Language support option from the Features dropdown list and find the hardware it supports and the templates it contains.
5. Configure the template as required and save the template. To learn more about template customization, refer to the Customizing Captive Portal Templates section.
Add the desired languages.
1. After the successful creation of the templates, click on + icon (Add Languages) as shown below.
2. Choose the required language from the dropdown and click on Add Language button.
3. After the Language is translated and added, click on the Save button
below as shown.
4. After saving, click on Publish icon and now the published portal will
have selected languages.
5. The sample page may look like this. Please make sure, every time when the
page is edited, the whole process of language addition needs to be followed.
6. If necessary, the user can download and view the translated files for each
HTML page by clicking the links provided in the 2nd column with the title
download/view translated files.
7. In any case if the user wishes to change the translation text which is
different from the translation provided. Follow the steps below.
Download the file to which the translations need to be modified (Downloading a file can be done as mentioned in the 6th point)
Search the existing translation in that file that needs to be changed.
Replace with the required text and save it.
Now click on the checkbox next to the page for which the modified file needs to be uploaded.
Click on choose file.
Upload the modified file.
Click on the save modified file button.
Click on save at the bottom of the page to go back to the portals.
Publish it.
Hardware and Templates
This document aims to provide an in-depth understanding of the hardware options offered by KloudPortal, the diverse range of templates available within each hardware, and the extensive array of authentication types and features that these solutions encompass.
KloudPortal’s commitment to excellence is reflected in its innovative hardware offerings, catering to various organizational needs and industry requirements. From the hardware selection process to the implementation stage, this document serves as an essential resource for network administrators, IT professionals, and decision-makers seeking to make informed choices about the ideal KloudPortal solution for their specific contexts.
The regional IP will be provided depending on the
region of the deployment.
Troubleshooting Guide
1. Captive Portal is Not Showing Up – Here’s Why and How to Fix it
Go to Gateway Devices.
Click on the name of your device.
On the left side menu bar, click Realtime Info.
2. MAC address showing in DHCP Lease, but Captive Portal not showing?
Click ‘Captive Portal Devices’ and check if users’ device MAC available here.
If the user’s MAC address is present here, then it should show the Splash Page.
3. MAC address showing under ‘Captive Portal Devices’ but still Splash Page
not visible?
Go to Gateway Devices -> Configurations (Network Groups in case of Access Points).
Select your Gateway Configuration (Network Groups in case of Access Points).
Click on LAN Profile (Network Profile in case of Access Points).
Verify the ‘Guest Template’ entered there. If it’s a template URL, verify if the URL is correct.
4. Splash Page still not showing or splash page not redirecting to facebook
or twitter, instead it’s just reloading?
Note: The network device configurations vary between devices. Some configurations include only a White IP list, while others feature both a White IP list and a White Domain list.
Go to Gateway Devices -> Configurations (Network Groups in case of Access Points).
Select your Gateway Configuration (Network Groups in case of Access Points).
Click on LAN Profile (Network Profile in case of Access Points).
Verify ‘White Domain List’. Check if URLs are entered correctly.
5. After successful Authentication, if you click on ‘Click Here To Continue’
the same success page reloads.
Go to Gateway Devices -> Configurations.
Select your Gateway Configuration (Network Groups in case of Access Points).
Click ‘Assigned Gateways’.
Click ‘Sync All Gws’ button -> Captive Portal. It will sync the device with the captive portal and then it should connect.
6. Gateway Device is synced with the Captive Portal but still after
successful Authentication, if you click on ‘Click Here To Continue’ the same
success page reloads?
Go to Gateway Devices.
Click on the name of your device.
From the menu, click Realtime Info.
Click Captive Portal Active Devices.
If you get the users’ MAC address here, that means the Authentication is successful and it should get access to the internet.
7. How to troubleshoot if authentication fails?
Go to Gateway Devices -> Configurations (Network Groups in case of Access Points).
Select your Gateway Configuration (Network Groups in case of Access Points).
Click on LAN Profile (Network Profile in case of Access Points).
Verify ‘Guest Template’ and ‘White Domain List’. Check if URLs are entered correctly.
If this is correct, Click ‘Assigned Gateways’.
Click the ‘Sync All Gws’ button -> Captive Portal. It will sync the device with the captive portal and then it should connect.
If it still fails, click Captive Portals -> Radius Data.
From the ‘Device Type’ drop-down, select ‘Radius Account Mapping’.
Search for your Gateway Device MAC address.
If the Gateway Device MAC address is present, then your Gateway Device is Authenticated with the Radius Server.
Now, select ‘Radius User Authentication’ from the ‘Device Type’ drop-down.
Search for users’ MAC address. If present, then the user is Authenticated.
8. If the user is Authenticated, but the internet not working
If it still fails, click Captive Portals -> Radius Data.
From the ‘Device Type’ drop-down, select ‘Radius User Attributes’.
Search for your users’ MAC address.
This page will tell if internet is not working due to ‘Session-Timeout’
If it still doesn’t help, select ‘Radius Post Authentication Logs’ from the ‘Device Type’ drop-down.
This page will display the result after Radius Authentication. It will display whether the authentication is Accepted or Rejected.
Select ‘Kloudspot Radius Authentication’ from the ‘Device Type’ drop-down.
Search Users’ Mac address.
It will display the information regarding Authentication Start-time, Expiry- Time, First seen, and Last Seen.
9. Where to get User History?
Click on Gateway Devices (or Access Points) -> User Search.
Search User with User’s MAC Address.
It will provide all history of the user.
User Activity: when users connect to AP or Gateway Device.
Login: When the user login successfully. You can invalidate the user here. Access Expired: Internet access has expired or the user is invalidated.
Here, you will see the list of all the connected devices.
Check if the users’ MAC address of the device is showing or not. If the users’ MAC address is available, then the device is connected, else the device is not connected.
Kloud Portal FAQs
What is a Kloud portal?
A Kloud portal is a web page that appears when you connect to a public Wi-Fi network. It requires user interaction, such as accepting terms and conditions or providing login credentials, before granting access to the internet.
Why do I see a Kloud portal page?
You see a Kloud portal page to authenticate and authorize your usage of a public Wi-Fi network. It ensures that you comply with the network’s terms of use before accessing the internet.
How do I access the internet through a Kloud portal?
To access the internet through a Kloud portal, connect to the Wi-Fi network, and open a web browser. The Kloud portal page should automatically appear. Follow the instructions on the page to gain internet access.
What information is typically required to log in on a Kloud portal?
Commonly, the Kloud portal may require you to provide your name, email address, or password. Sometimes, you might need to accept the terms of service or enter an access code.
Is using a Kloud portal network secure?
Using KloudPortal is 100% safe and secure.
Why doesn’t the Kloud portal page load automatically?
There could be various reasons for this issue. Check if you are connected to the correct Wi-Fi network, try opening a non-HTTPS website to trigger the portal, or clear your browser cache and cookies.
What if I’m unable to access the Kloud portal page?
If you’re unable to access the Kloud portal page, try restarting your device, forgetting the Wi-Fi network and reconnecting, or contacting the network administrator for assistance.
Can I use a VPN with a Kloud portal?
While utilizing a VPN is possible, access to the internet will only be granted once you’ve successfully authenticated through the captive portal.
How long does my internet access last through a Kloud portal?
The duration of your internet access through a Kloud portal varies based on the network’s policies. Some networks offer free access for a limited time, while others require you to renew or extend your session periodically.
Do I need to go through the Kloud portal every time I connect?
It depends on the network’s settings. Some Kloud portals may remember your device for a certain period, allowing you to bypass the portal on subsequent connections within that timeframe.
Can I use my social media account to log in to a Kloud portal?
Absolutely, you have the capability! We provide the option to log in using a variety of social media channels, including Facebook, Twitter, Instagram, Microsoft, Azure, Google Workspace, and LinkedIn.
What if I encounter technical issues with the Kloud portal?
If you experience technical issues, such as page errors or connectivity problems, try refreshing the page, clearing your browser cache, or restarting your device. If the problem persists, seek assistance from the network administrator or customer support.
Can I access local resources like printers or shared drives through a Kloud portal?
For the devices like printers which can’t go through the splash page login process, we can whitelist the MAC addresses of those devices. So those devices will be using the internet without going through the login process.
Is my personal information safe on a Kloud portal?
Yes, your personal information is safe on a Kloud portal and will not be visible to anyone.
Can I use a Kloud portal on my mobile device?
Yes, Kloud portals are accessible on mobile devices. Connect to the Wi-Fi network, open a browser, and the Kloud portal page should appear.
This guide explains the installation process for the Kloudspot software stack on a single node, whether it’s a virtual machine or a bare-metal server running Ubuntu 22.04.
Components
The Kloudspot software stack consists of the following components, which can be selectively installed:
KloudHybrid
KloudInsights
KloudManage
You can choose which components to install by modifying the values in the YAML file used for the Helm chart installation.
System Requirements
To ensure smooth operation, it is recommended to meet the following specifications based on your desired configuration:
Minimum Specification
KloudHybrid (<3000 users) or KloudManage
4 cores
16 GB RAM
150 GB SSD/Disk (configured with LVM, with 50 GB assigned to /)
Medium Specification
KloudHybrid (>3000 users) or KloudInsights
8 cores
32 GB RAM
300 GB SSD/Disk (configured with LVM, with 50 GB assigned to /)
Full System Specification
For the complete software stack, it is recommended to have:
16 cores
64 GB RAM
1 TB SSD (configured with LVM, with 100 GB assigned to /)
System Configuration
Follow these steps to configure your system before installing Kloudspot:
Install the Ubuntu 22.04 Server image.
Update the system’s libraries using the following commands:
sudo apt-get update
sudo apt-get -y upgrade
Reboot your system after the upgrade.
Install the Kloudspot tools by running the following command:
Once the installation is complete, logout and log back in again.
Storage Evaluation
Two types of storage are used for the installation:
Shared - allocated from a dynamic NFS share backed using the OpenEBS LVM provisioner.
Unshared - allocated from a LVM volume group using the OpenEBS LVM provisioner.
There needs to be enough free storage available to satisfy both needs. You can use the ‘kloudspot storage’ tool to review the available storage and estimate the required storage.
sjerman@k8s-single:~$ kloudspot storage estimate
Assuming a 1 node cluster installation
Openebs not installed
? Do you want to install Openebs? : [? for help](y/N)installing OpenEBS...
Successfully installed OpenEBS.
All Pods are UP now...
Volume Groups:
- ubuntu-vg ( 498.0 GB - 398 GB free) on /dev/sda3
Total Free space: 398.0 GB
Disks:
/dev/sda (500G)/dev/sda1 (1M)/dev/sda2 (2G) mounted as /boot
/dev/sda3 (498G) in Volume Group ubuntu-vg
/dev/mapper/ubuntu--vg-ubuntu--lv (100G) mounted as /
What features do you want to use
? Enable KloudManage No
? Enable KloudInsights No
? Enable Kloudhybrid Yes
Using ubuntu-vg for unshared volumes
Available: Shared 82 GB, Unshared 398 GB
How much storage do you want to assign to each volume
? Stream processing elasticsearch (GB)10? Kloudinsights database (GB)200Required: Shared 0 GB, Unshared 200 GB
The configuration looks OK
Prepare Kloudspot Configuration
You can use the kloudspot init command to create a configuration file for your new system. It will ask a few questions and then create a configuration file (/etc/kloudspot/values.yaml) file with the necessary configuration.
Warning
If you want to use your own StorageClass configuration, then please refer
CustomStorage
sjerman@k8s-single:~$ kloudspot init
installing OpenEBS...
Successfully installed OpenEBS.
All Pods are UP now.
By default, the ingress controller will use a self signed certificate.
It is much better to use a ‘proper’ SSL certificate.
Do you want to add ssl certificate? y/n
? Enter ssl key filepath: server.key
? Enter ssl ssl cert filepath: server.cert
Initialize Kloudspot System Configuration
First basic system information...
? DNS Hostname dibble.net
? Customer Reference steve
What features should be enabled
? Enable KloudManage No
? Enable KloudInsights No
? Enable Kloudhybrid Yes
Using ubuntu-vg for unshared volumes Available:
Shared 32 GB, Unshared 49 GB
How much storage do you want to assign to each volume
? Stream processing elasticsearch (GB)10? Kloudinsights database (GB)10 Required:
Shared 0 GB, Unshared 20 GB 'values.yaml'created sucessfully.
Start Kloudspot Application
Deploy the helm chart using:
kloudspot start
The deployment will take a while to complete, use following command to monitor:
*1 : The installation can be configured to get these images from docker.kloudspot.com or they can be sideloaded. See here for details
Inbound
Single Node
The following inbound ports need to be allowed if the function is required
Port
Usage
Optional
30003/UDP
Aruba RTLS
yes
30004/UDP
Aeroscout
yes
30002/TCP
Meraki MV Sense MQTT
yes
30005/UDP
Huawei
yes
30006/UDP
Huawei BLE
yes
Cluster
Port
Usage
Optional
3333/UDP
Aruba RTLS
yes
5555/UDP
Aeroscout
yes
6666/TCP
Meraki MV Sense MQTT
yes
7777/UDP
Huawei
yes
7778/UDP
Huawei BLE
yes
Multi-node Cluster
Overview
The Kloudspot software stack can be run on a High Availability Kubernetes cluster (including 3 or more compute nodes). As with a Single Node Install, these instructions assume the use of MicroK8S however similar approach should work with other K8S installations.
The primary requirement is that the underlying hardware must itself be highly available - no shared power, networking or physical components.
Stateless components will fail over to other nodes.
Stateful components with LVM storage will continue to operate with degraded availability.
Stateful components with shared storage will fail over to another node.
When the failed node comes back up:
Stateless components will rebalance if necessary.
Stateful components with LVM storage will restart, automatically resynchronize and start operating with full availability.
Stateful components with shared storage will rebalance if necessary.
System requirements
Important
Any system used needs to support the AVX flag - most newer bare metal systems will support this. VM servers often don’t by default. Please refer to your VM server documentation.
Each node should have a minimum of the following specification:
8 core
32 GB RAM
1 x 1TB SSD configured using LVM with 100 GB assigned to /
Ubuntu 22.04 Server image
The recommended spec when running both KloudInsights and KloudManage is:
16 core
64 GB RAM
1 x 1TB SSD configured using LVM with 100 GB assigned to /
Ubuntu 22.04 Server image
Three nodes are required for a system to be able survive node failure, however if there is a heavy load on the system, one or more worker nodes may need to be added to the cluster to provide extra capacity.
Important
Before you start the steps below, please obtain the following:
A static IP Address for each node
A static shared IP Address to use for the load balancer
A DNS entry for the shared IP address
A TLS certificate and key to use for the shared IP address (recommended)
Configure Each System
Install Ubuntu 22.04 on each system, and then update the system to the latest libraries:
sudo apt-get update
sudo apt-get -y upgrade
Info
Take the defaults for any questions
Reboot, then install the Kloudspot tools using the following command:
Create a volume in the LVM volume group created during installation that can be used for shared storage. Typically, the volume group will be called ‘ubuntu-vg’, so the following command shoud work:
sudo lvcreate -L 20G -n shared ubuntu-vg
Cloning Cluster Nodes
At the point you have a configured system that you can use to create clones.
Basically run this command on one node to get the command to run on another node.
microk8s add-node
If you have 3 nodes, allocate all 3 as managers.
If you have more than 3 nodes, allocate 3 as managers and the rest as workers.
Run the following commands to enable the other required MicroK8S add-ons:
microk8s enable dns
microk8s enable ingress
For full high availability we need to configure a virtual shared IP and a load balancer. We use metallb for this. It needs to be configured with a fixed static IP address. Run the following commands on one of the nodes…
microk8s enable metallb:<ip address>/32
Configure Storage
Two types of storage are used for the installation:
Shared - allocated from a OpenEBS cStor shared filesystem.
There needs to be enough free storage available to satisfy both needs. You can use the ‘kloudspot storage’ tool to review the available storage and estimate the required storage.
kloudspot@nmsc02:~$ kloudspot storage estimate
Assuming a 3 node cluster installation
Openebs not installed
? Do you want to install Openebs? : [? for help](y/N)installing OpenEBS...
Successfully installed OpenEBS.
All Pods are UP now...
Volume Groups:
- vg_data ( 93.1 GB - 87.1 GB free) on /dev/sdb1
- vg_share ( 106.9 GB - 0.0 GB free) on /dev/sdb2
Total Free space: 87.1 GB
Disks:
/dev/sda (50G) /dev/sda1 (1M) /dev/sda2 (50G) mounted as /
/dev/sdb (200G) /dev/sdb1 (93.1G) in Volume Group vg_data
/dev/sdb2 (106.9G) in Volume Group vg_share
/dev/mapper/ubuntu--vg-shared (100G)What features do you want to use
? Enable KloudManage : No
? Enable KloudInsights : Yes
? Enable Kloudhybrid : No
Using vg_data for unshared volumes
Available: Shared 106 GB, Unshared 87 GB
How much storage do you want to assign to each volume
? Stream processing elasticsearch (GB) : 10? Stream processing state storage (GB) : 10? Kloudinsights database (GB) : 10? Kafka distributed messaging (GB) : 2? Zookeeper coordinator (GB) : 2Required: Shared 20 GB, Unshared 14 GB
The configuration looks OK
Remember each node needs this amount of storage
Prepare Kloudspot Configuration
You can use the ‘kloudspot init’ command to create a configuration file for your new system. It will ask a few questions and then create a ‘values.yaml’ file with the necessary configuration.
Warning
If you want to use your own StorageClass configuration, then please refer
CustomStorage
sjerman@k8s-single:~$ kloudspot init
installing OpenEBS...
Successfully installed OpenEBS.
All Pods are UP now...
# If you have multiple bd on a node , select appropriate bd from list:which blockdevice do you want to use for node cluster1 ? blockdevice-b168c57f62054cfea8ee52cbde230d77
which blockdevice do you want to use for node cluster2? blockdevice-124ba28ef2874c3aa2a94967ccda6000
which blockdevice do you want to use for node cluster3 ? blockdevice-04f218481b2c48b3aa2dd1f1767c4823
Waiting for all CSPI UP...
CSPI up now!
Initialize Kloudspot System Configuration
By default, the ingress controller will
use a self signed certificate. It is much better to
use a ‘proper’ SSL certificate.
Do you want to add ssl certificate? y/n
? Enter ssl key filepath: server.key
? Enter ssl ssl cert filepath: server.cert
Initialize Kloudspot System Configuration
First basic system information...
? DNS Hostname dibble.net
? Customer Reference steve
What features should be enabled
? Enable KloudManage No
? Enable KloudInsights No
? Enable Kloudhybrid Yes
Using ubuntu-vg for unshared volumes
Available: Shared 32 GB, Unshared 49 GB
How much storage do you want to assign to each volume
? Stream processing elasticsearch (GB)10? Kloudinsights database (GB)10Required: Shared 0 GB, Unshared 20 GB
'/etc/kloudspot/values.yaml' created sucessfully.
Deploy Kloudspot Helm Chart
Deploy the helm chart using:
kloudspot start
The deployment will take a while to complete, use following commands to monitor:
microk8s helm3 status kloudspot
microk8s kubectl get all
kloudspot status
The ’nicest’ way to explore the system, access logs etc is using the dashboard. You can enable an ingress for it using the following in the ‘values.yaml’ file:
debug:
dashboard: true
And then go to https://<ip or hostname>/k8sdash/
You can get the required token using the following command:
kubectl create token default
If you just want temporary access, you can start up a proxy on a proxy port:
microk8s dashboard-proxy
The dashboard will be available on port 10443. Authenticate using the token that prints to the console.
Debug Container
Run the following command to enable:
kloudspot debug enable
A debug shell POD will be created containing useful utilities for accessing the database, Kafka etc.. You can connect to it either via the dashboard or via the CLI:
kloudspot connect <container>
Configuration Values
All of the configuration for the helm chart is set via the ‘/etc/kloudspot/values.yml’ file.
Since that file will gently age, you can get current values from the helm command:
defaults from helm chart:
microk8s helm3 show values kloudspot/kloudspot
values overrides being used currently:
microk8s helm3 get values kloudspot
all values being used currently:
microk8s helm3 get values --all kloudspot
Remember that you need to update the helm chart to get the ’latest’ stuff:
microk8s helm3 repo update
Storage Configuration
LVM Volume Group Configuration
Detailed information on LVM volume group configuration is beyond the scope of these instructions. See here for a readable guide.
However, two common scenarios are as follows:
Default Ubuntu installation on a single disk.
The Ubuntu installer, by default, creates a LVM volume group occupying the whole disk and then allocates 50% of the VG or 30 GB from the group as the root directory (’/’). The free space on the disk is then available to create other volumes.
Two Disks.
If you have a separate disk allocated for LVM, you probably need to create a Volume Group. You can use the following commands to identify a disk and provision it for LVM
List available disks:
sudo lsblk -p # find disks
NAME MAJ:MIN RM SIZE RO TYPE MOUNTPOINT
...
├─/dev/vda1 252:1 0 1M 0 part
├─/dev/vda2 252:2 0 2G 0 part /boot
└─/dev/vda3 252:3 0 98G 0 part
├─/dev/mapper/ubuntu--vg-ubuntu--lv 253:0 0 49G 0 lvm /
└─/dev/mapper/ubuntu--vg-gluster 253:1 0 49G 0 lvm
/dev/vdb 252:16 0 200G 0 disk
└─/dev/vdb1 252:17 0 200G 0 part
There are a few potential issues that can prevent proper startup. The notes below all assume that you have started up the Kubernetes Dashboard.
Storage Provisioning
The most common reason for components not starting up correctly is incorrect storage provisioning. When the Helm chart is set up, a number of Persistent Volume Claims (PVC) are set up. The claims are requests of the underlying storage provisioning for a volume with a specific size, access model and storage class.
Single Node
In a single node, all except one PVC will provisioned using OpenEBS Local LVM from the LVM volume group defined by storage.local.vg.
So ensure that this Volume Group has enough free space. If you look at the PVC list in the dashboard you should be able to spot the issue.
The remaining PVC (for Flink job manager state) will provisioned using OpenEBS NFS storage. This type of storage is used to allow the storage to be shared between multiple PODS ‘ReadWriteMany’. The storage will be provisioned from the root file system.
Multiple Nodes
In a cluster, two types of storage class are used:
Again you should ensure that there is enough of each type
TLS
If your HTTPS certificate is not working correctly, you can look at the Ingress logs for possible issues with the certificate.
Image Downloads
There are a few ‘containerd’ commands that can be useful when figuring out what is happening with image downloads:
microk8s ctr images check
Shows what images are being retrieved (which might include multiple image layers).
microk8s ctr content active
Shows active content (images/manifests) transfers.
Limited Internet Access
Kubernetes pulls images from the network according to the ImagePullPolicy which is set to IfNotPresent for the Kloudspot application containers.
The rule works as follows:
If the image tag is not ’latest’ then the image is only pulled if it is not already present locally.
If the image is ’latest’ then the image will always be pulled.
So don’t set a tag to ’latest’ for an offline installation!
Docker Registry Access needed:
By default, the following URLs need to be accessible in order allow images to be loaded. If this is not possible, then you will have to sideload the images.
The data receiver can be set up in standalone mode to work as a proxy. In addition it can be configured as a High Availability/Scalable N+1 configuration using zookeeper for group coordination and leader election. These instructions only cover single server/non high available installation.
These instructions are for a single node non-HA receiver.
If required, the receiver can be set up in either an Active/Active (using 3 or more hardware independent nodes) or Active/Passive (using two nodes). Please ask if you need to implement these configurations.
Configuration
Please ensure that the server configuration is completed first - talk to Kloudspot support to get this done.
Proxy VM requirements
OS/Resources:
The VM running the proxy should have the following specification:
RAM: 8GB
Disk :50 GB
4 core
OS: Ubuntu 18.04
Firewall:
The following routes should be enabled:
From VM to WLC : port 16113
From VM to Kloudspot Analytics Platform : port 9094
Proxy Receiver Setup.
Set up and update/upgrade a clean installation of Ubuntu 18.04 LTS.
When installing from scratch, make sure to install the open SSH server to allow remote access.
Test connectivity to the WLC and the Kloudspot Analytics Server from the VM:
Verify that you now have the key with the fingerprint 7DD9 F762 BBDB FBC9 3103 4270 0B15 B423 21FA FC35, by searching for the last 8 characters of the fingerprint.
$ sudo service zookeeper start
$ sudo systemctl enable zookeeper
Kloudspot Support will provide a client.truststore.pkcs file and password, copy this to /etc/kloudspot and edit the /etc/kloudspot/receiver.yml configuration to set the password and server address:
The connection to the WLC is authorized using an MAC address and an SSL file. In order to regenerate this file following the following steps:
Edit the /etc/kloudspot/receiver.yml file. Remove the current MAC Address and set the keystore to an empty writeable location, also change the password if desired:
$ sudo -H -u kloudspot /usr/local/kloudspot/receiver/run.sh
...
**************************
Add this values to the config file (push.nmsp.macAddress) :
MAC: 50:D3:7B:5B:70:F8
Run this command on the WLC
config auth-list add sha256-lbs-ssc 50:D3:7B:5B:70:F8 fecb74538bb6be79f33b4dc23951552cd86523c0e563b5ac13070bf4205e0538
********************
Stop the receiver as soon as you see the connection command.
Copy the generated keystore (/tmp/wlc-keystore.pks) to /etc/kloudspot and edit /etc/kloudspot/receiver.yml as follows:
Because our VPN software might be included in the package list and we don’t want to upgrade any packages except regarding Kloudspot-receiver.
Ans. Yes, that approach is acceptable.
What version should kloudspot-receiver be upgraded to? Also, how can we confirm the version after upgrading? Will “kloudspot-receiver -version” work?
Ans. Ask Kloudspot for the appropriate version to upgrade to. To confirm the version, use the following command:
apt list kloudspot-receiver -a
Using a custom StorageClass
Most standard installatations on MicroK8S use OpenEBS for storage and are configured automatically. However, some installations might need a custom configuration - for example to use NAS storage.
It is possible to configure the system to use custom Kubernetes StorageClasses as follows:
Warning
You need to create your own custom StorageClass for RWX and RWO mode. Please refer to Storage Classes in the Kubernetes documentation.
You can use the ‘kloudspot init –custom-storage’ command to create a configuration file for your new system. It will ask a few questions and then create a ‘values.yaml’ file with the necessary configuration.
sjerman@k8s-single:~$ kloudspot init --custom-storage
? Storage Configurations : Use custom storage class.
Use custom storage class.
? StorageClass for RWO storage : Name: microk8s-hostpath, Provisioner: microk8s.io/hostpath
? StorageClass for RWX storage : Name: microk8s-hostpath, Provisioner: microk8s.io/hostpath
Now using custom StorageClass for configuration
Initialize Kloudspot System Configuration
By default, the ingress controller will
use a self signed certificate. It is much better to
use a ‘proper’ SSL certificate.
Do you want to add ssl certificate? y/n
? Enter ssl key filepath: server.key
? Enter ssl ssl cert filepath: server.cert
Initialize Kloudspot System Configuration
First basic system information...
? DNS Hostname dibble.net
? Customer Reference steve
What features should be enabled
? Enable KloudManage No
? Enable KloudInsights No
? Enable Kloudhybrid Yes
Using ubuntu-vg for unshared volumes
Available: Shared 32 GB, Unshared 49 GB
How much storage do you want to assign to each volume
? Stream processing elasticsearch (GB)10? Kloudinsights database (GB)10Required: Shared 0 GB, Unshared 20 GB
'/etc/kloudspot/values.yaml' created sucessfully.
Command Line Interface Overview
The Command Line Interface (CLI) in Ubuntu is a powerful text-based tool that offers efficiency, automation, and control. Accessed through the Terminal, it allows users to execute commands for file manipulation, system management, networking, and more. CLI’s advantages include resource efficiency, remote server management, and deeper system understanding. It complements the graphical interface, empowering users to customize their Ubuntu experience, perform complex tasks, and boost productivity. With scripting capabilities, the CLI becomes indispensable for system administrators, developers, and experienced users, providing unparalleled flexibility and insights into the Ubuntu operating system.
Configuration File Reference
kloudspot
A Helm chart for Kloudspot KloudInsights & KloudManage Applications
Enable ingress access to the dashboard Run ‘microk8s kubectl create token default’ to get the token.
debug.enabled
bool
false
Enable debug container
debug.persistence
object
{"size":"10Gi"}
size of volume for debug container
debug.privateApi
bool
false
Show private swagger docs
elasticsearch.persistence.size
string
"2Gi"
Size of volume used for elasticsearch
elasticsearch_nms.esmemory
string
"4g"
Elasticsearch Memory Allocation
elasticsearch_nms.persistence.size
string
"50Gi"
Size of volume used for legacy Elasticsearch
feature.demoData
bool
false
Load KloudInsights demo data
feature.digitaltwin
bool
false
Load DigitalTwin app
feature.fiware
bool
false
FiWare
feature.fiware_iot
bool
false
feature.frsvision
bool
false
Load frs-vision
feature.full
bool
false
Enable all KloudInsights functionality
feature.ha
bool
false
Configure cluster usage
feature.hybrid
bool
true
Enable KloudHybrid components
feature.kloudinsights
bool
true
Enable KloudInsights components
feature.kloudmanage
bool
false
Enable KloudManage components
feature.teams
bool
false
Load teams app
fiware
string
nil
frsvision.extra_env
string
nil
gateway.apikey
string
nil
Gateway API key
gateway.apisecret
string
nil
Gateway API secret
global.storageClass
string
"openebs-local-kloudspot"
Storage class used for dependency charts (Kafka/Zookeeper/MongoDB)
imagePullSecrets
string
"dockerregistrykey"
Secret used to access Kloudspot Docker Private Registry Please reach out to Kloudspot team for username and password
ingress
object
{"annotations":{},"spec":{}}
Custom ingress - replaces default
jobmanager.memory
string
"4096"
Memory allocated for Flink Job Manager (MB).
jobmanager.persistence.size
string
"1Gi"
Size of volume used for state storage
kafka.commonLabels.tier
string
"base"
kafka.logRetentionBytes
string
"_104857600"
kafka.logRetentionHours
int
48
kafka.logSegmentBytes
string
"_104857600"
kafka.persistence.size
string
"5Gi"
Size of volume used for kafka
kafka.zookeeper.persistence.size
string
"1Gi"
Size of volume used for zookeeper
kloudmanage.extra_env
string
nil
Map containing custom environment variables for receovers container (all values need to be strings)
kloudmanage.persistence.size
string
"50Gi"
Volume size used for all storage types
license_secret_name
string
"kloudspot-license"
name of offline license
mariadb-galera.commonLabels.tier
string
"base"
mariadb-galera.existingSecret
string
"kloudspot-secret"
mariadb-galera.persistence.labels.backup
string
"true"
mariadb-galera.persistence.size
string
"4Gi"
mongo_db
string
"jameson"
name of Mongo database
mongodb.commonLabels.backup
string
"true"
mongodb.commonLabels.tier
string
"base"
mongodb.persistence.annotations.backup
string
"true"
mongodb.persistence.size
string
"20Gi"
Size of volume used for database storage
mqtt_svc.credentials.password
string
"kloudspot123"
MQTT password @default not set
mqtt_svc.credentials.username
string
"kloudspot"
MQTT username @default not set
namespace
string
"default"
Namespace to deploy KloudInsights The namespace to use to deploy KloudInsights components, if left empty will default to .Release.Namespace (aka helm –namespace).
namespaceCreate
bool
false
Create a K8S namespace if it doesn’t exist
receiverservice.extra_env
string
nil
Map containing custom environment variables for receovers container (all values need to be strings)
receiverservice.heap
string
"2048M"
Maximum Heap size for receiver service
storage.local.class
string
"openebs-local-kloudspot"
Storage class used for single node storage volumes
storage.local.vg
string
"ubuntu-vg"
storage.shared.class
string
"openebs-kernel-nfs"
Storage class used for volumes shared across a cluster
system.customer_ref
string
nil
Identifier for the customer system (used for licensing)
system.external_proxy
bool
false
Assume use of external reverse prozy so allow access via http
system.hostname
string
nil
The DNS hostanme for the system (required if using TLS cecrtificate)
system.ip_addr
string
nil
The IP address for the system (required for KloudManage)
taskmanager.memory
string
"4096"
Memory allocated for Task Manager (MB).
taskmanager.memoryManaged
string
"0.6"
% of Memory allocated for managed memory
taskmanager.taskslots
string
"8"
Number of Task Slots for Flink TaskManager
tls_secret
string
"kloudspot-tls"
name of the TLS secret
versions.digitaltwin
string
set to latest release
Version of DMS container
versions.dms
string
set to latest release
Version of DMS container
versions.fiware_broker
string
"1.2.0-PRE-1305"
Version of FiWare Orion-LD
versions.flink
string
set to latest release
Version of Flink container
versions.frsvision
string
"latest"
Version of frsVision
versions.insightsapp
string
set to latest release
Version of insights-app container
versions.kloudmanage
string
set to latest release
Version of KloudManage container
versions.receiverservice
string
set to latest release
Version of receiver-service container
versions.staticcontent
string
set to latest release
Version of DMS container
versions.teams
string
"2.0.257"
Version of DMS container
versions.webui
string
set to latest release
Version of kloudinsights container
webui.extra_env
string
nil
Map containing custom environment variables for KloudInsights container (all values need to be strings)
You cannot directly edit cipher suites for cluster-agent. So either turn it off (microk8s disable ha-cluster) or ..
Edit /var/snap/microk8s/current/args/cluster-agent and add:
--min-tls-version=tls13
Restart Microk8s
Run:
sudo snap restart microk8s
You can then check the port usage, using nmap as described above.
Monitoring
For a HA on-prem installation it is a good idea to set up monitoring and alerting so that you can monitor the state of the cluster and get alerts for issues such as memory limits exceeded or low disk space.
Once the kloudspot platform is installed, the necessary files will be installed in /opt/kloudspot/monitoring:
values.yaml : Helm chart configuration.
dashboard-config.yaml : Loader for Kloudspot specific dashboard.
monitors.yaml : Custom POD and Service monitor configurations to gather prometheus information from Kloudspot components.
sjerman@steve-nuc:/opt/kloudspot/monitoring$ kubectl apply -f monitors.yaml
servicemonitor.monitoring.coreos.com/kloudspot-flink-job-metrics created
podmonitor.monitoring.coreos.com/kloudspot-flink-tm-metrics created
servicemonitor.monitoring.coreos.com/kloudspot-web-ui-metrics created
Add a custom dashboard for the Kloudspot Platform:
sjerman@steve-nuc:/opt/kloudspot/monitoring$ kubectl apply -f dashboard-configmap.yaml
configmap/kloudspot-grafana-dashboard created