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

Version: rev number: 1.1.18

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
# Browser


Google Chrome (Recommended)


Mozilla Firefox




IE 11



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

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 URL from your web browser.

login page

Type in your login Credentials:

  • Username

  • Password


Typing the wrong password repeatedly will lock the account.
The language setting can be changed in the footer.
Useful links and references are available in the footer.
The DataPortal experience can be easily customized according to your brand or corporate style. How to do this is explained in Themes.

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. Contain an upper-case letter (A-Z)

  3. Contain a lower-case letter (a-z)

  4. Contain a space or punctuation mark (one of . , ! or ?)

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

  6. 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.

data portal dash side menu

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

3.2. Personal User Settings

The user profile menu in the top right-hand corner of the panel allows you to personalize dashboard parameters:

profile menu


You can change the Name, Email, Language, Unit System and Timezone fields.

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

Time is by default the users Browser time zone.

3.3. Home Dashboard

The Home Dashboard visualizes information, inventory and usage for the various organization objects. The Machine
Dashboard shows information relevant to a specific machine.

The layout can be customized and saved for different groups of users.

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.

Depending on the individual configuration, Widgets are used to display the required datasets or information on the

home dashboard

4. Widgets

A Widget is a configurable indicator that enables you to access and present machine data on the dashboard. Widgets on the home dashboard may be used to show organization wide metrics or summaries.

The Dashboard contains an overview of your fleet. Widgets that are visible here are linked to the entire fleet or a specific machine.
The Machines section contains details for a specific machine. Widgets shown in this section are for the active selected machine.

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

4.1. Adding a widget

This section describes each widget and illustrates how they are added on the dashboard.

To add a widget follow the steps:

In the upper right-hand corner of the Home Dashboard, click Edit to open the Edit Options.

data portal widget opt
Figure 1. Dashboard edit options
Table 2. Dashboard options
Item Description


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


Open a widget from the list for configuration and placement on the dashboard.


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


Open User widget layout controls or Organization widget layout assignments.


Save widget layout to selected Organizations.


Have a look at your Dashboard layout before everything has been saved.


Reload the default dashboard and widget layout.

Assigning widgets to different groups is explained in the Saving the Layout to Organizational Units (or Groups) section.
data portal widget select
Figure 2. List of widgets

Selecting a widget type on the left-side panel opens the configuration settings.

You can edit an existing widget by selecting the Edit Widgets icon as shown in Step 2.

Preview your widget and then save your settings once your configuration is complete.

4.2. Saving the Layout to the Organizational Units

OU’s are Organization Units or groups of users, defined by the Administrator. The users' entitlements determine if they are allowed to adjust and save the layout or not.

When saving a widget, the ASSIGN WIDGET LAYOUT TO ORGANIZATION(S) panel appears.

data portal widget save

Widgets are by default saved to your Organization(s).

To assign the widget to an Organization:

  • 1. Check the box next to the organisation

  • 2. Click ASSIGN

data portal widget save ou

The image shows the widget layout is assigned to three Organizations.

The layout is saved by clicking 'ASSIGN'.

To view the OU dashboard, Go to Administration → Overview → Select the Organization Unit → select the dashboard tab as shown in the Administration section.

4.2.1. Save Widget Layout to a Model

You can save the arrangement and configuration of widgets to a particular 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, edit or adjust the widget layout to your desired configuration.

  4. Select Edit at the top of the panel which opens the page management options.

  5. Select Store and the Assign widget layout of this model panel opens on the right of the panel.

Figure 3. Edit Layout to a Model

The check marks on the right indicate where the current model layout exists, and in which organizations the layout is used. This widget layout is assigned to the model in the top drop-down list. To change the layout to that of another model:

  1. Select a model from the drop-down list. The panel now displays the organizations where this layout is assigned to a model, and where the layout is assigned to an organization.

  2. Once a model is selected, you must select an organization.

  3. When you have determined the model and organizations where you want to save the widget layout, click Assign at the bottom of the panel.

  4. 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.

  5. Click Apply to save you changes.

widget layout modelSel
Figure 4. Select Model
widget layout modelDash
Figure 5. Confirm Selection

4.3. Common Parameters

When you create a widget on the Home dashboard you must first configure common or standard parameters.

Once you have selected the widget, you can add the the Model and the Machine as shown.


Next, parameters specific to the widget can be added and configured. For decimal place values you can specify the accuracy; the default option is a single decimal place.

Options to drag, reposition, and resize are available in edit mode.

widget resize

4.4. Reports and Historic Charts

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


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

4.5. 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. The signal itself cannot be displayed.


data portal widget capacity


  • 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

Sample Output:


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

4.6. Comments Widget

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


  • Title of the comment box

  • Free Text in the comment box


data portal widget comments

Suggested Usage: For free text and lists

4.7. Comparison Widget

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


  • 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)

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


data portal widget comparison

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

Sample Output:

data portal widget comparison example

Suggested Usage: Applicable to all signals

4.8. Counter Widget

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


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

data portal widget counter

Sample Output:

data portal widget counter example

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

4.9. Gauge Widget

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

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


  • 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


data portal widget gauge

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

Suggested Usage: For varying signals

4.10. 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.10.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 6. 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.11. History Widget

Description: The History widget allows users to view the signal values of a time period on a Line Chart or Bar Chart.


  • 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)

  • The Aggregation

  • The Line Style which can be line or column

data portal widget history

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 history example

Suggested Usage: Applicable to all Signals

4.12. Machine List Widget

Description: The Machine List widget allows users to view machines in the organisation.

data portal widget machinelist


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

  • Name

  • Model

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

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

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

  • Title of the list

  • Reset All - Removes all parameter values entered for the signal and machine

Additional Functionality: Clicking on the top-right icon within a widget redirects to a Report Chart that displays the trends over time for this specific signal.

Sample Output:

data portal widget machinelist example

Suggested Usage: Inventory list of Machines

4.13. 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


  • 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
  • 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.14. 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

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.15. 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


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

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

  • Map - Show 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.

  • The Last - 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 URL or uploaded files can be added here (for example the Operation Manual this machine can be added here).

Sample Output:

data portal widget machine master data example

The example shows the functionalities of Master Data widget.

  1. When clicking on the small button 1, the popup will list all the attachment or URL added to this Machine

  2. The Master Data button will allow a popup with all Master Data Information about the machine including the last activity.
    The Communication Unit Details shows the last connections date of the machine, the firmware version, the configuration version and the SIM card details.

  3. When zooming in the map, the user can see the locations travelled during "The Last" period selected and with the granularity of the "Bucket selected".

Suggested Usage: To have a quick view of the Communication Device status attached to the machine. History of locations. Useful links or media for a specific Machine.

4.16. 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 PieChart or a Donut and representing the different Signals in different colors.

data portal widget slice


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

  • Name

  • Model

  • Chart type - Representation in Donut or Pie Chart

  • The last - The period for which data is used

  • Aggregation - The aggregation used

  • Units

  • The Signal to represent on the Chart

Additional Functionality: As shown in the picture below, on clicking on the top right icon, the page is redirected
to the Report Chart page to show the trends over time for this specific signal.

Sample Output:

data portal widget slice example

Suggested Usage: Use it for multiple signals that sum up to a total.
This provides a visual distribution of the sum.

This example shows the different states of a Machine for the selected time period.

data portal widget slice example 2

4.17. 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.


  • Model

  • Machine

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

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


data portal widget signalstate

Additional Functionality: As shown in the picture below, on clicking on the top right icon, the page is redirected
to the Report Chart page to show the trends over time for this specific signal

Sample Output:

data portal widget signalstate example

Suggested Usage: Display varying signals that indicate to the user a change in state.

4.18. Cluster Heat Map Widget

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

data portal widget cluster map


  • Signal - The selected signal to represent.

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

  • The Last - 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.

Sample Output:

data portal widget cluster map example

The above is showing the average temperature variation from 0 degrees to 35 degrees over a period of 7 days measured each hour of the day.

4.19. DTC Widget

Technical notes:

Diagnostic Trouble Codes (DTC) specifies the communication schema designed to provide mobile machinery status data via the Internet.
The DTC is a set of binary communication which provides the location of the problem in the machine and the Error Code to specify and identify the error.
The responses from the machine containing specified data elements is used in the analysis of machine performance and health.
DTC follows the well-known ISO Standard 15143-3:2016.

Useful Links:

The DTC widget allows the user to see if there are any DTC codes transmitted within the last hour.

data portal widget dtc


  • Representation display can be Gantt, Table or Pages

  • And either Grouped or All (Machines)

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

Sample Output:

data portal widget dtc example

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

5. Machines

Machine is the digital representation of the real (mobile) machine or entity and is where the CU is mounted/connected to the CAN bus and transmits data.

5.1. Machines Overview Page

The machines overview includes a map showing the current position for all machines available to the user and basic information. The map can be switched off in the Themes section.
Underneath the map there is a list of available machines along with a link to the details page. Hovering over an entry in the list highlights it and allows you to open the right sidebar panel.


The map shows the most recent recorded positions of all devices. Machines that are located in close proximity to one another are grouped together and identified by a cluster symbol. Zooming in or selecting the symbol shows each individual machine.

machines overview
Figure 7. Machines map

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

  • Machine Name

  • Date and time of the most recent status change

  • Current operational status (online or offline)

Selecting a symbol opens the right sidebar view.

Machine List Table

The machine list displays the following attributes by default:

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

You can arrange the table entries in ascending or descending order by selecting the arrows above the column you want to use to sort the list. Additionally, filter or search functions 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, CU data and is configurable.

machine details
Figure 9. Machine Details Map and Widgets

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

5.2.1. Machine Actions

The Machine Actions functionality enables the user to transfer information entered into the DataPortal interface to the machine.

If enabled, a user or an account possessing the maintain permission level for the machine can view and change preconfigured parameters that are transmitted to the machine control system. See the sample configuration below.

Machine Actions Use Case

In our sample a service technician performs maintenance on a machine. Next, the service tech returns the machine to the owner fully operational.
Of course, after performing maintenance or repair tasks it is necessary to reset the service counter on the machine.

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.
Step 4. In the 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 10. 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.

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

right hand details
This sidebar can be deactivated under Behavior in the Themes configuration.

At the top of the panel are displayed general machine information:

  • Online / Offline state

  • Time of most recent state change

  • Machine Name

  • Organization the machine belongs to

  • Machine Model

  • Online state:

    • gray indicates currently offline

    • primary color indicates currently online

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.

6. Reports

6.1. Common Parameters

The following parameters are common for all the Reports modules.

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

1 : Time period: This allows the user to select the time range to represent the data on the Report.

2 : The user can select predefined selections, create a custom time range, or can also use a longer span in the past using the calendar as shown.

3 : The Add Data Set Option allows the user to add another Machine with its Data Set to be added to the Report.

4 : The Clone Data Set allows the user to clone an existing Machine Data Set, which will be included on the Report.

5 : The Apply button executes changes and also refreshes the report.

6.2. Map


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.


data portal reports common map example

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 a signal or metrics measurement 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

The example above shows different signals measured from a single machine on a single chart.

For each measurement, the units 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:

Figure 11. Create Assignments Dialog
Table 3. Create Assignments
Level Description


Assignment identification


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.


Client side identification


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.


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.

Figure 12. 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.

Figure 13. 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. 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.5.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 table:

Table 4. GeoLeash Criteria
Attribute Description


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


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


The GeoLeash area around the GeoLeash center.

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

Table 5. 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.5.3. Primary Use Cases

Common GeoLeash operation scenarios are show in the table:

Table 6. 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 the past 10 actions of the machine.

6.5.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 14. 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.

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 table:

Table 7. GeoLeash Notification Email
Info Description


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


Time the breach occurred.


Active or Passive breach.

Leash Length

Currently set GeoLeash ci.rcle length

Previous centroid

Original center location.

New centroid

Current center location.

6.5.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 table.

DP GL list
Figure 15. 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. See GeoLeash Map.

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 16. GeoLeash Map View

6.6. 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

This example shows data sets from two demo machines on the same scatter plot. 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.7. 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

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

7. Admin Section

7.1. Administration

The Administration section is comprised of the:

  1. Overview where Administrators can view all entities in relation to the Organization Unit tree and manage them.

  2. Contracts are also able to be viewed here depending on the Permission Set of the user.

  3. Themes where the look and feel of the DataPortal for each and every Organization Unit can be configured.

7.2. Admin Overview

In this section Administrators are able to build a proper hierarchy of Organization, Sub-Organization, and Machines that users can access depending on their entitlements.

Administrators can also create Users, activate and assign them to the required Organization or Sub-Organization.

Each Sub-Organization has its own views of Machines, Groups of Users, Sub-Organizations and even its own Theme and Dashboard.

Users can only see Machines and other Users within their own Sub-Organizations.
The IDs of different elements such as Users, Machines and Sub-Organization is found in the Administration Overview section. These IDs are useful during Troubleshooting and Fault Reporting
Interface Description

This is a description of the Administration Overview section together with all the functionality.

admin overview

The different areas of the Admin section of the DataPortal consist of:

1 - The Organization units within the Company together with their Sub-Organization. When Selecting a Sub-Organization and a Menu Item (4), only the Machines or the users belonging to this Sub organisation will appear on the Detail Panel(5).

2 - The Add, Edit and Delete Buttons to manage the Sub-Organization Units within the Organization.

3 - Expand and Collapse Button to have a better view of the Organization tree.

4 - The Top Menu allows viewing and assigning Users or Machine to Organization units. Each functionality is explained in the section Administration Top Menu.

5 - The Detail panel where the details are displayed after being selected from the top Menu bar. The information depends on the Selected Sub-Organization and the Menu Item selected on the Menu Bar.

6 - The Organization Units Side Bar appears on different so that Users can be assigned or Machines can be moved across Sub-Organization units.

7 - The Search bar to find a Machine, a user, or a Sub-Organization unit within the Organization.

8 - The Back Button allows the user to return back to the Normal User Dashboard.

7.2.2. 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.

Figure 17. 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.

Figure 18. Contract Details
Table 8. Contract Details - Communication Unit tab
Item Description


The identification number of the communication unit.

Current SIM card ID

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


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 9. Contract Details - Machine tab
Item Description


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


The part identification number for the machine.


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.3. Organization Units

Organization Units or OUs are groups of users that may have sub-organization units or child organizations. OU serves as containers for users and machines within the organization. Users and Machines can be assigned to sub-organisation units separately. Users can only see machines in their own organization and the organizations below.

7.3.1. Adding a Sub-Organization Unit

To add a new organization unit to your organization:

1: Highlight the parent organization unit or the sub-organization where the sub-organization will be added.

admin overview add ou

2: Click on the '+' button to add a new unit to this organization.

3: Add the Name and click the 'Create' button.

admin overview add ou added

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 10. Permission Set Levels
Level Description


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


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


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.


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 Permission / Service Description



Enables user to view report pages.





Enables user to make adjustments to Assignments for their organization.




Enables user to create and delete Assignments for their organization.


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 Permission / Service Description



Enables user to view contract data of organizations.





The user is able to renew or cancel contracts





The user is able to setup new or replace contracts.





Machines Service
Level Permission / Service Description



Enables user to view machine data.



Password Reset


Enables user to set a password for a selected machine in the machine management.



Enables user to create, manipulate and remove administrative machine data.





Enables user to administrate organization machines.



Models Service
Level Permission / Service Description



Enables user to view machine model data.



Enables user to update and assign (catagorize a list of machines) machine model data.







Enables user to create and delete models, edit its attributes including name and description and upload an image.
NOTE: Models with machines assigned to them cannot be removed.

Models assigned to the parent organization of a machines org unit is visible to the machine owner.
Organizations Service
Level Permission / Service Description



Enables user to view organizations.



Enables user to manage permissions assignment to users and change the organization tree by creating, updating or deleting organizations.


Enables user to invite, move and modify users to an organization.


Enables the user to see(?) organization themes.












Reports Service
Level Permission / Service Description



Enables user to view report pages.









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 11. 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


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.

Figure 19. 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 12. Create Models Overview
Item Description


Model identification


Where the model was created. Cannot be edited.


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


Definition of the model.

Figure 20. Create/Edit Model Dialog
Table 13. Create Models Machines
Item Description


Search the machines assigned to this model by Name


Search the machines assigned to this model by ID

Modify Machines

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


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


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.
Figure 21. Create/Edit Models Machines
Figure 22. Create/Edit Models - Modify Machines

7.7. Manage Machines

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

1 : List Machines: When selecting the Machines tab, a list of machines which is allowed within this Organization Unit. Search and Filtering is available on top of the Name and Model column.

2 : Machine Details: When clicking on the Machine Detail, the page is redirected to the Machine Details page so as to view all the properties of the Machine.

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
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.8. 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.9. Users

7.9.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
- Name
- Language
- Organization
- Permissions

Once this information is entered, click the Create button.

Account setup can only be performed by users with suitable entitlements
user add

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.

Figure 23. DataPortal Invite

The password must:
- Have at least 12 characters
- Contain an upper-case letter (A-Z)
- Contain a lower-case letter (a-z)
- Contain a space or punctuation mark (one of . , ! or ?)
- 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
  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 permission subjects access for the user.

  4. The permission level for a subject in the DataPortal.

  5. Click Update to save the changes.

7.9.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 DataPortal 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.9.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.10. 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 → Themes and you are brought to the Themes customization page.

theme 1
Figure 24. DataPortal Theme
Table 14. 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 to users at the login page.

7.10.1. 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
  <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">

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 25. DataPortal Theme, URLs
Table 15. 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.

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:

  • 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 16. Org Unit Categories
Classification Visibility Description


manufacturer (OEM), dealer, machine owner

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


Dealer, machine owner

Machine/equipment manufacturer.


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.

Figure 26. 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


A set time series measurements.


A time interval that defines the time resolution of signal data.


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


Provides the smallest value of a Bucket.


Provides the largest value of a Bucket.


Provides the average of all values of the Bucket.

Standard Deviation

Provides the Standard Deviation of the values of the Bucket.


Sum of all values of the Bucket.

Cumulative Sum

Sum of all values within the current Bucket and all previous Bucket sums in the selection.

Serial Difference

Provides the difference of the averaged values of the previous Bucket to the next Bucket.

9.2. Geo Data


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

glossary track

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, Basic-Concepts Organizations

organisation units
Figure 27. 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