Quick Start Guide - End to End IoT Solutions – WebNMS€¦ · Introduction The WebNMS IoT Quick...

Quick Start Guide

WebNMS IoT Platform

WebNMS IoT Platform – Quick Start Guide

2 Copyright @ 2019

Table of Contents

Introduction .................................................................................................................................................. 3 Installing WebNMS IoT ............................................................................................................................... 4

Installing on Windows System ................................................................................................................. 4

Installing on Linux System ....................................................................................................................... 8

Starting and Shutting Down the Server ..................................................................................................... 12 In Windows System ................................................................................................................................. 12

In Linux System ....................................................................................................................................... 14

Accessing the Web Application ................................................................................................................... 17 Adding Assets .............................................................................................................................................. 20

Asset Hierarchy ....................................................................................................................................... 20

Adding Organization ............................................................................................................................... 22

Adding Region ......................................................................................................................................... 22

Adding Site .............................................................................................................................................. 23

Adding Gateway and Sensors ................................................................................................................. 24

Viewing Asset Details ................................................................................................................................. 26 Dashboard Views ........................................................................................................................................ 29 Viewing Asset Location .............................................................................................................................. 32 FAQ .............................................................................................................................................................. 36


3 Copyright @ 2019

Introduction The WebNMS IoT Quick Start Guide explains the procedures involved in installing and getting started with WebNMS IoT Platform in different operating systems such as Windows and Linux.

Installation WebNMS IoT - Provides easy steps to install the product on Windows and Linux systems.

Starting and Shutting down the Server - Guides you to start and shut down the server.

Accessing the Web Application - Provides steps to connect to the web application.

Adding Assets - Provides step-by-step procedure to add the different assets.

Viewing Asset Details - Guides you to view the complete asset details.

Dashboard Views - Provides complete details about the dashboard for viewing complete asset details at a glance.

Viewing Asset Location – Provides the options available to view the assets location and their properties.

FAQ - Frequently asked questions by users are consolidated in this page.

Note: WebNMS IoT Platform's Mobile Apps are available for download. The Apps provide the user interface for monitoring and managing IoT assets remotely. Androd App : In the Play Store iOS App : In the App Store

Product Support

For sales queries, send mail to [email protected].

For technical support queries, send mail to [email protected].

For contact information, refer to the Contact page on our Web site www.webnms.com.

https://play.google.com/store/apps/details?id=com.webnms.iot

https://apps.apple.com/us/app/webnms-iot/id1477445552?ls=1

mailto:[email protected]


https://www.webnms.com/iot/contact.html

https://www.webnms.com/


4 Copyright @ 2019

Installing WebNMS IoT

Let's get started with the download and installation...

This section of the document provides easy step-by-step illustrations to install the WebNMS IoT Platform in Windows or Linux system. You will be able to run the application once you complete the installation.

Installing WebNMS IoT Platform

On Windows OS

On Linux OS

Note: All you need to do is to download the product and complete the installation wizard to install the WebNMS IoT Platform in your system. You can install the latest service pack over the product to ensure your product is up-to-date with the latest enhancements and bug fixes.

Note: By default, WebNMS uses the ports 9090 and 9089 as DATA and SERVER ports to send and receive data. Ensure these ports are available for proper working of the application.

Installing on Windows System

1. Download the Latest Product The latest free product download is available online. If you are having any issues / doubts in the downloading / installation of the product you can mail to [email protected]. The product can be installed in any of the compatible Windows systems. * Product : Download the installable .exe file for Windows. * Service Pack : Download the latest service pack. Note: It is recommended to install the latest service pack over the product installation for latest updates. To apply the latest service pack over the product, refer to the Installing Service Packs section.

2. Check Execute Permissions

1. Right click on the downloaded WebNMS_IoT_Platform_Windows.exe file. And click on the Properties item in the menu list.

2. Click on the Security tab in the Properties window.

3. Ensure that there is executable permission for the file for the logged in user.


https://www.webnms.com/iot/help/installation_guide/system_requirements/software_requirements.html

https://www.webnms.com/iot/download.html

https://www.webnms.com/iot/servicepack6_0.html

https://www.webnms.com/iot/help/installation_guide/index.html#installation_and_setup/service_pack/service_packs_iot.html



5 Copyright @ 2019

3. Run Wizard

1. Execute the downloaded product file (.exe). The InstallShield Wizard with the Welcome message is displayed.



6 Copyright @ 2019

2. Click Next. The License Agreement screen is displayed. Read the Agreement and select "I accept the License Agreement".

3. Click Next. The Localization screen is displayed. Choose the required language - English (default), Japanese, or Chinese.

4. Click Next. The Edition screen is displayed. It provides the choice of Server and Advanced installation options. Select Server to install the Combo package (BE server, FE server).


7 Copyright @ 2019

5. Click Next.

6. If you have chosen Server, skip this step and proceed to the next. If you have chosen Advanced, perform this step and proceed. When Advanced is chosen, the OEM Edition - Advanced screen is displayed with various installation options. Select the required type of installation.

7. Click Next. The directory location screen is displayed. Specify the location where the WebNMS IoT server has to be installed. Use the Browse button to specify a different location.

8. Click Next. The details of the installation (pre-installation summary) are displayed. If you need to change any of it, use the Back button to modify.

9. Click Next. The installation begins. Once the installation is complete, a final screen is displayed.


8 Copyright @ 2019

10. Click Finish.

Now on completing the wizard, the product is installed in the destination folder. It is recommended to install any service pack if available before starting the server. Note: To apply the latest service pack over the product, refer to the Installing Service Packs section.

Installing on Linux System

1. Download the Latest Product The latest free product download is available online. If you are having any issues / doubts in the downloading / installation of the product you can mail to Or mail to [email protected]. The product can be installed in any of the compatible Linux systems. * Product : Download the installable .bin file for Linux. * Service Pack : Download the latest service pack.

2. Check Execute Permissions Check the executable permission of the .bin file using the ls -al as given below:

ls -al WebNMS_IoT_Platform_Linux.bin -rwxrwxrwx 1 user group 256009000 Jun 28 15:48 WebNMS_IoT_Platform_Linux.bin r - read permission, w - write permission, x - executable permission.

If the file is not executable, run the following command to provide executable permission for all users:

sudo chmod 777 WebNMS_IoT_Platform_Linux.bin









9 Copyright @ 2019

3. Run Wizard

1. Execute the downloaded product file (.bin ) from the command prompt to start the wizard. ./WebNMS_IoT_Platform_Linux.bin

2. The InstallShield Wizard with the Welcome message is displayed.

3. Click Next. The License Agreement screen is displayed. Read the Agreement and select "I accept the License Agreement".

4. Click Next. The Localization screen is displayed. Choose the required language - English (default), Japanese, or Chinese.



10 Copyright @ 2019

5. Click Next. The Edition screen is displayed. It provides the choice of Server and Advanced installation options. Select Server to install the Combo package (BE server, FE server).

6. Click Next.

7. If you have chosen Server, skip this step and proceed to the next. If you have chosen Advanced, perform this step and proceed. When Advanced is chosen, the OEM Edition - Advanced screen is displayed with various installation options. Select the required type of installation.

8. Click Next. The directory location screen is displayed. Specify the location where WebNMS IoT server has to be installed. Use the Browse button to specify a different location.


11 Copyright @ 2019

9. Click Next. The details of the installation (pre-installation summary) are displayed. If you need to change any of it, use the Back button to modify.

10. Click Next. The installation begins. Once the installation is complete, a final screen is displayed.

11. Click Finish.

Note: To apply the latest service pack over the product, refer to the Installing Service Packs section.

Next Section: The next session guides on how to start the WebNMS IoT Server from the Launcher.



12 Copyright @ 2019

Starting and Shutting Down the Server Now that you have installed the WebNMS IoT Platform, starting the WebNMS IoT Server is just one click away.

Starting and Shutting down the WebNMS IoT Server

In Windows System

In Linux System

In Windows System

Starting the Server

You can start the WebNMS IoT Server from the Start menu in Windows or from the Launcher. Follow the steps given below:

Click on the Quick Start icon in the Windows System. It is located at the left bottom corner of the screen.

Click on the Start IoT Platform Start Server App link in the list.


13 Copyright @ 2019

Starting the Server from Launcher

You can start the WebNMS Server from the Launcher. Follow the steps given below:

Go to the folder where you have installed the product i.e <WebNMS IoT > the Destination Folder you provided while installing the product in the previous section.

Run the WebNMSLauncher.bat file.

Click on the Start IoT Server icon in the Launcher.

Shutting Down the Server

Warning: You will not be able to connect the application after shutting the server down.

You can stop the WebNMS IoT Server from the Start menu in Windows. Shutting down the WebNMS IoT Server is the appropriate way to kill the server and to shut down all the processes. Follow the steps given below :

Click on the Quick Start icon in the Windows System. It is located at the left bottom corner of the screen.


14 Copyright @ 2019

Click on the Start IoT Platform Stop Server App link in the list.

In Linux System

Starting the Server WebNMS IoT Server can be started from the Launcher. Follow the steps given below :

In the terminal, go to the folder where you have installed the product i.e <WebNMS IoT > the Destination Folder you provided while installing the product in the previous section.

Run the WebNMSLauncher.sh file.

Click on the Start IoT Server icon in the Launcher.


15 Copyright @ 2019

Shutting Down the Server Warning: You will not be able to connect the application to the server after shutting it down. You can stop the WebNMS IoT Server from the Launcher. Shutting down the WebNMS IoT Server is the appropriate way to kill the server and to shut down all the processes. Follow the steps given below :

1. Go to the folder where you have installed the product i.e <WebNMS IoT > the Destination Folder you provided while installing the product in the previous section.

2. Run the WebNMSLauncher.bat/.sh file. The Launcher window is displayed.

3. Click on the Shutdown IoT Server in the Launcher.


16 Copyright @ 2019

Next Section: The next session shows how to connect the web application from the browser.


17 Copyright @ 2019

Accessing the Web Application After starting the Server... the next step is to access the application to perform IoT specific configurations and to view them in list views, charts, and graphs.

Accessing the Application

Quick Tour and Get Started

Logging Out from the Application

Accessing the Application

1. Open a browser and connect to the application by typing the following URL: http://<machine_name>:<port> in the address bar. Here <machine_name> is the name of the machine where WebNMS IoT Server runs. By default, WebNMS Web Application runs on port 9090. or http://<IpAddress>:<port> in the address bar. Here <IpAddress> is the IP Address of the machine where WebNMS IoT Server runs. By default, WebNMS Web Application runs on port 9090. Example URL:

2. The login page is displayed. Enter a valid user name and password. This provides an authenticated access to WebNMS IoT. On first login, the user name root and password public can be used to logon to the application.


18 Copyright @ 2019

3. Click Login. On performing this, the web application is displayed.

4. On the first login, the form to change the default password is displayed. The user needs to change the password and also accept the terms and conditions in the privacy policy to proceed with using the application.

Warning: You will be able to proceed only on accepting the Terms and Conditions after reading the Privacy Policy statement.

5. Click Submit.

Welcome Page

When the client is connected for the first time, the Welcome page is displayed. Here Quick Tour and Get Started options are available. You can take this trip if you want an introduction to understand the hierarchy of the assets and to create them in the product. More details on this on boarding process are available in the Adding Assets section of this document.


19 Copyright @ 2019

Note: Quick Tour can be viewed anytime by clicking on the Settings > Quick Tour option from the top right corner of the client.

Logging Out from the Application

Click Settings icon in the top right corner of the client console.

Click Logout in the drop down list.

Next Section: The next session guides you to on board the assets that need to be monitored & managed by the application.


20 Copyright @ 2019

Adding Assets The first step in monitoring assets, is to onboard/add the assets in the application. Lets start adding the assets one by one using the various forms available...

Asset Hierarchy

Adding Organization

Adding Region

Adding Site

Adding Gateway / Sensor

It is important to understand the hierarchy in which the assets are maintained by the application and the connection between the assets before proceeding with the onboarding process.

Asset Hierarchy All assets such as organization, region, site, gateway, and sensor, etc., need to be added in the application to be monitored and managed.


21 Copyright @ 2019

Asset Description

Organization

The Organization forms the top most entity in the WebNMS IoT Platform. If you want to manage multiple organizations from the same application, you can configure all by creating them as different organizations.

Region

The Region is the second level in the asset hierarchy after the Organization. One or more regions can exist within an Organization. The region configured here is considered as the child of the Organization.

Site

The Site is the third level in the asset hierarchy after the Organization and Region. Multiple sites can be associated with one region. The Site configured here is considered as the child of the Region.

Gateway

Configuring the Gateways and the connected sensors is the final step in the onboarding process. This also involves configuring the sensors which are associated with the gateway. The gateway and sensors are the end points where the external data is collected. WebNMS IoT Platform provides an easy template based gateway onboarding procedure.

Sensor

The rest of the document provides the step-by-step procedure for adding each of these assets.


22 Copyright @ 2019

Adding Organization A new organization can be configured from the Add Organization button in the Admin tab. Single or multiple organizations can be created in an application, you can configure all by creating them as different organizations here. At the highest level, all data and reports can be viewed based on the organization. Further filtering can be done for region or site which forms the next levels of the asset hierarchy.

Clicking on the Add Organization link in the Admin tab displays the below form to add the organization.

For complete details on Adding an Organization, refer to the Adding an Organization section of the User & Admin Guide.

Adding Region A new region can be configured from the Add Region link in the Gateway section of the Admin tab.

https://www.webnms.com/iot/help/user_admin_guide/general_admin/configuring_gateway/configuring_rtu.html#Adding_Organization


23 Copyright @ 2019

One or more regions can exist within the Organization. The region configured here is displayed as links in the Regions section of the Maps and as a list view in Assets module.

For complete details on Adding a Region, refer to the Adding a Region section of the User & Admin Guide.

Adding Site A new site can be configured from the Add Site menu in the Gateway section of the Admin tab. Multiple sites can be associated with one region. And also, one site can be associated with multiple regions.

https://www.webnms.com/iot/help/user_admin_guide/general_admin/configuring_gateway/configuring_rtu.html#adding_region


24 Copyright @ 2019

For complete details on Adding a Site, refer to the Adding a Site section of the User & Admin Guide.

Adding Gateway and Sensors The configuration of the gateways and the connected sensors form the final steps in the onboarding process. WebNMS IoT platform provides an easy template based gateway onboarding procedure. The sensors which are the functional units play the vital role of sending the data from the asset component such as the Door, Light, and Voltage etc.

https://www.webnms.com/iot/help/user_admin_guide/general_admin/configuring_gateway/configuring_rtu.html#adding_site


25 Copyright @ 2019

For complete details on Adding a Gateway and configuring the sensors, refer to the Adding/Updating Template Section of the User & Admin Guide. For details on the supported gateways and the properties, refer to the Deployment Guides in the online resources page.

Next Section: The next session describes the options available to view the asset details and the actions that can be performed in the views.

https://www.webnms.com/iot/help/user_admin_guide/general_admin/configuring_gateway/configuring_rtu.html#Add_Gateway_Options

https://www.webnms.com/iot/resources.html#deploy


26 Copyright @ 2019

Viewing Asset Details Asset views are the detailed views of the asset details entered in the previous section. Let's have a quick look at the asset view formats and samples...

Asset List View

Asset Details View

Asset List View The asset details are the properties of the asset that have been provided while adding the asset, and the monitored parameter values of the asset.

Click on the Assets tab in the web application. The asset details are displayed in the tabular format in the hierarchical order.

Note: The list views are available for the assets you have added. You can click on the asset hierarchy name in the left Assets tree to view the corresponding list view.

Organization List View

All Components List View

Lists all the assets present at different levels in the hierarchy.


27 Copyright @ 2019

Note : Additional asset information of an asset can be viewed using the operation buttons on top of the list view. Select any asset in the list view to display the buttons on the top of the tabular list view.

Asset Details View Additional details on the assets can be viewed from the Asset details page. This displays the details of the asset and their properties in a neat grid arrangement of widgets. The widgets can be customized to display the parameter values of assets in different formats of views such as graphs or table formats for different time intervals.

In the Asset List view, click on the asset name in the application as shown in the image below. The asset details view of the selected asset will be displayed.


28 Copyright @ 2019

Asset List View

Asset Details View

For complete details on Viewing Assets and Configuration of the page, refer to the Configuring Asset Views section of the User & Admin Guide.

Next Section: The next session describes the Dashboard View where all vital information can be displayed.

https://www.webnms.com/iot/help/user_admin_guide/general_admin/configuring_asset_view.html

https://www.webnms.com/iot/help/user_admin_guide/general_admin/configuring_asset_view.html


29 Copyright @ 2019

Dashboard Views The dashboard forms the home page of the application. The dashboard is the arrangement of widgets to showcase the vital live data of the site at a glance. A new arrangement of widgets can be designed to create custom dashboards. Let's understand the dashboard and the procedure to create custom dashboards...

Default Dashboard

Creating New Dashboards

Associating Widgets to Dashboards

The default Monitoring dashboard is displayed on accessing the web application. A new dashboard can be created with a new set of widgets.

Default Dashboard

The Monitoring Dashboard is the default dashboard of the application. This dashboard can be modified to display the required values.

Sample Custom Dashboard


30 Copyright @ 2019

Creating New Dashboards New custom dashboards can be created by adding the necessary widgets.

1. Click the Dashboards tab. The default Monitoring dashboard will be displayed. Click the Actions drop down list.

2. Click the New Dashboard item in the drop down list. The Add Dashboard dialog is displayed.

3. Enter the required details, and click Submit to create the Dashboard

Note : Select Enable Dashboard in mobile option to enable viewing the dashboard in the mobile application.

The complete details of creating the dashboards are available in the Working with Dashboards and Widgets document in the User & Admin Guide.

Associating Widgets to Dashboards

Widgets can be associated with dashboards when creating dashboards, and also later when the necessity arises. The following steps must be performed to associate a widget to an existing Dashboard.

1. Click the Actions drop down list.

2. Select Add Widget item in the drop down list, and click Add to add the widget.

https://www.webnms.com/iot/help/user_admin_guide/web_client/dashboard/working_with_dashboards.html



31 Copyright @ 2019

The complete details of the default widgets in the product are available in the Working with Dashboards and Widgets document in the User & Admin Guide.

Next Section: The next session describes the Maps view that displays the location of the assets.




32 Copyright @ 2019

Viewing Asset Location Google Maps based asset location views can be used to easily identify the exact location of an asset. Let's understand the map view which indicates the location of an asset, and also displays the asset details when clicking on a particular asset.

Sample Map View

Viewing Asset Details from the Map

Schematic Views

Note: The Maps view of asset location uses the Google Map's APIs for the background rendering. By default, the "InvalidKeyMapError" page is displayed when the Maps page is invoked without configuring the GMap key in the application. To get the GMap Key, complete the wizard in the Google Maps Platform page.

The generated GMap Key must be configured in the GMap Configuration page. Refer to the GMap Key Registration section of the User & Admin Guide for further details.

https://www.webnms.com/iot/help/user_admin_guide/web_client/maps/viewing_with_google_maps.html#GMap_Key_Registration





33 Copyright @ 2019

Sample Map View

Expand the Regions node in the left tree to view the Site available in the Region. And click on the Site to view the site details.

Viewing Asset Details from the Map Click on the asset symbol to view the asset details.


34 Copyright @ 2019

The complete details of the Map Views refer to the Viewing with Google Maps section in the User & Admin Guide.

Schematic Views The Schematic view enables viewing schematic diagrams or line diagrams with symbols representing the components. The devices can be added at locations on the schematic diagram to display more intuitive views with appropriate tool tips to display the desired properties.

Schematic views can be added to the Map views using the Add SLD option under the Actions menu. And symbols can be added to the view to design a view of the panel or circuits.

Sample Add SLD View Screen

https://www.webnms.com/iot/help/user_admin_guide/web_client/maps/viewing_with_google_maps.html


35 Copyright @ 2019

Sample Add Symbol Screen

The complete details on working with the SLD views are available in the Working with SLD Views section of the document.

Next Section: The next session states some of the frequently asked questions by customers.

https://www.webnms.com/iot/help/user_admin_guide/web_client/maps/configuring_sld_view/working_with_sld_view.html


36 Copyright @ 2019

FAQ

1. How to contact Sales and Product Support?

For sales queries, send mail to [email protected]

For technical support queries, send mail to [email protected]

2. How to get the lastest WebNMS IoT platform and the latest service pack? The latest product is available at the Product Download page. The latest service pack is available at the Service Pack page. The instructions for installing the service pack are available in the Service Pack Installation document. 3. How to access the complete product documentation? The documents for the latest product available online can be accessed from the Resources page.





https://www.webnms.com/iot/help/installation_guide/index.html#installation_and_setup/service_pack/installing_service_packs.html

https://www.webnms.com/iot/resources.html#documentation

Quick Start Guide - End to End IoT Solutions – WebNMS€¦ · Introduction The WebNMS IoT Quick...

Documents

Transcript of Quick Start Guide - End to End IoT Solutions – WebNMS€¦ · Introduction The WebNMS IoT Quick...