¶ Introduction
The Navigine software platform consists of 2 components – client and tracking, and provides map editing , monitoring devices and visitors, tracking analytics, creating information and advertising messages in real time on the selected territory.
This documentation describes the functionality and purpose of the client section.
¶ New user registration
First, register on https://client.navigine.com/
If you already have a username and password from your personal account, skip this point. When you click the "Register" button, the registration page opens.
To register, you must fill in required fields:
- "Email address"
- "Password"
Navigine team recommends choosing safe passwords that match the criteria:
- - Contain 8 or more characters
- - Have a minimum of 2 lowercase letters (capital letters)
- - Have a minimum of 2 digits
Then you can sign in to your personal account.
¶ Personal account
After signing in to your personal account, you can see the «Home Page»
On the left, on the dark background, there is a vertical navigation bar with sections:
- Home page
- Locations
- Marketing
- Versions
- Analytics
- Applications (Apps)
- Manage users (optional)
- Profile
¶ Locations
The locations contain a list of locations and object positions.
In the left column, there is a clickable list and the “Add Location” button.
When you select a location, the list of locations opens.
After selecting a specific sublocation, an interactive map appears with positions and objects that are drawn on it.
By clicking on the "gear" icon, a window will offer changing the location or sub-location.
While adding a sublocation, the map page will appear and the browser can offer to determine the location (click "Allow"). On the left side, there is a form for creating a new location.
You can also switch to the advanced parameters mode, with additional functionality.
If the browser has not determined the location, or you need to specify a different address, use the address search.
After all the actions are completed and all the fields are filled in correctly, you need to save the changes by clicking the "Save" button.
Map management tools
The map toolbar. Use the +/- buttons to adjust the scale of the map being viewed. The next 10 buttons are used to control the map content.
|
Icon |
Action |
Description |
 |
Add transmitter |
Adding new iBeacon, Eddystone, WiFi, WiFi-RTT, Locator и BLE. |
 |
Manage venues |
Adding/Changing points of interest on the map such as a café, medical center, store, etc. |
|
Draw barrier |
Adding barriers |
|
Draw route |
Adding routes |
|
Measure sublocation |
Setting the sublocation size |
|
Add elevation point |
Adding stairs, elevators, etc. |
|
Draw zone |
Adding zones |
|
Editing elements on map |
Editing existing objects on the map |
|
Erase elements on map |
Erasing existing objects on the map |
|
Center of the map |
Centering of the map |
To call an action, select the tool and apply it on the map. Some tool functions are called directly after clicking on an object located on the map. For example, when you click on objects such as transmitters, barriers or places, a pop-up window appears with the ability to edit the data of this object.
¶ Add transmitter
If you click on this tool, the icon color will change to the active blue:
The transmitter can be active or passive. Passive transmitters include iBeacon, Eddystone, and BLE beacons, while active transmitters are WiFi and Wifi-RTT access points and locators. The mouse cursor on the map will be highlighted with a blue dot, which means the tool is waiting for the location of this beacon to be selected. You need to click the mouse cursor on the place where the beacon is physically installed or planned to be installed.
To add a new beacon in the system, you must fill Type, Description, UUID, Major and Minor fields.
- Description – beacon name in the system
- UUID - unique identifier of the beacon manufacturer
- Major, Minor - IDs of the location involvement
¶ Manage venues
If you click on this tool, the icon color will change to the active blue:
Here is an example of adding new "Venue".
To add or change Venue, fill in the following fields.
- Name – name of Venue
- Nickname – alias or abbreviation of Venue
- Description – brief description of Venue
- Phone – phone number
- Class – category from the list
- Coordinates – coordinates of Venue on the map (filled in automatically).
- Image - Venue image.
¶ Draw Barrier
When you click on this tool, the icon color will change to the active blue:
Barriers are objects that mean obstacles a person cannot pass through (columns, walls, etc.). The minimum number of points for the barrier is 3. If you need to cancel the active "barrier" action, press the ESC or click the "barriers" icon on the map management toolbar.
¶ Draw route
When you click on this tool, the icon color will change to the active blue:
You need to click the mouse cursor on the place where the route will start. To draw a route, you must specify at least 2 reference points in the direction of the desired route. The route is shown as a green line on the map. To complete the route, you need to double click with the left mouse button. If you need to cancel the active "route" action, press the ESC or click the "route" icon on the map management toolbar.
There are two types of routes:
- Main
- Alternative
You can switch the visibility of these routes in the drop-down list - "Layers". It is also possible to disable the visibility of any layer by unchecking the box in the list.
¶ Measuring sublocation
When you click on this tool, the icon color will change to the active blue:
After adding a new location, you need to calculate the map size correctly. You need to click on two different points of the map and specify the distance between them.
¶ Add elevation point
When you click on this tool, a window with a list of elevations is activated. This functionality is used to form transitions between high rise markers (floors, staircases, elevators, escalators).
As you can see on the image above, ‘2 floor’ and ‘Quuppa, BLE’ sublocations are connected and have common points. These points are transitions from one floor to another.
If there are lots of transitions between floors, it is recommended to use the display of the "height mode" in the form of a table.
¶ Draw Zone
When you click on this tool, the icon color will change to the active blue:
Zones are designed to limit the area on the map where the appearance of a person, for example, is prohibited or dangerous. These could be closed territories, dangerous zones and premises.
You need to click the mouse cursor on the place where the zone will start. To draw a zone, you need to set reference points. Each zone has at least 3 points, and the number of points in one zone is unlimited. Each zone must be closed. To close the shape and apply zone drawing, you need to connect the finish point with the start point.
Then, by clicking on the drawn zone, you can select its color (type) and set the zone name.
¶ Editing elements on map
When you click on this tool, the icon color will change to the active blue:
You must click the mouse cursor on the object which settings you would like to change. After clicking on the object, a modal window will appear. It contains variable parameters depending on the type of object (zone, location, barrier or transmitter).
¶ Erase elements on map
When you click on this tool, the icon color will change to the active blue:
By clicking on the ‘cross’ icon, you could remove drawn barriers, areas of transmitters, venues, etc.
¶ Marketing
‘Marketing’ section provides the functionality of adding advertising and informational PUSH messages.
To add a new PUSH message, select the desired location and sublocation. If the selected location already has PUSH messages, they will be displayed in a list. For a new message, click the button "Add PUSH”.
Each PUSH message has a set of parameters:
- Belonging to the beacon
- Title – name of the PUSH
- Content - description of the PUSH message
- Interval – time value of the interval for receiving a repeated message.
- Priority - from 0 to 10
- Trigger condition - when it is located
- Duration
- Proximity – range
- Image – image of the PUSH icon
- Activity schedule – PUSH schedule. (If it is omitted, PUSH will always be active).
To change an existing PUSH, you must first select it from the list. When you add or change a PUSH, an action form appears on the right.
¶ Versions
The "Versions" section provides the functionality of the map resource and content version system. When you make changes of location or sublocation, a new version is automatically created. If you need to roll back several versions, select the desired version and click "Use".
- The “Edit " button is used to open the window for changing versions and parameters.
- The “Download " button helps to download the archive with the configuration parameters of the location.
- The “Use” button is aimed to define the selected version as the main one.
¶ Analytics
The "Analytics" section is essential for displaying the collected data about location and sublocation sessions.
Analytics supports two data-viewing modes:
- Statistics
- Heatmaps
To view Analytics, you need to select a location and a sublocation. To switch to the heatmaps mode, click on the "Heatmaps" button in the upper-right corner:
¶ Analytics mode
In the analytics mode, there are two histograms with user data and a form for requesting data in a specific period.
Histograms about users are available for daily, weekly, and monthly periods. Moreover, daily selection of users is based on a time interval that could be set.
¶ Heatmaps mode
The heatmaps mode shows the map and user activity zones.
¶ Apps
The app section is required for communication with the tracking platform. You need to add a list of users with the access to the tracking platform to the "Team" section. After that, select the desired location in the "Locations" section. In the "Parameters" section, choose the necessary reports that will be displayed in the tracking platform.
- alert_reports - notification report. Basic functionality, available by default.
- object_reports - report on objects. Basic functionality, available by default.
- social_contacts_reports - report on violation of the social distance. This report only works while using certain hardware.
- monitoring_devices - monitoring the status of locators.
- zone_contacts_report - reports on violation of the social distance in the specified zone.
¶ Profile
A user profile is required to change user information.
The profile consists of several fields which are form for switching foreign language and "Exit" button. Two settings are also supported: "Edit password" and "Edit workspace".
When you click on the "Edit password" button, a window appears. It requires filling in three fields: current password, new password and confirmation of the new password.
When you click on the "Edit workspace" button, you will see a page for adding new users through the invitation system, in other words, for sharing the location.