====== First steps with WebGate platform ======
WebGate is a web interface provided by our DataGate tracking server, accessible via most modern desktop or mobile browsers (Edge, Chrome, Firefox, Safari, etc).
===== Log-in =====
{{:webgate_platform:image_2023-03-25_205402895.png?nolink&310 |}}
Navigate to https://webgate.org to load the login page, and then enter your username and password to proceed.
1 username: it can be anything and not necessarily an email address but is limited to 15 characters
2 password: it can be anything but needs to be more than 8 characters and no more than 16 characters, you will be provided with a temporary password that we strongly recommend you to change after your first login. If you lose your password, you cannot reclaim on directly and you will have to enquiry your administrator to reset your password
3 The ''Keep me logged in'' option enables cookie to be stored on your machine to allow you to reconnect at any time. Only use this option on your own machine !
When an existing cookie is detected, the log in prompt will be bypassed and replaced with a choice to continue as the previously logged in user.
Select ''Log in as another user'' to start a new session.
4 Once you've entered your credentials, simply click the ''Log In'' button
5 You can use an automatic authentification using your google account instead but you will for this need to enter your corresponding google account email address into the list of the user's email address (see here: [[platform:users:user_alerts|User Alerts]])
You may only log in with the same user name on one device at a time. If an existing session is active you will be prompted to confirm your log in, after which the other session will be closed.
\\\
===== Change Password =====
{{:webgate_platform:image_2023-03-25_205157043.png?nolink&600 |}}
You have been provided with a temporary password, it is safe and recommended to change it at your first log-in in case you did not saw the prompt to proceed this at the first log-in.
1 In the title bar, click on your user name on the right side. \\
2 In the contextual menu, click on ''Change Password''\\
3 A pop-up will be displayed, enter your old password and you new password. Confirm by clicking the button ''Change Password''. If all OK, you will have a green prompt confirming the new password has been set-up. You can click on the ''Close'' button to revert the main page.\\
If you have lost your password, you can ask your operator to reset it or ultimately contact us
\\\
===== Main Page =====
{{:webgate_platform:image_2023-03-25_212703925.png?nolink&300 |}}
The WebGate page will appear after the log in succeeds. There are two versions of the page: touch and non-touch.
By default the touch version will be shown when accessing the page from a mobile device, while the non-touch version shows for desktop browsers.
1 You may also select which version you prefer on the main menu at the top left of the screen
2 Click on the ''Switch to Non-Touch Interface'' menu
This choice will be saved for your next log in from that device.
==== Non-Touch Screen ====
The non-touch screen uses small icons and text to display as much information as possible. In this mode, the asset properties section is shown when the screen is at least 480 pixels high, and the asset, map and messages sections can be reduced to 260 pixels width.
The asset and message sections can be toggled on and off using at the top of the screen. These icons are highlighted in green when the sections are enabled.
==== Touch Screen ====
The touch version uses larger icons and text to aid selection of menus and data. The asset properties section is hidden unless the screen is over 700 pixels tall. The asset, map and message sections can only be reduced to 320 pixels width, and the connection status bar near the top of the screen is minimized when the screen is under 600 pixels tall.
When the screen width is too narrow to display all sections, either the asset or message list is automatically hidden. You may still toggle the asset and message lists on or off using the icons at the top of the screen, but only one list will be visible at any time.
If the screen size drops further, only one of the asset, map or message sections will be visible at
once. A new icon appears to allow the map to be selected.
====== Platform Layout ======
{{:webgate_platform:image_2023-03-25_213354932.png?nolink&900 |}}
You can click on each below link to browse \\
directly to the corresponding section
1 [[platform:first_steps#title_bar|Title Bar]]
2 [[platform:first_steps#connection_status|Connection Status Bar]]
3 [[platform:first_steps#list_panel|List Panel]]
4 [[platform:first_steps#properties_section|Properties Window]]
5 [[platform:first_steps#maps|Map Panel]]
6 [[platform:first_steps#messages|Messages Panel]]
7 [[platform:first_steps#sub-map_panel|Sub-Map Optional Window]]
8 [[platform:first_steps#view_selector|View Selector]]
\\\
===== Title Bar =====
1 The top of the platform screen shows the title bar:
{{:webgate_platform:image_2023-03-25_214312709.png?nolink&1200|}}
The name of the user currently logged in appears at the end of the title bar, here are the other sections:
^ ^ ^ ^
| {{:webgate_platform:image_2023-03-25_214613173.png?nolink&40|}} | **Main menu** | [[platform:history|History]] – Access asset history (if enabled)\\ Legend – Show asset icon legend\\ Load Sounds – Useful on some mobile devices which do not play sounds until\\ requested by a user\\ Test Sound – Test website sound\\ Switch to Touch/Non-Touch Mode – Toggle screen mode |
| {{:webgate_platform:image_2023-03-25_214701858.png?nolink&40|}} | **Asset List** | Click to toggle the asset list on and off when the screen size is large enough. With a small screen, clicking this icon will select the asset list. \\ A small numeric overlay is shown if there are any filtered assets (yellow overlay) or assets with alarm state (red overlay). |
| {{:webgate_platform:capture_d_ecran_2020-03-10_a_00.02.35.png?40&nolink}} | **View Map** | When the screen size is small enough this icon is shown to select map view. \\ On larger screens the map is always shown, and this icon will be hidden. |
| {{:webgate_platform:image_2023-03-25_214746891.png?nolink&40|}} | **Message List** | Click to toggle the message list on and off when the screen size is large enough.\\ With a small screen, clicking this icon will select the message list. \\ A small numeric overlay is shown if there are any new messages (yellow overlay for standard messages, or red for alerts). |
| {{:webgate_platform:image_2023-03-25_214857489.png?nolink&40|}} | **User Menu** | Custom Link – Link defined by provider\\ Change Password – Allows users to change password. \\ Log Out – Log user off the system. If the user has saved sessions on other devices, a second link is provided to log out on all devices |
| {{:webgate_platform:image_2023-03-25_214409175.png?nolink&40|}} | **Full Screen** | Custom Link – Link defined by provider\\ Change Password – Allows users to change password. \\ Log Out – Log user off the system. If the user has saved sessions on other devices, a second link is provided to log out on all devices
===== Connection Status =====
2 A connection status bar is displayed under the title bar. This bar is green when connected to the WebGate Cloud server, and red when disconnected.
{{:webgate_platform:capture_d_ecran_2020-03-10_a_23.02.57.png?nolink&500|}}
Under normal conditions the page will remain connected to the server indefinitely, and get updated automatically as server activity occurs (up to once per second). In this case the connection bar will show the most recent update time. Note that the bar will appear minimized on small screens in touch mode.
If a connection problem occurs, the bar will turn red and show the cause of the problem.
The page will automatically reconnect after a temporary connection loss.
An error message will appear if the connection problem is permanent. This might happen if the connection is dropped and the “Keep Alive” option was not selected, or if another device logs in with your user name.
We do monitor our main Cloud server availability and there is a public page to check current status and history. So if for any reason, you've lost the connection to our server, and there is no specific error message, then the first good thing to do is check if the server is up and running at this URL : [[http://stats.pingdom.com/rfklw2s537q6/4714745|WebGate SLA]].
If it is shown as up and running, then the issue is most probably on your side. If the server is down, we are probably doing an update or a hot fix. This is usually not taking more than a couple of minutes. If the problem remains more than 5 minutes, then something is wrong on our side !
===== List Panel =====
3 The list panel displays by default the assets list you have access to. If you have access to multiple groups, assets are listed under group headings. Any assets with active alarms will be shown with a red background.
Depending upon your rights and permissions granted you will see various possible list to display
You will see a light blue line under the list you're currently displaying (here for example the Assets list)
{{:webgate_platform:image_2023-03-25_220659383.png?nolink&350|}}
Click below buttons to access special pages about each list type
[[platform:assets|Assets]] Display all your assets group by group.
[[platform:users|Users]] Display all the other users, if you have sufficient rights toward a user you can then configure it from here.
[[platform:groups|Groups]] Display all the groups and sub-groups.
[[platform:drivers|Drivers]] Display all your drivers and pilots names and tags.
[[platform:fences|Fences]] Display all the circular and polygon geofences you have created or shared.
[[platform:POI|POI]] Display all the Point of Interest you have created or shared.
===== Properties section =====
4 This Properties window shows detailed properties about the currently selected asset/user/group/fence/POI. The properties box is only shown when the screen height exceeds a certain value. With smaller screens the asset properties can be opened by clicking on an asset in the list (in touch mode), or using the Properties item in the asset menu.
{{:webgate_platform:image_2023-03-25_230138586.png?nolink&300|}}
It is possible to retrieve the exact address of the location of the last GPS report received using the ''Address Lookup'' button when you're in the Assets list view.
===== Maps =====
5 The map shows the location of your assets using the same icons as shown in the asset list. A small “left arrow” icon on the top-left side of the map allows selection of base maps layers and optional overlays.
{{:webgate_platform:image_2023-03-25_211918610.png?nolink&250 |}}
Clicking on an asset on the map will select this asset on the asset list. If the asset list is not currently visible then the asset properties window will appear.
By default at first connection, it is possible that all the available map overlays are loaded and it is highly recommended to deactivate some, so that the map remains readable.
1 Simply open the Map selector \\
2 Choose the main map base layer opening this drop-down menu\\
3 Untick the map overlays ''Live Traffic'', ''World Transportation'', ''Boundaries & Places'', and ''World Ocean Ref''. \\
A few base maps are regionals and some others are vector maps requiring a web page refresh to display correctly
Please refer to the dedicated page for more details on [[platform:mapping options]]
\\\
==== Map menu ====
{{:webgate_platform:image_2023-03-25_231713879.png?nolink&180 |}}
Clicking on the map header shows the following menu:
* Grid/Postcode Search - It is possible for our server to supports local postcode lookup when requested via the user interface, or when automatically attaching to an asset’s location. Our cloud server does not contain any postcode data by default, but postcodes can be imported as required.
* Address Lookup – If available, this link allows you to search for an address. The address lookup will return a number of possible matches. Click on a location to zoom there on the map, where a circle icon will indicate the matched location. Clicking on the circle icon will remove it from the screen.
* Show / Hide Asset Labels – Shows or Hides labels next to asset icons on the map
* Show / Hide Hide POI/Fence Labels - Shows or Hides labels next to POI and Fences icons on the map
* Show My Location – If available, this option shows a circle on the map to indicate your location
* Show Fences – Toggle geofences on/off.
* Show POI – Toggle POI on/off.
\\\
==== Follow ====
{{:webgate_platform:image_2023-03-25_231530087.png?nolink&180 |}}
Click on this icon in the map header to toggle follow mode on or off.
With follow mode on (icon highlighted in green), the map screen will automatically scroll to keep the currently selected asset in view (at the current zoom level).
It is particularly helpful to monitor a vehicle that needs to be followed on map while it is moving without the constant need to move the map along the vehicle trip.
If a group is selected (by clicking on the group name in the asset list) or all assets have been selected (by clicking on the “zoom to all” icon on the asset or map header), the map will scroll and zoom to provide the best fit for all selected assets.
If you keep the option active while displaying another asset or group, the map will scroll and zoom accordingly over the new asset selected in the asset list !
===== Messages =====
6 The messages list contains recent messages and events sent to or received from assets. The list is shown with the newest messages at the top. A link is provided at the bottom of the list to load more messages if there are more than 100 available. The server may automatically truncate this list, in which case a message shows a warning that this has happened. Truncated messages are still available when running history reports.
\\\
{{:webgate_platform:image_2023-03-26_205656752.png?nolink&350 |}}
New messages are shown in with a thin blue vertical left border line and a bold blue text. \\
Simply click on it to open the detailed message window\\
----
{{:webgate_platform:image_2023-03-26_205852535.png?nolink&350 |}}
Once read the message will appear in black without any blue side line.\\
You can still open it back at anytime to comment or delete it
----
{{:webgate_platform:image_2023-03-26_210054006.png?nolink&350 |}}
When a high-priority alerts is incoming, the message will appear with a red line on the side and a warning icon and the text written in red.\\
By default the alert label will be shown as ''Unhandled''
----
{{:webgate_platform:image_2023-03-26_210849240.png?nolink&60 |}}
Clicking on this icon in any message will immediately center the map on the asset for which this message is assigned.\\
It will also select it in the asset list, showing thus in the asset properties window all the details from this specific asset
==== Messages Menu ====
{{:webgate_platform:image_2023-03-25_231943883.png?nolink&250 |}}
Clicking on the messages header shows the following menu:
* Show Latest New Message – Displays the latest new message, if available
* Show Latest alert – Displays the latest alert, if available
* Delete Checked – Deletes any checked messages
* Delete All Messages – Deletes all messages
* Mark All Messages as Read – Mark all new messages as read
* Handle All Alerts - Confirm all current active alerts are handled by the logged in user
* Resolve All Alerts - Acknowledge that all alerts are now treated and solved (usually a second step after alert handling)
\\\
==== Messages Tick Box ====
{{:webgate_platform:image_2023-03-25_232515844.png?nolink&200 |}}
Use this icon to allow to select multiple messages and proceed with some bulk action like use the previously introduced ''Delete Checked''
\\\
===== Sub-Map Panel =====
7 You can show / hide a small sub-map window in the left panel when in Assets list view by editing your user configuration settings.
{{:webgate_platform:image_2023-03-26_221942365.png?nolink&500|}}
Browse in the user configuration settings window down to the preferences part and tick / untick the ''Show Submap'' option\\
Don't forget to save your choice by clicking the ''Update Preferences and Reload'' button
\\\
{{:webgate_platform:image_2023-03-26_222512938.png?nolink&500|}}
The Submap is particularly useful to display 2 different maps at different zoom levels for example
\\\
===== View Selector =====
8 coming soon