Getting Started

Welcome to Kiwire & Omaya Documentation! This guide will walk you through how to get started in the Kiwire & Omaya in version 3.0, dashboard, the centralized cloud management platform for all compatible devices and services. 

This Documentation aims to provide you a guide on how to manage and utilize Kiwire & Omaya 3.0 Platform effectively.

Preface

This documentation and all information contained herein (“material”) is provided for general information purposes only. Synchroweb and its licensors make no warranty of any kind, express or implied, with regard to the material, including, but not limited to, the implied warranties of merchantability, non-infringement and fitness for a particular purpose, or that the material is error-free, accurate or reliable. Synchroweb reserves the right to make changes or updates to the material at any time.

What's New in Kiwire 3.0?

The Kiwire version 3.0 now comes with the following new features and enhancement over previous edition.

No.FeaturesDescription
1.0Edition 
1.0 Support Single or Multi tenant edition
1.1 Support on-site installation as well as Cloud edition
No.FeaturesDescription
2.0System 
2.1 Support High Availability Setup
2.2 Password Security Adhere to global password security policy standard
2.3 Administrator and user password saved in encrypted format
2.4 Support unlimited administrator and users
2.5 Administrator/Operator role can be defined in detail
2.6 Provide schedule statistic reports to users & adminstrator
2.7 Support 2 Factors authentication for Administrator via Google Authenticator
2.8 Support multiple language (MY,EN,ESP)
2.9 Support dual theme (white and dark mode)
2.10 Support multiple timezone
2.11 Support Disconnect Message and Change of Authority (CoA)
2.12 Health check
2.13 Flexible as services can be split to multiple server for performance
2.14 Support devices which are not enabled cookies
2.15 Adjustable schedule date and time to perform check, reset and reporting
2.16 Tenant can use multi-tenant license or specific to the tenant license
2.17 SMTP server support TLS/SSL connection
No.FeaturesDescription
3.0Dashboard 
3.1 Provide overview of users connectivity and login activity
3.2 Provide statistic of users account summary , load and campaign effectiveness
No.FeaturesDescription
4.0Intergration with 3rd Party Services 
4.1 Support Radius & Federated Radius authentication
– wispr attributes
– RADIUS support group mapping via VSA
4.2 Support Active Directory authentication and support group mapping
4.3 Support LDAP authentication with multiple RDN checks and support group mapping
4.4 Support the following Social Login
– Facebook & Facebook page
– Twitter & Twitter page
– Instagram
– KakaoTalk
– VK
– Line
– Zalo
– WeChat
– Linkedln
4.5 Support 802.1X authentication
4.6 Support Microsoft network SSO Authentication
4.7 Support Radius Single Sign On ( SSO ) [ coming soon ]
4.8 Support Email verification
4.9 Support SMS authentication with 3rd Party SMS Gateway (goSMS, Genusis SMS, Twillio & more)
Support customizable SMS gateway
4.10 Support 3rd party Bulk Email Provider (Madmimi & Mailchimp)
4.11 Support Direct Database Authentication ( Oracle / MySQL )
4.12 Support Hospitality Property management System ( PMS ) such as
– Multiple PMS Protocols
– PMS agent (TCP to Kiwire API) for Kiwire cloud
– Support profile selection based on parameter pass to Kiwire
– Kiwire PMS Guest Interface using TCP connection
– HTTP Web Interface
– Certified Oracle Opera Link
– Cloud PMS (IDB PMS, Ezee, E-soft)
– Socket PMS (JDS, FCS, 3CX, Infor HMS, ABS, WinHMS, Oasis, Commanche)
– FIAS ( Fidelio Interface Application Specification )
4.13 Support with LBS Service (Omaya) [ coming soon ]
4.14 Support API integration
– RESTful API with JSON payload
– Support multiple API keys with specific permission
4.15 Support Payment Gateway integration such as [ coming soon ]
– PayFast
– Paypal
– Wirecard
– Alipay
– Stripe
– SenangPay
– Adyen
– Ipay88
4.16 Support Zapier Apps automation [ coming soon ]
No.FeaturesDescription
5.0Devices / NAS (Network Access Server) support 
5.1 Support Multi vendor & Brand Gateway devices/protocol such as
– Mikrotik
– Wifidog + with seamless login
– CMCC
– Cisco WLC
– Nomadix
– Meraki
– Fortigate
– Ruckus
– Zebra Wifi
– Xirrus
– Chillispot
– Aruba
– Cambium
– Huawei
– Sundray
– Ubiquiti
5.2 Built in Lite Device monitoring via SNMP v1 & 2c
5.3 Support device monitoring logs
5.4 Support Software Define Local Area Network ( SD-WAN ), which let operator create policy and rules based on smart zone define by ssid , vlan , ap or gateway and ip address.
5.5 Support unlimited zone & project mapping
5.6 Support limit connected user by zone.
5.7 Support zone by Network segment, VLAN, SSID, controller ID and controller zone.
5.8 Support different zone different user profilling
No.FeaturesDescription
6.0Login Engine 
6.1 Customizable user login flow using login journey editor
6.2 Support MAC sign up and login
6.3 Support Public sign up and login
6.4 Support approval signup and login (Sponsor signup), where guest require approval to approve the login
6.5 Support customizable notification messages
6.6 Support built in media browser
6.7 Support drag and drop user login page design.
6.8 Support customizable user login page design via html, bootstraps, javascripts and more. Page designer using Bootstrap as a design framework to meet the industry standard
6.9 Support QR login for users
6.10 Design own users templates such as
– Email design template
– SMS design template
– Voucher printout template
– User Status template
– Web Push notification template
6.11 Customizable auto login checks via zones, cookies, MAC or QR code
6.12 Create and capture unlimited data field from user sign up
No.FeaturesDescription
7.0Network Policy 
7.1 Option to Auto-disconnect same user session if same user relogin
7.2 Auto suspend users account if credit assign to the user have been exhausted
7.3 Option to remember user credential for the next login
7.4 Option to require 2 factor authentication for user login (via sms)
7.5 Option to require captcha
7.6 Support unlimited number of MAC Address to be registered per account.
7.7 Support user defined autologin validity
7.8 Allow options for password policies such as minimum 8 characters, contain 1 alphabet, contain at least 1 symbol and many more.
7.9 Block MAC and IP Address
7.10 Create dynamic zone restriction to specific zone
7.11 Dynamic Bandwidth , auto allocation bandwidth to zone or no of users , allow user to burst the network when usage is low and auto apply back limit when users count is higher
7.12 Support Vendor Specific Attribute (VSA) to enable device functionality
No.FeaturesDescription
8.1 Group users by Profile (bandwidth speed, usage time, quota and etc) and Personas (user demo graphic such as age, gender, location, birthday, email and etc)
8.2 Support unlimited users, voucher generation and profile
8.3 Bulk users editor.
8.4 Auto reset user account in schdule every 30mins, hourly, daily, weekly, monthly, yearly or once reached limit.
8.5 Import users account from CSV
8.6 Built in control panel for users to manage their own profile and setting
8.7 Forgot password via email or SMS
No.FeaturesDescription
9.0User control Panel 
9.1 Provide option to enable Users control panel for self service function
9.2 Auto add auto-login devices that does not support captive portal function
9.3 Self service change password
9.4 check current and historic login and usage
No.FeaturesDescription
10.0Marketing Campaign 
10.1 Built in Marketing campaign engine
10.2 Support Video/Image ads/Youtube Video Link/Message/JSON Server
10.3 Email Marketing
10.4 SMS Marketing
10.5 Support image ads for desktop,tablet and mobile view.
10.6 Support Survey management
10.7 support Coupon management
10.8 Support smart banner for mobile apps (iOS / Android)
10.9 Support web push notification to users
10.10 Support Retargeting Ads / Marketing [Coming Soon]
10.11 Support Marketing campaign engine require approval process pior set live
10.12 Support JSON data as ads source ( including Adobe Experience Manager )
10.13 Support ads by persona [based on previously login info]
No.FeaturesDescription
11.0Finance Module 
11.1 Generate / view invoice and status
11.2 Manual Posting of charges for PMS
11.3 Payment report, shows all the payment transaction via payment gateway
11.4 Support detailed voucher summary and able to export out.
11.5 Support printed voucher with multiple layout such as A4 size, POS size, QR code and many more.
No.FeaturesDescription
12.0Insight & Analytics Reporting 
12.1 More than 80 report pages
12.2 Accounts Summary : Overview of all account summary such as total voucher, total user, total accounts, total number of activated accounts, expired accounts and suspended accounts. Comes with pie charts. Able to export using CSV, PDF, print or copy to excel.
12.3 Accounts Expiry : all expired accounts listing, expiration date and interval (interval days to/from expiration date). Use the date range to search the expired account. Able to export using CSV, PDF, print or copy to excel.
12.4 Account Creator : View account creator – means who is creating the account and count how many times created either via system (if user use signup form to register), admin (if admin/operator created in Kiwire WebAdmin GUI) and etc. Use the date range to search to view the account creator. Able to export using CSV, PDF, print or copy to excel.
12.5 Voucher Activation : will list out all voucher that already activated by detecting if the voucher has been used to login to network. This will provide an actual usage revenue reporting based on usage of the voucher. Use the date range to search voucher activation account. Able to export using CSV, PDF, print or copy to excel.
12.6 Voucher Availability : list all of the available voucher that have not been use yet. (fresh voucher). Use the date range to search voucher availability.
12.7 Creation Summary : list all accounts created by date and total number of accounts created. Use the date range to search. Able to export using CSV, PDF, print or copy to excel.
12.8 Active Session : list all users who are connected to your network regardless from which NAS equipment or zone. It indicates how much your network been used. This metric directly correlated to the user’s satisfaction and to a high ROI. It will list out all the information such as, login time, username, MAC Adrress, IP Address, upload traffic, download traffic, zone, NAS id, average usage speed, class (smartphone, phablet, table, desktop), brand, model, OS and tenant. Able to export using CSV, PDF, print or copy to excel.
12.9 Login Record : list all the user logged in history report. All information such as login date/time, logout date/time, username, MAC Address, IP address, zone, reason of disconnection, total time usage, average bandwidth speed, traffic usage, class, brand, model and tenant. Able to export using CSV, PDF, print or copy to excel.
12.10 Login Summary : will provide a graphical and table report of the user login success and failure rate. This graphical report will provide insight on your network performance. For example if your users are having high rate of issue of wrong password or trouble login in. Use the search option to view specific date range. Also available to view by daily data, and you be presented the information of login transaction summary group by hourly for the particular date. Able to export using CSV, PDF, print or copy to excel.
12.11 Login Frequency : will provide a graphical chart and table report on the number of users login frequency over a period by succeed vs unique login. This report primary objective is to provide insight of user behavior. Use Search box date from and date to, to select the report period and zone if you wish to view by zone. An example use case will be if high total number of login and low unique users, means users may have problem accessing the network in a WiFi environment due signalling issue. Able to export using CSV, PDF, print or copy to excel.
12.12 Login Frequency by Profile : will show the login frequency-reporting group by profile. This provide insight on while profile is deem popular and are active during the duration of date selected. Use the date range selection to select the date of reporting you wish to view and if you wish to view by Project or Zone. Able to export using CSV, PDF, print or copy to excel.
12.13 Login Device Frequency : will show the login frequency by device MAC address/identity. This will detect if a same device used with multiple username or vice versa and provide an accurate login frequency, as usually the no of device is unique in a public WiFi environment. Also login device is an accurate way to determine the usage of the network. Use the date range to search date start and date end. In addition, the report available to view by daily data, and you be presented the information of login device frequency by hourly for the particular date. Able to export using CSV, PDF, print or copy to excel.
12.14 Login Error : will provide statistic and overview of error encountered by users in the last 24 hour. Able to export using CSV, PDF, print or copy to excel. Use the date range to search date start and date end.
12.15 Session Concurrency : shows the session concurrency . As some users may use more than 1 hour or days for their network access. Concurrency report will tell the actual connected user over the period. This report provide a graphical report of the concurrency and utilization of the network. This provide a way to plan for your network upgrade. Use the date range selector to select the report period and zone if you wish to view by zone. In addition, the report available to view by daily data, and you be presented the information of concurrent session by hourly for the particular date. Able to export using CSV, PDF, print or copy to excel.
12.16 Dwell Time Summary : will provide an analytic on users average usage time (HH:MM:SS) within the network. Dwell time will provide insight on your user average usage time. Use Search box date from and date to, to select the report period and zone if you wish to view by zone. In addition, there is a detail view that shows specifically dwell type of usage for example, how many users stay connected for 5min, 15min, 30min, 45min, 1hour, 2hours, 3hours, 4hours, 5hours, 6hours and more than 6hours.   Able to export using CSV, PDF, print or copy to excel.
12.17 The Dwell Time by Profile : will provide an analytic on users average usage time (HH:MM:SS) within the network by profile. Dwell time will provide insight on the profile average usage time. Use Search box date from and date to, to select the report period and zone if you wish to view by zone. In addition, there is a detail view that shows specifically dwell type of usage for example, how many users stay connected for 5min, 15min, 30min, 45min, 1hour, 2hours, 3hours, 4hours, 5hours, 6hours and more than 6hours by profile. Able to export using CSV, PDF, print or copy to excel.
12.18 The top account module describe total login by that specific user / mac. It helps to know which user is more actively using. Use Search box date from and date to, to select the report period and zone if you wish to view by zone. Able to export using CSV, PDF, print or copy to excel.
12.19 Return Account Summary : will shows the reporting of returning user, or user who has login and return to login over a period of time. Use Search box date from and date to, to select the report period and zone if you wish to view by zone. A high number of returning users shows that your venue has a loyal clientele and that your visitors appreciate your Wi-Fi service and use it multiple times. When users recognized by the network and are automatically reconnected, this information is shown in the database in their records, near the data of the single connections they did. In addition, there is a hourly view that shows specific hour how many total login, return user and new user. Both daily and hourly able to export using CSV, PDF, print or copy to excel.
12.20 Bandwidth Usage Summary : will show the total bandwidth usage used by users within the network. It also provide a graphical chart and table report on the number of download and upload bandwidth in Mbps. Use Search box date from and date to, to select which zone you wish to view, by zone. This report able to export using CSV, PDF, print or copy to excel.
12.21 Bandwidth Usage Per Account : will show the bandwidth utilization information send by NAS to Kiwire via radius accounting protocol. It will let you view the specific user bandwidth utilization. Use Search box to search date range and specific the username. The table will show download, upload, average Upload and Download Speed in (MB) as well. Use Date Search box date from and date to and select the username. This report able to export using CSV, PDF, print or copy to excel.
12.22 Historic Top Account : will show the top accounts who utilize the most bandwidth in the network. Use the date range if you want to sample specific dates for the report. Select the report period and select zone if you wish to view by zone. Select the type whether Download/Upload. This report able to export using CSV, PDF, print or copy to excel.
12.23 Current top user : will show the top user who utilize the most bandwidth in the network now. Select the zone if you wish to view by zone. The table will shows, login time, username, usage time, IP address, MAC address, download, upload, and average speed. This report able to export using CSV, PDF, print or copy to excel.
12.24 Bandwidth vs Login module will show network bandwidth utilization with the number of users connected during the same time.   It also provide a graphical chart and table report on the bandwidth vs user. This will let you understand the utilization of network bandwidth correlated with number of users connected. This report able to export using CSV, PDF, print or copy to excel.
12.25 Controller Bandwidth: will show you controller (NAS) bandwitdh usage via SNMP information. It will have total upload, total download and average bandwidth. Use the search option to view specific date range. Also available to view by daily data, and you be presented the information of controller bandwitdh summary group by hourly for the particular date. This report able to export using CSV, PDF, print or copy to excel.
12.26 Controller Report: will provide a graphical and table report of the controller status information. This graphical report will provide insight on your controller availibility. It also shows the incendent count how many times connection disconnected. Use the search option to view specific date range. Able to export using CSV, PDF, print or copy to excel.
12.27 Impression Summary: show all the details regarding captive portal or login page such as total impression, average impression, average login, and average unique login. In other words, it will provide you report of all the impression view by user. This including unauthenticated user as well. This is useful if you want to know how many unique user have view your message or slider advertisement. The Unique user are unique impression that view the impression and Total Impression is the overall view done by user. Use Search box date from and date to, to select which zone you wish to view, by zone. In addition, the report available to view by daily data, and you be presented the information of total login and total impression by hourly for the particular date. Able to export using CSV, PDF, print or copy to excel.
12.28 Campaign Impression Summary : provide a report on actual impression of the ads campaign by active campaign. Use the search box to see the date range for the report. In addition, the report available to view by daily data, and you be presented the information of total impression and unique impression by hourly for the particular date. It also provide a graphical chart for hourly impression and unique impression. Able to export using CSV, PDF, print or copy to excel.
12.29 Campaign Click Engagement: shows a report on actual users click or engage on ads or link of the all campaign. Use the date range to view the date range of the report. In addition, the report available to view by daily data, and you be presented the information of total click thru and total unique click by hourly for the particular date. It also provide a graphical chart for hourly clicked and unique clicked. Able to export using CSV, PDF, print or copy to excel.
12.30 Survey Response : The survey response date will display the record for the survey perform by users such as date/time, username, MAC Address of the device then followed by the survey answers. Use the date range to view the date range of the survey response report. Select the survey from the drop down to view the data recorded. Able to export using CSV, PDF, print or copy to excel.
12.31 User Device Info : will provide insight into your network, on what type of device and brand the user is using to connect to the network. Use the date selector to select the date range you wish to see the report. Able to export using CSV, PDF, print or copy to excel.
12.32 Registration Data : will display all the information recorded by the user during guest self-sign up as well as additional data-field that you may have setup at the data field module such as mobile no, email address, gender and etc. Use the date selector to select the date range you wish to see the report. Able to export using CSV, PDF, print or copy to excel.
12.33 Social Network Analytics : will provide an overview and insight of the social network growth and activity of your network. It also show the statistic of social network used by your network users, such as gender and age group. Use search box to select the date range. Able to export using CSV, PDF, print or copy to excel.
12.34 Social Network Data: shows information of users who use social network to login to your network, including demo / biography information of the users that sign up. Collected data are based on the users social privacy setting. Collected data such as fullname, gender, age group, location, email and birthday. Able to export using CSV, PDF, print or copy to excel.
13.0Help & Tools 
13.1 Online knowledge based provide a quick and easy way to access our Kiwire 3.0 online knowledge base and latest software documentation.
13.2 Diagnostic Account let you perform user account diagnostic using the username and password to check if there is any login problem of the account.
13.3 Software Update module enables you to setup the software update function of Kiwire. An active valid support subscription is required for this to function. There are 2 methods, auto-update or on demand update.
13.4 Database diagnostic show all available table that exist in the system with the status. Operation team will able to monitor the databased status from this module. Besides, they also can monitor database disk usage from time to time. In addtion, there is a database performance provides information and key statistic of the database performance. For databased maintence, it allows you to backup the exisiting database, Purge account inactive more than 6 months, Purge device history inactive more than 3 months, Purge survey response create more than 3 months, Purge network monitoring system (nms) log created more than 1 month, Purge general report data created more than 3 months, Purge device report data created more than 3 months, Purge dwell type report data created more than 3 months, Purge error report data created more than 3 months, Purge profile report data created more than 3 months, Purge campaign report data created more than 3 months, Purge controller report data created more than 3 months, Purge campaign unique data for click and impression created more than 3 months and Purge messages created more than 3 months.
13.5 System Health shows you an overall health status of Kiwire platform. It shows the system health dashboard. It consist of CPU load, memory usage, disk usage, all related services such as mariadb, redis, nginx, php-fpm, kiwire service, kiwire integration, HA replication, PMS-Guest, PMS-Opera and PMS-IDB
13.6 The License Usage module will show you the current utilization of license within your Kiwire platform. Able to export using CSV, PDF, print or copy to excel.
13.7 Network tool such as ping tool that helps you to verify if a domain/server is operating and network accessible. Network ICMP ping to a host and see the response time.
13.8 Find Mac Address lets you find the location and information related to a Mac address. It will provide insight of the login time, IP address location of the Mac device is being used in your network. Mac address are unique to a device. it also provide information of the Brand of the Mac address device if its from known manufacture and username registered with the mac address using mac auto register. Able to export using CSV, PDF, print or copy to excel.
13.9 The System Quick Fix lets you to fix the simple system issues very quickly such as Reset operator role, Clear cached, update System / Database / PHP Timezone and No file display / unable to upload in Login Engine -> Media
No.FeaturesDescription
14.0Cloud Management 
14.1 Dashboard, provide overview of users connectivity, login activity, statistic of users account summary , load and campaign effectiveness.
14.2 Tenant management, this allow operator to register new customer, update or delete existing customer.
14.3 Superuser management allow to add, update and delete superuser. In addition, support 3 types of superuser permission such as read, write & read+write.
14.4 Able to restrict superuser access for selected tenant
14.5 Role management for superuser, to specify which module/features that allow the superuser to access.
14.6 API integration for customer/tenant management.

Explore Kiwire 

You can find out more about Kiwire on our main site, including information on products and contacting our sales team.

Explore Kiwire

 

Explore Omaya 

You can find out more about Omaya on our main site, including information on products and contacting our sales team.

Explore Omaya

 

Contact Support

Most questions can be answered by reviewing our documentation, but if you need more help, our Technical Support is ready to work with you.

Open Case

 
Back to Top