Logo

Author: Proemion Documentation Team <docs@proemion.com>

Version: rev number: 11.0.3


1. Introduction

This is the User Manual for the Proemion DataPortal.

The information is organized into the following sections:

DataPortal management is organized based on the Organization Unit’s administrator-user that creates and arranges sub-organizations, users and assigns entitlements.

The DataPortal is a REST-based web application. The documentation and API data can be accessed at our Document Library.

1.1. Audience

This manual is intended for equipment manufacturers, fleet management organizations and machine owner/operators.

User access to the DataPortal is by default with standard permission and does not engage the machine parameters at any time.

1.2. Browser Recommendations

The DataPortal is a responsive web-application that functions flawlessly on any operating system.

Table 1. Supported Browsers
Performance Rank Browser

1

Google Chrome (recommended)

2

Mozilla Firefox

3

Edge

4

Safari

DataPortal testing is carried out on Google Chrome. The DataPortal is accessible from mobile phones for the screen sizes:
- 1920 x n
- 1024 x n
- 600 x n
- 360 x n
Proemion will no longer actively support the use of Internet Explorer to access DataPortal. There is no guarantee that certain functions will work with this browser.

1.3. How to use this Document

This document describes the functionality, configuration and operation of the DataPortal web application.

  • Users with little to no knowledge about Proemion or telematics solutions should begin with the Dashboard section and progress to the end. Afterwards you should read the Admin Overview.

  • Users with telematics experience may begin with sections 4-6.

  • Org/User management is explained in the Admin Overview.

OEM administrators should get comfortable with the Admin Overview in order to properly manage the following tasks:

  • Create a hierarchy of the Organization Units.

  • Assign the Machines and Users to the corresponding Organization Units.

  • Apportion entitlements to users.

2. Login

2.1. Login Page

Access the DataPortal at https://dataportal.proemion.com from your web browser.

login page
Figure 1. Enter your Username and Password

Type in your login credentials:

  • Username

  • Password

Click LOGIN

Typing the wrong password repeatedly will lock the account. The language setting can be changed in the footer. The DataPortal appearance can be customized according to your brand or corporate style in Themes.

The DataPortal username is NOT case sensitive. This means john.doe@sample.com, John.Doe@Sample.com and johN.doE@sAmple.com are identical and represent a single user account.

2.2. Password Policy

New users are asked to create a new password with the following criteria:

The password must:

  1. Have at least 12 characters

  2. Not have any characters more than twice in a row

  3. Not be your username

2.3. Password Reset

Users can reset their password by selecting the Reset It link. You are then prompted to enter the account email address and a link to change the password will be sent. Enter your new password according to the Password Policy.

3. Interface Layout

3.1. Left Side Menu

The left side menu contains the DataPortal functionality. The item or function from the most recent session opens by default.

.thumb

Select a topic from the list to jump to that section in the manual:

On tablets or mobile mode, the left side menu is collapsed as shown in the image below:
sidemenu collapsed
Figure 2. Collapse Side Menu Button (tablet)

The DataPortal includes a search field that allows you to perform a single-click global search for the following objects:
- users
- organizations
- models
- machines
- VIN
- PIN
- serial number

By entering a search term in the field, an autocomplete results window will appear as long as there is a match.
Selecting an entry from the results brings you to the machine details page for the device.

searchField
Figure 3. Search Example

In the list of results that appears, the matches are displayed in bold.

3.3. Personal User Settings

The user profile menu in the top right-hand corner of the DataPortal allows you to personalize your preferences:

profile menu
Figure 4. User Profile Menu

Selecting My Profile you can view and change:
- Name
- Email
- Language
- Timezone
- Date & Time format
- Unit System

personalise
Figure 5. User Profile Settings

The entitlements panel displays the authorizations for which the user has access.

Time is by default the users Browser time zone.

3.3.1. Subscribe to DataPortal Notifications

The DataPortal has a number of features that allow you to subscribe to daily notification per email. To access the subscriptions dialog:

Step 1. - Select Personal User Settings in the upper right-hand corner of the DataPortal Dashboard.

Step 2. - Next, select Subscriptions to open the Subscription Settings dialog.

Step 3. - Depending on your assigned Permission Sets the dialog will appear as shown:

subscriptions
Figure 6. Dataportal Subscriptions
Table 2. Available Subscriptions
Notification Description

Geoleash

An email is sent for every machine with an active Geoleash that executes an event once a day.

Machine Errors

An email is sent once per day with a list of machines that have registered a DTC within the past 24 hours.

Thresholds

An email is sent once per day that includes a summary of threshold breaches of the subscribed security level.

3.4. Dashboard

The Dashboard provides you with an overview of your machine fleet and data on an organizational level.

Layouts can be configured and stored based on the organization unit; usually this is defined by the OEM. The user entitlements determine if they are allowed to adjust and save the layout or not.

The dashboard displays the required datasets and information and is configurable. Depending on user entitlements, users are able to adjust the layout of this page.

home dashboard
Figure 7. Dataportal Dashboard

3.5. Search

The DataPortal includes a search field that allows you to perform a single-click global search for the following objects:
- users
- organizations
- models
- machines
- VIN
- PIN
- serial number

By entering a search term in the field, an autocomplete results window will appear as long as there is a match.
Selecting an entry from the results brings you to the machine details page for the device.

searchField
Figure 8. Search Example

In the list of results that appears, the matches are displayed in bold.

4. Widgets

A Widget is a configurable indicator that enables you to access and display machine data on the dashboard. In the DataPortal widgets can be added to the home dashboard at Organization level and on the Machine Details page.

The Dashboard contains an overview of your fleet. Widgets that are visible here are linked to the entire fleet or a specific machine. Machines displays the details for your fleet or a specific machine.

User permission sets determine whether it is possible to customize and save layouts or not.

4.1. Adding a widget

This section describes how to add a widget to a dashboard. The DataPortal features:
- the home (or main) Dashboard: displayed upon entering the DataPortal and is bound to an organization unit.
- Machine Details page is the dashboard for machines and is bound to both the organization unit and a model.

The home dashboard or the Machine Details page can share layouts or be distinct. Typically, an organization has a default dashboard layout, and then specific layouts for different models and machines.

To add a widget:

  1. In the upper right-hand corner of a dashboard, click Edit to open the Edit Options.

    data portal widget opt
    Figure 9. Dashboard edit options
    Table 3. Dashboard Options
    Item Description

    Edit

    Display the Open, Preview, Store (save), Delete and Reset configuration options.

    Add

    Open a widget from the list.

    Delete

    WARNING: This will remove the entire dashboard of the organization as well as ALL sub-organizations, that inherit this dashboard.

    Open

    Open widget layout or organization widget layout.

    Store

    Save widget layout to the selected Organizations.

    Preview

    Display your dashboard layout before saving.

    Reset

    Restore the default dashboard and widget layout.

    Assigning widgets to different groups is explained in the Saving the Layout to Organizational Units section.
  2. Select ADD from Edit Options.

    data portal widget select
    Figure 10. List of Widgets
  3. Select a widget on the left-side panel to open the configuration settings.

  4. Preview your widget.

  5. Once you have completed configuring the widget, save your settings.


4.2. Saving the Layout to the Organizational Units

Organization Units are groups of users, defined by the administrator. Permission Sets determine if you are allowed to perform management operations.

When saving a widget layout, the ASSIGN WIDGET LAYOUT TO ORGANIZATION(S) panel appears. Widget layouts are saved to your organizations by default.

You can only see your organization and its sub-organizations.
data portal widget save
Figure 11. Available Organization Tree

To assign the widget layout to an organization:

  1. Place a check in the box to the left of the organization.

  2. Click ASSIGN.

data portal widget save ou
Figure 12. Organization Tree Assign

In the image the checkbox on the left of the org unit allows you to assign the widget layout to the organization of your choosing. The check to the right indicates which organizations already have the widget layout assigned.

To view the organization unit dashboard, select Administration from the left-hand menu and then Overview from the drop-down list. Then select the organization unit you want to view and the Dashboard tab.

4.2.1. Save Widget Layout to a Model

You can save the widget/dashboard layout to a model.

  1. Select Machines from the left-side menu.

  2. In the Machines Overview page that opens, select Details next to a machine with a widget layout you would like to save or edit.

  3. In the Machines Details page that opens, select Edit at the top of the panel which opens the page management options.

    When creating a new machine, follow the instructions in the section New Machine.
  4. Edit or adjust the widget layout as desired.

  5. Select Store and the Assign Widget Layout Of This Model panel opens on the right of the panel.

    70%
    Figure 13. Edit Model Layout

    The checkbox on the left of the org unit allows you to assign the widget layout to the organization of your choosing. The check to the right shows which organizations already have the widget layout assigned. This widget layout is assigned to the model in the drop-down list at the top of the panel (in this example that is the 3337 Demo Device). To change the widget layout:

  6. Select a model from the drop-down list. The panel now displays the organizations where this layout is assigned to a model. it also shows where the layout is assigned to an organization.

  7. Once you have selected a model, you must now select an organization.

  8. When you have selected the model and organizations, click Assign at the bottom of the panel.

  9. In the Chosen Organizations panel that opens, select Chosen organizations to display a list of all of the org units that will have the widget layout assigned.

  10. Click Apply to save your changes.

widget layout modelSel
Figure 14. Select Model
widget layout modelDash
Figure 15. Confirm Selection
Assign a Model to a New Machine

If the Edit button is not active for a machine that is because there is no model assigned. For this scenario you must assign the machine to a model:

  1. Select Administration from the left-hand menu.

  2. Select Overview from the drop-down.

  3. Select the organization unit from the org tree that has your preferred model.

  4. Click Details to the right of the model you want to assign.

  5. Select the Machines tab.

  6. Click Modify Machines and enter the name of the machine in the search field or select your machine from the list and click the Apply button.


4.3. Common Parameters

When configuring a widget on the dashboard you must first select the common parameters Model and Machine.

25%
Figure 16. Assign Model and Machine

You can specify the accuracy for decimal place values; the default option is a single decimal place. Options to drag, reposition, and resize are available in edit mode.

widget resize
Figure 17. Widget Editing

4.3.1. Signal Labels

Signal labels allow you to display to end-users the meaning of a numeric signal value. Signals that represent error codes or numeric machine states can be presented as text.
The list below presents an example of engine states in text form:

Default Engine State Example Engine State as Text

0

OFF

1

Ignition ON

2

Engine Running - Idle

3

Engine Running - Work

4

Engine Running - Power

5

Error

In addition to the text display in the Right Sidebar, text replacement is also available for the following widgets (and reports):

You can disable signal labels when configuring a widget by toggling the Use model-configured signal labels switch in the dialog.

widget signalLabel
Figure 18. Signal Labels switch

Signal labels are configured in the PDC and not from the DataPortal directly.

4.4. Reports and Historic Charts

Clicking the graph icon (upper right-hand corner) opens a plot report, as shown in the image.

25%
Figure 19. Convert Widget to Report

The report allows you to view the historical variations of the selected signal for a given time period.


4.5. Tab Container

The Tab Container organizes your dashboard by grouping widgets by tabs. You can add multiple tabs along with a label for each and designate one tab as the default.
Each tab can contain widgets and you can configure the header orientation (left, right, or center) and position.

4.5.1. Tabs Container Configuration

You can create a widget and place it on the Dashboard or the Machine Details page by following the steps below:

Step 1. - From the dashboard, select Edit data portal widget edit to open the dashboard configuration menu.

Step 2. - Select Add to open the widget selection preview dialog.

Step 3. - In the widget selector that opens, select Tab Container to open the configuration dialog.

tab container
Figure 20. Tab Container Configuration
Table 4. Tabs Container Options
Item Description

Title

The title for the widget (English is the default, additional languages must be configured. See Language below).

Language

Select the language for configuring the title of the widget.

Tab title

Give each tab a distinct name that identifies its contents.

Add Tab

Place additional tabs into the organizer.

Default Tab

Select the tab that will be displayed when the page loads.

Tab Position

Display the tab above or below the widget title.

Adding Widgets to your Container

After you have created the Tab Container and organized your widgets, you can add additional widgets to the current tab.
From the dashboard
Step 1. - Select Edit
Step 2. - Select the Gear icon tab containerGear on the container to add the selected widget to the container.
Step 3. - Add and configure the widget as you would on the dashboard or the machine details page.
Step 4. - Save the widget/changes in the container tab.
Step 5. - Save the dashboard/machine page.


4.6. Capacity Widget

Description: The Capacity widget allows users to select and display a value for an individual signal and total remaining capacity.

The number displayed in the capacity widget is a percentage of the maximum, or 100% value.
data portal widget capacity
Figure 21. Configuration

Parameters:

  • Model

  • Machine

  • Signal (depending on the Model and Machine, a list of signals is available to select)

  • The 100% value, maximum value or usage capacity of the signal

capacity_example
Figure 22. Capacity Widget Sample Output

Suggested Usage: For Temperature measurement, Tank Capacity, Working Hours, Network Traffic, Inclination


4.7. Comments Widget

Description: The Comment widget is used for general labelling or dashboard comments.

Parameters:

  • Title of the comment box

  • Free Text in the comment box

data portal widget comments
Figure 23. Comments Widget Configuration

Suggested Usage: For free text and lists


4.8. Comparison Widget

Description: The Comparison widget allows users to compare values within a time period and displays the percentage increase or decrease.

Parameters:

  • Model

  • Machine

  • Time period of 5 mins, 1 hour, 1 Day, 7 Days and 30 Days

  • The signal (depending on the Model and the Machine - a list of signals is available to select from)

data portal widget comparison
Figure 24. Comparison Widget Configuration

Sample Output:

data portal widget comparison example
Figure 25. Comparison Widget Sample

Suggested Usage: Applicable to all signals


4.9. Counter Widget

Description: The Counter widget allows users get the actual count of objects in the user’s organization.

Parameters:

  • A drop down list to select Machine, Machine Models, Units, Organization, Users.

data portal widget counter
Figure 26. Counter Configuration

Sample Output:

data portal widget counter example
Figure 27. Counter Widget Sample

Suggested Usage: Inventory of Machine, Machine Models, Units, Organization, Users.


4.10. Gauge Widget

Description: The Gauge widget allow the user to present signal data on a relative scale, including peak values.

Parameters:

  • Title - Title of the list

  • Language - Select the language for the title

  • Model

  • Machine

  • Decimal place

  • The signal (depending on the Model and the Machine - a list of signals is available to select from)

  • Min Value where the counter will start

  • Max value (peak value) where the limits of signal capacity or usage are reached

  • Zones are a distinct value range on the gauge and many zones can be added on the gauge

Configuration:

data portal widget gauge
Figure 28. Gauge Configuration

The steps to configure the Gauge widget:

Step 1: Select the Model, Machine and the value decimal places for the signal

Step 2: Select the signal

Step 3: Insert the Min and Max Value for the full range

Step 4: Select the time period of to which the current value is to be compared

Step 5: Select the colours for the different values

Step 6: Add the number of zones that is required.

Additional Functionality: As shown in the picture below, clicking on the top-right icon redirects to the Report Chart to display the trends over time for this specific signal.

Sample Output:

data portal widget gauge example
Figure 29. Gauge Sample

Suggested Usage: For varying signals


4.11. Machine Efficiency Widget

Description: The Machine Efficiency enables machine owners to track operating hours for individual machines or for your fleet. The functionality enables the following:

  • Compare operation hours in different states.

  • Compare utilization percentage.

  • View operating hours for individual machines or the fleet.

  • Visualize the data as a chart, graph or table.

The Efficiency feature requires the availability of certain signals/keys on the machine.

4.11.1. Configuration

You can create a widget and place it on the dashboard or the Machine Details page by following the steps below:

Step 1. - From the dashboard, select Edit data portal widget edit to open the dashboard configuration menu.

Step 2. - Select Add to open the widget selection preview dialog.

Step 3. - In the widget selector that opens, select Machine Efficiency (snapshot or history) on the left and a preview is visible.

Step 4. - Click the Apply button. This brings you to the configuration dialog.

DP efficient
Figure 30. Configure Machine Efficiency Snapshot
Table 5. Efficiency Widget Options
Item Description

Title

The title for the widget (English is the default, additional languages must be configured. See Language below).

Language

Select the language for configuring the title of the widget.

Select Machines

Select the machine or machines for which you want to display efficiency.

*Bucket

Choose the time intervals between data points in the report from hour, day or week.

Time range

The time period for the measurements.

Display Form

Display the data as a pie chart, a bar graph or a table.

Type

Choose between Collection (efficiency for each selected machine) or Aggregation (cumulative efficiency data of selected machines)

Bucket is only available if Machine Efficiency History is selected.
Machine Efficiency Visualization Examples
DP efficient chart
Figure 31. Machine Efficiency Snapshot Collection

This machine efficiency snapshot Collection type is configured with the following options:
- 5 machines are selected.
- The Graph and Collection display form radio buttons are selected.
- The Time range in the table is 30 days.

DP efficient chartAgg
Figure 32. Machine Efficiency Snapshot Aggregation

This machine efficiency snapshot Aggregation type is configured with the following options:
- 5 machines are selected.
- The Graph and Aggregation display form radio buttons are selected.
- The Time range in the table is 30 days.

DP efficient chartTable
Figure 33. Machine Efficiency Snapshot as a Table

This machine efficiency snapshot table is configured with the following options:
- 5 machines are selected.
- The Table display form radio button is selected.
- The Time range in the table is 30 days.

DP efficient Hist
Figure 34. Machine Efficiency History

This machine efficiency History is configured with the following options:
- 4 machines are selected.
- Bucket size is one day
- The other bars in the graph represent an operational state corresponding to the key to the right of the graph.
- The Time range in the graph is 7 days.


4.12. Geoleash Widget

Geoleash tracks and enables automatic notification about machine relocation (defined as movement from one area to another). In this section we demonstrate widget setup and configuration for the Home Dashboard and/or the Machine Details page. To enable the functionality for the Dataportal or machine(s),

It includes both a range of values to indicate and a comparison function similar to the Comparison widget.

4.12.1. Configuration

You can also create a widget and place it on the Dashboard or the Machine Details page.

Place a Geoleash widget on the DataPortal Dashboard/ Machine Details page:

Step 1. - On the dashboard/ machine details page, select the Edit label to display the options.

Step 2. - Select Add.

Step 3. - The widget signals list opens. Select Geoleash Events on the left and a preview opens in the right sidebar. Click the Apply button.

DP GL EventsWidg
Figure 35. Geoleash Events List

Step 4. - The Geoleash widget is now placed on your Dashboard and a signal dialog opens.

  • For a widget on your Dashboard you can select the 'Model', the 'Machine' and the timeframe you want to view for events.

  • For a widget on your Machine Details page you can only select the 'Timeframe' you want to view for events.

Step 5. - Click the Apply button.


4.13. History Widget

Description: The History widget allows users to view historical signal values (for single or many machines/signals) on a chart.

data portal widget history
Figure 36. Widget Configuration
Table 6. History Widget General Parameters
Option Option

Title

Language

Time range

Bucket

Model*

Machine*

Color

Signal

Aggregation

Chart Style

Decimal places

Auto/Manual:
Scale automatically or manually set the minimum and maximum scale values

Clone Metric

Add Metric

When creating a History widget on the machine details page, the machine and model parameters are unavailable.
data portal widget historyDash
Figure 37. History Widget
History Report Sample

Clicking on the icon in the top-right of the widget opens the report displaying trends over time.

data portal widget history example
Figure 38. Report Example

Suggested Usage: Applicable to all Signals


4.14. Machine List Widget

Description: The Machine List widget allows users to view a list of machines, specify displayed details and include selected signals for each machine.
You can select the machines from the list or sort using a filter.

data portal widget machinelist
Figure 39. Machine List Widget Configuration
Table 7. Machine List Widget General Parameters
Option Description

Title

Title of the list for the specified language.

Language

Select the language for the title.

Options

Show model: Toggle model display by default.

Show organization: Toggle organization display by default.

Show serial number: Toggle serial number display by default.

Show PIN: Toggle PIN display by default.

Show VIN: Toggle VIN display by default.

Use Model Configured Signal Labels: Present custom error codes or machine states in textual form. See Signal Labels.

Select

Provide a list of machines from an entire organisation or a specific organisation.

Filter

Select machines based on entered criteria. If all fields are empty, then all machines are listed.

Name

Machine name

Model

Model name

Organization

Specify the organisation in which the machines should be selected.

4.14.1. Custom Signal Filter

This section expands to present signal configuration options when Add Signal is clicked. Custom signal filters allow the display of machines that meet one or more criteria.

data portal widget machinelist signal
Figure 40. Machine List Signal Configuration
Table 8. Machine List Widget Signal Parameters
Option Description

All filters have to match

ALL conditions must be met.

Any filter has to match

ANY (at least one) conditions can be met.

Signals

Signal to filter results by.

Comparator

Comparison operators >, < and = are available for numeric values, and contains is available for string values.

Comparative value

Value used to filter and sort results.

Decimal Places

Decimal places considered in the filter results.

Default Signal Sort

Sort by signal: Signal used to sort the signals.

Sort order: Choose from Sort ascending or Sort descending.

Machine List Widget Example
data portal widget machinelist example
Figure 41. Machine List Widget Example with Custom Signal Filters

Suggested Usage: Inventory list of Machines


4.15. Machine Map Widget

Description: The Machine Map widget allows users to view machines in their organisation on a map and grouped in clusters
separate from the rest of the fleet. A group of machines can also be selected to be displayed on the map.

data portal widget machinemap

Parameters:

  • Title - Title of the list

  • Language - Select the language for the title

  • Selection - To provide a list of the entire organisation or for a specific organisation

  • Name

  • Model

  • Organization - Specify the organisation in which the machines should be selected

  • Marker - The type of icon to represent the machines

  • Title of the Map

A cluster icon is used to represent many machines which are close-by within a geographical location.

Sample Output:

data portal widget machinemap example
Figure 42. Machine Map Example
  • 1, 2, 3 Shows the cluster of Machines. When zooming-in bigger clusters are broken down into smaller ones.

  • 4 shows the individual machines when the user zooms in the map

Suggested Usage of the Machine Map Widget: Overview of the distribution and position of the Machines.


4.16. Machine Widgets

Machine widgets are added on the Machine Details Dashboard by the following method:

Step 1 : Click on the "Machines" tab on the left hand side menu.

Step 2 : When the Machine Master Data Appears, select a machine.

  1. Either: On the Map, Click on the Machine, Click on the Details label

  2. Or: On the Machine table list, on the Detail column (No. 2 as shown below)

data portal widget machine add
Figure 43. Link to Machine Dashboard

Step 2 :
Same as on the Home Dashboard, click on the Edit label then click on Edit Widgets and click on Add Widgets
to get a list of Widgets to add on the Machine Dashboard.

After adding, proceed with the configuration, preview and save.
Note that widgets can be dragged, positioned and resize accordingly and this option is enabled in the edit mode.


4.17. Machine Master Data Widget

Description: The Machine Master Data widget, allows the user to view the machine vital information & status and the journey travelled during a selected time period.

data portal widget machine master data

Parameters:

  • Machine Image - Show the image of the Machine - The image can be uploaded here.

  • Communication details - Shows the communication technology used and usage.

  • Map - Display the location of the machine on a map.

  • Track - This enables a view of the different locations travelled to during the time period set in the "The Last" parameter.

  • Timezone - Display the timezone of the machine’s last known location.

  • Address - Display the street address of the machine’s last known location.

  • Time range - The period of time for location will be shown on the map.

  • Bucket - The granularity of machine locations to be shown on the map.

  • Links - Here links to URLs can be added.

data portal widget machine master data example
Figure 44. Machine Master Data Example

The example shows the functionality of the Master Data widget.

  1. Click the Open communication unit details icon in the bottom-right corner to view device data.

  2. The Communication Unit Details screen displays the last connection date, firmware version, configuration version and SIM card details.

  3. The Show Full Firmware & Config Version History button opens the Software History screen.


4.18. Slice Widget

Description: The Slice widget allows users to view several signal levels or usage for a specific period of time.

This representation can be either a pie chart or a donut and representing the different signals in different colors.

data portal widget slice

Parameters:

  • Title - Title of the list

  • Language - Select the language for the title

  • Selection - To provide a list the whole organisation or for a specific organisation

  • Name

  • Model

  • Chart type - Representation in Donut or Pie Chart

  • Time Range - The period for which data is used

  • Aggregation function

  • Units

  • The Signal to represent on the Chart

Signal State Widget Example
data portal widget slice example
Figure 45. Slice Widget Example

Additional Functionality: Clicking on the icon top-right redirects you to the Report Chart page that displays trends for this specific signal.


4.19. Active Errors Widget

The Active Errors widget provides machine owners with a visualization of active machine errors and error history up to 30 days.

There are 2 tabs on the widget, Active Errors and Errors History.
The Active Errors tab shows:

  • Total active errors of the machine on the left-hand side

  • Latest active error details on the right-hand side:

    • Start time: when the error first appeared (local time)

    • Active time: how long the error is active

    • Component: where the error occurs

    • Signal: the signal affected by the error (SPN)

    • Type of error: detailed error description (FMI)

errors Active
Figure 46. Active Errors Tab

The Error History tab shows:

  • A list of errors from most recent to oldest (default)

  • Start time: when the error first appeared (local time)

  • Stop time: when the error was cleared* (local time)

  • Component: where the error occurred

  • Signal: the signal affected by the error (SPN)

  • Type of error: detailed error description (FMI)

If the Stop time is empty the error is still active.
errors Hist
Figure 47. Errors History Tab

4.19.1. Active Errors Configuration

You can create a widget and place it on the Machine Details page.

To place an Active Errors widget on the DataPortal Machine Details page:

Step 1. - On the machine details page, select Edit admin overview add ou editIcon.

Step 2. - In the menu that opens select Add.

Step 3. - The widget signals list opens. Select Active Errors and a preview opens. Click the Apply button.

Step 4. - The Active Errors widget is now placed on the Machine Details and the configuration dialog opens.

errors config
Figure 48. Errors Configuration

In the configuration dialog you must select:

  • Title: the name of the widget on the screen

  • Language: the language for configuring the title of the widget

  • Time Range: select from Last day, Last 7 days, Last 30 days

Once you have made your selections, click the Apply button to save your changes and place the widget on the Machine Details page.


4.20. Signal State Widget

Description: The Signal State widget displays different signal states on a single widget.

From this the User can have a general view of the different signal on a single view.

data portal widget signalstate

Parameters:

  • Title

  • Language - Select the language for the title

  • Model

  • Machine

  • Signal

  • Signal Icon

  • Color

  • From

  • To

  • State Icon

  • Label

The Signal Icon and State Icon have available a set of icons that you can choose to represent the signal or state.

data portal widget signalstateIcons
Figure 49. Signal State Widget Icons
Signal State Example

Clicking on the top right icon< you are brought to the Report Chart which displays the trends over time for this signal.

data portal widget signalstate example
Figure 50. Signal State Widget Example

4.21. Cluster Heat Map Widget

Description: The Cluster Heat Map shows the variation of specific signals within a time period.
Different aggregation function of the signal is available for representation and can be grouped in either hours or days.

data portal widget cluster map

Parameters:

  • Title - Title of the list

  • Language - Select the language for the title

  • Model

  • Machine

  • Signal - The selected signal to represent.

  • Aggregation - The selected aggregated value to show on the heat map.

  • Time Range - The period of time for location will be shown on the map.

  • Clustering - The grouping of the values to apply the aggregation.

  • Min and Max Values: The values as well as the range.

  • Colour themes for Min and Max Values: Colour themes so as to view the noticeable changes in values.

Heat Map Example
data portal widget cluster map example
Figure 51. Cluster Heatmap Widget Example

The above is showing the average temperature variation from -10 degrees to 40 degrees over a period of 180 days (6 months) measured each day of the week.


4.22. DTC Widget

Description:
The DTC widget allows the user to see if there are any DTC codes transmitted within a specified time period.

data portal widget dtc

Parameters:

  • Title - Title of the list

  • Language - Select the language for the title

  • Representation display can be Gantt, Table or Pages

  • And either Grouped or All (Machines)

  • Time range - The period of time for which data should be displayed

DTC Widget Example
data portal widget dtc example
Figure 52. DTC Widget Example

Suggested Usage: Detect any fault or recurring issues on the Machines or component.

5. Machines

Selecting Machines from the left side menu opens an overview of telematics equipped machines in your organization.

5.1. Machines Overview

The default* machines overview includes a map (in the menu under Administration and then Themes) that shows the current position for all machines visible to the user.
Underneath there is a list of machines with links to the details pages. Selecting an entry in the list opens the right sidebar panel for this machine.

The default setup of the DataPortal is described here. For more information see the DataPortal User Manual.
machines overview
Figure 53. Machines Map

Hovering over a machine on the map displays the following details:

  • Machine Name

  • Current operational status (online or offline)

  • Date and time of the most recent status change

Selecting a symbol opens the right sidebar panel for this machine.

Machine List Table

The machine list displays the following attributes by default:

You can also sort and search each set of attributes at the top of each column.

VIN, PIN and Serial Number are not shown by default and can be configured in Themes under Behavior.
machines list
Figure 54. Overview List

You can sort the columns in the table by selecting the arrows above the column you want to sort. Filter and search are available by entering text into the fields at the top of each column.


5.2. Machine Details

The machine details page presents an overview of the machine data.

machine details
Figure 55. Machine Details Map and Widgets

The content is defined for the machine or model. The visualization setup is configured by an administrator.


5.3. Machine Tracking

Machine Tracking enables you to track the route and signal values of a machine for a specific time-frame.
The machine route is represented as connected geo positions on a map. Signal values are displayed as graph data points that correspond to a geo marker on the map.

5.3.1. Machine Tracking Configuration

From the Dashboard menu select Machines and then open the Machines Details page of the machine you want to track. From the dashboard:

1) Click the pin icon in Machine Details to open the machine tracking page

tracking configOpen
Figure 56. Open Tracking Configuration

2) On the Tracking configuration panel, select the Time range and the signal Bucket size
3) Click Apply to track the machine route on the map

tracking configGeo
Figure 57. Machine Route

After you have configured the machine location tracking you can now configure and view the corresponding signal values.

4) Select a signal from the drop-down list.
5) Select an aggregation type for the signal data
6) A chart plots the signal values for the selected time frame

tracking configPlot
Figure 58. Tracking Signal Plot

Hovering over a data point on the plot centers the map to the machine geo marker.

Signal Tracking Details

Hovering over a datapoint on the plot opens a popup on the map for the most recent geo event before or equal to the time from the plot - which corresponds to the bucket showing Latitude, Longitude, Date and Time.


5.4. DTC Notification

The Proemion DataPortal features a daily email summary of machines with DTCs (diagnostic trouble codes or errors codes) within the previous 24 hours (active and cleared errors). This feature enables machine owners to quickly identify machine issues and track their resolution.
Notifications are sent once per day and include a list of and links to machines with DTCs.

5.4.1. Notification Content

The email contains the information described in the table below.

Element Description

Component

Machine component

Signal

Signal that shows erroneous behaviour

Type of error

Type of failure detected.

Excessive Indicator

If there are more than 3 error entries or more than 100 machines with errors, this will be indicated in the summary.

Subscribe to DTC Notifications

To subscribe to DTC notifications for your organization:
Step 1. In the upper right-hand of the screen select Your profile.
Step 2. Select Subscriptions from the menu that opens.
Step 3. Toggle Machine Errors to the right-hand position.
Step 4. Click the arrow on the right side to open the drop-down list and select the severity level for which you would like to receive notification.

Once notifications are configured the user will receive DTC Notifications for all of the machines in their visible organization(s).
The notifications are sent daily between 5 a.m. and 6 a.m (local time).


5.5. Threshold Notification

The Proemion DataPortal features email notification of machine signal changes outside of normal signal value (or healthy) range. Values in the healthy range are defined by thresholds which are set by the OEM/manufacturer.

Notifications are triggered when a signal value breaches a threshold. A summary of threshold breaches is sent once per day.
The summary includes all threshold breaches of the subscribed severity level.

5.5.1. Severity Levels

A severity level indicates the signal value is outside of (above or below) the healthy range. If a value breaches a threshold but later returns to the healthy range, the threshold is then rearmed.

Every breach triggers a separate notification included as part of the daily summary for the severity level.
thresholdLvl
Figure 59. Severity Level Indicators

In the example, the red-shaded area represents a warning threshold. Once the threshold has been breached, a notification is included in the daily summary. The fuel level must be refilled filled past the blue-shaded area to rearm the trigger.

threshold example
Figure 60. Threshold Breach Example

Thresholds only take into account the current signal value. So if more than one severity level is set for a signal, each threshold breach triggers a separate notification.
There are some rules to keep in mind regarding severity levels:

  • For successive low signal thresholds, the lowest signal value must have the highest severity level.

  • For successive high signal thresholds, the highest signal value must have the highest severity level.

  • The healthy region is determined by:

    • the signal values between the high and low thresholds

    • if all thresholds are high signal values the healthy region begins at the lowest value threshold until the maximum value for the signal

    • if all thresholds are low signal values, the healthy region begins at the highest value threshold until the minimum value for the signal

threshold healthyRegion
Figure 61. Threshold Healthy Region

In the example, the critical threshold is rearmed on 10/25 yet the signal is still in the warning level range. On the following day the warning threshold is rearmed.

threshold example rearm
Figure 62. Threshold Rearm Example

Once you have set severity levels for a signal, you can view the thresholds by setting the With Thresholds switch in the reports/plots Configure dialog to the on position (as shown).
The switch only appears for signals that have severity levels set in the Threshold Configuration.

threshold plots
Figure 63. Threshold Switch

In the plot shown below, the Beyond Average label is triggered when the fuel level dips below 25%. The yellow plot line represents rearming the threshold.

threshold plotsChart
Figure 64. Plot Example with Thresholds

5.5.2. Threshold Configuration

From the Dashboard menu select Administration ⇒ Overview. In the Administration Overview that opens:

1) select the organization from the tree
2) select the Models column
3) select Details to the right of the model you want to configure

threshold config
Figure 65. Navigate to Threshold Config

From the Edit Model/Overview dialog, select the Threshold tab to open the configuration settings.

threshold configLvl
Figure 66. Threshold Configuration Dialog
Table 9. Threshold Configuration Options
Item Description

Signal

Drop-down list of machine signals available for threshold notification.

Severity

Select the severity level outside of the healthy signal value region.

Threshold

Set the signal value for a threshold.

Rearm Value

Set the value where the notification trigger is rearmed.

5.5.3. Subscribe to Notifications

To subscribe to threshold notifications for your organization, in the upper right-hand of the screen select Your profile then select Subscriptions from the menu that opens. In the Subscriptions Settings screen that opens
Step 1. Toggle Severity to the right-hand position.
Step 2. Click the arrow on the right side to open the drop-down list and select the severity level for which you would like to receive notification.

thresholdSubscribe
Figure 67. Subscribe to Thresholds

Once notifications are configured the user will receive Threshold Notifications for the selected Severity Level and all levels above.
The notifications will be sent as a daily between 5 a.m. and 6 a.m.


The right sidebar view provides a quick overview about the machine state and measurements.

right hand details
Figure 68. Right Sidebar panel
This sidebar can be deactivated under Behavior in the Themes configuration.

General machine information is displayed at the top of the control panel:

  • Online / Offline state

    • gray indicates currently offline

    • green or blue indicates currently online

  • Time of most recent state change

  • Machine Name

  • Organization the machine belongs to

  • Machine Model

Click on Details to open the Machine Details Page.

Click on the Target symbol to zoom the map to the machine.

Signals preview

In the signals preview section the latest available measurements for all signals of the selected machine are presented.
To the right of the signal name the latest available measurement is displayed.
To the left of the signal name a preview of the last 24 hours signal history is shown.
Click on the History preview to open the Plots page for this signal and this machine.

5.7. Machine Actions

The Machine Actions functionality enables the user to transfer information entered into the DataPortal interface to the machine. Information can be sent to the machine as one of the following:

Data Type Description Sample Use Case

Numeric Value

Data sent to the machine that acts as a trigger or target value.

Change a machine control parameter such as maximum engine speed (numeric increase/decrease).

Set State

Data sent to the machine that allows the setting of a discrete (or distinct) state.

Change the machine mode from Power to_Eco_ mode.

String Value

Data sent to the machine so the device can execute some action.

A string could be sent from the DataPortal to the machine display.

Machine Actions functionality including user permission level and organizational unit access are configured in the PDC file.

5.7.1. Machine Actions Use Cases

In our sample a service technician performs maintenance on a machine. After completing these tasks it is necessary to reset the service counter on the machine. The next task is to activate fast logging.

In our use case, the service tech performs the following actions:

Step 1. Login to the DataPortal.
Step 2. Go to the Machine Details page.
Step 3. Select the Manage Machine icon Manage Machine in the upper right-hand corner to open the dialog.

Numeric Value Example

In the Manage Machine dialog, select Reset Service Counter from the list.

When an Action is triggered the transfer of data to the machine can be delayed depending on whether the device is online or offline.
Actions sample
Figure 69. Reset Service Counter Sample Configuration

1 - Reset Service Counter Action (preconfigured) control.
2 - Input box for a number/value. In our use case the value is for the Next Service in X amount of hours.
3 - Previous number/value (of hours until next service).
4 - Action history list shows the most recent actions triggered.

Once a new value is entered and the Set button is clicked, the new service value is sent to the machine control system.

Set State Example

In the Manage Machine dialog, select Activate Fast Logging from the list.

When an Action is triggered the transfer of data to the machine can be delayed depending on whether the device is online or offline.
ActionsState sample
Figure 70. Activate Fast Logging Sample Configuration

1 - Activate Fast Logging control.
2 - State switch.
3 - Current State.
4 - Action history list shows the most recent actions triggered.

The new service value is entered and the Set button is clicked, the new service parameter is sent to the CANlink mobile. Depending on the configuration the parameter may then be forwarded to the control system via CAN.

6. Reports

6.1. Common Parameters

The following parameters are shared between all the Reports modules.

User entitlements determine whether or not reports are able to be viewed, generated or created.
data portal reports common
Figure 71. Reporting Parameters

1 - Time range allows you to select from and to dates for the data represented in the report.

2 - Select a predefined or specify custom dates.

3 - Bucket allows you to select the time intervals between data points in the report.

4 - Model allows you to select the type of machine in your fleet, and Machine is the specific machine being reported on.

5 - Aggregation is the value returned for the signal. The value is calculated using all of the measurements within each Bucket. Some common types are listed:
- Minimum: the lowest value recorded for the signal.
- Maximum: the highest value recorded for the signal.
- Average: the mean value of a signal.

6 - Reports are by default scaled automatically along the value axis (in reports this corresponds to the Y-axis but in scatter plots applies to X and Y ). Selecting Manual allows you to customize the Min and Max values along the Y-axis.

7 - Apply saves your changes and updates the report. Reset All removes all of the information from the report.

8 - Add Metric allows you to add another machine to the report.

9 - Clone Data Set allows you to clone an existing data set and include it in the report.


6.2. Map

Description:

The Map report allows the user to view information about the movement of the Machine, its current location or its tracks covered during a selected time period.

Several Machines can be added on the same map and information will be displayed for the same time period.

The different tracks can then be viewed and compared for the different machines or time period selected.

Example:

data portal reports common map example
Figure 72. Reporting Map

The example above shows the machine track covered on the last days with points drawn at every hour.

On this map two machines are visualized on the same map.

Additional Functionality:

1 : Real-time monitoring is enabled by clicking this button and the position of each machine is updated every 20 seconds.

Clicking again disables real-time monitoring.

2 : A the user can use the + and - buttons on the map to zoom in or out of the map.


6.3. Plots

The Plot report allows the user to view the variation of signals during a selected time period.

On the same graphs, different metrics can be viewed for the same time or the same metrics of different machines can be viewed and compared on the same plot.

Several Machines and different signals or measurement can be added on the chart for the same time period and visualized on the same plot.

The data-sets can then be visualized or compared to another set of data of the same signal and machine or with a different sets of data from another machine.

data portal reports common plots example
Figure 73. Plot Example

The example above shows different signals measured from a single machine on a single chart. For each measurement, the unit is displayed on the axis and in the tool tip.

Additional Functionality:

1 : Real-time monitoring is enabled by clicking the button and the data polling and display is refreshed every 5 seconds.

2 : The chart can be downloaded in various image formats or exported to raw data as csv and excel format as shown.

3 : A slider bar allows the user to zoom in and out of the plot graph or select a specific segment of the data-set to visualise.


6.4. Assignments

The Assignments functionality provides machine owners with the capability to create usage-based reports that track specified machine tasks or jobs for bookkeeping/service tracking purposes.
An Assignment can be created for a list of machines for an individual organization unit only.
Currently Assignments can only be created for fuel consumption and operating hours. In order to track these signals for your machines you can create a widget.

Assignments is activated with the Proemion standard keys.

6.4.1. Create New Assignment

Step 1. Open the Assignments module from the left hand menu by clicking and expanding Reports.
Step 2. Select Add Assignment to open the Create Assignment dialog.
Step 3. In the dialog that opens, enter the following information:

AssignCreate
Figure 74. Create Assignments Dialog
Table 10. Create Assignments
Level Description

Title

Assignment identification

Description

Definition of the assignments purpose

Start Date

Date the assignment is activated

End Data

When active, the assignment no longer collects data after this date.

Key

Client side identification

Status

Draft: the Assignment is created but does not have all the data necessary to generate a report.

Defined: the Assignment has all data needed to generate a report.

Archived: the Assignment is no longer relevant since its report has been used.

Machine

Select the machine(s) that are included in this assignment.

Step 4. Select Create when you have entered the information.

6.4.2. View/Edit Assignments

Step 1. Open the Assignments module from the left hand menu by clicking and expanding Reports.

Step 2. Selecting Assignments opens the Overview panel.

AssignOVR
Figure 75. Assignments Overview

On the Overview panel, the following information is available:
1. Filter: Search for existing Assignments by time frame, machine or status.
2. Assignment title
3. Start/End date
4. Key (client system reference number)
5. Create a new Assignment
6. Assignment Status:

  • Draft: the Assignment is created but does not have all the data necessary to generate a report.

  • Defined: the Assignment has all data needed to generate a report.

  • Archived: the Assignment is no longer relevant since its report has been used.

Step 3. Select Details to the right of an assignment.

AssignDet
Figure 76. Assignments Overview

Step 4. On the Assignment Details panel, the following information is available:
1. Assignment Title
2. Key (client system reference number)
3. Description
4. Machines search filter
5. Fuel Consumption
6. Operating Hours
7. Export to CSV

Step 5 . Select Update to submit and confirm your changes to the Assignment.


6.5. Machine Efficiency

Efficiency reporting enables machine owners to track operating hours and calculate efficiency for a machine or fleet. In the DataPortal you can view the data as a report or as a widget on the dashboard.

Machine Efficiency Requirements

Machine Efficiency requires that the following signals are available for the machine:

Table 11. Machine Efficiency Required Signals
Signal Key

Total machine operating hours across all operating states

value.common.machine.hours.total

Total machine operating hours in idle state

value.common.machine.hours.idle.total

Total machine operating hours in load operation

value.common.machine.hours.operation.total

Additionally, custom operation and idle states can be defined by applying the following schema:

Table 12. Optional Machine Efficiency Signals
Signal Key

Custom machine idle operation states that do not contribute to machine working time

value.custom.machine.hours.idle.{state}.total

Custom machine operating states that contribute to machine working time

value.custom.machine.hours.operation.{state}.total

More information about the signal keys can be found in the Standard Metrics Documentation at http://docs.proemion.com.

6.5.2. Create an Efficiency Report

Configure an Efficiency report by following the steps below:

Step 1. On the left-hand menu of the DataPortal dashboard, select Reports.

Step 2. Next, select Machine Efficiency from the menu to open the configuration dialog. The following options are available:

Table 13. Efficiency Report Options
Item Description

Time range

The time period for the signals.

Report Type

There are 2 report types to choose from:
- Machine Collection Snapshot: cumulative efficiency for the time range
- Machine Collection History: efficiency broken down by bucket.

Select Machines

Select the machine or machines for which you want to display efficiency.

*Bucket

Choose the time intervals between data points in the report from hour, day or week.

Graph or Table

Display the data as a bar graph or in a table.

Bucket is only available if Machine Collection History is selected as the Report Type.

Step 3. Once you have configured the report criteria, click apply.

Step 4. The DataPortal then calculates the data and generates a report.

DP efficientRep
Figure 77. Machine Efficiency Report

6.6. Geoleash

Geoleash tracks and enables automatic notification about machine relocation (defined as movement from one area to another). Notification is based on criteria and requires minimal configuration by the user.

Geoleash vs. Geofence

Geoleash functionality differs from Geofence in the amount of configuration effort required. Geoleash handles designating the area of operation and awareness automatically (based on the initial settings) eliminating the need for detailed configuration. This minimizes the effort for tracking a larger fleet. However, Geofence may still be neccesary in some cases and both features can be enabled simultaneously.

6.6.2. Concept

A specific land area is defined by criteria that is set to active. Whenever the machine with active Geoleash criteria breaches (or exits) the boundary, a notification is sent.

Geoleash attributes are described in the following table:

Table 14. Geoleash Criteria
Attribute Description

Center

The latitude and longitude coordinates applied as the center of the Geoleash circle. Sometimes called a centroid.

Length

The Geoleash boundary defined as the radius of the Geoleash circle.

Circle

The Geoleash area around the Geoleash center.

The CU also informs the platform whenever the following events occur:

Table 15. Geoleash Events
Event Description

Passive Breach

The criteria is active and when the device is switched on a breach is detected based on the current location and a new center is set.

Active Breach

The criteria is active and while the device is running the machine breaches the constraint.

6.6.3. Primary Use Cases

Common Geoleash operation scenarios are show in the following table:

Table 16. Geoleash Use Cases
Use Case Function Description

Tracking <5 machines

Passive breach

A machine is relocated outside of the Geoleash circle while offline; upon relocation a notification with the new center and circle is sent automatically.

Moving from one location to another

Active breach

While in operation, a machine moves from one location to another outside of the set Geoleash, a notification is sent.

Machine relocates frequently

Active breach

A machine relocates between multiple work sites while online. Each relocation outside of the set Geoleash generates an event notification automatically.

Machine activity

View

View the past 10 actions of the machine.

6.6.4. Setup and Configuration

To configure Geoleash for a CU follow the steps below:

Step 1. - On the left-hand menu of the DataPortal Dashboard, select Machines.

Step 2. - Next, select the Machine Details link of the machine where you want to activate the Geoleash feature.

Step 3. - In Machine Details, select the Manage icon to the upper right of the details panel.

Step 4. - This opens the 'Manage Machine' dialog. Select Geoleash from the left side of the dialog as shown in Geoleash Dialog. Here you must set the 'leash Length' and you must switch the toggle to 'Active'.

DP GL manageSet
Figure 78. Geoleash Dialog

Here you can configure the Geoleash length (from the current position), and activate the feature for this machine.

Geoleash is not enabled for every Proemion CU. If you have questions about this feature, contact your Proemion representative or send an email to support@proemion.com.
Notifications

To enable Geoleash notifications you must first activate the event notifications in your user profile, and then configure Geoleash for the CU. To activate the notifications:

Step 1. - Select your user profile in the upper right-hand corner of the DataPortal, and then select Subscriptions.

Step 2. - The 'Subscription Settings' dialog opens. Toggle Geoleash relocations to active.

Once a breach has occurred, a notification is sent containing the information found in the following table:

Table 17. Geoleash Notification Email
Info Description

Name

Name of the machine including a link to the machine page.

Time

Time the breach occurred.

Type

Active or Passive breach.

Leash Length

Currently set Geoleash circle length

Previous centroid

Original center location.

New centroid

Current center location.

6.6.5. View Breach Events

To view Geoleash breach events follow the steps below:

Step 1. - On the left-hand menu of the DataPortal Dashboard, select Reports to open the reports options.

Step 2. - Next, select 'Geoleash' to open the 'Reports / Geoleash' page.

Step 3. - On the Filter Geoleash Events' panel select the time range ('The Last') for events you want to view, the machine you want to view events for, and the type of events you want to view.

Step 4. - The filtered events appear in the following table.

DP GL list
Figure 79. Geoleash View
Map View

You can also view the location of Geoleash events listed in the table by selecting the 'Map' label to the right of the table entry.

Breach events are visualized by three markers listed on the map:

  • (P) stands for previous centroid or position.

  • (N) stands for the new position.

  • The current position marker has no label.

DP GL map
Figure 80. Geoleash Map View

6.7. Scatter Plots

A scatter plot is a three-dimensional data visualisation (x, y and z axis) that uses a collection of dots to represent the relationship between data-sets.

Data-sets can originate from different signals or Machines and for an identical or different time period.

The data-sets can then be visualized or compared to another set of data, signals, machines or different sets of data from another machine.

data portal reports common scatterplots example
Figure 81. Scatter Plot Example

This example shows data sets from a single demo machine. The plot can be used for visual comparison.

Additional Functionality:

1 : The chart can be downloaded in various image formats or exported to raw data as shown.

2 : A slider bar allows the user to zoom in and out of the Scatter Plot or select a specific segment of the data-set to visualise.


6.8. Tables

The table report is the simplest visualisation for data-sets

Data-sets can be for different time periods, from different signals of the same machine or from different machines.

The information on the tables can be used to visualise and compare different data sets onto the same table.

data portal reports common table example
Figure 82. Table Example

This example shows the output results of the data sets from three different machines on a single table.

7. Admin Section

7.1. Administration

The DataPortal Administration menu is available to users that possess Admin entitlements for organizations, contracts or reports.
The following DataPortal topics are covered here:

admin overview leftside
Figure 83. Administration Left-side menu
  • Overview where Admins can view, manage and create organization objects and data.

  • Themes where the look and feel of the DataPortal for organization can be customized.

  • Contracts for machine sim cards (dependent on the permission set).

7.2. Admin Overview

The Administration section provides entitled users with an overview of organization assets. The overview is limited to the organization the Admin is assigned to and therein OUs. Each OU has its own view of machines, users, sub-organizations, theme and dashboard.
In the Administration Overview you can also see the IDs for organization objects (users, machines, OUs).

7.2.1. Interface

Open the DataPortal overview from the main Dashboard by selecting Administration from the left hand menu, and select Overview from the expansion menu.

admin overview
Figure 84. Admin Overview

1 - The Organization tree.

2 - Organization Unit type label. Only org units with a different type/category than the parent org unit are indicated (i.e. have a label).

3 - The Add, Edit and Delete buttons for OU management.

4 - Expand and collapse controls for the organization tree.

5 - Selecting a label from the top menu provides you with the following information:

Table 18. Organization Unit Overview
Item Description

Machines

A list of machines in the organization and identification details (ID, VIN, PIN, Serial Number, Model)

Models

Models assigned to the organization. Details menu opens the model edit dialog.

Communication Units

CU identification and login status info.

Users

Users assigned to this organization.

Details

OU details (name, description, contact information).

Theme

OU DataPortal design elements (colors, login page) links and behavior.

Dashboard

The main dashboard layout for the OU.

Sub-Organizations

OUs or organization units controlled by the current OU.

6 - The OU side panel is displayed separately so that users or machines can be assigned and moved across OUs.

7 - The Go Back control returns the user to the DataPortal Dashboard.

8 - The Search field allows you to search for a machine, user, or a sub-organization within the organization.

7.3. Organization Unit Management

Organization Units (OU or sub-organization) are groups of users with a name and type (category) and are subordinate to the user’s organization.
Organization Units may have their own sub-organizations and users, and machines can be assigned to units separately. Users can only see DataPortal objects in their own organization unit and the sub-organizations (subsidiaries).

7.3.1. Organization Unit Types

Organization units are arranged in categories based on the tasks performed. The categories begin with distributor, then manufacturer, dealer, machine owner and none.

The DataPortal allows users with organization maintainer permission to:

  • query or retrieve a list of organization units that share type with or are sub-organization units.

  • add organization units

  • update organization units details

    • assign or change the category

  • move an organization unit

7.3.2. Add a Sub-Organization Unit

To add a new organization unit to your organization:

Step 1. From the dashboard left-hand menu select Administration then select Overview from the expansion menu to open the Admin dashboard.

Step 2.. Select the organization unit where the sub-organization will be added.

Step 3. Click on the + button to add a new sub-organization to this organization.

Step 4. Enter a Name for the sub-organization.

admin overview add ou
Figure 85. Add Sub-Organization Unit

Step 5. Select a Type from the drop-down list.

  • Type is by default none.

  • If the Type for the parent organization is None, you cannot assign the new organization a different category.

  • Type for the new sub-organization can only be identical or subordinate to the parent organization.

Step 6. Click the Create button to save your changes and close the dialog.

7.3.3. Edit a Sub-Organization Unit

To change the details for an organization unit:

Step 1. From the dashboard left-hand menu select Administration then select Overview from the expansion menu to open the Admin dashboard.

Step 2. Select the organization unit that you want to change.

Step 3. Click on the Edit admin overview add ou editIcon button to edit the properties of this organization.

Step 4. Optionally change the Name for the sub-organization.

Step 5. Optionally select a Type from the drop-down list.

admin overview add ou edit
Figure 86. Edit Sub-Organization Details
  • Type is by default none.

  • If the Type for the parent organization is None, you cannot assign the organization a different category.

  • Type assignment for the sub-organization can only be identical or subordinate to the parent organization.

Step 6. Click the Update button to save your changes and close the dialog.

7.3.4. Move an Organization Unit

To move an organization unit:

Step 1. From the dashboard left-hand menu select Administration then select Overview from the expansion menu to open the Admin dashboard.

Step 2. From the org-tree select the organization/sub-organization that contains the organization unit that you want to move.

Step 3. Select the SUB-ORGANIZATIONS column from the management menu on the right. A list of sub-organization appear appears.

Step 4. Place a check in the box to the left of the name of the sub-organization and the Move Organization panel opens on the right side of your screen.

top menu org move
Figure 87. Move Organization Panel on the Right

Step 5. In the Move Organization panel place a check next to the organization where you want to relocate the organization to.

admin overview add ou added
Figure 88. Update Sub-Organization Details

Step 6. Click the Move Organization button at the bottom of the panel to confirm your changes and close the dialog.

top menu org moveConfirm
Figure 89. Organization Move Confirmation

7.3.5. Contracts Overview

The DataPortal allows a user with Admin entitlements an overview of the contracts and the current status for their machines.
When a machine/ communication unit (CU) is activated, the tariff is then selected and a contract is created. When the machine changes ownership from the OEM to the machine owner, the contract typically remains with the OEM. Each CU has a single contract.

To view the contracts select Administration from the main menu on the left-side of the panel and then select Contracts. This opens the Contracts Overview page.

ContractsOvr
Figure 90. Contracts Overview

To view the details, in the row to the right of the contract you want to view select Details to open the dialog.
In the dialog you can also view communication unit and machine details relevant to the contract.

ContractsDet
Figure 91. Contract Details
Table 19. Contract Details - Communication Unit tab
Item Description

CU - ID

The identification number of the communication unit.

Current SIM card ID

The identification of the SIM card currently inserted into the CU.

Provider

The mobile data provider of the sim card inserted into the CU.

Last Login

The last time the CU was connected to the Proemion server.

Table 20. Contract Details - Machine tab
Item Description

Name

The identification of the machine. This can be a number separate from the CU and Serial or identical depending on your organization.

PIN

The part identification number for the machine.

Serial

The unique, identifying number or group of numbers and letters assigned to the machine.

Organization Unit

The organization unit the machine is assigned to.


7.4. DataPortal Permissions

A Permission Set is a group of entitlements consisting of levels and subjects that can only be assigned to Users.

The common permission set for all users is rest.enable which enables users to login to the DataPortal.

7.4.1. Levels

The level defines which actions the user can perform for a given subject.
Beginning with level View, each successive level contains the capability provided for in the previous level.

Table 21. Permission Set Levels
Level Description

None

The user can sign into the DataPortal but has no subject visibility.

View

The user can consume the subject data but cannot remove or change the configuration.

Maintain

The user can perform management operations (i.e. set password, change name) on a pre-set configuration for the subject.
The user however usually cannot perform create/delete operations.

Admin

Full operation capability including create/delete for a given subject in all visible organizations.

Keep in mind that Permission Set Levels are applied across all child organization units.

7.4.2. Subjects

The Permission subject defines the DataPortal entity or object that the level applies to. The principle DataPortal subject, descriptions and permissions levels are described in this section.

The following subjects are available for assigning permission levels to users:
- Assignments Service
- Contracts Service
- Machines Service
- Models Service
- Organizations Service
- Reports Service

Subject Service Descriptions

The following tables list the available services along with its description.

Assignments Service
Level Description

View

Allows access to assignments.

Maintain

Allows updating the:
- assignment title
- assignment description
- assignment time range
- assignment external key
- assignment status
- assignment machines

Admin

Allows creating a new assignment.

Allows deleting a new assignment.

Assignments Service Keys:

  • value.common.machine.hours.operation.total

  • value.common.engine.fuel.used.total

Assignments access is limited to exact organization unit match.
Contracts Service
Level Description

View

View contract data for the machine with the basic attributes:
- contract identifier
- order number
- state
- end date

Maintain

View the contract attributes:
- tariff description
- activation date
- start date
- next billing date
- tariff begin date
- tariff end date
Perform GoLive requests on provisioned machines

Admin

Submit a contract renewal request.

Machines Service
Level Description

View

Enables user to view machine data.

Maintain

Allows changing the:
- machine name
- machine serial number
- machine PIN (Product Identification Number)
- machine VIN (Vehicle Idenfification Number)
- geoleash length configuration for this machine

Allows assigning a model to a machine.

Allows switching’s CU’s communication mode between logging and realtime.

Allows starting a realtime diagnosis session for the current user on this machine.

Allows activating geoleash on this machine.

Allows deactivating geoleash on this machine.

Allows access to geoleash configuration and history for this machine.

Models Service
Level Description

View

Enables user to view machine model data.

Maintain

Allows changing the:
- model name
- model description
- model image file
- model data configuration (PDC)

Allows overriding the data configuration (PDC) assigned to machines at model level by assigning a data configuration to a specific machine.

Admin

Allows creating:
- a new model
- a threshold for a signal

Allows deleting:
- a model
- a threshold for a signal

Models assigned to the parent organization of a machines org unit are visible to the machine owner.
Organizations Service
Level Context Description

View

-

User can view organization units.

Maintain

Org Unit

Move:
- machines to a different organization unit
- users to a different organization unit

Update:
- organization unit parent based on the candidate list
- organization unit type
- organization unit Name
- user permission sets

Retrieves a list:
- organization unit parent candidates
- user permission sets

Create an organization unit.

Delete an organization unit.

User

Retrieve a list of all users or a single user’s details.

Update:
- user details
- user email

Theme

Create a new theme for the organization unit.

Access:
- an organization unit’s theme
- the organization tree
- the images from the organization unit’s theme

Delete a theme.

Model dashboard

Create or update a dashboard for a model.

Allows access to the tree of an organization unit and viewing whether or not a dashboard for a model is configured for specific organization units.

Delete a dashboard for a model.

Organization dashboard

Create or update a dashboard for a specific organization unit.

Allows access to the organization tree and viewing whether or not a dashboard is configured for specific organization units.

Delete a dashboard for a specific organization unit.

Admin

User

Create new user.

Change a user’s ban status.

Resend and invitation email to an inactive user.

Reports Service
Level Description

View

Enables user to view report pages.

Maintain

-

Admin

-

7.4.3. User Roles

Typically, a top-level organization has a single user (and at least one substitute) with full administrative privileges at the topmost level in the hierarchy and hence throughout the entire organization. The Admin invites users to the DataPortal and is responsible for assigning permission sets.

This section shows some typical DataPortal user’s roles and provides examples for assigning permission levels to users with this role.

Table 22. Permission Set User Roles
User Role Description Permissions

Machine Activation User

A user with this role can activate machine contracts during the factory end-test without possessing any other permission.

- Assignments: None
- Contracts: Admin
- Machines: Maintain
- Models: View
- Organizations: None
- Reports: None

Machine Owner

This user can view machine details.

- Assignments: Maintain
- Contracts: View
- Machines: Maintain
- Models: View
- Organizations: None
- Reports: View

Dealer

A user with this role can activate machine contracts during the factory end-test without possessing any other permission.

- Assignments: None
- Contracts: View
- Machines: Maintain
- Models: View
- Organizations: Admin
- Reports: None

7.5. The Top menu bar

The Top menu bar works in conjunction with the left side Organization Tree.

Details are presented by selecting the item on the menu and the data appears only for the Organization which is selected on the left.

Below is a description of all Menu items which is present on the top Menu bar.

7.6. Manage Models

The DataPortal enables the management of machine models so that Admins can categorize the machines in their organization. A model represents the type and class of a machine such as Digger 950L or Digger 1070XL. The machine on DataPortal represents the individual real machine such as Digger 1070XL - S/N 190512.
In this section we demonstrate the Model Management dialog.

7.6.1. View Models

View the models in your organization by following the instructions.

Step 1. From the main Dashboard, expand by selecting the Administration label on the left hand menu, and in the expansion menu select Overview.

Step 2. You are now brought to the Organization Overview. Select an organization and then select the Models tab from the menu.

This opens a list view of the models that are assigned ONLY to this organization in addition to the number of machines assigned to that model.

modelList
Figure 92. List Of Models

7.6.2. Create Models Dialog

Click the New Machine Model button on the upper right side of the models list to open the Create Model dialog box. Here you can enter some details in the Overview and Machines tabs.

Table 23. Create Models Overview
Item Description

Name

Model identification

Organization

Where the model was created. Cannot be edited.

Image

The model image will be shown for any machine assigned to this model, if for this specific machine no machine image has been uploaded.

Description

Definition of the model.

70%
Figure 93. Create/Edit Model Dialog
Table 24. Create Models Machines Tab
Item Description

Name

Search the machines assigned to this model by Name

ID

Search the machines assigned to this model by ID

Modify Machines

View and edit/modify which machines are assigned to this model.

Remove

Delete the model from the organization.
NOTE: This is only available to users with Admin permissions

Update

Confirm changes made to the model.

7.6.3. Edit Models Dialog

To Edit an existing model:

  1. Select Details to the right of a model from the list.

  2. This opens the Edit Model dialog (see above).

Remove model button only functions if no machines are assigned to the model.
70%
Figure 94. Create/Edit Models Machines
70%
Figure 95. Create/Edit Models - Modify Machines

7.7. PDC Management

You can assign a PDC to a new machine (or machines) or a model from the Administration Overview or Machine Details.
This is available to users who have the model maintain (or manage) permission. PDCs assigned to a model are assigned to all machines within the model*.

To override the model PDC please consult your Proemion representative.
Table 25. PDC Management Functions
Function Description

Assign a version to a Model

From the Edit Model dialog, select the PDC tab and select a PDC by searching a Name and the Version.

View which PDC is assigned to a Model

From the Edit Model dialog, select the PDC tab and the PDC file assigned to this model can be viewed under Name and Version.

View which PDC is assigned to a Machine

Go to the Machine Details page, select the Manage icon MachineManage in the upper right-hand corner and select PDC. Here you can see the name and the current version of the PDC assigned to this machine.

pdc tab
Figure 96. PDC tab - Edit Model
  • REMOVE: deletes the model from the DataPortal when all machines have first been removed from the model. For more information about, see Manage Models.

  • UPDATE: accepts and save any changes made to the model.

pdc machineManage
Figure 97. PDC Info - Manage Machine

7.8. Manage Machines

On clicking the Machine Menu table, the following details are displayed:

1 : List Machines: Displays a list of machines that are allowed within this OU. Search and Filtering is available above the Name and Model column.

2 : Machine Details: Redirects the page to Machine Details page where all machine properties can be viewed.

3 : Move Machines: Selected machines can be moved from one OU to another OU:

  1. Select the Machines which the user wants to move (1)

  2. The side menu containing the list of Organization Units will appear.

  3. Select the Organizations to move the machine.

  4. Click on the button below to move the machine to the Organization Unit (2).

top menu machine move
Figure 98. Move Machines from Org to Org

7.8.1. Machine Actions Configuration

The Actions configuration (the labels for the DataPortal and the object descriptions on the communication unit) is described in the PDC file. Contact your Proemion representative for further information.

7.9. Communication Units

The communication units section provides the name, serial number as well as the last login and logout on the communication device.

The Details link opens the Master Data panel that displays the most recent connection date, the firmware version, the configuration version and the SIM card details.

The Master Data Information and Communication Unit Details are viewed from the Machine Details section.

7.10. Users

7.10.1. User Account Setup

Users are added by clicking the New User button as shown. In the New User dialog that opens, the following information must be entered:
- Email address (this is the username for the account)
- Name
- Language
- Organization
- Permissions

Once this information is entered, click the Create button.

Account setup can only be performed by users with suitable entitlements

The DataPortal username is NOT case sensitive. This means john.doe@sample.com, John.Doe@Sample.com and johN.doE@sAmple.com are identical and represent a single user account.
user add
Figure 99. New User Account

An invitation link is sent to the user as shown and users are requested to verify their email address. Users are then redirected to the DataPortal where they can set a password before login.

userInvite
Figure 100. DataPortal Invite

The password must:
- Have at least 12 characters
- Not have any characters more than twice in a row
- Not be your username

Entering the wrong password multiple times will lead to a locked account for 2 minutes.

User List:
To view and edit users in an organization, you must first select the organization in the org-tree on the left of the panel, then select Users from the main panel menu. This view lists all the users in the selected child organization.

users view
Figure 101. User Details
  1. Select Details to the right of the user to open the Edit User panel.

  2. The organization corresponds to the structure displayed in the org-tree.

  3. The permissions access for the user.

  4. Click Update to save the changes.

7.10.2. User Permissions and Deactivation

The 3 permission levels are:

  • View: the account is limited to read access

  • Maintain: in most cases the account is able to change preconfigured data sets but not add or remove.

  • Admin: the account is able to perform CRUD (create, read, update and delete) operations for users and subjects for all visible organizations for the subject.

See the section Permissions for more information about access and entitlements.

To deactivate the DataPortal account, click the Deactivate button and the user will not be able to login to the application. To activate an account, click Reactivate.

7.10.3. Move Users across Organizational Units

Users can be moved across Organization Units by:

  1. Selecting the user.

  2. Checking the box next to the user.

  3. The Organization tree will appear in the org-tree to the right of the panel.

  4. Select the destination organization.

  5. Select Move User on the bottom right to apply the change.


7.11. Themes

As an Administrator, you can customize the theme (logo, color scheme, title, etc.) of your organization in the DataPortal. On the left-side menu, select Administration then select Themes from the drop-down menu and you are brought to the Themes customization page.

theme 1
Figure 102. DataPortal Theme
Table 26. Customizable branding options
Item Description

1 - Menu

Open, Preview, Store (Save), Delete and Reset theme configuration options.

2 - Browser Title Bar

The brand name (text) that appears on the web page tab.

3 - Upload Favicon

The image (logo, graphic) that appears on the web page tab.

4 - Design

Primary and accent colors for your brand. You can also select the machine icons you want to use in your organization.

5 - Logo

Upload your company logo that will appear on the header of the DataPortal page.

Custom DataPortal Email Sender Signature

You can customize the signature text in all email communication sent from the DataPortal. In the Themes area, scroll to the bottom of the page until you see the headline/field Email Sender Signature.

theme signature
Figure 103. DataPortal Signature

Simply enter the text you want to appear in all of your DataPortal emails.

7.11.2. Custom DataPortal Login (URL handling)

You can use your own login page (i.e. your own landing page or web site) to allow customer access to the DataPortal. To do this you must implement the following form on the page where you want your customers to login to the DataPortal remotely (from a URL you provide):

HTML Login Form, required fields
<html>
  <form method="POST" action="https://api.proemion.com/authz/oauth2/token">
    <input name="username" type="text">
    <input name="password" type="password">
    <input name="grant_type" type="hidden" value="password">
    <input name="client_id" type="hidden" value="portal">
    <button type="submit">Login</button>
    <input name="redirect_uri" type="hidden" value="https://dataportal.proemion.com/#!/dashboards">
  </form>
</html>

All URLs must utilize a secure connection - https:// - and this also eliminates the possibility of using a local file. The Login Page URL is where the users are returned when they log out of the DataPortal.

theme 2
Figure 104. DataPortal Theme, URLs
Table 27. Customizable branding, further options
Item Description

1 - Login Page URL

Login to the DataPortal from a URL of your choice. Default maximum length is 200 characters.

2 - Links and Footer

Add links and display text (100 character maximum) to the page footer.

3 - Login Image

Upload your own image to the standard DataPortal login page.

7.11.3. Behavior Options

The options in the table below allow you to customize the user experience on the DataPortal.

Table 28. DataPortal Behavior options
Item Description

Show map on machine overview

Show the map on the machine overview page.

Show VIN or machine overview list

Include a column with the VIN number in the list of machines.

Show PIN on machine overview list

Include a column with the PIN number in the list of machines.

Show serial number on machine overview list

Show the serial number column in the list of machines.

Show right sidebar on machine list selection

Right sidebar appears when selecting a machine from the machine list or on the map.

7.11.4. Custom Menu Entries

The DataPortal allows you to customize the theme of your portal by adding categories to the main menu and URL links.
To add a category and/or links to your DataPortal theme:

From the dashboard left-hand menu select Administration then select Themes from the drop-down menu to open the Themes page. Scroll down until you see the Menu subheading as shown.

theme Menu
Figure 105. DataPortal Theme, Custom Menu

Customize your DataPortal theme with the following options:
1. Category icon: Select an icon for the new category.
2. Display text: Enter a label name for the category.
3. URL: Add your URL.


8. Basic Concepts

The machine represents the physical machine or vehicle on the DataPortal (a so-called digital twin). The Communication Unit (CU) is the telematics modem mounted to the physical, real-world machine that collects data and sends it to the DataPortal.

8.1. Machine Model

The model describes the type of machine as a set of attributes and is assigned to the parent org unit (typically OEM or manufacturer) within the organization. An example is a dump truck or shredder. The machine model concept places management (configure features, edit attributes, assign to a list of machines) at manufacturer (OEM) level, and visibility is restricted to the currently selected organization.

By default the Admin for a Model created in the Proemion DataPortal is the user that created it.

8.1.1. Concept

Model represents a type of machine, and can also be understood as the class, while machine is an instance of that class.
Management on the DataPortal enables the following:

  • PDC Management

  • Grouping machine types (such as small, medium or large), or machine model series (e.g. Shredder 7 series, Dump Truck XR series)

  • Entry point for feature enabling and configuration for a type or series

  • Handling identical machines in a uniform manner

  • Base widget layouts on the model and organizational unit

A common application in the DataPortal is the execution of data operations/ comparisons and calculations for one or more machine types.

Different parent organizations can have identically named models that have different data requirements. Machines that have identical data requirements can be assigned different models to identify differences in size (i.e. Small=100, Medium=150, Large=200).



8.2. Organizations

An organization comprises groups of users in hierarchical org units that carry out management tasks. The highest rank in the hierarchy is the distributor level org unit that has visibility of the entire organization. The distributor creates and performs administrative functions for child org units. Generally an organization manages machine models, machines, data and objects such as reports and widgets. The primary org unit types are:

Table 29. Org Unit Categories
Classification Visibility Description

Distributor

manufacturer (OEM), dealer, machine owner

Provides telematics devices, services, 1st-level support and escalation to 2nd-level support.

OEM

Dealer, machine owner

Machine/equipment manufacturer.

Dealer

Machine owner

Provides machines including customer service to end-customers.

Machine Owner

Operators and machines

Owner/operator of the machine in operation.

Org unit members can view child org units but not parent or sister org units.

Org units contain users, models, machines and communication units. Users are assigned entitlements or permissions that allow them to perform functions, manage users, data and machines.

Org
Figure 106. Organizations in the DataPortal

The primary roles are Admin and Maintainer. The Admin is responsible for creating the structure of the organization (creating org units, models, widgets) including configuring permissions for Maintainers.
The Maintainer is responsible for managing models, widget layouts, machines and users in org units.

9. Glossary

9.1. Time Series Data

Signal

A set time series measurements.

Bucket

The bucket defines the time resolution of the output. All data points for the signal are combined using the defined aggregation type.

Aggregation

A mathematical function applied to all data points of a Bucket.
The result of the Aggregation is one value that is provided as the value for the entire Bucket.

Aggregate all

This plotting option aggregates the selected signals of all applicable machines into a single signal.
Usually used in combination with a machine Model selection.
If a machine Model is selected the operation includes date from all machines of that Model.
The selected signal is then aggregated into one single signal covering all machines.

For each machine

This plotting option shows one signal for each applicable machine.
Usually used in combination with a machine Model selection.
If that case one signal for each machine of the selected Model is provided.

9.1.1. Aggregations

Minimum

Returns the smallest value in a Bucket.

Maximum

Returns the largest value in a Bucket.

Average

Returns the mean or the average of all values in a Bucket.

Standard Deviation

Returns the amount of variation of the values in a Bucket.

Sum

The resulting total of the signal values in a Bucket.

Cumulative Sum

Returns the sum of all values within the current Bucket and all previous Bucket sums in the selection.
For example, the cumulative sums of the sequence 'a, b, c, …​', are 'a, a + b, a + b + c, …​'.

Serial Difference (Avg.)

Returns the difference of the averaged signal values from a previous Bucket to the next Bucket in a sequence.

Delta

Returns the difference between the last value before the time frame start and the last value before the time frame end.
However, the DataPortal will return multiple delta values (one for each bucket):

  • if the time frame is larger than the bucket size

  • if the time frame start and end is on different calendar days

Delta aggregation is only available for continuous counter signals (AND configured in the PDC) and signals that do not reset at the end of an event.

9.2. Geo Data

Track

A position history on the Machine is usually visualised as a line as shown.

glossary track
Figure 107. Machine Position History

The user can see similar tracks using the Machine Map widget

9.3. Organization Units

The Organization Unit or OU is an object within the DataPortal that contains its own Users, Machines, Themes and other Sub-Organizations. See Organizations.

organisation units
Figure 108. Org Units Interface

9.4. AEMP compliant

The AEMP, which is short for Association of Equipment Management Professional, is a Telematics Standard approved and recognised by the International Standards Organization and is demoted by ISO 15143-3