DataPortal User Manual for SMB

General¶

The information is organized into the following sections:

Get started with the Proemion DataPortal, browser settings, login and concepts.
The user interface, personalization, and search.
Introduction to widgets.
An overview of your machines.
Tools for the day-to-day operation of each machine.
Maintenance Tasks.
Events.
Reports.
Settings topics such as organization and model management, user permissions and interface design.
Tools for the day-to-day operation of your fleet.
OEM Insights
Glossary.

The DataPortal is the front end of the DataPlatform, a REST-based web application. The documentation and API data can be accessed at our Document Library.

Introduction

Audience¶

Proemion offers small and medium businesses (SMB) a more simplified access to the telematic system by offering starter bundles.

OEM's of approx. 100 machines are the primary audience of this concept described in this manual; for an overview of this offer, see Platform Contracts.

Browser¶

The DataPortal is a responsive web-application that works flawlessly on any operating system. The 2 most recent releases of each of the browsers in the table are tested compatible with the DataPortal.

Performance Rank	Browser
1	Google Chrome (recommended)
2	Mozilla Firefox
3	Edge (only current version)
4	Safari

Viewing the DataPortal on mobile devices is optimized for the following screen sizes:

1920 x n
1024 x n
600 x n
380 x n (minimum supported width)

The DataPortal is demoed on phones and we strive to support the following pages for viewing (not editing):

Dashboard
Machine list
Machine details

Browser Troubleshooting¶

In case there is an issue with a certain browser, perform the following steps:

Update the browser to the latest version
Check if the problem exists with an up-to-date version of a different browser from the list
Contact support with the details and steps to reproduce the issue

Note

Proemion will no longer actively support the use of Internet Explorer to access DataPortal.

To sign in to the DataPortal, proceed as follows:

Open a web browser and go to DataPortal.
Enter your Username and Password.
Figure 1: Enter your Username and Password
Select Log in

If you enter an incorrect password multiple times, the login screen may be temporarily locked. If you forgot your password, see Password Reset.

You can change the language in the footer. The Login page can be customized in Themes.

The default URL for the Proemion login page is https://dataportal.proemion.com/.
If you use an OEM-branded access to the DataPortal, use the URL provided by your OEM.

Usernames for DataPortal are not case-sensitive.

Sign out behaviour

When users sign out of the DataPortal:

The user´s session ends.
The user is returned to the login page.
No redirect to an external URL occurs.

Alias Email¶

For the email address, usually used as the username, it is allowed to use email subaddresses, provided that your email provider supports it. By that, you can have multiple accounts with 1 email address, e.g. myemail+machine-owner@oem-mail.com.

This feature supports Dealers that work on multiple OEMs; there might be many users that need multiple emails to log in to different OEMs' DataPlatform accounts. It can also help a single OEM's user to create test users for different organization unit types or even subcustomers, e.g. myemail+dealer@oem-mail.com, myemail+customer-a@oem-mail.com.

Alternative method for alias email¶

If the method described above does not work, consider the following option to make it work:

Use machine-owner+myemail@oem-mail.com, instead of myemail+machine-owner@oem-mail.com.

Some providers require the alias directly before the @ symbol, i.e. "current-username+alias@oem-mail.com". For concrete examples, see the following list:

Gmail (Google): Format: username+alias@gmail.com
- You do not need to create a new email or user to receive these emails to your primary Gmail account.
- You may need to create an official alias within Gmail to reply FROM your account without exposing your actual Gmail address.
Microsoft: Format: username+alias@domain.com for Outlook services (such as Live.com, Outlook.com and possibly more)
- You may need to create an official alias within Outlook to reply FROM your account without exposing your actual Outlook address.
Proton Mail (proton.me): Format: username+alias@proton.me

The use of the "+" symbol in email addresses, often referred to as "plus addressing" or "subaddressing," is described in RFC 5233 "Sieve Email Filtering: Subaddress Extension" and RFC 5321 "SMTP" section 4.5.1. Between RFC 5321 SMTP and RFC 5233 Sieve Email Filtering: Subaddress Extensions, the lack of a universal standard allows providers to interpret placement individually, leading to variations in how subaddressing is implemented across different email systems.

Password Policy¶

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

The password must have:

Min 12 characters.
Max 64 characters. Any character is allowed.
Different from username or email.
Max 2 consecutive characters.

Password Reset¶

Users can reset their password by selecting the Forgot password 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.

Note

The link for the password reset is valid for 10 minutes.

Note that as an admin you may also Force Password Reset, Suspend Users and Inactive Users or Delete Users.

Note that when an admin used the Force Reset Password option, you as the user don't receive an email and can't log in unless you create the new password via Forgot password as described.

Permissions¶

In the DataPortal, you can assign each user individually a Permission Set
A Permission Set is a group of entitlements consisting of levels and subjects.

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

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.

Hierarchy (1 < 2 < 3)	Level	Description
1	View	The user can consume the subject data but cannot remove or change the configuration. The account is limited to read access.
2	Diagnostics	The user can sign in to the DataPortal and can perform Realtime sessions.
		The user however usually cannot perform create/delete operations.
3	Admin	Full operation capability including create/delete for a given subject in all visible organizations. The account is able to perform CRUD (create, read, update and delete) operations for users and subjects for all visible organizations for the subject.

When selecting a level, e.g. "View", it is applied to all subjects, see the following example:

Select the user role, e.g. View.

Figure 1: Select Level
All subjects will be then automatically set to the permissions according to the user role "View":

Figure 2: User Role "View"

Note

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

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:

Assignment Subject
Contract Subject
Dashboard Subject
GeoArea
Maintenance Task Subject
Location Subject
Organization Subject
Realtime Subject
Report Subject
Tenant Subject
Theme Subject

Subject Descriptions¶

The following tables list the available subjects along with their descriptions for each permission level.

Assignment Subject¶

The Assignment Permission Set is allows users to edit and maintain Assignments.

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.

Note

Assignments access is limited to exact organization unit match.

Contract Subject¶

The Contract Permission Set allows users to edit and manage the contracts of the machines' CU.

Level	Description
View	View contract data for the machine with the basic attributes:
	- contract identifier
	- order number
	- state
	- end date
	Submit a contract renewal request.
Maintain	View the contract attributes:
	- tariff description
	- activation date
	- start date
	- next billing date
	- tariff begin date
	- tariff end date
	Perform Go Live requests on provisioned machines.
Admin

Dashboard Subject¶

The Dashboard Permission Set allows users to edit and manage organization and model dashboards for their organization(s).

Note

This permission can be only granted to users within tenant organization and of Organization Type "OEM".

Level	Description
None	The user is not allowed to edit or create dashboards.
Admin	Allows to edit and manage dashboards.

Note

Assignment of additional dashboards to lower level organizations will break the chain of inheritance. Please refer to chapter Dashboard.

ECU Subject¶

The ECU Permission Set allows users to access and manage ECU Firmware Over-the-Air (ECU FOTA) features, including Software Repositories, Electronic Architectures, and ECU update requests. For further information read the ECU FOTA documentation.

Note

The ECU Permission Set is only available when ECU FOTA has been activated for the organization by Proemion. Contact your Account Manager or Field Application Engineer (FAE) to request activation.

Level	Description
Admin	Allows access to Software Repositories and firmware version management.
	Allows creating and configuring Electronic Architectures and ECU definitions.
	Allows creating and managing ECU update requests.

Location Subject¶

The Location Permission Set governs user access to location data for all events, tracking, reports, maps and notifications. Location access is set to none by default and must be configured by an administrator.

Level	Description
None	The user is not allowed to see any location data.
Latest location	The user location data view is restricted to the current location.
Location history	The user can view the latest location and location history.

Maintenance Task Subject¶

The "Task" subject is referred to as the Maintenance Task Subject within this manual.

The Maintain permission level for this subject is typically granted to the Dealer user role
Tasks can be seen if the user can access the machine.

Level	Description
View	- Enables users to see the scheduled Maintenance Tasks.
	- Users with solely machine view permission can also see them.
	- The status Upcoming, Overdue, Completed and Skipped can be viewed, but not edited.
	- Checklist item updates can be viewed only when the maintenance task has been completed, but not in the History
	They will appear as "Pending" until the task is completed, then will show as the actual state.
	- Print Maintenance Tasks.
	- View the feature Acknowledge Maintenance Tasks
Maintain	Can change the status of a maintenance tasks for a machine
	Can update the activities checkboxes and the completion note
	Can view the History of the assigned maintenance task.
Admin	Can assign a maintenance task to another user
	Can view the History of all maintenance tasks
	View the signature for Acknowledge Maintenance Tasks.

Operational Subject¶

The Operational:View Permission Set allows read-only access to Product Data and selected Related Service Data via the Proemion REST API. It was introduced to support compliance with the EU Data Act (Regulation (EU) 2023/2854) and is only used for the creation of REST API Clients to facilitate data access. The Operational:View Permission Set can replace the previous Permission Set for relevant endpoints, enabling secure access to the required data.

For example, if an endpoint previously required Machine:Admin Permission Set for reading Related Service Data, it can now be accessed with either the Machine:Admin or the Operational:View Permission Set.

Level	Description
View	Allows API clients to retrieve readily available Product Data and selected Related Service Data. This level does not allow modification of machines, configurations, actions, or services and does not provide access to Derived Information.

Organization Subject¶

The Organization Permission Set allows users to view, edit, and manage organization units, users, and machines of the organization (unit).

Level	Context	Description
View	Org Unit	Access Settings > Organization Structure in read-only mode. View: - the organization tree - the Details tab (organization and tenant metadata, domain configuration, statistics, contact details) - the Sub-Organizations tab (organization units controlled by the selected organization)
Maintain	Org Unit	View: - OEM external key (filter and sort)
		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
		Retrieve a list of: - organization unit parent candidates - user Permission Sets - organization units that share type with or are sub-organization units
		Create an organization unit.
		Delete an organization unit.
		Share machines to a different organization unit. See Machine Share Definitions
	User	Retrieve a list of all users or a single user's details.
		Update: - user details - user email
		Create new user.
		Change a user's ban status.
		Resend and invitation email to an inactive user.
		View the last login and the email address of users.
	Details	Allows access to the data analytics instances of your organization unit.
Admin	Org Unit	Create and change the OEM external key (only as admin of the parent organization)
	User	Create new user.
		Assign user roles.
		Change a user's ban status.
		Resend and invitation email to an inactive user.
		View the last login and the email address of users.
	Dashboard	Create Edit and Delete sets of metrics used in efficiency definitions.

Realtime Subject¶

The Realtime Permission Set controls access to real-time related functionality, pages, and device behavior and allows users to change settings for the CANlink® mobile 3600.

Level	Description
View	Grants read-only access to protected real-time data.
	Allows to view real-time events on the Events page.
	Allows to view real-time related information on the Diagnostics page.
	Grants read-only access to the Remote Machine Tunnel feature.
Admin	Provides full control over real-time functionality, e.g. endpoint management for the Remote Machine Tunnel .
	Can switch the CANlink® mobile 3600 to Realtime/Logging.

Report Subject¶

The Report Permission Set is used for Reports.

Level	Description
View	Enables user to view report pages.
Maintain	-
Admin	-

Tenant Subject¶

The Tenant Permission Set allows users to edit subjects on the tenant level.

Level	Description
View	-
Maintain	-
Admin	Can Configure the DataPortal Imprint document. Can upload legal documents (Privacy Policy and EUA) in different languages.

Theme Subject¶

The Theme Permission Set allows users to edit and manage themes for their organization.

Level	Description
None	The user is not allowed to manage the theme.
Admin	Allows to edit and manage themes.

GeoArea Subject¶

The Geo Area permission allows users to manage Geo Areas.

There is no distinction between the levels. One Permission Set allows to create, modify, delete geographical areas bound to organizations.

Personal User Settings¶

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

Selecting Account Overview you can view and change:

Name
Organization
Username
Email
Password
Language
Time Zone
Date & Time format
Numbers Formatting
Notifications

The permission sets panel displays your authorizations.

Date & Time¶

In the Account Settings menu, you can configure your time zone and date format preferences. All machine data displayed in the DataPortal uses the time zone set here. By default, this is your browser´s time zone.

Lab Mode¶

In the Account Settings menu, the Lab Mode enables functionalities in an experimental state activated via Feature Switch in the Organization Administration menu
The Feature Switches are available for features regarding Data Science, Sections and Languages.

You have the option to enable Lab Mode in your Personal User Settings.

Note

Note that the Lab Mode must be activated first for each feature, see Lab Mode Activation.

To change the status of Lab Mode for your user profile, proceed as follows:

Select the Account Settings in the top right-hand corner of the dashboard.
Select Lab mode.
Toggle the status ON or OFF.

Once Lab Mode is enabled for the profile, features activated are visible in the DataPortal interface.

Numbers Formatting¶

In the section numbers formatting, the unit system, the decimal separator and the thousand separator can be defined.

In My Account, click Account Settings.

Figure 5: My Account Settings
Click Numbers formatting.

Figure 6: Select Numbers Formatting
Select a unit system.

Figure 7: Definition Numbers Formatting
Select the desired type of decimal separator.
Enable optional a thousand separator and select the desired type for it.

Notifications

The DataPortal has a number of features that allow you to subscribe to daily notification per email.

Note that for receiving notifications about Assignment Completion you must have at least maintain permission.

To access the subscription's settings page:

Select My Account in the upper right corner of the DataPortal Dashboard.
Select Notifications to open the notification settings page.
Depending on your assigned Permission Sets the dialog will appear as shown:

You can now activate and configure the notifications for the following events:

Notification	Description
GeoLeash	An email is sent immediately when a GeoLeash event occurs for a machine.
Machine Errors	You can choose from Daily or Instant (when the code is triggered) event notifications with a list of machines that have registered a DTC within the past 24 hours
	NOTE: You won´t receive DTC or threshold notifications from machines which you can only access through a share.
Maintenance Tasks	Receive a weekly summary of maintenance tasks and their current status for your machines
	The email includes an Excel attachment containing the same structure as in exporting Maintenance tasks, and additionally the machine's location.
Thresholds	You can choose from Daily or Instant event notifications that includes a summary of threshold breaches of the subscribed security level and the location of the machine of the past 24 hours
	NOTE: You won´t receive DTC or threshold notifications from machines which you can only access through a share.
Time Fence	An email is sent immediately when a Time Fence event occurs for a machine.
Assignment Completion	Receive a notification email with report as soon as an assignment is completed.
Contract end	Receive a weekly notification email about contracts ending soon.
GeoFence	Receive a notification email when a machine from the buisness unit enters or leaves a GeoFence; requires Location:Location history Permission Set.

Note

Location data access (visibility) for notifications must be set by an organization admin.

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.

Note

You won´t receive DTC notifications from machines which you can only access through a share.

Notification Content¶

The email contains the information described in the table below.

Element	Description
Machine	Links to the Machine Page in the DataPortal.
Time	Shows when the error started, resp. when it ended (for Machines with cleared errors).
Component	Machine component.
Signal	Signal that shows erroneous behaviour.
Type of error	Type of failure detected..
Severe Level	Level of severity, e.g. "Least Severe Level (17)".
Excessive Indicator	If there are more than 3 error entries or more than 100 machines with errors, this will be indicated in the summary.

To subscribe to DTC notifications for your organization, configure the Machines errors (DM1) in your Notifications settings.

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

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, see Threshold Configuration.

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.

Note

You won´t receive threshold notifications from machines which you can only access through a share.

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.

Note

Every breach triggers a separate notification included as part of the daily summary for the severity level.

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.

Samples¶

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

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.

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.

In the plot shown below, the Extreme label is triggered when the fuel level dips below 5%.

Figure 7: Plot Example with Thresholds - Apply Zoom

To subscribe to threshold notifications for your organization, configure your Notifications settings and choose the severity level for which you would like to receive notifications by choosing the color accordingly:

Severity Level

The notifications will be sent as a daily between 5 a.m. and 6 a.m.

Example of a threshold notification content:

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

Select a topic from the list to jump to that section in the manual: - Organization Dashboard - Machines - Maintenance - Events - Assignments - Reports - Settings

Note

On tablets or mobile mode, the left-side menu is collapsed as shown in the image below:

Figure 2: Collapse Side Menu Button (mobile phone)

Search¶

The DataPortal includes a search field that allows you to perform a single-click global search for the following objects:

Machines (machine name or IMEI number of CU)
Vehicle identification number (VIN)
Product Identification Number (PIN)
Serial number
Users^*
Organizations^* (a search by Organization Type is also possible)
Models^*

Note

^*Searching users, organizations and models is only possible from the Administration panel.

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 forwards you to the Machine Page for the communication unit.

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

Recent Search¶

Opening the search field without performing a specific search shows you the three last recently viewed machines in the search results:

Figure 2: Recently Viewed - Search field

Search within Map¶

You have the possibility to search directly within maps.

When you type in a specific name of a location, the map will be zoomed to this location while showing the machines within this location.

Hierarchical Geo Data¶

The DataPortal provides hierarchical geo data for machines in your organization to use as filter criteria in reports and machines lists. Any machine that has position data also has hierarchical geo data. This functionality enables filtering all machines within a continent > country. Herewith you can categorize or aggregate reports and data by location.

#	Item	Description
1	Column type	User can filter machines of a specific Country or Continent.
2	Locations with most machines	List of locations with most machines is displayed here. User can enable a filter for the given countries or continents.
3	Search	Input field if a user wants to search for a specific location.
4	All Locations	Tree of all locations and the distribution of the machines is displayed here. Enable the checkbox for the required continent or country.
5	Machines with unidentified locations	Enable this checkbox to also list machines with Unknown location.
6	APPLY	Button to APPLY the location filter. If the filter settings needs to be removed, click on CLEAR ALL

Note

Only users with the Machine: View and Latest location or Location history permission sets have access to this functionality. Location history is necessary to retrieve the data via API.

Note

The Geo Data Location Filter can only be applied to machines where the setting for the Geo permissions in the assigned PDC also allows visibility of the location for the respective organization type. If a machine has a PDC without Geo permission for the user's organization type, the Location of this machine is displayed as Unknown Location. For further information regarding the permission settings, please refer to PDC Manual - Permissions.

The table below shows the availability of the GEO Data Location Filter in the DataPortal.

Feature/Menu Item	Module/ Column	Filter? Y/N	Navigation
Machines Overview	-	Y	Machines > Machine list > Location column
Maintenance	-	Y	Maintenance > Filter > Machine > Machines filter: Location
Events	-	Y	Events > Filter > Machine > Machines filter: Location
Assignments	-	Y	Assignments > Filter > Machine > Machines filter: Location
Reports
	Maps	Y	Reports > Maps > Configure Maps > One machine > Machines filter: Location
	Plots	Y	Reports > Plots > Configure Plot > One machine > Machines filter: Location
	Scatter Plots	Y	Reports > Scatter Plot > Configure Scatter Plot > One machine > Machines filter: Location
	Tables	Y	Reports > Table > Configure Tables > One machine > Machines filter: Location
	GeoLeash	N	Reports > Filter GeoLeash Events > Select machine
	Machine Efficiency	Y	Reports > Efficiency Snapshot > Select machines
		Y	Reports > Efficiency History > Select machines
	Assignments	N	Reports > Assignments > Assignment Report > Configure report
Settings > Administration > Organization Structure
	Machines Management	Y	List of machines
	Models	N	New machine model > Machines > Select machine
	Communication Units	N	Settings > Administration > Organization Structure > Communication Units tab
	Contracts	N	Settings > Administration > Contract > Contracts list

Table Options¶

Tables are used to represent data in several menus and elements of the DataPortal. Within these tables you have different options to view, search or filter data:

Each row is clickable and leads you to the details of the machine. You can search throughout the table or specific columns, see below.

Sort and Filter Table¶

Reset all options to default values.
You can remove or add each column from the table.
You can sort by each column in the table by selecting the arrows above the column.
Via the 3-dots icon by the end of each row, you find further actions and options in the drop-down menu, see Machines Overview for an example of available options.
Filter and search of specific columns are available by clicking the filter icon and entering the searched text into the fields at the top of each column.

For date columns, the filter offers relative time presets (e.g. Last 4h, Last 24h, Last 48h, Last 7 days) or a Custom option to define a specific date-time range.

For number columns, the filter offers a numeric range with From and To input fields.

Resize Columns¶

Columns can be resized by dragging the handle at the right edge of the column, which shows a double-headed arrow icon with two vertical lines in the middle, see screenshot below:

Any columns resized by the user are saved locally and restored when reopening the table.

Export Table¶

Via the export icon, tables can be exported.

You can select to export all columns or only specific columns as viewed in the DataPortal:

You can select to export the tables mostly as a CSV, JSON or XLSX file and PDF file:

Depending on the exported table, the column headers include the units (for the "Signal" column) and the time zone GMT+0:00 (for the "Last updated" column).

Important note on rounding¶

Consider that due to rounding, the displayed values in tables and charts may differ slightly from the underlying data.

Therefore, refer to the raw data displayed in the exports for exact figures of a report (instead of, for example, summing up the values displayed in a chart) as the values are displayed in full precision.

Note that in the XLSX exports, 3 decimals at maximum are displayed by default, yet the full precision raw value remains.

Dashboards

Organization Dashboard¶

The organization associated dashboard displays the required datasets and information for the entire organization.

It is also possible to create and save multiple organization associated dashboards for dedicated target users, application and time range. In this case, the desired organization associated dashboard must be selected from the drop-down menu.

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:

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.

The primary roles are "Admin" and "Maintainer, see Permission levels.
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.

Filter by Organizations¶

As the Organization Dashboard shows data in the widgets of the entire organization tree, you can filter the dashboard by the organization units for your individual view in the DataPortal. This can be done for every dashboard configuration.

To filter the dashboards, proceed as follows:

In the Dashboard menu, open to the Organizations drop-down.
Figure 3: Organization associated Dashboard - Organizations Filter
Select the organizations that you want to view their data in the dashboard (widgets). When selecting an organization (parent), all its children organizations are selected, too, and will be greyed out. This means that all widgets will fetch information for the selected organization together with its children.
As a result, the dashboard shows data only from the selected organizations. An icon will be displayed in the widgets that show the filtered data.

Figure 4: Organization associated Dashboard - Filtered Data

Note

The filter criteria are preserved when switching between dashboards during a session in the DataPortal.

View as¶

Use the View as drop-down to switch your view of the organization dashboard to the one of either an OEM, Dealer, or Machine Owner, based on the organization type.

To define organization types for each organization dashboard, go to Visibility level/Binding in the Dashboard Page Layout

Page Layouts¶

It is also possible to create and save multiple organization dashboards/layouts that display different widgets and/or time range.

In this case, select the desired organization dashboard from the Page layouts drop-down:

To define different layouts of organization dashboards, go to Duplicate/Create Layout in the Dashboard Page Layout

Model Dashboard¶

The model associated dashboard displays the required datasets and information for specific machine models and herewith for all machines which are assigned to this model. The dashboard is displayed in a dedicated Machine Page for each machine belonging to this model.

A user viewing a machine page gets a widget layout based on the template assigned to the model of the machine.

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.

Concept¶

Model represents a type of machine, and can also be understood as the class, while machine is an instance of that class.

Model 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
Add links to documentation and brochures in multiple languages. Links added here will be visible in the widget layout of all machines of this model.

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

Machines Overview

Machines Overview¶

The Machines Overview is the central place for managing specific machines on different views.

The machines can be displayed in map that allows to zoom-in and-out and gives a quick description of the machines whn hovering over.
The machines can be also displayed in a table/list view to have a clear structure of the available machines.

By default, the Machines overview offers the 3 views: List view, Map view and Split view on all machines visible to the user. You can disable the possibility to select the Map view via Settings > Portal Appearance > Theme > Behavior Options.

The following filters and options let you narrow down the machines shown to the ones relevant to you (e.g. only machines with upcoming maintenance, or only machines belonging to a specific organization); for details, see Filters and Options:

List and map filter each other toggle, above the table/map next to the Reset icon and the Filters button
Reset icon, next to the toggle
Filters dialog, top right corner
Table options, above the table next to the search field (available for the list view only)
3-dots menu, at the end of each row (available for the list view only)

Filters and Options¶

The filters and options described below are to be found on the Machines Overview.

List and Map Synchronization¶

The List and map filter each other toggle is active by default.

By switching it off, the map and list are not linked and can be used independently. That means, you can filter the list without affecting the map, or zoom in the map without the list being filtered by the machines visible on the map.

Reset Icon¶

Use the Reset icon to globally reset both Map and List views to default state or to reset filters only.

Filters¶

Filtering has moved from individual table columns to the Filters menu. This enables filter options that a simple column filter could not support, such as filtering by an organization and all its child organizations at once.

The following filter categories are available:

Connection status: e.g. online status.
Asset types: filter by the asset types assigned to the models.
Data source: filter by the CU hardware type, e.g. CANlink® mobile 10000, CANlink® mobile 3600.
Model
OEM
Organization: select an organization to filter by. The filter includes both the selected organization and its child organizations.
Maintenance deadline: filter by Upcoming and/or Overdue maintenance status.
Maintenance progress: filter by Unplanned, Planned, Skipped last week or Completed last week maintenance task status.
Location: filter by Continent or Country.

Once applied, a filter is displayed as a tag with its name and value above the list table. Select the close icon on the tag to remove that filter.

Table Options¶

Adapt the list and export it, see also Table Options.

The options regarding the table are available in List and Split view only.

Unlike other tables in the DataPortal, the machine table does not offer column-level filtering. Use the Filters menu instead.

Use the search field above the table to search machines by name, serial number, PIN or VIN.

The drop-down menu can be opened via the 3-dots by the end of each row in both the List and Map views and offers the following options:

Go to Machine Page
Go to Maintenance Task (only in Map view; if the maintenance filter is applied).
Open Signals Overview Panel.
Show machine on map (only in List view) Zooms to the location of the machine on the map. This option is useful when the List and map filter each other toggle is deselected.
Open in Google Maps. Opens Google Maps in a new tab with the static location/coordinates of the machine.

Tip

All filters and options applied (apart from visible columns) will be included in the URL.

The following location-related options can be used with permission set Location:Latest.

Copy address¶

Copies the machine address at the time the link was created, i.e. street name and number, zip code and city.

Copy coordinates¶

Copies the latitude and longitudes coordinates of the machine at the time the link was created.

The permission set Location:History is required instead Location:Latest to enable the following links.

Create a link to a web page/view on the static machine location at the time the link was created, or
Create a link to the live machine location.

The machine's live location is updated every 5 minutes by default as long as the link is valid, but stops the refresh if the machine is idling for 1 hour.

The links are accessible by users without DataPortal account and is valid for 48 hours. The number of shared links is displayed in the share dialog.

Note

A maximum of 5 links can be shared.

To create a shareable link, proceed as follows:

Click Share location or the 3-dots in the map.
Choose Share via secure link:
Figure 2: Share location dialog
Choose either Share static location and Share live location.
Confirm with Create and copy link:

The link will be copied to the clipboard.

The shared page looks as follows:

Note

Note that the page is displayed in the language of the browser when not logged in, otherwise it displays in the selected DataPortal language.

You can open the live location in Google Maps via the 3-dots, see also 3-dots Menu.

You may stop the sharing of the location via the share dialog again. Consider the note:

Map¶

The map in the Machines Overview shows the most recent recorded positions of all machines. 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.

Hovering over a machine on the map displays a pop-up with basic details for online and offline (showing "Last contact") machines:

Selecting the machine icon shows the view with the following details:

Note

You can view the map elements like country-, city names, etc. translated as per the language set in your account preferences.
Supported languages: English (also fallback language), German, French, Italian, Spanish, Korean, Japanese

Current connection status (online or Last contact (offline) ¹)
Machine Name
Serial number/PIN
Organization
OEM name
Model
Asset type; if there is no asset type assigned to this model, the organization unit name is displayed instead
Location together with its last datapoint¹
Signal (e.g. operating hours)
Date and time of the most recent status change
Maintenance status (if the maintenance filter is applied)

- Last contact shows the timestamp of the last time the CU contacted the DataPlatform, i.e. went online.
- Last datapoint shows the timestamp of the last datapoint, i.e. transmitted files or received machine signals, e.g. engine or location data. Note that certain signals don't update the Last Datapoint, see Proemion Standard Metrics → "Standard System Metrics".
↩↩

List¶

The machine list in the Machines Overview displays the following parameters in different columns:

Online state
Name
VIN
PIN
Serial Number
Model name
Organization unit name
Last contact¹
Last datapoint¹
Maintenance Tasks status ("Upcoming", "Overdue", "Skipped last week", "Completed last week")
Asset type
Data Source (shows the CU type, CU model, and import source for identifying the machine data source, e.g. "Hardware Proemion CANlink mobile 3600")
By the end of each row, you find the drop-down menu via the three-dots with links as described in 3-dots Menu².

For information on how to adapt or export the table view, see Table Options.

Note

Note that all columns will be exported.

Last contact shows the timestamp of the last time the CU contacted the DataPlatform, i.e. went online. Last datapoint shows the timestamp of the last datapoint, i.e. transmitted files or received machine signals, e.g. engine or location data. Note that certain signals don't update the Last Datapoint, see Proemion Standard Metrics → "Standard System Metrics". ↩↩
You can open the Machine Page by selecting an entry in the list or selecting the 3-dots by the end of the line of each machine. ↩

Signal Overview Panel¶

The Signals Overview Panel provides a quick overview of the machine’s current state and key measurements. It allows users to monitor real-time signals and assess the operational condition of the selected machine at a glance.

To open the Signals Overview Panel, you have two options:

In the Machine List, select the row of the desired machine.
In the Machines Overview, open the 3-dots menu at the end of the machine's row and select the option Open signal overview panel.

This will display detailed signal data for the selected machine in a sidebar panel on the right side of the DataPortal, see following Screenshot.

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

Online / Offline state
- gray background color indicates currently offline.
- green or blue background color indicates currently online.
Time of most recent state change
Machine Name
Organization the machine belongs to

Click on GO TO MACHINE to open the Machine Page.

Click on the marker icon to zoom the map to the machine.

Unknown Machine Location¶

Machines with unknown locations are displayed in both map and table views as follows - irrespective of map interactions, e.g. using "List and map filter each other", or state changes, e.g. "online"/"offline":

List View: In the list view, filter for machines with an unknown location by selecting the "Unknown Location" filter. This will display a count directly in the list of how many machines lack location data. The filter is to be found in the column "Location"; if the column is not visible in the List/Table view, add it as described in (4) Table options above.
Map View: In the map view, it is not possible to render machines without a known location. Since these machines do not have associated geographic coordinates, they will not appear on the map. You will only see the count of these machines, which can be identified through the list view.

Split View: In split view, use the "Unknown Location" filter to see the count of machines without location data in the list section. Similar to the map view, these machines will not be displayed on the map section, but only the count of the machines which can be then identified in the list.

Machine Page

Introduction¶

The Machines page is a representation of the data of a particular machine.

You can open the Machines Page via the Machines Overview, the Signal Overview Panel or searching the machine.

The navigation buttons in the top-right corner allow you to switch between the Machine Pages of your organization's machines (not shown when more than 12 machines are available)
Hovering over the navigation buttons shows the name of the next/previous machine.

Requirements¶

In order to view or edit the Machines Page within the DataPortal, the following requirements must be fulfilled:

Permission Set Name	Level	Action
Machine	View	for viewing the Machine Page

The Master Data widget will display the information in form of a panel on the dashboard within the following two tabs Machine Details and Location - provided that options are activated in the Master Data Configuration.

Machine Details¶

Shows the machine info and other details via icons for Maintenance Tasks, Machine Tracking and Weather Forecasts and Overlay when enabled in the Feature Switch. In the Details tab, the following information is displayed additionally to the configured ones:

#	Item	Description
1	Machine Name	Name of the machine.
2	Connection Status	Current state (online/offline) since a particular date.
3	Location	Share the location of the machine, see Location.
4	Machine Info	Serial number - Serial number of the machine. Organization - The organization that created the machine and shares details. Machine Model - See Machine Model. OEM - The Organization the machine belongs to. Asset Type - See Asset Types.
5	Tabs
		Weather - Check the weather and configure the weather overlay on the map, see Weather Forecasts and Overlay.
		Maintenance - Leads you to the maintenance page of the machine.
		Timefence breaches - Leads you to the Timefence breaches of the machine.
		Machine Tracking - Track route of your machine, see Machine Tracking.
		Contact Dealership - Contact the service location of your Dealer, see Dealers.
		Communication Unit - Configure the functions of the machine, e.g. Device Mode (Realtime/Logging), see Communication Unit and History. For more information on configuration, see Machine Actions and Realtime/Logging Switch.
6	Manage Layout	Configure the layout of the Machine Details Page, see Manage Layout
7	Manage Machine	Configure the machine's properties, see Manage Machine.
8	Map	Displays the machine's location on a map. If the machine is offline, a drop icon with a minus sign indicates its last known position. If the machine is online, the endpoint of the current track (circle with the number 3) is displayed . When zooming in, both the starting point (circle with letter A) and the current location (circle with number 2) of the machine are displayed.

Location¶

The Location tab gives information about the machine's address and its Status and Update. Via the 3-dots you have options to copy and share the machine's location, see also Machines Overview.

Only if tracking is activated in Machine Master Data, location tracking is visible for the time range displayed above the map.

Note

Location data access must be set by an organization admin and is necessary to use this feature.

Contract Renewal¶

Contracts that are expiring soon are highlighted in the Machine Page within a banner on the top.
Depending on the user, the information in the banner changes:

As a user without at least Contract:Maintain permissions e.g. as a Machine Owner, you may only Request Renewal:

Figure 4: Contract Renewal banner

Note

This request will be displayed both on the OEM portal and in the digest email listing the soon expiring contracts.
The eligible user may then renew the contract with Proemion. see below.
As an eligible user e.g. as the OEM, you are displayed the message that a renewal was requested:

Figure 5: Contract Renewal requested
- Clicking Renew Contract, you will be forwarded to the Machine Contracts menu, where you can configure and confirm the Renew process for the selected machine:
  
  Figure 6: Renew Contracts
  
  Note
  
  To renew an "active (canceled)" or terminated contract, you need Contract:Maintain permissions.
- After successful renewal, a confirmation will be displayed in the Machine Contracts menu:
  
  Figure 7: Renew Contracts confirmed

After clicking the link in the banner, it will disappear from the machine.

Manage Machine¶

The Manage Machines window is available in the top right corner of the Machine Page. It shows all properties of the selected machine. And you may also configure several functions as described as follows in the documentation:

Note

Note that the available functions depend on the Device Mode of the machine.

Properties:
- Edit PDC Assignment
Advanced Functions:

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.

Machine Tracking is accessible via the marker icon in the Machine Master Data widget, which is usually to be found in the Machine Page.

Note

Location history access must be set by an organization admin and is necessary to use this feature.

Configuration¶

Click the marker icon in Machine Master Data to open the machine tracking page.

Figure 1: Open Tracking Configuration
Adjust the settings for the time range, signal and visualisation according to your needs.

Note

The number of allowed waypoints may be limited on the map. A higher resolution view of the path is possible by limiting the displayed time range.
Click Apply to track the machine route on the map.

!!! note Additionally, it is possible to select a signal which can be visualised along the track. There are two options. The first option is the visualisation with a Gradient and the second option is to create a Chart in parallel.

!!! note The default color of the path tracking can be customized by selecting Settings > Portal Appearance > Theme > Map Style section.

Samples¶

Map with Gradient Signal Visualisation¶

#	Item	Description
1	Time Range	Define the time range for the track. Please be aware that there is only a maximum time period of 7 days possible when a signal along the tracks needs to displayed.
2	Signal	Select the signal which needs to be visualized along the track.
3	Signal Visualisation	Gradient, see Map/Location Reporting
4	Gradient Options	See Map/Location Reporting
5	Print PDF	Option to export the track to a PDF.
6	Overlay	See Maps Overlay.
7	Zoom Options	With these buttons the size and the center of the map can be optimized.
8	Machine & Signal Name	The selected machine and signal is shown here.
9	Map Legend	This legend shows the grouped signal values and the assigned colours for the track.
10	Waypoint Popup Window	Shows position and signal value.

Note

A mouse click on a waypoint on the map opens a popup window with the exact position, time stamp and the value for the selected signal.

Map with Chart Signal Visualisation¶

#	Item	Description
1	Time Range	Define the time range for the track. Please be aware that there is only a maximum time period of 7 days possible when a signal along the tracks needs to displayed.
2	Signal	Select the signal which needs to be visualized along the track.
3	Signal Visualisation	Gradient, see Map/Location Reporting
4	Track options	See Map/Location Reporting
5	Print PDF	Option to export the track to a PDF
6	Overlay	See Maps Overlay
7	Zoom Options	With these buttons the size and the center of the map can be optimized.
8	Signal Chart	The chart for the selected signal and time range is shown here.

Note

A mouse click on a waypoint on the map opens a popup window with the exact position and time stamp. Additionally, the corresponding value of the selected signal is marked at the chart.

Note

This feature is only available for subscriptions of the Medium bundle or higher, see Platform Contracts.

Time Fence/Timetable¶

The Time Fences feature allows you to define a schedule for when a machine should be allowed to be in use. An active time fence checks at machine start if a breach - a connection to the portal outside scheduled operation - exists. If so, a breach event is registered resulting in an immediate email notification to the users subscribed to this notification.

Note

The DataPlatform generates time fence breach events when the machine starts operation due to ignition or CAN activity outside the configured schedule. Wake-ups caused by real-time clock (RTC-driven) mechanisms (for example cyclic wake-up intervals or alarm-based wake-ups) do not trigger time fence breach events, even if the device connects to the DataPlatform after waking up.

Note

This feature is only available if it has been activated for the organization from the Features tab in the Administration menu.

For example the schedule can be arranged thusly:

Day	From - To
Monday	9:00 - 17:00
Tuesday	9:00 - 17:00
Wednesday	9:00 - 17:00
Thursday	9:00 - 17:00
Friday	9:00 - 17:00

A time fence schedule arranged as shown in the table sends a breach event whenever the machine is in operation outside the designated time frames.

Configuration¶

To configure the Time Fence the Machine:View Permission Set is required.

To do so, proceed as follows:

On the Machine Page, select the machine you want to manage and click the Manage Machine vehicle button in the top-right corner.
This opens the Manage Machine window.

In the Manage Machine window, open the Machine advanced functions and select Time Fence.
Click the + sign and select a day and time; you can define multiple time fences from Monday to Friday.

Click Apply to save the time fence.

To subscribe to Time Fence Notifications for your organization, configure the Time fence breaches in your Notifications settings
Once subscribed you receive email notification about the first breach per day per machine.

Via Events you can see all breach events:

#	Item	Description
1	Event Severity	Event timestamp (when the event was fired), machine name and severity level.
2	Time fence Definition	Link to the configured time fence schedule.
3	Time Fence Breach Occurrence	Incident timestamp (when the breach occurred).

Connection Types¶

This documentation provides an overview of the different connection types available for CANlink® mobile devices, with a particular focus on the Online mode, which is the standard connection type for current devices. Legacy connection types such as Logging and Realtime modes are only relevant for older devices and are covered for completeness.

Note

The Online mode replaces the previously separate Logging and Realtime modes that are only used in some legacy devices. In order to use Diagnostic Cases make sure that Realtime cases are included in your machine's Contract Details.

Online Mode¶

The Online mode connection type combines the functionality of both Logging and Realtime modes. Devices operating in this mode:

Continuously log data to the DataPortal.
Support real-time diagnosis sessions for remote diagnostics and monitoring at the same time.

This connection type enables seamless data acquisition and interaction, as devices operate in a combined mode that does not allow switching between Logging and Realtime. Devices using the Online mode connection type appear in the DataPortal with a green indicator (small green circle in the first column). These devices are included in both the Realtime and Online filters. This means they are visible whenever either filter is applied, appearing in both filtered views within the DataPortal.

This feature must be enabled in the Behavior Options.

The mode is displayed and can be filtered in the following DataPortal features, if enabled:

Machines Overview
Machine Map widget
Machine List widget
Machine Master Data widget
Signal Overview Panel

Realtime/Logging Switch¶

Note

This functionality is only available for legacy devices.

The Device mode functionality enables switching the CANlink® mobile device between the modes Logging and Realtime.

In Logging mode, the device records preconfigured machine signals when it is online and transmits them to the DataPlatform. In contrast, in Realtime mode, the device transmits raw CAN messages to a service application for live diagnostics, and no signals are logged to the DataPlatform.

Device Mode¶

You can see the current mode for the machines in both the Organization Dashboard and Model Dashboard.

Note

To display the online status and device mode of the machines, the administrator should have enabled the Machine List or the Machine Map widgets that both show the indicators.
On the left of each machine row within the Machine List widget, Realtime mode is indicated by a blue online marker and Logging is indicated by a green online marker.
The machine map widget allows to filter machines by their online status/device mode. This is done by means of the corresponding toggle switch.

Switch Device Mode¶

The Realtime:Admin Permission Set is required to switch between Realtime and Logging modes. If the communication unit is offline, the device mode switch is not available.

To switch the device mode, proceed as follows:

On the Machine Page, select the machine you want to manage and click the Manage Machine vehicle button in the top-right corner.
This opens the Manage Machine window.

In the Manage Machine window, open the Machine advanced functions drop-down menu and select Device mode.
Figure 2: Device Mode Dialog
Select Realtime or Logging mode from the Active state drop-down menu.

CAN Network Configuration¶

The Machine Actions functionality enables the user to configure the CAN Network parameters of the machine within the DataPortal interface, e.g. , e.g. CAN 1, 2, 3 + CAN Identifier as well as the Baudrate (e.g. "shutdown in...").

This allows you to set parameters during the initial configuration of the machine, before connecting the device to a CAN Bus.

Warning

WARNING: Configure these parameters before the machine is operational and verify that there are no problems when the gateway is connected to the CAN Bus Networks of the machine. ATTENTION: Do not configure these parameters when the machine is operational in the field, it could compromise its correct operation and cause unwanted machine downtime.

Requirements¶

To change the information, you need the Machine:Admin permission set.

How-to¶

Note

After applying the new configuration, the device restarts, a NMT Restart will be applied. A warning will be displayed when saving your configuration.

Go to Machine Details Page and click Manage Machine in the top-right corner.
Open Advanced functions > CAN Network:

<br>

Adapt the fields as desired. If you have already set some parameters, you will see the last value set.

<br>

Save your configuration.

Machine Actions Use Cases¶

Following information can be configured to the machine as one of the following:

CAN Interface
For CAN1, CAN2 and CAN3
Baud rate; Selection from 125, 250, 500, 1000
CAN-Id; Numeric, range: 1-127
TCU
Shutdown method; Selection from
By ignition
- 0x3333, 0x32: 300
- 0x3333, 0x41: 0
by CAN-BUS activity
- 0x3333, 0x32: 0
- 0x3333, 0x41: 300000
send one OBW containing the default password and all the settings

A history or record of last sent values to use them as prefill can be provided by Proemion.

Reset Device¶

The Reset Device feature is only available for CANlink® mobile devices.

To reset the device, the Machine:Admin Permission Set is required.

Proceed as follows:

On the Machine Page, select the machine you want to manage and click the Manage Machine vehicle button in the top-right corner.
This opens the Manage Machine window.

In the Manage Machine window, open the Machine advanced functions and select Device Config.
Select a Reset type from the drop-down menu and click Apply. The device will be restarted.

The following reset options are available:
- Revert to Factory Configuration
- Delete All Log Files
- Revert to Firmware Defaults Remote
- Revert to Firmware Defaults plus Format Remote

For more details about the different type of resets, refer to following information from the chapter Device Reset CANlink mobile 3600 of the CANlink mobile Device Manual showing the according objects and their sub-indexes for triggering the various reset options available via the CAN interface:

Function	Index	Subindex	Description
Revert to Factory Configuration¹	`0x1011`	`0x01`	The factory configuration is restored. All logged data is deleted.
Delete All Log Files	`0x1011`	`0x62`	All logged data stored on the device is deleted.
Revert to Firmware Defaults Remote	`0x1011`	`0x63`	The standard configuration¹ of the current firmware is restored. All logged data is deleted. CAN, Wi-Fi®, Bluetooth and mobile radio parameters as well as the factory configuration are retained.
Revert to Firmware Defaults plus Format Remote	`0x1011`	`0x64`	The standard configuration of the current firmware is restored. All logged data and the factory configuration are deleted. CAN, Wi-Fi®, Bluetooth and mobile radio parameters are retained.
Revert to Firmware Defaults Local	`0x1011`	`0x65`	The standard configuration of the current firmware is restored. All logged data and parameters are deleted. The factory configuration is retained.

Consider that when a Device Reset is being performed, the ON LED flashes in a magenta color and the Status LED orange, see Device Reset CANlink mobile 3600.

Difference between Factory configuration and Standard configuration:

Factory configuration

With the end-of-line tests (EOL test), Proemion loads a standard configuration (DOD.bin file) into the file system of the device.
This configuration is called Factory configuration.
The content of this file is activated in the device by using the object 0x1011, subindex 0x01. The factory configuration can be easily overwritten by the customer via the object 0x3333, subindex 0xF0.
This makes it easy for customers to define and install their own configuration as the "factory configuration".
If there is no file in the file system, the device configuration will not be changed, but the logged data will always be deleted.

Standard configuration

Each firmware version has its own default values in the code for non-volatile configuration parameters. These default values are loaded automatically for fresh devices, for example.
The default values of the firmware are loaded via the object 0x1011, subindex 0x63.
In contrast to the factory configuration, the standard values cannot be changed by customers.
These are fixed values in the code memory. ↩↩

Restart Device¶

The Restart Device feature is only available for CANlink® mobile devices.

You must have Machine:Admin permission to be able to reset the device.

Proceed as follows:

On the Machine Page, select the machine you want to manage and click the Manage Machine vehicle button in the top-right corner.
This opens the Manage Machine window.

In the Manage Machine window, open the Machine advanced functions and select Device Config.
Click Restart. The device will be restarted.

Figure 1: Device Restart

Maintenance Tasks

Maintenance Process Overview¶

The maintenance process in the DataPlatform is enabled by the Maintenance Planner, a feature that automates the planning and management of machine maintenance based on telematics data.

It supports OEMs and service organizations in ensuring timely maintenance execution and improving maintenance coverage.

This section provides an overview of how maintenance tasks are triggered and managed using telematics data and DataPlatform capabilities.

Telematics data enables condition-based and usage-based maintenance by providing continuous insight into machine operation.

Maintenance processes rely on OEM-defined maintenance manuals. For Maintenance Planner in the DataPlatform these are translated into digital maintenance catalogs that specify intervals, activities, and required materials for each machine model.

Maintenance tasks are generated based on these definitions and can be managed within the DataPortal or integrated with external ticket systems.

The following diagram illustrates the overall maintenance workflow, from data acquisition to task execution and completion.

Prerequisites and Setup¶

The following prerequisites must be met to set up and operate maintenance processes effectively.

These prerequisites cover:

the data and configuration required to create maintenance tasks, and
the DataPlatform setup required to manage and assign those tasks.

Telematics Data¶

Telematics data for maintenance execution is collected and processed by the DataPlatform.

Maintenance can be based on the following signals, or on a calendar interval:

Machine operating hours.
ECU-indicated maintenance (e.g. hours to next service counter)
Machine component based wear indicators.
DTCs - Diagnostic Trouble Codes. When specific DTCs occur, maintenance tasks can be scheduled.

Calendar-based maintenance is based on the machine's activation date instead of a telematics signal and does not require an additional signal to be configured.

Machine Model Alignment¶

Maintenance tickets usually contain a description or a list of activities needed which are specific to the machine models. Machine models configured in the DataPlatform must be aligned with the maintenance requirements of the corresponding machines.

Maintenance Catalog¶

Maintenance processes rely on maintenance catalogs that define intervals, activities, and required materials. The OEM's maintenance manuals' prescription are translated into a digital format that can be used by the Maintenance Planner in the DataPlatform.

For details, see Maintenance Catalog.

DataPlatform Setup¶

Maintenance Tasks must be activated via Feature Switches. Scheduled Maintenance and Maintenance issues have separate feature switches.

For efficient maintenance organization, service personnel from service centers must be represented in the DataPortal.

This includes:

setting up appropriate Organizational Structures and
adding users and assigning maintenance tasks via User Management and Task Assignment.

This enables better workload distribution across the service organization by assigning individual maintenance tasks to service personnel.

Task Management¶

Maintenance tickets must be monitored by operational staff.

This is required to:

schedule maintenance activities with the machine owner
support the coordination of service execution, especially when no regular service contract with the service center is in place.

This ensures that service centers maintain a continuous and well-balanced workload and that upcoming maintenance activities are executed in a timely manner.

It can also support the identification of opportunities for additional service offers and spare parts sales.

Process Alignment¶

Maintenance processes should be aligned among all stakeholders (partners, service and operational personnel), to ensure consistency and efficiency.

This includes understanding the specific tooling that will be used and the business processes that are part of efficient maintenance business processes.

Maintenance Catalog¶

A maintenance catalog defines maintenance requirements for machines based on predefined intervals, activities, and related resources.

It is defined using YAML configuration files.

For details on the configuration structure and available parameters, see Maintenance Planner.

For a complete example, see Maintenance Catalog example.

Catalog Content¶

A maintenance catalog is configured based on the data you provide. Some of this information can be derived from the Proemion device manuals if required.

The following sections describe the main components of a maintenance catalog.

Intervals and Activities¶

Maintenance is organized in intervals based on a defined base such as operating hours.

Each interval defines a specific maintenance scope and includes a set of activities.

Typical activity types include:

Check
Replace
Change
Inspect
Lubricate
Test
Service

Spare Parts and Materials¶

Maintenance intervals can include predefined sets of required spare parts and materials, typically grouped into kits.

External Links¶

Maintenance entries can include links to external resources such as:

Spare part ordering portals
Parts catalogs

Signals¶

Maintenance tasks are triggered based on telematics data.

Examples of signals:

Machine operating hours. This is the most common setup.
ECU indicated maintenance can be implemented in various ways, including a decreasing hours to next service counter. A maintenance task can be created when this counter approaches 0, but without additional information different maintenance task types cannot be distinguished.
Wear indications (e.g. brush diameter)
DTCs - Diagnostic Trouble Codes

Machine Models¶

Maintenance definitions are specific to machine models.

The machine models in the DataPortal need to be aligned with the maintenance requirements for those machines.

Relationship to Maintenance Tasks¶

A maintenance catalog is used to generate maintenance tasks based on:

Defined intervals
Signal values
Maintenance logic configured in the catalog

Each task contains:

Descriptions
Activities
Required materials
References to external resources

Maintenance Tasks Overview¶

This documentation provides an overview of the Maintenance Tasks feature and describes how maintenance tasks are displayed, filtered, and managed in the DataPortal.

Note

The behavior and configuration of maintenance tasks can vary depending on the manufacturer's requirements and implementation.

Maintenance Tasks is available in two views: the default Table View (left) and the old Card View (right).

Topic	Description
Process Overview	How maintenance tasks are triggered and managed using telematics data
Prerequisites	Requirements for setting up maintenance processes
Catalog	Defines intervals, activities, and materials for maintenance tasks
Filters	Filter tasks by type, progress, deadline, and more
Activities	Optional checklist shown instead of the Description list
Completion Note	Add information regarding the maintenance task
Acknowledge Maintenance Tasks	Shows who has acknowledged the completion of the maintenance task
History	Lists all actions performed on the maintenance task
Assign Task	Assign maintenance tasks to users
Update Task	Mark a maintenance task as planned, skipped, or completed
Print Maintenance Tasks	Print individual or filtered lists of tasks
Permission Sets	Required permissions for viewing and managing maintenance tasks
Dealers	Contact the service location of your dealer

Table View¶

The Table View is the default view for Maintenance Tasks, see Maintenance Tasks Overview.

Note

The behavior and configuration of maintenance tasks can vary depending on the manufacturer's requirements and implementation.

Maintenance Task Table¶

The following columns are available for each task and can be shown, hidden, or reordered. Most columns can also be filtered individually via the filter icon in the column header, see Filters:

Maintenance type - Scheduled maintenance or Maintenance Issue
Deadline - Upcoming or Overdue, shown as a colored label with tooltip
Progress - Unplanned, Planned, Skipped, or Completed, shown as a colored label with tooltip
Signal threshold (e.g. operating hours)
Date threshold (calendar-based maintenance)
Created / Updated
Assigned user
Description or Activities
Completion Note
Acknowledgement

Depending on the defined maintenance workflow, Deadline and Progress states might be set by the Maintenance Planner, see Maintenance YAML configuration explanation.

The table supports the standard table functions:

Search
Export to CSV or XLSX, see Print list of tasks
Resizing for a larger screen view

Single Task Actions¶

Each task row provides access to individual actions via the three-dots menu. Clicking anywhere on a row opens the task detail view without using the three-dots menu.

Action	Description
View task	Opens the task detail view (same as clicking anywhere on the row)
Mark as planned / skipped / completed	Changes the progress state directly without opening the task detail view, see Update Task
Show signal in plots	Opens the Plot Report pre-configured with the machine and signal driving the maintenance task
View machine	Navigates to the Machine Page of the machine associated with the task, showing machine state, diagnostics, and operating data
Print task	Opens the print dialog for the individual task, see Print Maintenance Tasks

Bulk Actions¶

Use bulk actions to apply the same change to multiple tasks at once, without opening each task individually.

Click Bulk Actions at the upper right to enable multi-selection of maintenance tasks. Select the desired tasks using the checkboxes, then click Choose Actions to open the bulk edit dialog.

Bulk actions support:

Progress: set the progress state (Unplanned, Planned, Skipped, or Completed) on all selected tasks at once
Completion Note: add or delete a completion note (up to 2,000 characters) on all selected tasks at once
Assignee: assign a user to or remove a user from all selected tasks at once

Each section can be toggled on or off in the dialog. Click Update to apply the changes.

Selecting Show only selected displays only the selected rows, independent of the active page or any applied filters. Active filters do not affect the current selection.

Selecting Select all is limited to 50 results. When assigning a user during a bulk action, the assignee list is not searchable.

Note

Submitting an empty Completion Note during a bulk action deletes the existing Completion Note on the selected tasks, unless the Completion Note has been configured as mandatory - in that case, an empty note shows a validation error instead, see Completion Note.

Task Detail¶

The task detail view shows:

Item	Description
Deadline / Progress / Type	Shown as colored labels
Maintenance Thresholds	Shown for scheduled maintenance tasks based on a signal, a calendar interval, or both. Displays the Service in and Threshold value for each configured threshold (signal name or date). Additionally the Latest value is shown for signal thresholds. Click View latest value in plot report to open the Plot Report for a signal threshold (not available for the date threshold). Not shown for unscheduled maintenance issues.
Assigned to	Assign a user to the task, see Assign Task
Machine	Name, model, OEM, and organization of the associated machine
Description	The maintenance task description
Activities	Optional checklist of steps to complete, grouped by category where configured. Can be shown instead of Description.
Completion Note	Add information regarding the task
Document links	Links to external resources such as spare part ordering portals or documentation, configured via the Maintenance Planner
Acknowledgement	Shows who has acknowledged the completion of the maintenance task
History	Chronological list of all actions performed on the task

When a maintenance task is completed, click Mark as... > Mark as completed in the header, see Update Task.

Assign Task¶

Maintenance tasks can be assigned to service technicians directly from the task detail view.

Figure 3: User field for assigning Maintenance Task

Open the desired Maintenance Task.
Choose from the list of eligible users in the Assigned to field. You can also search by name.

The user is now assigned to the Maintenance Task.

To unassign the user, click the delete icon next to the name:

Figure 4: Unassign user from Maintenance Task

Note

If the permission set of the assigned user changes to a lower level, the user will be automatically unassigned.

Acknowledge Task¶

Acknowledging a maintenance task means adding a signature to confirm the completion of the task. Once signed, the maintenance task shows the Acknowledgement section.

Click Show image to view the signature. This is only available to users with Maintenance Tasks:Admin Permission Set.

Machine Owners can see the completion note and that the task was acknowledged for completed tasks only.

Update Task¶

The Mark as... menu at the top of the task detail view can be used to set a task's progress to Planned, Skipped, or Completed. The menu is not displayed for skipped maintenance tasks.

To complete the maintenance task, click Mark as... and select Mark as completed. A confirmation dialog is displayed:

Figure 7: Complete the task confirmation

Confirming with Complete changes the Progress of the maintenance task to Completed and iterates/resets the Service Cycle. This action cannot be undone.

Note that a maintenance task may be closed despite pending Activities.

Switch to Card View¶

To switch to the Card View, click Back to old view at the upper right of the table.

Card View¶

The Card View is the old view for Maintenance Tasks, see Maintenance Tasks Overview.

Note

The behavior and configuration of maintenance tasks can vary depending on the manufacturer's requirements and implementation.

Task List¶

Maintenance tasks are displayed as a list of cards. Each card shows:

Maintenance type indicator, see Maintenance Task Types: Scheduled maintenance or Maintenance Issue
Deadline and Progress state, shown as a colored icon combined with a text label (e.g. Upcoming/Overdue, Unplanned/Planned/Skipped/Completed)
Threshold and Service in for each configured signal or date threshold
Machine, model, OEM, and organization
Created and updated dates

Depending on the defined maintenance workflow, Deadline and Progress states might be set by the Maintenance Planner, see Maintenance YAML configuration explanation.

Above the list:

The map icon forwards you to the Machine Map where you can view machines with upcoming and overdue Maintenance Tasks.
Filter tasks by Type, Progress, Deadline, Organization/Machine/Model, Assigned to, Total service cycle, or Time, see Filters
Active filters are shown as removable tags above the task list
Sort by Newest, Oldest, or Last Modified
Export/Print list of tasks as CSV, XLSX, or PDF

Task Detail¶

Clicking a card opens the task detail panel, showing:

Maintenance Thresholds, same as in Task List, but also including the Latest value for the signal threshold
Assign Task to User - the user's initials are added to the Maintenance Task
Description, or Activities shown instead as a checklist
Completion Note
Acknowledge Maintenance Tasks
Document links, added via the Maintenance Planner
History of all actions performed on the task

For details on assigning tasks, acknowledging tasks, and updating the progress, see Table View - the process is identical in both views.

When a maintenance task is completed, click the Update Progress button and mark the task as completed, skipped or planned.

Leave Feedback¶

Use this feature to explain why you switched back from the Table View and what prevented you from continuing to use it.

A Leave feedback button is shown after switching back from the Table View.

Figure 2: Leave feedback button in old view

Clicking Leave feedback opens the following form:

Maintenance Task Types¶

This section explains the two maintenance task types - Scheduled Maintenance and Maintenance Issue - how they are created, and how they are managed.

Scheduled Maintenance¶

Scheduled maintenance tasks are based on the Service Cycle, DTCs, faults, or other regular intervals and are implemented by the manufacturer via the Maintenance Planner. A task becomes due once its Threshold is reached, see Task Detail.

Calendar-based Maintenance¶

Scheduled maintenance tasks can also be triggered by a calendar interval instead of, or in addition to, a signal such as operating hours. If both are configured for the same maintenance item, the task becomes due whichever target is reached first.

The target date is calculated from the machine's activation date and the configured interval, defined via the Maintenance Planner. If the machine's Commission Date is available, it is used as the activation date.

See Table View and Card View for how the Date threshold is displayed.

Hours-to-next-service¶

Scheduled maintenance tasks can also be based on hours-to-next-service instead of an incrementing operating hours counter. In this case, a decrementing, resetting signal is used to create the next maintenance task.

For hours-to-next-service tasks, the Latest value is always positive, and so is the Service in value, unlike for regular Scheduled Maintenance tasks. The Threshold is not displayed, as the signal value counts down to zero and showing 0 as a threshold does not provide meaningful information.

Consider that in the Machine Companion App Manual, a mix of maintenance tasks based on the signals hours-to-next-service and operating hours is used.

Maintenance Issues¶

Unscheduled tasks, so-called Maintenance Issue, are created for tasks that need to be done in between service cycles — for example, based on DTCs or wear-based components, or manually by manufacturers and machine owners using the REST API call Create Maintenance Task.

Dealers and machine owners are able to view and manage tasks, such as adapting the state or adding a Completion Note.

Both scheduled and unscheduled maintenance tasks undergo the same progress from Unplanned to Completed and can have the same deadlines Upcoming and Overdue.

Filters¶

Filtering options depend on the view you are using, the Table View or the Card View.

Table View Filters¶

Most table columns support the standard column filter, including text search and date-time/numeric range filters, see Table Options.

Maintenance-specific columns that can be filtered include Deadline, Progress, Type (see Maintenance Task Types), Acknowledgement, and Signal Threshold.

The Date Threshold column does not currently offer a filter.

The Organization column filter also includes machines shared into the selected organization.

Card View Filters¶

Click the filter icon to open the filter dialog. Select the desired filters and click Apply Filters to apply them, or Clear All to reset all filters.

Filter	Options
Deadline	Upcoming, Overdue
Progress	Unplanned, Planned, Skipped, Completed
Type	Scheduled maintenance, Maintenance issue
Acknowledgement	All tasks, Acknowledged only, No acknowledgement
Organization	Select by organization. Also includes machines shared into the selected organization.
Machine	Select by machine, see Machine Selector
Model	Select by model
Assigned to	All, or select a specific user
Total service cycle	All cycles, or select a specific cycle
Time	Filter by Created or Updated date

These filters are also useful when exporting or printing maintenance tasks.

Activities¶

Activities are an optional checklist of the single steps for completing the maintenance task. Use Activities to guide service technicians through the required work and track completion of individual steps.

When activated, the checklist is shown in the task detail view. To activate the list of Activities, create a ticket at the Support or contact your Proemion representative.

These activities are imported from the Maintenance Catalog and will be listed as separate checkboxes. Activities can be grouped under a category (e.g. Change, Test, Control), depending on whether they are configured as a flat or nested list in the Maintenance Catalog, see Activities configuration.

Activities can optionally include links (e.g. to external documentation or instructions), added via the REST API when creating or updating a maintenance task, see Create Maintenance Task. Selecting a link opens it in a new browser tab.

The checkbox for each step can be ticked separately by the maintenance service technicians when completed. The History will be updated accordingly.

For the required permissions, see Permission Sets.

Note

Consider that the maintenance task may be closed despite pending activities, see Update Task.

Completion Note¶

The Completion Note field allows service technicians to document work performed, observations, or follow-up actions directly on the Maintenance Task.

The note can be edited at any time during the Maintenance Task, before or after finishing it.

It can be added by the maintenance service technicians with Maintenance Tasks:Maintain Permission Set for the Maintenance Tasks they are assigned to.

This Completion Note is then made accessible to users with Maintenance Tasks:View Permission Set, e.g. Machine Owners as soon as the Maintenance Task is completed.

In the History, a new entry "updated Completion Note" will be noted when adding, editing or deleting a Completion Note.

To add a Completion Note, proceed as follows:

Open the task details page of a Maintenance Task and click + in the Completion Note section.
Figure 1: Add Completion Note
Add the desired text and click the Disk icon to save your Completion Note. The change will be directly written in the History below.
Figure 2: Add Completion Note Text

The Text cannot be formatted and is limited to 2000 characters.
Click Update Progress and choose one of the available options to close the complete Maintenance Task with the note.

✓ The Completion Note will be added to the Maintenance Task and a corresponding message is displayed in the History.

To change the Completion Note, add a new text in the Completion Note field and click the Disk icon to save your changes.

To delete the Completion Note, save an empty Completion Note.

A note may be edited multiple times.

History¶

The History section lists all actions including their time stamp performed regarding the selected Maintenance Task. Filtering or sorting based on the History is not supported.

Additional to the creation date of the maintenance task, it will also show for example:

actions regarding the Completion Note when it has been created, adapted or deleted: "User xy updated Completion Note"
actions regarding Activities: "User xy marked Change: Engine oil filter as pending".

Print Maintenance Tasks¶

You can print individual tasks, a collection of tasks by using the filters beforehand, or all displayed tasks (without filters).

The prints include the Activities, the Completion Note and their state, and the full History of the task.

You must have the Maintenance Tasks:View Permission Set to use the print feature.

Table View¶

To print task(s) from the Table View, proceed as follows:

Use the Filters to display only the desired tasks, or select an individual task.
Print the task(s) using one of the following options:
- Click the export icon above the table to print all displayed (pre-filtered) tasks.
- Click Print task in a row's three-dot menu, or Print task in the task detail view, to print an individual task. The print dialog of your system opens where you can proceed to print the maintenance tasks.

Card View¶

To print task(s) from the Card View, proceed as follows:

In the Maintenance Task menu, select the individual task or use the Filters to display only the desired tasks.
Click the export icon:
- On the left side, to print all displayed (pre-filtered) tasks.
- On the right side, to print the individual task.
Figure 1: Maintenance Task Print
Select Print list of tasks/Print task
The print dialog of your system opens where you can proceed to print the maintenance tasks.

Reports

Introduction¶

The DataPortal offers both preconfigured reports and the creation of manual reports to get an instant overview of different events, signals and data of a machine.

Specific Reports

Fleet Activity Report¶

The Fleet Activity Report offers a report on the machine activity, specifically the machine's operating hours. The report shows a "heat map" per week for a maximum of 20 machines. The machine activity of the past 10 weeks can be checked.

You must have Reports permission to access the Fleet Activity Report.

The Fleet Activity Report is based on the value.common.machine.hours.operation.total signal. To view when a machine was ON/OFF, check Machine Activity Report.

Go to Reports > Specific Reports > Fleet Activity Report.

This layout gives a quick overview on what days of the week a machine was online or, when offline, to quickly analyze whether this happened by default or due to an error, for example:

The machine was online but sent invalid data on that day, i.e. >24 operating hours. A warning will be displayed.
The machine was online but sent no data at all on that day. A warning will be displayed.
The machine was not online and sent no data on that day, i.e. 0 operating hours. This is not an error and, therefore, no warning will be displayed, but the cell will be greyed out.

You can hover the single days/cells to view the last time online of the machine.

Export Fleet Activity Report¶

The report can be exported to an Excel file. The export can be used as a basis for invoicing.

Machine Activity Report¶

The Machine Activity Report offers a report on the operational status of a single machine. This report provides Machine Owners information on the times in a day a machine was ON during a week.
You can switch between the weeks in the top-right corner.

Go to Reports > Specific Reports > Machine Activity Report and select the machine

This layout gives a quick overview on what days of the week and for how long a machine was online or offline.

The Machine Activity Report is either based on the value.common.engine.state signal (0 is OFF) or value.common.cu.sensors.ignition.state - either one signal is used depending on the availability of the users.
To view the machines' operating hours, check Fleet Activity Report.

Showing Totals¶

The report shows daily and weekly total number of hours (hr).

The bars are color-coded:

Gray bars represent "OFF" time.
Hovering over a gray bar shows how long the machine was off.
Blue bars represent "ON" time.
Hovering over a blue bar shows how long the machine was on.

When you hover over a bar, additional details like the start time, end time, and total duration, i.e. the exact duration the machine was either "ON" or "OFF", are displayed.

Daily Totals¶

For each day, the total daily "ON" time in hours is displayed to the right of the charts.

These daily totals are summed up at the end of the week to provide the total "on" time for that week, giving an overview of the machine's activity.

Weekly Totals¶

The weekly machine activity reports use bars to represent the machine's states and the duration spent in each state.

Weekly totals are displayed at the top- and bottom-right corners of the chart.

Machine Efficiency¶

Efficiency reporting enables machine owners to calculate and track efficiency for individual machines or for the fleet. In the DataPortal you can view the data as Efficiency History and Efficiency Snapshot reports or as a widget on the dashboard.

Machine Efficiency Requirements¶

The Machine Efficiency default configuration is done in the Efficiency Definitions.

Note

The Efficiency reports aren't accessible if no Efficiency definition exists.

Create Efficiency Report¶

Note

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

Configure an Efficiency report by following the steps below:

On the left-hand menu of the DataPortal dashboard select Reports.
Select Efficiency Snapshot or Efficiency History from the menu to open the configuration dialog.
Configure the Efficiency Report options as described below.
Once you have configured the report criteria, select the machines and click .
The DataPortal then calculates the data and generates a report.

Figure 1: Machine Efficiency Report Options

#	Item	Description
1	Time range	Select the time period for the measurements up to the previous 2 years.
2	Bucket	Choose the time intervals between data points in the report. Please note that Bucket is only available if Efficiency History is selected.
3	Efficiency definition	Select a predefined efficiency definition.
4	Sort by	Choose between sorting by efficiency or by name.
5	Sort direction	Choose between ascending and descending.
6	Select Machines	Select machine(s) for which you want to display efficiency.
7	Export report	Allows you to export the report as CSV file or to share a link.
8	Bar chart	Graphical representation of the reporting.
9	Explanation of chart	Explains chart elements and displays summary.

Note

This feature is only available for subscriptions of the Medium bundle or higher, see Platform Contracts.

Geoleash¶

Geoleash tracks and enables automatic notification about machine relocation (defined as movement from one area to another). Notification is based on a set of criteria requiring minimal configuration.

Note

Geoleash functionality (configuring a boundary) can only be activated for devices (communication units - CU) where the installed firmware supports this feature. Contact your Proemion representative for more information.

Note

Location history access must be set by an organization admin and is necessary to use this feature.

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 necessary in some cases and both features can be enabled simultaneously.

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:

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:

Event	Description
Passive Breach	The criteria are active and when the communication unit is switched on, a breach is detected based on the current location and a new center is set.
Active Breach	The criteria are active and while the communication unit is running the machine breaches the constraint.

Primary Use Cases¶

Common Geoleash operation scenarios are shown in the following table:

Use Case	Function	Description
Tracking < 5 machines	Passive breach	A machine is relocated outside 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 the set Geoleash generates an event notification automatically.
Machine activity	View	View the past 10 actions of the machine.

Setup and Configuration¶

Note

Geoleash is not enabled for every Proemion CU. If you have questions about this feature, contact your Proemion representative or create a ticket at the Support.

To configure the Geoleash length the Machine:View Permission Set is required.

To do so, proceed as follows:

On the Machine Page, select the machine you want to manage and click the Manage Machine vehicle button in the top-right corner.
This opens the Manage Machine window.

In the Manage Machine window, open the Machine advanced functions and select Geoleash.
Select Set Geoleash Length from the Active state drop-down menu and set the leash length in meters from the current position.

Figure 1: Set Geoleash length
Click Apply.

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, go to Notifications settings.

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

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.

View Breach Events¶

To view Geoleash breach events follow the steps below:

On the left-hand menu of the DataPortal Dashboard, select Reports.
Select the Geoleash module to open the Reports / Geoleash page.
Select the time range, the machine and the type of events you want to view.
The filtered events appear in the following table.

Figure 2: Geoleash View

Note

Geoleash events are automatically deleted after 120 days.

Map View¶

You can also view the location of Geoleash events listed in the table by selecting the Open Map option at the end of each line 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.

Assignments¶

The Assignments functionality provides machine owners with the capability to create usage-based reports that track specified machine signals/counts according to the machine's jobs and tasks for bookkeeping/service tracking purposes
An Assignment can be created for an individual or a group of machines, for an individual or group of organization units
For a signal, such as fuel consumption or operating hours, to be available as an Assignment the signal must be configured as Counter in every PDC that is assigned to a Model or a Machine in the Organization, including Sub-organizations
You can also track these signals for your machines by creating a widget.

Note

In order to use the Assignments, it is essential to use standardized and harmonized metrics in the PDC files. For further details, refer to the Signal Catalog, the Proemion Standard Metrics and the PDC Manual.

Assignments Control Panel¶

You can view Assignments for your organization by selecting Assignments from the left-side menu to open the control panel. Here you can perform further actions:

Create
Clone
Export

#	Item	Description
1	Short Description	The title, key, dates and status of the assignment.
2	Create	Create a new Assignment.
3	Filter	Select and apply filters to the Assignments list shown.
4	Sort	Set the filter criteria for the order of the Assignments in the list.
5	Export	Export all assignments with any kind of filter set or without filters as CSV and XLSX. The export file also includes additional information like the serial number of the machine.
6	Description	Text explaining the Assignment objective.
7	Machines	Machines included in the Assignment.
8	Signals	Signals included in the Assignment.
9	Delete	Remove the Assignment from the system.
10	Clone	Open the Clone Assignment dialog with options already populated.
11	Edit	Open the Edit Assignment dialog with options already populated.

If you already have Assignments in place, you can generate a report.

Create New Assignment¶

Note

Clone and Edit Assignment dialogs are identical to the Create Assignment dialog explained in the next section.

Click Assignments from the left-side menu.
Click the Create icon to open the dialog and enter the configuration options shown in the screenshot below.

Figure 2: Assignments Dialog

Option	Description
The Assignment to copy from	Select an Assignment to use as a template.
Title	Assignment identification
External Key	Free text (i.e. contract or invoice ID, etc.) provided by the machine owner.
Status	Draft: The Assignment is created but the start date is still in the future.
Confirmed: The contract is signed and the Assignment is confirmed.
Archived: Deactivated Assignment.
Description	Text explaining the Assignment objective.
Dates	Fixed End Date^*: Toggle an end date for the Assignment. Otherwise, it wil generate reports indefinitely.
From: Assignment start date and time.
To: Assignment end date.

!!!tip ^*An Assignment intended to run indefinitely can be defined without an end-date so that a manual completion must be executed. Once the end date has been reached, the Assignment is concluded.

Once you have entered the data in the Options tab, click Next Step to select the Machines.

Once you have selected the machines for the Assignment, click Next Step to select the Signals.

Item	Description
Signal	Drop-down list of available signals.
Add Signal	Add additional signals to include in the Assignment.
Apply	Create the new Assignment.

Click Apply to create the Assignment.

When the Assignment has been successfully created, a message appears stating A new Assignment has been created. It may not be visible due to your current filters.

Generate Reports¶

To generate a report from an existing Assignment:

Open Reports > Assignments.
Select the Assignment you want to generate a report for from the drop-down list.
Optionally, change the From and To dates if you need to view another time period.

An aggregated report is generated as well as a report for each machine that you can open in the format of Tracking page, Map report and Plot report.

In the top menu of the Assignments Reports page, the following options are available:

Map report: Open the Location Reporting configuration.
Plot report: Open the plot configuration.
Export: Generate a CSV or PDF file that contains the Assignment report data.
Clone: Duplicate the Assignment configuration.
Edit: Edit the Assignment configuration.

Generate Email Notification¶

To get informed when the assignment is at status completed, it is possible to subscribe for an email notification within the user account settings.

The status of the assignments can be verified at the Assignments Control Panel
The notification gets triggered when the right status indicator is at COMPLETED:

formalpara-title Assignment Status

Figure 5: Assignment with status COMPLETED

Click on My Account > Notifications.

Figure 6: Subscribe for Assignment Notification
Enable the toggle switch for Assignment Completion.

Figure 7: Enable Assignment Completion

An email with a summary and a link to the corresponding assignment is sent to the configured email address of your user account:

Figure 8: Assignment Completion Notification

Note

The interval of the cyclic assignment completion check for notifications is 30 minutes. After the assignment has been recognized as completed, there may be a maximum delay of 30 minutes in sending the email.

Generate Event¶

When an assignment is marked as completed, it will also appear in the DataPortal Events list.

Reporting Tools

Report Parameters¶

This page provides an overview of the general report parameters shared between the different Reporting Tools.

The report parameters in all reporting tools are largely similar. The available reporting tools are:

Plots
Maps
Tables
Scatter Plot

Depending on the assigned Permission Set, users can view, generate, or create reports.

All reporting tools share common UI behavior:

Collapsible sections: Configuration sections are collapsible, allowing users to minimize completed metrics for a cleaner overview. The number of configured metrics remains visible when collapsed.

Metric limit: Each report can include up to 20 metric configurations.

The general parameters are summarized below.

Configure Report¶

Defines the time range and aggregation settings.

Time Range – Select a Relative or Absolute period for the data to be displayed
Bucket – Defines the time unit used to aggregate data points (e.g. Second, Minute, Hour or Day)¹.
Apply / Reset – Apply the selected configuration or reset all parameters

Machine Selection¶

Defines which machines are included in the report and how results are aggregated.

Choose how machines are handled in the report:

One machine – Select a single machine
For each machine – Display results per machine
Aggregate all – Summarize data across all selected machines

The Machine Selector is only available when One machine is selected.

Machine Selector¶

The Machine Selector allows you to search, filter, and select machines within a single panel.

Opens when clicking on the input field
Displays all available machines if no search term is entered
Supports search by:
- Name
- Serial number
- VIN
- PIN
Filters – Narrow down machines directly in the selector:
- Location (e.g. Continent, Country)
- Model
- OEM
- Organization
Show Selected – Filters the list to display only the currently selected machines
Machine counts update dynamically based on the applied filters
Selecting a machine automatically closes the panel
Selected machines and filters persist when reopening the selector

Signal Selection¶

Defines which signal(s) are visualized in the report.

Signal – Choose the signal to be analyzed
Aggregation – Defines how signal values are calculated (e.g. Minimum, Maximum, Average)
Show Threshold – Displays the defined threshold, if available

Visualization¶

Controls how the data is displayed.

Color – Select the display color for the configured metric
Advanced Options – Additional visualization settings (e.g. line style, fill, thresholds, min/max configuration)

Add / Clone Metric¶

Enables adding or duplicating metrics within the same report.

+ ADD METRIC – Add another signal or machine
Clone Metric – Duplicate an existing configuration

Apply / Reset¶

Executes or clears the current configuration.

Apply – Updates the report using the selected parameters
Reset – Removes all configured selections

The Second bucket can be selected only if the time range is less than 3 hours (i.e. 2h 59 minutes or less) and the time range type is set to Absolute. ↩

Plots¶

Plots are the standard reporting tool used to visualize signal variation during a time period in the DataPortal. You can design a report to visualize data for multiple signals for the same time period, and/or compare an identical signal from multiple machines.
Configure a Plot by following the steps below:

Select Reports from the left-hand menu to expand the DataPortal reporting menu.
Go to Reporting Tools > Plots.
Set up the general parameters and the Plot specific parameters (described in the section below) to configure your Plot.

Example

The following example shows data for an identical signal (Electric Motor - Temperature) from 2 different machines within a time range of 1 week. For each measurement, the unit is displayed on the axis and in the tool tip.

Plot Specific Parameters¶

The following settings are specific to Plots and extend the general configuration options.

Configuration Section	Description
Advanced Options	Choose from various line styles to define how data is displayed: - Line (default) - Dashed Line - Dotted Line - Heavy Line - Step - Column

Multi-Graph Layout¶

Plots support a multi-graph layout that allows data to be displayed in multiple synchronized charts.

After applying a Plot report, users can choose between different grouping modes to restructure the visualization.

When printing or downloading grouped Plots, each chart is exported separately to preserve a readable layout. Charts are automatically scaled to fit the available page or file size.

The following grouping modes are available:

Grouping Mode	Description
None	Displays all configured datasets within a single chart without applying grouping.
Metric	Groups datasets by the configured metric. A separate chart is created for each metric.
Machine	Groups datasets by machine. A separate chart is created for each machine.
Unit	Groups datasets by measurement unit. A separate chart is created for each unique unit.

Examples¶

Grouped by Metric

Grouped by Machine

Grouped by Unit

Synchronized Chart Interaction¶

Hovering over a chart synchronizes the cursor position and tooltip across all grouped charts.

Zooming into a time range in one chart automatically applies the same zoom level to all grouped charts.

Chart Option	Description
Show all	Resets the Plot to the default zoom level, displaying the entire selected time range.
Apply Zoom	Drag a frame with the mouse pointer over a desired time interval to zoom into that period. If the Plot is already zoomed in, clicking Apply Zoom refines the resolution of data points by automatically switching the bucket size to the highest available resolution for that zoomed interval.
Grouping	Reorganizes the Plot into multiple synchronized charts based on the selected grouping mode: - None - Metric - Machine - Unit
5 Sec.	Enables real-time monitoring by refreshing the data every 5 seconds.
Export Menu	Provides multiple options to share or save the report: - Request raw dataset - Download image formats: PNG, JPEG, PDF - Export data as CSV or XLSX - Print chart - Share link: Copy to clipboard or Input into address bar to save the report URL as a browser favorite. See note ¹.

Plot Export of Raw Data¶

The Request raw dataset option from the Export Menu allows to export the raw data of a configured Plot.

Note

When the configuration of the machine data Plot exceeds the maximum of 10 machines and 10 signals for a time range of up to 7 days, the Request raw dataset option is greyed out and a mouseover message with the allowed configuration settings will appear.

Once the export is completed, an email containing a download link for the corresponding *.csv file will be sent to the user.

The download link is valid for 24 hours only.

Visualization grouping does not affect CSV or XLSX raw data exports. Exported raw datasets always contain the original ungrouped data.

To export the raw data for a configured Plot, proceed as follows:

Configure the Plot with a time range of max. 7 days, 10 machines and 10 signals.
Click Apply.
Click the Export icon.
Select Request raw dataset option.
Figure 4: Request Raw Dataset
Select the desired option for the time stamp settings.
Click SEND REQUEST.
Figure 5: Request Raw Dataset - Send Request

A confirmation that the request has been processed will be displayed.
Figure 6: Request Raw Dataset - Confirmation
Check the inbox of your user email address.
Once the export has finished, an email with the download link for the .csv file is received.
Figure 7: Request Raw Dataset - Email
Download the provided *.csv file.

The raw data within the *.csv file can be used for further processing and analysis.

Visualization grouping does not affect CSV or XLSX raw data exports. Exported raw datasets always contain the original ungrouped data.

Accessing Reports Through Widgets¶

Widgets that display Time Series Data have a graph icon in the upper right-hand corner. Click on the icon to open the Report Parameters for the signals displayed in the widget.

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

This procedure allows you to reopen a preconfigured report at a later point of time. ↩

Maps Report¶

The Maps 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.

Note

The Map report can only display data for a maximum time range of 7 days. Limiting the time range can also improve map performance and resolution of the tracks.

To use this feature, the Location:Location history Permission Set is required.

To configure a Map report, proceed as follows:

Select Reports from the left-hand menu to expand the DataPortal reporting menu.
Go to Reporting Tools > Maps.
Set up the general parameters and the Map specific parameters (described in the section below) to configure your Map.

Example

The example shows a single machine track covered for the last 24 hours.

Note

The number of allowed waypoints may be limited on the map. A higher resolution view of the path is possible by limiting the displayed time range.

Map Specific Parameters¶

Configuration Section	Description
Signal Selection	Show track: To display a track with metric for a given time range and machine, this option must be enabled. Add signal to track: Select the signal which needs to be displayed along the track.
Visualization Options	Definition of Minimum and Maximum value: This is the option to define the minimum and maximum value of the selected signal which needs to be displayed with a color gradient. It is recommended to leave the Minimum and Maximum at Automatic mode. If required, it is also possible to manually define own thresholds. Values which are outside the min/max range will be marked in grey then

Map Visualization	Description
Track option	Adapt the displayed tracks on the map: - All Tracks: Show tracks on the map for all machines. You may toggle the track for single machines. - 20 sec: Enable real-time monitoring by clicking this button and the position of each machine is updated every 20 seconds. Clicking again disables real-time monitoring. Note that you must activate the realtime mode toggle in Behavior Options beforehand.
Legend	Display the legend for a signal.
Export Menu	Provides multiple options to share, save, or export the displayed data: - Share: Page URL is copied to your clipboard. - Download Map: Save the current map view as an image (PNG, JPG, PDF). - Export data: Export both the reported GNSS (track) data and the signal data of a machine displayed on the map. Signal data (CSV, XLSX): Contain raw signal values per timestamp. GNSS (track) data (KML, GPX): Contain the machine’s movement (track) over time; the current machine position is not included.

Add Signal to Track¶

Note

The Add Signal to Track function is only available for a maximum number of 5 data sets.

This feature allows users to display numeric signal values or machine states directly along a machine’s track on the map. This enables the visualization of how a signal changes across different geographic positions, as well as the driving direction of the machine.

Variations of numeric signals are displayed as a continuous gradient, while variations of machine states are shown in discrete colors.

Data points are based on raw signal data and are linked to the closest GNSS position according to their timestamp. For performance and clarity, data points are grouped into invisible clusters — zooming in and out dynamically reveals additional data points and direction arrows along the track.

You can further customize the track appearance using the following Display Options:

View track gradient increasing
View track gradient decreasing
View track only
View points on the track (zoom in to reveal more data points)
View driving direction on the track (zoom in for detailed direction arrows)

When a machine state is displayed along the track, the legend and corresponding color coding are generated automatically.

A mouse-click on a specific data point along the track shows the transmitted GNSS position, the signal value/state and its corresponding time stamp. Note that warnings regarding the status of the location are displayed automatically, see Status and Update.

Tables¶

The Tables report is the simplest visualisation for data sets.

To configure a Tables report, proceed as follows:

Select Reports from the left-hand menu to expand the DataPortal reporting menu.
Go to Reporting Tools > Tables.
Set up the general parameters to configure your Table.

Example

The following example shows the output results of the data sets from different machines of a specific model on a single table.

Scatter/Bubble Plots¶

A Scatter Plot is a two-dimensional plot that uses dots to represent values for two different numeric variables. The position of each dot on the horizontal and vertical axis indicates values for an individual data point. Scatter plots are used to observe relationships between variables.

Scatter Plot¶

The example shows data sets from machines which belong to a demo model. The plot can be used for visual comparison.

#	Signal	Description
1	Time Range	Select the time period for the measurements up to the previous 2 years.
2	Indicator/Color	Choose from bubble, diamond, triangle up, triangle down symbols and the color.
3	Model/Machine	Select the model and machine to display the comparison.
4	Signal/Aggregation	Select the signal to be the displayed and the Time Series Data.
5	Scaling	Scale automatically, manually or use predefined min/max values from PDC.

Bubble Plot¶

The scatter plot can be extended to a bubble plot that is used to look at relationships between three numeric variables instead of two. Each dot in the bubble chart corresponds with a single data point, and the variables’ values for each point are indicated by horizontal position, vertical position, and dot size.

This example shows configuration of a bubble chart:

#	Description
1	Time range selection.
2	Selection of a specific machine(s), machines of a certain model and optional aggregation of entire data set.
3	Color and shape of the marker
4	Signal selection
5	Machine Operating Hours - Full Load. Represented by the location of the dot on the vertical axis.
6	Machine Operating Hours Total. Represented by the location of the dot on the horizontal axis.
7	Machine Fuel Used - Full Load. Represented by the dot size.

Additional Functionality¶

The chart can be downloaded in various image formats or exported to raw data as shown.
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.

Export Center

Export Center Introduction¶

The Export Center provides exports of (raw) data of your machines.

Available exports/reports:

Fleet Data Export

Fleet Data Export¶

The Fleet Data Export provides a raw export of machine data as a ZIP file for a maximum of 20 machines for a selected time range.

The export can be used by Machine Owners to download the complete raw data logged within the selected time range of their machines.

The menu is to be found at Reports > Export Center > Fleet Data Export.

Select Machines¶

You may select up to a maximum of 20 machines.

You can filter and search machines using the available selection options.

For details on machine selection, filtering, and selector behavior, see Machine Selector.

For the selected machines, you can then proceed to Request Data for their export.

Request Data¶

To request the export(s), select the desired year and month and select Request data. The start of the export will be indicated in a pop-up:

Each request/export is then added to the Recently requested section where you can directly download it as a ZIP file.

In the Recently Requested section, you can view the status of the export:

successful: ZIP file is downloadable.
pending: the pending icon shows the files are being generated.
failed: the X icon shows the export has failed.

The exports expire after 7 days.

Note

A maximum of 7 exports can be requested and maintained in the DataPortal. If additional reports are needed, it is always possible to delete the available ones in the Recently Requested section so the export possibility will be enabled again.

The links to the exports are also provided in an email sent to the user.

Exported Data¶

In the exported ZIP file, each machine is included in a dedicated .csv file. The Machines included in export section shows you which machines are considered for the export.

Each CSV file includes data in the following columns:

machine_id
machine_name
machine_serial
date_time Optional: To change the default timestamp to a Custom date formatting, remove the Display dates in CSV as timestamp option and select:
- Excel dates (my timezone) - change to your time zone
- Excel dates (select timezone) - change to another time zone by selecting the country/city
signal_key - standard and custom signals, for example "value.common.cu.sim.traffic.month" or "value.custom.machine.battery.stateofcharge"
value

Note

Note that the export is targeted to be machine-readable and might not be easily used in common programs like Excel as the files might become very big in size.

Settings

Administration

Organization Structure

Business Units Concept¶

Business Units (BU) are one of the Core Organizational Concepts built on top of the Organization Structure.

Business Units group all organization units of the same type within the organization structure. The root is a special organization unit to identify the start of a BU, reflecting all the organization units that belong to it.

Each BU has one root organization and may include several sub-organizations. When creating a sub-organization, the organization type is automatically inherited from its parent. As a result, sub-organizations share the same type and belong to the same BU. A BU continues until another organization becomes a BU root.

The next root organization reflects a different BU with its own sub-organizations. A sketch of BU's can look as follows:

OEM 1 (BU root/tenant)           > Dealer A (BU root)
          |  |-> Dealer B (sub-org) > Machine Owner a (BU root)
          |  |-> Dealer C (sub-org) > Machine Owner b (BU root)
          |  |-> Dealer D (sub-org) > Machine Owner c (BU root)
          |  |        |-> Machine Owner d (sub-org)
          |  |        |-> Machine Owner e (sub-org)
          |  |-> Dealer E (sub-org) > Machine Owner f (BU root)
          |
          |-> OEM 2 (sub-org) > Dealer F (BU root)   > Machine Owner g (BU root)
          |
          |-> OEM 3 (sub-org)    > Machine Owner h (BU root)
                        |-> Machine Owner i (sub-org)
                        |-> Machine Owner j (sub-org)

BUs and Tenant

When a new OEM is created (e.g., by a Distributor) and this is the first OEM organization unit, it is automatically created as a tenant and becomes the BU root of a new BU.

Requirement: Ensure the first OEM organization is the first organization in the tree that is of type OEM.

Terminology¶

Term	Definition
Business Unit (BU)	A collection of organization units of the same type within the organization structure.
BU Root	An organization that has no parent or whose parent has a different organization type. It defines the start of a BU.
BU Sub-Organization	An organization within the organization tree of a BU root that has the same type as the BU root.
Organization Type	The classification of an organization (e.g., OEM, Dealer, Machine Owner).
Convert to `<organization type>`	The action of changing an organization's type. This may change the BU assignment of the organization and its child organizations.

Advantages¶

BU's give OEMs an overview of the Dealers and Machine Owners/machines belonging together.

This concept also enables users to view and maintain features only for their organization or below. It also enables sharing data with organizations belonging to the same Business Unit, but not outside the Business Unit, for example: dealership locations, assignments, geoareas, geofence alerts.

BU's allow OEMs to directly connect with Dealers or Machine Owners.
Dealers can only connect with Machine Owners.
All users are provided access of the organization assets depending on the organization root and its sub-organizations the users belong to within the Business Unit.

Requirements and Validation¶

The BU concept is active by default when creating a new account, e.g. when a Distributor creates an account for an OEM.

It requires an accurate grouping and nesting of organizations (even before and during the migration process):

Validate the children organizations of the same type.
Make sure that organizations which should not share resources are separated. Especially, take care of Dealers that are nested under other Dealers.
Review the users associated with each organization.

Organization Type Changes¶

You can change an organization's type within the DataPortal using the option Convert to <organization type>.
If a type change is not permitted by the system, the option will not be available.

To change the organization type, proceed as follows:

Navigate to Settings > Organization Structure
Search for the organization in the organization tree.
Open the organization menu via the three dots and select Convert to <organization type>.
Figure 1: Change Organization Type
Review the confirmation dialog carefully. Click Convert to confirm the organization type change.
Figure 2: Confirm Organization Type Change

How an organization change affects your organization¶

When you change an organization type, the system automatically recalculates the BU structure.

Although many structural constellations are possible, the type change results in one of the following structural effects, depending on the organization’s position in the structure:

The organization becomes a new BU root

If the new type differs from the parent's type:

The organization leaves its current BU.
It becomes a new BU root and forms its own BU.
Its sub-organizations remain assigned to it.

The organization joins the parent's BU

If the new type matches the parent organization’s type:

The organization joins the parent's BU.
It is no longer a BU root.
Depending on their type, its direct sub-organizations might become new BU roots.

The BU structure remains unchanged

If the organization is already a BU root and the organization change does not require it to join or leave a BU:

The organization type is updated.
The BU assignment remains the same.
The overall hierarchy structure stays unchanged.

Note

Review the organization structure before making changes. Changing an organization type can affect data visibility and access to shared resources within the BU.

Organization Structure Overview¶

An Organization Structure organizes every Proemion customer, dealer, and machine owner into a single, company-wide organization tree. It mirrors your real-world business relationships and controls which machines, users, and configurations are visible to whom. For example, a Dealer can manage their own Machine Owners without seeing other Dealers' customers. See Core Organizational Concepts for how the organization tree, organization type, tenant, and business unit concepts relate to each other.

To open the Organization Structure page, go to Settings > Administration > Organization Structure.

This page consists of:

Organization tree on the left (selection drives the content)
Top menu bar with different tabs (Machines, Models, Details, Users, etc.)
Optional controls like Show all sub-organizations and Export

For creating, editing, removing, or moving organization units and for required Permission Sets, refer to Organization Unit Management.

Overview page elements¶

UI element	Description
Organization tree	Hierarchical navigation (org tree). Selecting an organization updates all tabs.
Three-dots icon	Context actions for the selected org unit (create/edit/remove etc.).
COLLAPSE / SHOW ALL LEVELS button	Collapses or expands the tree.
Show all sub-organizations	Includes sub-org content in tables where supported.
Search	Search by IDs and entries (users, machines, OUs). See Search.
Export	Exports the current table (where available). See Export.

The Top Menu Bar works in conjunction with the organization tree and updates its content based on the selected organization unit. The table below lists all available tabs. Each tab links to the documentation describing its purpose and functionality.

Tab	What it shows
Machines	Machines in the selected org (ID, VIN, PIN, Serial, Model).
Models	Models available for the selected organization.
Users	Users assigned to the selected organization.
Sub-Organizations	Organization units controlled by the selected organization.
Details	Organization metadata, tenant and domain configuration, statistics, contacts.
Firmware	Firmware management and assignments.
MFA Configurations	MFA requirement overview (only if MFA is enabled for the org).
Data Analytics	Data analytics instances.
Features	Feature/language switch management (if implemented for the org).
API Clients	Create/manage API clients for REST API and AEMP API.
PDCs	PDC management. See PDC Management.
Communication Units	CU details and status.

Details tab¶

The Details tab displays further information about the selected organization: organization and tenant metadata, domain configuration, statistics, and contact information.

Section	Field	Description
Organization details	Name	Display name of the organization
	OEM name*	Associated OEM identifier
	Business unit type	Organization type (e.g. OEM)
	OEM external key	External system reference ID
Tenant details	Tenants (OEM root)	Root tenant owning the organization
	OEM external key	Tenant-specific external identifier
Domain config	Customer domains	Allowed email domains for users
	User locking	Enables or disables user lock enforcement
	Manual SSO user creation	Allows manual creation of SSO users
	Native user creation	Allows non-SSO (local) users
	MFA configurations	Multi-factor authentication status
Statistics	Number of users	Total users assigned
	Number of machines	Total machines assigned
Contact details	Customer no	Internal or external customer reference
	Contact mail address	Primary contact email
	Sender mail address	Email used for outgoing system notifications

Note

^* The OEM name is defined for tenant organizations and is used as the default name for machines when provisioning or activating machines, if no model-specific name is defined.

Requirements

OEM name is supported only for tenant organizations, not for child organization units.
Changes to the OEM name are performed via the REST API by Proemion.
Users with Organization:Maintain Permission Set can view the OEM name.

Export CSV/XLSX¶

Administrators can export tables to .xlsx or .csv (export icon on the right side of the page).

Requirements¶

Export icon is available on tables that support export.
Export reflects:
applied table filters
Show all sub-organizations selection
Required Permission Sets:
Machines:Admin, Models:Admin and Organization:Admin

Export Tables¶

Open Settings > Administration > Organization Structure
Open the desired tab/table (e.g. Machines, Models, Users, Sub-Organizations, etc.)
Click the export icon and select format

Supported exports (depending on configuration): - Machines - Models - Communication Units - Users - Sub-Organizations - PDCs - API Clients - Transfers - Machine Share Definitions

Organization Unit Management¶

Organization Units (OU/org units 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 org units separately. Users can only see DataPortal objects in their own organization unit and the sub-organizations (subsidiaries).

Permissions¶

Different actions on organization units, such as viewing, adding, or moving them, require different Permission Sets, from Organization:View to Organization:Admin. The exact capabilities are listed under Permission Set.

Management Permission by Organization Type¶

For a detailed overview of the user capabilities for creating Business Units/sub-organizations from each level, see section the table below.

Organization Type	Permissions
OEMs	- Create new Dealer and Machine Owner Business Unit with each Dealer/Machine Owner root.
	- Create, edit or delete all (sub-)organizations within the Business Units.
Dealers	- Create new Machine Owner Business Unit with Machine Owner root.
	- Create, edit or delete sub-organizations of organization type Dealer or Machine Owner within an existing Business Units. The Organization:Maintain permissions is needed.
Machine Owners	- Create, edit or delete sub-organizations of organization type Machine Owner.

Organization Type¶

Organization units are assigned to organization types based on the tasks performed. The organization type serves three purposes: it gives users a visual label to identify what kind of organization they are looking at, it controls which user segments can access specific PDC signals, and it determines which Organization Dashboard and Machine Page layouts are shown to a user.

The organization types have the following hierarchical order:

Distributor
OEM (manufacturer)
Dealer
Machine Owner
None, a legacy type from migration that should not be assigned to new organizations.

A child organization's type can never be higher in this hierarchy than its parent's, though levels may be skipped, e.g. a Distributor may have a Machine Owner sub-organization directly.

With the Feature Switch "Machine Pages by Organization Type" it is mandatory to assign the organization type to all organization units. A warning will be displayed next to the organization when it has no organization type (None). You can then click the link Show all organizations with the type "None" that will expand the organization tree to the relevant organization units:

Note

If the parent organization unit has no organization type defined, only then "None" can be assigned; the warning will be displayed nevertheless. Otherwise, it is mandatory to select the organization type.

System Organizations¶

Proemion automatically creates special organizations for technical purposes based on shipment information. These organizations are system-managed and act as technical inboxes for shipped CUs before they are assigned to a machine and activated.

System-managed organizations are identified by the prefix [System] in the organization name.
They are required for correct shipment mapping and activation logic and are not intended to be deleted by users but can be renamed.

For further information refer to installed and pending CU's.

Create Business Units and Sub-Organizations¶

The creation of Business Units and sub-organizations is done in the menu Settings > Administration > Organization Structure. They can be created either directly in the Organization Tree, see Organization Structure Overview, or in the SUB-ORGANIZATIONs tab.

Proceed as follows to create a Business Unit (root) or sub-organization.

In the Organization Tree or in SUB-ORGANIZATIONS where the new Business Unit or sub-organization needs to be added, click the three-dots icon .
Select the New sub-organization or select New Dealer/New Machine Owner to create a new Business Units with the root organization.

Figure 1: New Business Unit root/Sub-Organizations

Add the name of the Business Unit root/sub-organization and optionally add an OEM external key.
Submit to save the changes.

Business Unit of type OEM can be created at the top of the Organization tree by the OEM. Below, an arbitrary number of Dealer- and Machine Owner Business Units as needed with each including one Business Unit root and an arbitrary number of sub-organizations for each Business Unit. Consider that the following relation is also possible: 1 OEM (root) > 1 Dealer (root) > 1 Machine Owner (root).

Sub-organizations are created related to their parent organization, i.e. are of the same type as their parent organization.

Note

Selecting an organization in the Organization Tree changes the structure under SUB-ORGANIZATION!

Edit Organization Unit¶

To change the details for an organization unit:

Open Settings > Administration > Organization Structure.
Select the (sub-)organization unit that you want to change.
Click on the 3-dots icon .
Click on Edit to edit the properties of this organization.
Optionally change the Name for the sub-organization.
Figure 2: Edit Sub-Organization Details
Click the SUBMIT button to save your changes.

Remove Organization Unit¶

Note

DELETE (Remove) only works when there are no entities assigned to this organization anymore. Otherwise, this message will appear: The organization is still in use by having PDCs, users, devices, machines, models, assignments or sub-organizations associated with it.

To remove an organization unit:

Open Settings > Administration > Organization Structure.
Select the organization unit that you want to remove.

Click on the three-dots icon .
Click on Remove to remove this organization. ✓ The Delete organization dialog opens.
Read the summary. For example: Are you sure you want to delete the organization "Machine Owner E Organization"?
Click on Delete to remove the organization.

✓ The success message Organization deleted successfully appears in the upper right corner.

OEM external key¶

The external key can be used to assign machines or users to the organization based on it.

The OEM external key can be added and edited to new and existing (sub-)organizations by the admin of the parent organization. The parent organization must be of type "OEM".

Feature Switch¶

You can enable (or activate) configured features and languages for your organization from the DataPortal Administration menu.

Note

The Feature Switches functionality (including the configured features) is not available out-of-the-box and must be implemented for each organization specifically.

Feature Management¶

To open the Features management panel for an organization:

Select Settings > Administration > Organization Structure from the expansion menu to open the Admin page.
Select the organization where you want to set feature access for.
Select Features from the Administration Menu from the Top Menu Bar.
After configuring the features, click Apply.

Item	Description
Languages*	Lists the languages available to your organizations in the DataPortal, see Available Languages.
Sections	Displays the features available to your organization, see Available Features.
Data Science	Data operations features that analyze a condition (e.g. counter units, fuel level) and trigger events based on data operations, see Available Features.
For each language or feature, you can configure the State:
State	On: All users in the organization and sub-organizations have access to the feature. Lab Mode: Only users with Lab Mode enabled from user preferences can access the feature/language. Off: Access to these features is disabled and the page/language option does not appear in the DataPortal.

Note

^* Enabling a language requires that the translations are available in the PDC and DataPortal.

Available Languages¶

Enable or disable configured languages for the DataPortal (English cannot be disabled)
The users can then change the language on the Login Page or Personal User Settings.

You can choose from the following languages:

English
German
Chinese^*
Czech^*
Danish^*
Dutch^*
French
Italian
Japanese^*
Korean^*
Spanish
Swedish^*

Note

^*Those languages cannot be added by default, but must be requested first to be enabled by Proemion.
It should be noted that implementing those and other new languages requires additional Proemion resources including project setup, manual configuration, recurring services which may result in additional costs.
Contact your Sales representative at Proemion.

Available Features¶

The table below provides a link and description to the documentation of features that are available via the Feature Switch functionality.
Enable or disable the configured features for the DataPortal.

Note

If you want to make use of a feature that is listed here but not in the feature switch section of your account, Proemion may need to activate it first for your organization
Create a ticket at the Service and Support or contact your Proemion representative.

Feature	Description
Events	Visualizes events details (such as timestamp, machine, etc.) captured by the data platform.
Maintenance Issues	For maintaining machine service tasks based on unscheduled maintenance issues inbetween service cycles.
Scheduled Maintenances	For maintaining machine service tasks based on service cycles.
Machine Lifecycle	Allows you to provision and activate the machine.
Time Fence/Timetable	Allows you to define a schedule for when a machine is permitted to be in use.
Firmware Management	Enables monitoring and updating of the installed firmware versions on the available communication units.
Configuration Management	Enables monitoring and updating of the installed configuration versions on the available communication units.
Weather	Visualizes the weather forecast details as a map overlay or in tabular format for the current location of a machine.
Named Dashboards	Create multiple dashboards for different user groups or different time periods (e.g. last 7 days or last 30 days).
Share Machine	Allows you to open access to your machines to DataPortal users outside your organization.
Model-Based Signals Visibility	Enable Model-Based Signals visibility in the DataPortal and as a base for the DataScience feature. See DataScience Manual → "Model-Based Signals".
Contract End Digest	Display the toggle in the Notifications menu for enabling contract end notifications.
OEM Name	Allows you to enable OEM name (display machine data, machines filter) globally for machines in your fleet.
Documentation Links	Allows to configure links to external documents and resources for each model. The defined links are shown on the Machine Master Data widget on the machine detail page. Please be aware that existing links at the Machine Master Data will be overwritten by model based document links.
Org type machine dashboards	Configure layouts for dashboard and specify their visibility according to the organization type.
Manageable Named Geo Areas	Create geo areas for custom DataPortal features.
OEM Insights	Analyze aggregated data of your users and machines in different charts.
Data Analytics Instances	Get insights on the data collected from the machines. See DataScience Manual → "Data Analytics".
Fuel Guard	Detect refill and loss events for fuel signal data. See DataScience Manual → "Fuel Guard".
Counter Guard	Detect inconsistencies (as events) in counter signal data. Relevant for the features listed in DataScience Manual → "Counter Guard".
Historical Weather Data	Import historical weather data according to the machine geolocation. See DataScience Manual → "Historical weather data".

Warning

As of June 1st, 2025, the Historical Weather Data feature has been temporarily deprecated. If you're interested in accessing this feature, please contact our Sales Team to explore options.

Lab Mode Activation¶

Beta (or trial) access to new DataPortal features for users in an organization is activated via Lab Mode. However, users must separately enable the lab mode in their personal settings to use the activated feature/language, see Lab Mode.

To enable a feature for the organization, toggle the status for a feature to Lab as shown:

OEM Name Feature¶

When the OEM Name feature is enabled, machines can be filtered by OEM name in supported features and widgets.

Enabling this feature allows filtering machines by OEM name in the following areas:

Feature/Menu Item	Module/ Column	Filter? Y/N	Navigation
Machines Management		Y	Settings > Administration > Organization Structure > Machines tab
Models Management		N	Settings > Administration > Organization Structure > Models tab > New machine model dialog > Machines > Select machine
Machine List	-	Y	Machines > Machine list widget
Maintenance	-	Y	Maintenance > Filter > Machine
Events	-	Y	Events > Filter > Machine
Assignments	-	Y	Assignments > Filter > Machine
	-	Y	Assignments > Create new assignment > Machines
Reports	Maps	Y	Reports > Maps > Configure maps > Select machine
	Plots	Y	Reports > Plots > Configure plots > Select machine
	Scatter Plots	Y	Reports > Scatter Plot > Configure scatter plot > Select machine
	Tables	Y	Reports > Table > Configure tables > Select machine
	GeoLeash	N	Reports > Filter GeoLeash Events > Select machine
	Machine Efficiency	N	Reports > Efficiency Snapshot > Select machines
		N	Reports > Efficiency History > Select machines
	Assignments	N	Reports > Assignments > Assignment Report > Configure report

Model-Based Signals¶

Model-Based Signals comprise a fixed catalog of signals that require no configuration and enable comparison operations via widgets and reports.

Standard operations based on a model are described in Models Management.

You can also edit models' visibility for users in different organization.

Model-Based Signals are also used for the DataScience feature
Read about the feature and its use case in DataScience Manual → "Model-Based Signals".

Model-Based Signals Catalog¶

The signals defined by the OEM for a model are managed via the PDC Manual the same as machine signals.
Contact your Proemion representative for more information.

Model-Based Signals Visibility¶

Model-Based Signals Visibility allows you to mark a model to be visible for users in the DataPortal whether they are in the organization that owns or can view the model by default (e.g. org units that have a machine of this model).

Administrators can perform the following functions to Configure Model-Based Signals for a model for users in different organization.:

Configure models visibility
Standard operations based on a model are described in .
Configure visibility for sub-organizations for users who do not have access to a machine of a particular model.
Set the model management (create, modify and admin overview) flag for visibility.

Enable Model-Based Signals¶

To enable visibility for MBS independent of a machine, proceed as follows:

Open Settings > Administration > Organization Structure.
Select Features (switch) from the Top Menu Bar.
Under Sections, toggle the state of Model Visibility to On.

Configure Model-Based Signals for a model¶

To edit the visibility of Model-Based Signals, proceed as follows:

Open Settings > Administration > Organization Structure.
Select Models from the Top Menu Bar.
Select the Edit link to the right of a model that you want to edit.
This opens the Edit Models dialog. Here you can select from 2 visibility options:
- Regular: All organizations with machines of this model can use it across widgets and reports.
- Distributed: Organizations that do not have machines of this model can use widgets with Model-Based Signals metrics of this model.

You can filter visibility for Model-Based Signals by selecting the Visibility from the Models tab in Administration as shown.

Figure 4: Filter Model-Based Signals Visibility

Communication Units¶

The Communication Unit (CU) is the telematics device installed on a machine.

Note

A CU cannot connect to the DataPlatform if it is not assigned to a machine.

Communication Unit Details¶

To open the Communication Units tab, go to Settings > Administration > Organization and select Communication Units from the Top Menu Bar.

Alternatively, open the Communication Units page via the icon on the Machine Page.

On the Communication Units page, users can find detailed information about all CUs assigned to their organization and manage them. For example, users can:

See an overview of all devices including basic information such as CU ID, serial number, last login and logout on the physical device etc.
Access detailed information for each CU via the Details option, see table below.

To view detailed information of a CU, open the three dots menu at the end of the row and choose Details.

#	Item	Description
1	View session history	Button to open detailed session information. See Session History.
2	View firmware and configuration updates	Button linking to Firmware and Configuration Updates.
3	View software history	Button linking to Software History.
4	Properties	Display of CU master data: Name, IMEI, Serial Number, Hardware / Data Source, Product Code.
5	Session History (Summary)	Display of last Login and last Logout timestamps.
6	Usage	CU operating hours, contract information, and connection permission status.
7	Mobility Data	Information about the eSIM (ICCID), mobile network provider, and traffic.
8	PDC	Information about the assigned PDC file (UUID, Name, Version).

Installed and Pending Communication Units¶

The Communication Units tab contains the following two sub-tabs, to clearly separate active devices from devices that still require activation:

Installed: Displays all Communication Units that have already been activated and are live. These CUs are fully provisioned, assigned to a machine, and actively transmitting data. This tab is selected by default.
Pending Installation: Displays Communication Units that have already been shipped to the customer but are not yet activated. These devices are visible to support a transparent activation process and are ordered by shipment date (oldest first) to help users prioritize the activation of older devices.

For Communication Units listed under Pending Installation, an Install button is available once at the top of the table and at the end of the row of a machine to start the activation process. When selected, the Install dialog with the activation workflow opens with the CU pre-selected and key device information such as the serial number and IMEI number automatically filled in.

This allows users to quickly assign the device to a machine and complete the activation with minimal manual input. Once a Communication Unit has been assigned to a machine and successfully activated, it automatically moves from the Pending Installation sub-tab to the Installed sub-tab.

Communication Units listed under Pending Installation may belong to organizations that were automatically created by Proemion based on shipment information.

For further information refer to system organizations.

Session History¶

The Session History allows to gain additional information about the operating mode, wakeup reason, duration and signal strength of each session within a given time range.

#	Item	Description
1	Time range	Drop down menu to define the time range for the session history
2	Mode	Display of the operating mode (Online, Logging, Realtime or Unknown). "Online" is available for the CANlink® mobile devices. For more information, read CANlink mobile 3600 Online feature.
3	Wake-up reason	Details about the wake-up reason of the device for example due to ignition, power on, CAN activity, real-time clock–based wake-ups (interval or alarm) and accelerometer events. Not all wake-up reasons are applicable to all device types.
4	Login	Date and time of session start.
5	Logout	Date and time of session stop.
6	Signal strength	Mobile network signal quality at session start. Values are shown in decibel unit (`dB`). For more information, see Signal Strength.
7	Export	Table Options.

Signal Strength¶

For an evaluation of the mobile signal quality, the values need to be converted to RSSI values with the formula:

RSSI = 2*x - 113 dBm (Formula for CANlink mobile 3600)

where x is the value from the CANlink mobile (Index 0x5251 Sub 0x00 in the CANlink mobile 36xx).

The following table shows the mapping of RSSI to db:

Note

31 in all cases means "maximum". The smaller the dBM the better the signal strength is.

dB	RSSI (RSSI = 2*x - 113 dBm)
0	-113dBm or less
1	-111dBm
2...30	-109dBm... -53dBm
31	-51dBm or greater
99	Not known or not detectable
100	-116dBm or less
101	-115dBm
102...190	-114dBm...-26dBm
191	-25dBm or greater
199	Not known or not detectable
100~199	Extended to be used in TD-SCDMA indicating received signal code power (RSCP)

The next table describes the meaning of the signal values (source of the table: RSSI Teltonika)

Note

The RSSI on its own is useful when comparing different antennas on your device, or for example to check whether directional antennas have a good orientation. But there might be a strong signal but with a lot of (other) traffic that will lead to poor reception. Thereby, it needs to be considered that there is no linear mapping like "RSSI value > x = good reception". But the following table gives a good indication.

RSSI	Signal strength	Description
> -65 dBm	Excellent	Strong signal with maximum data speeds
-65 dBm to -75 dBm	Good	Strong signal with good data speeds
-75 dBm to -85 dBm	Fair	Fair but useful, fast and reliable data speeds may be attained, but marginal data with drop-outs is possible
-85 dBm to -95 dBm	Poor	Performance will drop drastically
< = -95 dBm	No signal	Disconnection

API Client Management¶

API Clients can be used for connecting DataPlatform to other systems or 3rd parties via REST API and AEMP API.

Info

API Clients are intended for machine-to-machine integrations without an individual end user, such as scripts or ERP integrations. If you need to give your own application user-level access on behalf of a signed-in DataPortal user, read DataPlatform as Identity Provider instead.

Organization Admins with Organization:Admin Permission Set can create and delete clients while users with Organization:Maintain Permission Set can view client information (i.e. URL and available Permission Sets).

In the DataPortal navigate to Administration > Organization Structure and open the API Clients tab.

#	Item	Description
1	New API Client	Open the create new client dialog.
2	Show All sub-organizations	Show or hide Clients for the sub-organizations.
3	Status	Shows the access status of the API Client.
4	ID	Automatically generated client ID.
5	Name	Name provided by the client admin.
6	Organization	The DataPortal organization the client can access.
7	URL	URL of the client.
8	Details	View or edit client details. Configure the access, see Ban API Clients.

To view information about an existing client select Details to the right of an item in the list. Here you can also edit the permission set.

Note

Users with the Organization:Maintain Permission Set cannot edit clients.

Managing API Clients¶

This section covers how to create a new API Client and suspend or restore its access.

Create a New Client¶

To create a new API client:

Select Settings > Administration > Organization Structure from the left-hand menu to open the Administration Dashboard.
Select the organization unit from the org tree on the right side where you want to create a new API client.
Select the API Clients tab.
- Optionally toggle the Show all sub-organizations to display all API clients.
Select the New API Client button .
In the panel that opens enter a name and select the permissions for the client.
Figure 3: New Client Configuration
Select Submit to view and Copy the Client Secret Now.

Danger

Store your client secret in a safe location.
Confirm the creation of the new API Client.

Figure 4: Client Configuration Confirmation

The new API client is now visible in the list of clients for this organization.

Ban API Clients¶

You may ban API Clients in order to disable them to obtain an authentication token or request other endpoints with previously obtained (not yet expired) token.
To ban API Clients, i.e. suspend the access, the Organization:Admin Permission Set is required.

In the API Client Management administration table, the Status column shows the current access status of the client.
To change the status, at the end of the table row of each API Client, select the 3-dots icon > Suspend access.

Select Allow access to revoke the ban.

EU Data Act¶

In order to share data with 3rd parties according to EU Data Act, use the Operational:View Permission Set which can only be assigned to REST API Clients. This Permission Set grants the necessary read-only access to Product Data and selected Related Service Data, without granting administrative or configuration privileges.

For further information on EU Data Act, please contact Service and Support or contact your Proemion representative.

Access AEMP Service¶

The following chapter targets OEMs and describes which requirements to fulfill in order for consumers, e.g. Machine Owners' third party fleet management systems, to retrieve data via the Proemion ISO 15143-3 (AEMP) API with their account and machines
For more information on the API, read AEMP API.

The machine data that should be retrieved via the ISO 15143-3 API are defined in the PDC using standard metric keys
Refer to AEMP API and Proemion Standard Metrics
Machine data include any history of a machine.

Make sure to meet the following criteria to make machine data accessible via the AEMP API:

The machines must be identifiable using the following identifiers (read also about the identifiers in the section General properties > Identifiers / Request parameters in the AEMP API):
- VIN or PIN identifiers: recommended for consumers to use as the parameters for VIN or PIN are not likely to change over the machine's lifetime.
- MakeModelSerial identifier (combination of the parameters for OEM name (Make), Model and Serial number): optional to use; both the OEM name and Model are more likely to change than PIN/VIN
  In case of a change of a parameter, in the AEMP API the machine must be accessed by a new identifier
  Moreover, the OEM name is to be set for each machine individually.

Note

Both identifiers are configured by the OEM. It is highly recommended for the OEM to maintain all the parameters for these identifiers to ensure compatibility with any request type a consumer may use.

In order to access the AEMP interface, the AEMP - View permission set must be assigned to the requesting Rest Client, see AEMP Subject.
The AEMP API should be accessed with a REST client only.

Data Analytics¶

Data Analytics are an additional option to assist in various kinds of data exploration.

For further information on Data Analytics refer to the DataScience Manual → "Data Analytics".

Note

The Data Analytics tab is not enabled by default and require specific setup and configuration for your organization. For instruction on how to enable it for your account, please contact your Proemion representative.

Note

Only users with at least Organization:Maintain Permission Set have access to the DataPortal Analytics tab.

Note

Please make sure that the correct organization unit within the organization tree is selected to display the available Data Analytics.

Item	Description
Name	The specific name of the available data analytics instance.
Status	Current status is displayed. (STOPPING, PENDING, IN SERVICE)
Start	Button to start the predefined data analytics instance.
Open	Button to open the latest instance of the data analytics instance.
Stop	Button to stop the latest instance of the data analytics instance.

Start Data Analytics Instance¶

As the instances run on flexible computing resources, the instance needs to be built everytime it shall be used.

To build an instance, hit the Start button.
After a start it takes approx. 10 minutes until the instance is built and available for the requester.
After this time the instances is IN_SERVICE service state and can be accessed via the Open button.

Note

After > 1 hour not being used, the data analytics instances are shut down automatically and need to be restarted in case of further use.

MFA Configurations¶

Note

The MFA Configurations tab is only available if Multi-Factor Authentication is enabled for your organization.

The MFA Configurations tab is used to display information about Multi-Factor Authentication (MFA) requirements for users. It shows a table with the Permission Sets and their corresponding levels for which users are required to set up and use MFA.

Machines Management¶

The Machines tab is selected by default when opening Settings > Administration > Organization Structure
The following details are displayed:

Machines List: Displays a list of machines in the selected (sub-)organization; you can select a machine to move or share it.

Note

Consider that machines may be assigned to different org units, see Organization Unit Management.
GO TO MACHINE: Redirects you to the Machine Page
The GO TO MACHINE link is to be found at the end of the line of each machine.
EDIT: Opens the Manage Machine dialog to change Properties like Machine Name, VIN, etc. or use the Advanced functions, e.g. Device Mode, Time Fence and other Actions.
The EDIT link is to be found at the end of the line of each machine.
Machine Properties can be also accessed via Machine Page.

Figure 1: Go to Machine and Edit links

Move a Machine¶

Note

The Organization:Maintain permission set is required to move a machine from one organization unit to another.

Select the check box(es) of the machine(s) you want to move to open the To Move/To Share dialog.
Select an organization that you want to move the machine(s) to from the list of organization units.
Click the Move Machines button at the bottom of the dialog to move the machine(s) to the organization unit.

Once you successfully move a machine to another organization, it appears in the list of machines of the organization you have moved it to.

Provisioning¶

Provisioning allows you to make a machine with a telematics unit installed available on the DataPortal. The machine will be visible and during the process you can assign a model and change the machine name, serial number and PIN/VIN.

The Machine:Admin permission set is required for the tasks that need to be performed for this feature.

Note

The status of the new machine can be verified within Settings > Administration > Contract.

If you want to reactivate a machine with terminated contract that is still visible to your organization, follow the steps described in chapter Reactivation.
If you want to renew the contract of the machine, follow the steps described in chapter Contract Renewal.
If it is no longer visible for your organization, you have to complete the Provisioning and Go Live like for new machines.

Data retention and GDPR

The machine is automatically removed from the DataPlatform three month after contract termination. All historical machine and communication unit (CU) data are permanently deleted and cannot be recovered.

Provision Machine Dialog¶

To open the provisioning dialog, go to Settings > Administration > Organization Structure and open one of the following tabs from the Top Menu Bar:

Machines tab:
1. Click the Provision Machine button .
Communication Units tab:
1. Click Pending Installation.
2. Click the Install button . Machines that can be provisioned are displayed in the table.

The provisioning dialog opens.

Enter the following data within the provisioning dialog:
Figure 3: Provision Machine dialog
- OEM Name (see also OEM Name)
- IMEI¹ (of the communication unit to be provisioned)
- Serial Number¹ (of the communication unit to be provisioned)
- Organization Unit¹ (where the provisioned machine will be assigned)
- Machine Model¹ (only models with assigned PDC can be selected here; if the model has no PDC assigned, it is greyed out, see following image)
- Serial Number¹ (of the machine)
- Machine Name¹
- PIN
- VIN
- Your internal reference no.² (purchase order number for later reference)
- Configuration ² (if there is a configuration bundle available for the selected CU, the user can enable the automatic configuration update after the activation)
Click on Close to exit the provisioning dialog when the message ✓ PROVISION MACHINE SUCCESSFUL appeared.
Figure 4: Provision Machine Successful

Tip

To perform Go Live immediately after provisioning, click the checkbox and select the required hosting plan.

A successfully provisioned machine is visible on the DataPortal within Settings > Administration > Contract and has the state Provisioned
In the Provisioned state, the communication unit is not permitted to connect to the DataPortal and to transfer data until it is Live:

Go Live¶

Go Live is the activation of Communication Units (CU) after Provisioning. Once the CU has been activated, it is authorized to connect to the DataPlatform and transfer data.

During the activation the following processes are performed:

Creating a legal contract between the OEM and Proemion.
Enabling the CU for data transfer.
Activation of the SIM card.

Note

The automatic activation of the integrated SIM card usually takes about 15 minutes. In exceptional cases it can take up to one working day.

If activation is delayed, the following notification is displayed: "Activation is in progress. The machine will go live shortly".

Once these steps have been completed, the CU has the status Live
The hosting contract is enabled and data can be sent to the DataPortal
For information on the availability of the Proemion tariffs for each country, see Hosting Plans across Regions.

The Contract:Maintain permission set is required for the tasks described below that need to be performed for the Go Live feature.

Note

A pre-set internal reference/purchase number can only be changed by users with Contract:Admin permission set.

Activation of provisioned Communication Unit¶

There are three options to perform the activation of a provisioned communication unit:

	Option
1	Go Live immediately after Provisioning
2	Go Live in Contracts Overview
3	Go Live in the Manage Machine Dialog

Go Live immediately after Provisioning¶

When the message PROVISION MACHINE SUCCESSFUL is displayed after Provisioning of a new machine, enable the Go Live check box.
Select the required Hosting Plan.

Note

Note that the list of available hosting plans is based on the CU type to be activated and, therefore, might change depending on the CU type, e.g. CANlink® mobile 3600 or Basic Tracker, etc.

Note

You can view whether the hosting plan supports the (planned) machine location via Supported Countries, i.e. whether the country the machine is or will be located in is covered by the hosting plan.
The supported country can also be checked in the Contracts menu.

Figure 6: Provisioning to Go Live
Ensure that the corresponding Your internal reference number is added (the internal reference number can be assigned during Go Live).
Click on GO LIVE.

Go Live in Contracts Overview¶

Open Administration > Contracts.
Click on the label PROVISIONED at the communication unit which needs to be activated. You may also filter the CU - State column by the label.
Figure 7: Contract Overview
Select the required Hosting Plan from the drop-down list.

Note

Note that the list of available hosting plans is based on the CU type to be activated and, therefore, might change depending on the CU type, e.g. CANlink® mobile 3600 or Basic Tracker, etc.

Figure 8: Contract Overview GoLive Dialog
Ensure that the corresponding Your internal reference number for later reference is entered.
Click on GO LIVE.

Go Live in the Manage Machine Dialog¶

On the Machine Page, select the machine you want to manage and click the Manage Machine vehicle button in the top-right corner.
This opens the Manage Machine window.

Open the Machine advanced functions menu and select Machine go live from the left-hand menu.
Select Machine GoLive.
Select the required Hosting Plan from the drop-down list.

Note

Note that the list of available hosting plans is based on the CU type to be activated and, therefore, might change depending on the CU type, e.g. CANlink® mobile 3600 or Basic Tracker, etc.
Ensure that the corresponding Your internal reference number is added (the internal reference number can be assigned during Go Live).
Click on Go Live.

Reactivation¶

This section refers to the reactivation of a CU with terminated contract. A CU can be reactivated for up to one year after contract termination. Within three months after contract termination, the CU can be reactivated directly using the process described in this chapter. After three month, reactivation is only possible via Provisioning and GoLive.

In case that a machine with terminated contract needs to be reactivated and the machine is still visible to your organization, the following steps must be performed:

Go to Settings > Administration > Organization Structure > COMMUNICATION UNITS tab and search for the machine which needs to be reactivated.
Click on DETAILS of the corresponding communication unit.
Make a note of the: IMEI and Serial Number (of the CU).
Go to Settings > Administration > Organization Structure > MACHINES tab and search for the machine which needs to be reactivated.
Make a note of the Organization Unit, Model, Serial Number (Machine), (Machine) Name, PIN and VIN.
Provision the machine as described in chapter Provisioning.
Activate the communication unit as described in chapter Go Live.

Verify Contract Status¶

The status of the contract can be verified by opening Settings > Administration > Contracts > > Contract details.

The Share Machine functionality allows you to grant access to your machines to DataPortal users outside your organization. You should note that a Share Machines functionality to an organization unit means that the parent organization also has identical access to the machine
Additionally, the receiving organization:

will see their own widget layout for the machine.
can see the owner in the Machine Info on the Machine Page.
can assign (e.g. move the share) the machine to one of their own organization units.
will receive notifications for shared machines.
can not manage the machine because the permission level is automatically set to none.

Note

Share Machine is available in the DataPortal as part of Feature Switches. The Organization:Maintain permission set is required to share a machine from one organization unit to another.

You may also categorize your machine shares, see Machine Share Definitions.

To share a machine:

Select the check box(es) of the machine(s) you want to share to open the To Move/To Share dialog.
Select the To Share tab at the top of the dialog.
Select a Machine Share Definition from the drop-down list underneath the share/move tabs.
Select an organization that you want to share the machines to from the list of organization units.
Click the Share Machines button at the bottom of the dialog to share the machine to the organization you have selected.

Once you have successfully shared a machine to another organization, it appears in your list of machines with the Share icon .

To remove a share:

Go to Settings > Administration > Organization Structure.
In the list of machines, click the Share icon next to a machine and select the Delete Share Machines functionality icon.

Geo Areas¶

Geo Areas are pre-defined areas on the map that can be applied in features which are based on the machine locations, e.g. in the GeoFence feature.

Geo Areas are bound to the business unit of the user creating them.

In the Geo Areas tab, you can individually draw and store these areas. Thereby, you don't need to draw the area manually each time you want to limit the area on the map.

In the according DataPortal feature you can then choose from a list of Geo Areas.

Requirements¶

The required permission set to define, edit, delete or export Geo Areas is GeoAreas:Maintain.
GeoAreas can only be created by Tenants where Business Unit is enabled globally. If you create GeoAreas in a sub-organization, it will be automatically assigned to the parent Business Unit.

Create Geo Area¶

To define Geo Areas, proceed as follows:

Open Settings > Administration > Organization Structure > Geo Areas tab. If the Geo Areas tab has already defined Geo Areas, they will be displayed in a table.
Figure 10: Geo Areas page
To define a new Geo Area, click
button. The map opens:
Figure 11: + NEW GEO AREAS
Draw the Geo Area with the
rectangle icon or polygon icon.
Figure 12: rectangle icon
Enter a Name, a Description (optional) and an External Key (optional), that can be used to add custom keys, e.g. for reference.
Activate or deactivate the option Enable geofence. For more information read section GeoFence.
Click create to save your changes.

✓ The new Geo Area is now listed in the page and can be used in the DataPortal.

Edit Geo Area¶

Open Settings > Administration > Organization Structure > Geo Areas tab.
In the Geo Areas page, select the
3-dots at the end of the line of the desired Geo Area to open the available options:
Figure 13: 3-dots

Select the desired options:

Option	Description
View/Edit	View or edit the selected Geo Area in the map as shown in Create Geo Area. When editing the Geo Area, make sure to use the Edit layer options: . IMPORTANT: When drawing a new area on the same map by using the polygon or rectangle options, the selected designed Geo Area will be deleted (a warning will be displayed beforehand).After editing, save your changes.
Delete	Delete the selected Geo Area. The Geo Area will be removed from the Geo Areas page.
Duplicate	Create a copy of the selected Geo Area. The duplicate will be listed in the Geo Areas page with "Copy" in the name:

= Required ↩↩↩↩↩↩
- The internal reference number can already be entered in the provisioning dialog. In case that the Go Live process is started at a later time, the correct internal number is already assigned to the machine then.
- The automatic configuration is only available when the Feature Switch for Configuration Management is enabled and if there is a corresponding configuration bundle available for the selected CU.
↩↩

User Management¶

There are different kinds of user accounts and security configurations that can be set up on the DataPortal:

Regular, standard accounts allows user to log into the DataPortal directly, see Create Regular User Account.
SSO accounts allow for a centralized login, see Create SSO User Account.
MFA (Multi-Factor Authentication) can be enabled to increase the security of user logins by requiring a second factor in addition to the password, see section Multi-Factor Authentication.

Large equipment manufacturers might want to use SSO to access the DataPortal for security (centralized access control), comfort (a single sign-on/authentication to remember) and providing customers with a single landing page for all applications. SSO users can have multiple accounts for multiple applications, including the DataPortal, but only need to log in once.

Overview¶

The User Management is to be found at: Settings > Administration > Organization Structure > Users tab.

The Permission Set Organization:Maintain is required for viewing and editing the user management.

The Users tab lists all users in a table and shows additional information on the account activity in different columns, e.g.:

Type (Regular, SSO)
Status
Last Access
Creation Date
Last Invited On
Last Password Change
Reset Password and Password Reset Request At, see also Force Password Reset

Create Regular User Account¶

Add users to the DataPortal within the Settings > Administration > Organization Structure > Users tab by following the steps below:

New User¶

Select the corresponding organization unit in the org tree on the left and click on the New User button to open the dialog.

Enter User Details¶

In the Overview, enter the information for the Regular account:

Item	Description
E-Mail	Email address of the user.
First/ Last Name	First and last name of the user.
Organization	The organization the user belongs to in the DataPortal as selected above in New User.
Language	The language group the user belongs to.

Note

For the email address, usually used as the username, it is allowed to use email subaddresses, provided that your email provider supports it.
By that, you can have multiple accounts with 1 email address, e.g. myemail+machine-owner@oem-mail.com
This feature supports Dealers that work on multiple OEMs; there might be many users that need multiple emails to log in to different OEMs' DataPlatform accounts.
It can also help a single OEM's user to create test users for different organization unit types or even subcustomers, e.g. myemail+dealer@oem-mail.com, myemail+customer-a@oem-mail.com.

Note

The DataPortal email/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.

Note

It must be considered that below each specific DataPlatform URL, such as dataportal.proemion.com usernames have to be unique. But identical usernames could appear below separate white-labelled DataPlatform URLs like customer1.proemion.net or customer2.webpage.com. In case a white-label package is required, please get in contact with your Proemion sales representative.

Assign Permissions¶

After entering the user information in the Overview, select Next Step to assign Permissions.

User permissions can also be managed using predefined User Roles.

After assigning the permissions to the account, select the Submit button to complete the user setup.

After selecting Submit to conclude the process, the user is added to the DataPortal pending email verification.

Email Verification¶

An invitation link is sent to the user as shown and users are requested to verify their email address.

Note

The invitation link is valid for 7 days.

Users are then redirected to the DataPortal where they can set a password before login
For the creation of new passwords, see Password Policy.

Figure 5: DataPortal VERIFY EMAIL ADDRESS

Multi-Factor Authentication¶

When Multi-Factor Authentication (MFA) is enabled, users must authenticate using a second factor (a time-based one-time password from an authenticator app) in addition to their regular login credentials. Once enabled, users will be prompted to configure MFA during their next login.

Enable MFA for Tenant¶

MFA is configured per tenant by assigning the required Permission Sets to the tenant.

Note

Please contact your Proemion representative to enable MFA for your organization.

Once MFA is enabled for a tenant, users matching the defined Permission Set (or higher) will :

Be prompted to set up MFA during their next login.
Be required to enter a valid time based one-time code (TOTP) during each subsequent login.

Upon first login after MFA is enabled, users are shown a QR code to scan using an authenticator app:

After completing setup, users will be prompted to enter a new one-time code from their authenticator app at each login:

Verify MFA Enabled for Tenant¶

You can verify whether MFA is active for a tenant by viewing the tenant's permissions.
To do so, proceed as follows:

Go to Settings > Administration > Organization Structure.
Select the tenant on the left side and navigate to the MFA tab.

If MFA is enabled for the tenant, a list of Permissions requiring MFA is displayed. Users with one of these Permission Sets (or higher) are required to configure and use MFA.

Verify MFA Enabled for User¶

To check whether MFA is enabled for a specific user, proceed as follows:

Go to Settings > Administration > Organization Structure.
Navigate to the Users tab.
Look for the MFA Enabled column. If MFA is enabled for the user, this column will display Yes.

Reset MFA for a User¶

If a user no longer has access to their MFA device (e.g. due to a lost phone or removed authenticator app), a system administrator can reset their MFA configuration. To reset MFA, proceed as follows:

Go to Settings > Administration > Organization Structure.
Navigate to the Users tab.
Open the 3-dots menu at the end of the row of a user and choose one option of the following from the context menu:
Select the Reset MFA option.
Select the Details option and click the Reset MFA Configuration button.
Figure 10: MFA Reset via Edit User menu
Click Confirm in the reset dialog.

Warning

Resetting MFA does not disable it. The user will be required to reconfigure MFA at the next login. The user will then be prompted to set up MFA again during their next login.

Create SSO User Account¶

The authentication (confirmation of your identity) of SSO users is performed by the configured identity provider, whereas the user permissions and their organization assignment are managed on the DataPlatform.
We recommend doing this automatically on the user login by setting up a customized mapping from attributes in the identity provider like roles to organization units and permissions in the DataPlatform.

Note

By doing so, the manual creation of one or both "regular" and "SSO" user types can be disabled by Proemion and the New User button won't be displayed
This might be needed for organization units that are not tenants.

Alternatively, SSO users can be created manually in the DataPortal
The account creation can only be performed by authorized users
Add users to the DataPortal within the Settings > Administration > Organization Structure > Users tab by following the steps below:

New SSO User¶

Select the corresponding organization unit in the org tree on the left and click on New User button to open the dialog.

Use the SSO form:

Item	Description
External Username	This is the name of the account in the SSO identity provider.
E-Mail¹	Email address of the user.
First/ Last Name¹	First and last name of the user.
Organization¹	The organization the user belongs to in the DataPortal as selected in New SSO User.
Language¹	The language group the user belongs to.

Assign Permissions¶

After entering the user information in the Overview, select Next Step to assign Permissions.

After assigning the permissions to the account, select the Submit button to complete the user setup.

Note

SSO users do not receive an invitation link.

View and Edit User¶

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 top menu bar
This view lists all the users in the selected child organization.

Select Details to the right of the user to open the Edit User dialog.
Adapt the fields as desired and proceed to the Next Step.
In Permissions, adapt the user access for the Subjects.
Click Submit to save the changes.

Note

The link to verify a new email address is valid for 4 hours.

Note

The organization corresponds to the structure displayed in the org tree and cannot be changed.

Move Users across Organizational Units¶

Users can be moved across Organization Units as follows:

Select the user(s).
Activate the checkbox of the user(s).
The Organization tree will appear in the Select Organizations dialog on the right.
Select the target organization.
Click Move User on the bottom right to apply the change.

Force Password Reset¶

DataPortal Admins can force a password reset for users.
Users with a pending forced password reset cannot log in, until they have requested a new password in the login mask and completed the password reset, see Password Reset.

Note that after forcing a password reset, the users receive no email unless they reset the password.

To force the password reset, proceed as follows:

Permission Set Name	Level
User	Admin

Open the Settings > Administration > Organization Structure > Users tab.
Open the drop-down menu by the end of the row of the user.
Select the Force password reset option.
Confirm the reset in the dialog window:

In the Users table, you can then view whether a user has a forced password reset and when it was requested:

Suspend Users and Inactive Users¶

To suspend access for the DataPortal account, open the Details of the user account.
In the Edit User dialog, click the Suspend access button and the user will not be able to login to the application.
To re-activate an account, click Restore access.

Inactive users that meet the following criteria will be removed from the system automatically:

users that have no account activity in more than a year AND never logged in

OR

no login over 3 years AND no account activity for 2 years

To comply with GDPR, once a month user-accounts that meet the above criteria are removed from the system.

Note that as an admin you may also Force Password Reset.

Delete Users¶

Use Delete permanently if you want to permanently remove the user and all their data from the platform and related services.

Required permission:

Permission Set Name	Level
Organization	Admin

Users can be deleted as follows:

Select the user.
Activate the check box next to the user.
Click on Delete permanently.

✓ The message User has been successfully deleted. will appear in the upper right corner.

User Details for SSO accounts are provided by the identity provider and cannot be edited in the DataPortal. ↩↩↩↩

Machine Contracts¶

The DataPortal allows a user with the Contract:Maintain permission set 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. For information on the availability of the Proemion tariffs for each country, see Hosting Plans across Regions.

To view the contracts, open Settings > Administration > Contract.

You may search, sort or filter by the following items.

Item	Description
Contract ID	The identification number of the communication unit's hosting contract.
Your Internal Reference Number	Your order/purchase number for internal reference (the internal reference number can be assigned during Go Live).
Contract start date	Shows the date when the contract was started.
End date / Renewal date	Shows the reference date when the hosting contract will be renewed (in case of a manual Contract Renewal by the user) or terminated in compliance with a period of notice (in case of State = active (cancelled)).
Activation Date	Shows the date when the device was activated.
Deletion date	Shows the date planned for deleting a terminated machine.
Contract State	Shows the current state of the contract.
	NOTE: Machines with terminated contracts will be removed from the portal after 3 months, i.e. the historic machine and CU data will be then deleted.
	For more information on the different states, see Contract State and CU State.
Renewal requested	Indicates if a user requested a renewal. Only if the feature has been activated.
Hosting Plan	The identification number of the hosting plan.
Hosting Plan Description	The name/description of hosting plan, e.g. "PE DataPlatform Hosting 50 GlobalLight+".
CU - ID	The identification number of the communication unit.
CU - State	The state of the communication unit.
	For more information on the different states, see Contract State and CU State.
Machine Name	The identification of the machine.
Machine Model	The name/identification of the model.
Serial	The unique, identifying number or group of numbers and letters assigned to the machine.
PIN	The Part Identification Number of the machine.
Machine Location	The current location (country) of the machine.
Support in Machine Location	Shows whether the (planned) machine location is supported by the current hosting plan, i.e. whether the country the machine is or will be located in is covered by the hosting plan. The supported country can already be checked in the Go Live menu.
	Possible values:
	- "Supported": The current machine location is supported by the hosting plan.
	- "Not Supported": The current machine location is not supported by the hosting plan.
	- "Unknown machine location": The location of the machine is not known.
Organization Unit	The organization unit the machine is assigned to.

Contract Details¶

To view a single contract, at the end of each row, select to open the drop-down menu and select the Contract Details. The Contract Details window looks as follows.

The Contract Details, Communication Unit and Machine tabs may show additional information on the contract, see below.

Item	Description
SIM traffic volume (used/limit)¹ ²	Shows the used SIM traffic of the current month and the contract's limit.
Active tariffs	Shows a list of the description of the active hosting tariffs, i.e. Hosting Plan.
Current SIM card ID	The identification of the SIM card currently used by the CU.
Provider	The network provider that was last used for communication by the CU.
Last Login	The last time the CU was connected to the DataPlatform.

Contract State and CU State¶

The Contract State and CU State may have the following values.

The following Contract states are possible:

Contract State	Description
testphase	Contract with future start date. CU is allowed to connect and send small amounts of data.
active	Contract is active. The CU is allowed to send data. All contracts with this state will be renewed automatically a specific time before the Renewal date.
active (cancelled)	Contract has a defined End date and will be terminated once this date is reached. The contract term can be extended by using the Contract Renewal function.
terminated	Contract has reached its End date and the CU is no longer allowed to connect. Please refer to chapter Reactivation for further details on how to reactivate a terminated device.

Data retention and GDPR

Machine and communication unit (CU) data are retained for 3 months after contract termination. After contract termination, the contract state changes to terminated and the CU can no longer connect to the DataPlatform. You can reactivate the machine within this 3-month period, as long as it is still visible in your organization. If you reactivate the machine within this period, historical machine and CU data remain available. After 3 months, the machine is automatically removed from the DataPlatform. All historical machine and CU data are permanently deleted and cannot be recovered. Proemion does not retain customer data without a valid contract in order to comply with GDPR requirements.

The following CU states are possible:

CU State	Description
created	CU/Machine exists in the Data Platform. It is ready for Provisioning. Note: Machines with this state may not be visible on your account.
provisioned	CU is visible on your account and ready for activation with Go Live.
Live	CU is activated and can send data.
terminated	CU is no longer allowed to connect. Please refer to chapter Reactivation for further details on how to reactivate a terminated device.
archived	CU and machine data have been wiped. Please refer to chapter Reactivation for further details on how to reactivate an archived device.
resiled	Machine data have been wiped from the CU. Please refer to chapter Reactivation for further details on how to reactivate a resiled device.

Contract Renewal¶

The contract renewal is available on "active (cancelled)" contracts with an end date in the future that is within the next 12 months. Terminated contracts cannot be renewed, but only re-activated, see Reactivation.

Users can either request the renewal; eligible users can directly renew the contracts on their own, see also the Requirements for the required user permissions.

When renewing the contract, both the contract ID and start date of the contract remain the same.

Note

Contracts that are not canceled will be automatically renewed.

Requirements¶

Users without permissions (e.g. at least Contract:Maintain permissions) can request the renewal of their expired or soon to expire contracts via the Machine Page.

The receiver of the request - usually the OEM or Dealer - can contact the requester, make an offer and renew the contract as described below in Contract Renewal.
The receiver must have the Contract:Maintain permissions - to renew both active canceled contracts and terminated contracts

Renew Contract¶

To manually renew a contract, proceed as follows:

In the Contracts menu, select the option Renew Contract via the 3-dots icon by the end of the row :

Figure 4: Contracts Overview - drop-down menu

✓ The Renewal details page opens.

Select the New duration: 1 Year, 2 Years, 3 Years, 4 Years or 5 Years.
Enter a new Your internal reference number (maximum length of 35 characters) or just keep the existing one for later reference (this number can be assigned during Go Live). It is recommended to have a recurring reference number for easier reference of your machine/contract in your system, see Provision Machine Dialog.
Click Renew.

✓ The request for contract renewal is transmitted. ✓ You will receive an updated contract confirmation via email.

Note

With the contract renewal, the complete duration will be billed at once.

Contract End Notification¶

Users with contract permissions of organizations with the contract expiration feature enabled can subscribe to weekly contract notifications.

These notifications inform the user of all contracts that need attention because they are about to expire, have already expired or a customer has expressed interest in extending the contract.

CANlink® mobile light Upgrade¶

The concept of the CANlink® mobile light is described in the CANlink® mobile 3600 device manual, see CANlink® mobile light.

To upgrade the CANlink® mobile light to a standard device/hosting plan, proceed as follows:

Go to the Contracts menu and open the Details of the according machine.
In the Contract Details, select Upgrade, see also image in the Contract Details.

You have successfully requested the upgrade to the standard CANlink® mobile 3600 device with all the features offered and an independent hosting plan.
The request is displayed in the Contracts menu.

You may then subscribe to contract expiration email, see Subscribe to DataPortal Notifications.

The SIM traffic volume and the number of Realtime cases are only updated once a day. Due to technical restrictions, there might be some time shift of the displayed data usage and Realtime cases. ↩
Consider that the actual used SIM traffic volume will be displayed only after closing a session. Example: 5 MB are displayed in the DataPortal, but a message has been sent to the customer because the limit of 10 MB has been already reached during the yet open session. ↩

Platform Contracts¶

Proemion offers a free trial of the DataPortal.
Afterward, you must upgrade to one of the 3 plans.

The onboard process is as follows:

You may start a free trial with demo machines.
Those machines cover historic data up to 1 year in the past including time-series data and also DTCs.
By upgrading to one of the 3 plans, you can access your own machines/devides on the DataPortal.
You may then subscribe to one of the other plans, see Plans.

Plans¶

Go to Settings > Platform Contracts.

There, you can subscribe to different plans that cover different configuration levels for devices + access to the DataPortal.

Within the these plans, you are offered a dedicated view on the devices in the the DataPortal, see Access the DataPortal.

Access DataPortal¶

To offer a simple start into the Proemion telematic system, the plans offer only the basic features/access to the DataPortal and limited set of configuration.

The free trial offers a demo view on the DataPortal.

By upgrading to one of the plans, you can view your own machines in different views:

Home Dashboard
Model Dashboard
Machine Details Page
Reports

The configuration options are as follows:

Machines can be configured via CAN Network parameters: CAN 1, 2, 3 + CAN Identifier as well as the Baudrate (e.g. "shutdown in...").
Depending on the plan, you may configure Themes
Basic signals, i.e. J1939 signals are displayed
Automatic PDC assignment, i.e. no configuration of the PDC (signals)
Default device configuration will be appplied, i.e. no configuration of the DOD
No dashboard configuration
No configuration of user permissions
No Feature toggles

Portal Appearance

Note

This feature is only available for subscriptions of the Medium bundle or higher, see Platform Contracts.

Themes¶

As an Administrator, you can customize the theme (logo, color scheme, title, etc.) of your organization in the DataPortal
To do so, select Settings > Portal Appearance > Theme
The Themes customization page opens where you can adapt the design for different sections and elements of the DataPortal:

Browser Title Bar
Design
Logo
Machine icon
Login Page
Behavior Options
Custom Menu Entries
Custom DataPortal Email Sender Signature

Browser Title Bar¶

In the following sections, the brand name and the favicon are defined which should then be displayed on the webpage tab.

Design¶

In the following section, adapt the primary, accent and header colors for your brand and the map style.

Primary color applies to selected menus and hovering over menus in the main menu on the left side, see example with red color:

Figure 4: Primary Color - red color example
Accent color applies to the background of the main menu, see example with red color:

Figure 5: Accent Color - red color example
Header color applies to the header of the DataPortal, see example with red color:

Figure 6: Header Color - red color example

Figure 7: Map Track Color - red color example

Figure 8: Map Marker Color - red color example

Logo¶

In the following section the company logo is defined, which will be displayed in the upper left corner of the DataPortal.

Figure 9: Logo

Machine icon¶

In the following section, the machine icon is defined
The machine icon is displayed in the main menu next to Machines menu.

In this area the copyright notice, image and footer links for the Login Page are defined.

Item	Description
Copyright	Defines the text displayed in the copyright notice in the footer of the Login Page and in system-generated emails. The company name can be customized. The year is automatically generated by the system and cannot be modified.
Footer links	Add static links and display text (100 character maximum) to the page footer. These links can point to external resources such as company websites or support pages. They are part of the customizable branding configuration and are not related to the sign-out process.
Login image	Upload your own image to the standard DataPortal Login Page.

For more information, see Sign in to the DataPortal.

Behavior Options¶

The Behavior options allow you to customize the user experience in the Machines Overview.

Item	Description
Show map on machine overview	Show the map in the Machines Overview.
Show realtime mode toggle on machine overview map	This option allows the user to filter machines by their operating mode on maps.
Show/hide the machine and asset icon on maps (not map widgets)	By disabling this option, the asset icons are not displayed, instead only a map icon is displayed, see following example: toggle on (default): toggle off ("hide asset icon"):
Show VIN or machine overview list	Include a column with the Vehicle Identification Number (VIN) in the list of machines.
Show PIN on machine overview list	Include a column with Personal Identification Number (PIN) in the list of machines.
Show serial number on machine overview list	Show the serial number column in the list of machines.
Enable visibility of the right panel with the overview of signals	Signal Overview Panel appears when selecting a machine from the machine list or on the map.

The DataPortal allows you to add menu categories to the main menu with URL links provided in the panel on the left side.

To add a menu category with menu links to your DataPortal menu, go to Themes > Menu section and proceed as follows:

Figure 13: DataPortal Theme, Custom Menu

Select the language of the DataPortal you want to add the new menu category for.
Click +Add Menu Category
The section for menu category opens.
Select a Category icon and add the Display title that will be used as the header of the drop-down-menu in the panel.
To add sub-menus, click Add menu link.
Add the Display title and provide the URL for the clickable sub-menus
You may add as many menu links as desired.
To create a preview of your custom menu entries, click Preview in the upper-right corner. The preview is shown in the same window and can be stopped by selecting Finish preview.

Figure 14: Custom Menu Preview
To save your changes, click Store in the upper right corner.

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.

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

Machine Contracts¶

The DataPortal allows a user with the Contract:Maintain permission set 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. For information on the availability of the Proemion tariffs for each country, see Hosting Plans across Regions.

To view the contracts, open Settings > Administration > Contract.

You may search, sort or filter by the following items.

Item	Description
Contract ID	The identification number of the communication unit's hosting contract.
Your Internal Reference Number	Your order/purchase number for internal reference (the internal reference number can be assigned during Go Live).
Contract start date	Shows the date when the contract was started.
End date / Renewal date	Shows the reference date when the hosting contract will be renewed (in case of a manual Contract Renewal by the user) or terminated in compliance with a period of notice (in case of State = active (cancelled)).
Activation Date	Shows the date when the device was activated.
Deletion date	Shows the date planned for deleting a terminated machine.
Contract State	Shows the current state of the contract.
	NOTE: Machines with terminated contracts will be removed from the portal after 3 months, i.e. the historic machine and CU data will be then deleted.
	For more information on the different states, see Contract State and CU State.
Renewal requested	Indicates if a user requested a renewal. Only if the feature has been activated.
Hosting Plan	The identification number of the hosting plan.
Hosting Plan Description	The name/description of hosting plan, e.g. "PE DataPlatform Hosting 50 GlobalLight+".
CU - ID	The identification number of the communication unit.
CU - State	The state of the communication unit.
	For more information on the different states, see Contract State and CU State.
Machine Name	The identification of the machine.
Machine Model	The name/identification of the model.
Serial	The unique, identifying number or group of numbers and letters assigned to the machine.
PIN	The Part Identification Number of the machine.
Machine Location	The current location (country) of the machine.
Support in Machine Location	Shows whether the (planned) machine location is supported by the current hosting plan, i.e. whether the country the machine is or will be located in is covered by the hosting plan. The supported country can already be checked in the Go Live menu.
	Possible values:
	- "Supported": The current machine location is supported by the hosting plan.
	- "Not Supported": The current machine location is not supported by the hosting plan.
	- "Unknown machine location": The location of the machine is not known.
Organization Unit	The organization unit the machine is assigned to.

Contract Details¶

To view a single contract, at the end of each row, select to open the drop-down menu and select the Contract Details. The Contract Details window looks as follows.

The Contract Details, Communication Unit and Machine tabs may show additional information on the contract, see below.

Item	Description
SIM traffic volume (used/limit)¹ ²	Shows the used SIM traffic of the current month and the contract's limit.
Realtime traffic cases (used/limit) ¹	Shows the number of Realtime cases of the current month and the contract's limit. See also Realtime Cases by Contract
Active tariffs	Shows a list of the description of the active hosting tariffs, i.e. Hosting Plan.
Current SIM card ID	The identification of the SIM card currently used by the CU.
Provider	The network provider that was last used for communication by the CU.
Last Login	The last time the CU was connected to the DataPlatform.

Contract State and CU State¶

The Contract State and CU State may have the following values.

The following Contract states are possible:

Contract State	Description
testphase	Contract with future start date. CU is allowed to connect and send small amounts of data.
active	Contract is active. The CU is allowed to send data. All contracts with this state will be renewed automatically a specific time before the Renewal date.
active (cancelled)	Contract has a defined End date and will be terminated once this date is reached. The contract term can be extended by using the Contract Renewal function.
terminated	Contract has reached its End date and the CU is no longer allowed to connect. Please refer to chapter Reactivation for further details on how to reactivate a terminated device.

Data retention and GDPR

Machine and communication unit (CU) data are retained for 3 months after contract termination. After contract termination, the contract state changes to terminated and the CU can no longer connect to the DataPlatform. You can reactivate the machine within this 3-month period, as long as it is still visible in your organization. If you reactivate the machine within this period, historical machine and CU data remain available. After 3 months, the machine is automatically removed from the DataPlatform. All historical machine and CU data are permanently deleted and cannot be recovered. Proemion does not retain customer data without a valid contract in order to comply with GDPR requirements.

The following CU states are possible:

CU State	Description
created	CU/Machine exists in the Data Platform. It is ready for Provisioning. Note: Machines with this state may not be visible on your account.
provisioned	CU is visible on your account and ready for activation with Go Live.
Live	CU is activated and can send data.
terminated	CU is no longer allowed to connect. Please refer to chapter Reactivation for further details on how to reactivate a terminated device.
archived	CU and machine data have been wiped. Please refer to chapter Reactivation for further details on how to reactivate an archived device.
resiled	Machine data have been wiped from the CU. Please refer to chapter Reactivation for further details on how to reactivate a resiled device.

Filters¶

Contracts that are "to expire soon" or "expired" or contract renewal "requested" are now listed as filters above the Contracts table.

You must have Contracts:View permissions to view these filters.

When filtering by those options, the contracts will be listed in the table accordingly. In the columns, you can view the machine name, organization unit and other data belonging to the contract, see above.

These filters are also useful for the Contract Renewal process, see below.

Realtime Cases by Contract¶

Note

A Realtime case is started by a Realtime diagnosis session, and includes all sessions in the subsequent 4 hours window.
The number of Realtime cases are only updated once a day.

Starting in summer 2025, the DataPortal starts to manage the number of Realtime cases based on machine hosting contracts and will enforce usage limitations:
While some machine-specific tariffs allow a predefined set number of Realtime cases per month, others completely restrict Realtime service.

The count and the number of allowed cases is displayed in the Contract Details:

After exceeding the included number of Realtime cases, no new Realtime diagnosis sessions can be established via tools like the Remote Service Tool, Proemion SoftGateway, PLUS+1 Service Tool, etc.
The data logging remains unaffected, i.e. devices can still go online and connect with the DataPlatform and transmit machine logged data (e.g. clf files).

Realtime sessions used by the Proemion Support team are not counted.

Consider that with newer firmware versions, particularly for the CANlink mobile 3600, the distinction between Realtime and Logging modes has been combined into an "Online" mode, which allows for both data logging and Realtime diagnostics simultaneously, see also CANlink mobile 3600 Online feature.

Add Additional Realtime Cases¶

You may request to add additional Realtime cases to the current month limit.

To do so, contact Service and Support.

Once the request has been confirmed, you will see a new row "Real Time Top Up [requested number] Cases" in the "Active tariffs" list, see image below, and the "Realtime traffic cases (used/limit)" number increases accordingly.

Figure 5: Additional Realtime Cases tariff

Contract Renewal¶

The contract renewal is available on "active (cancelled)" contracts with an end date in the future that is within the next 12 months. Terminated contracts cannot be renewed, but only re-activated, see Reactivation.

Users can either request the renewal; eligible users can directly renew the contracts on their own, see also the Requirements for the required user permissions.

When renewing the contract, both the contract ID and start date of the contract remain the same.

Note

Contracts that are not canceled will be automatically renewed.

Requirements¶

Users without permissions (e.g. at least Contract:Maintain permissions) can request the renewal of their expired or soon to expire contracts via the Machine Page.

The receiver of the request - usually the OEM or Dealer - can contact the requester, make an offer and renew the contract as described below in Contract Renewal.
The receiver must have the Contract:Maintain permissions - to renew both active canceled contracts and terminated contracts

Renew Contract¶

To manually renew a contract, proceed as follows:

In the Contracts menu, select the option Renew Contract via the 3-dots icon by the end of the row :

✓ The Renewal details page opens.

Select the New duration: 1 Year, 2 Years, 3 Years, 4 Years or 5 Years.
Enter a new Your internal reference number (maximum length of 35 characters) or just keep the existing one for later reference (this number can be assigned during Go Live). It is recommended to have a recurring reference number for easier reference of your machine/contract in your system, see Provision Machine Dialog.
Click Renew.

✓ The request for contract renewal is transmitted. ✓ You will receive an updated contract confirmation via email.

Note

With the contract renewal, the complete duration will be billed at once.

Contract End Notification¶

Users with contract permissions of organizations with the contract expiration feature enabled can subscribe to weekly contract notifications.

These notifications inform the user of all contracts that need attention because they are about to expire, have already expired or a customer has expressed interest in extending the contract.

CANlink® mobile light Upgrade¶

The concept of the CANlink® mobile light is described in the CANlink® mobile 3600 device manual, see CANlink® mobile light.

To upgrade the CANlink® mobile light to a standard device/hosting plan, proceed as follows:

Go to the Contracts menu and open the Details of the according machine.
In the Contract Details, select Upgrade, see also image in the Contract Details.

You have successfully requested the upgrade to the standard CANlink® mobile 3600 device with all the features offered and an independent hosting plan.
The request is displayed in the Contracts menu.

You may then subscribe to contract expiration email, see Subscribe to DataPortal Notifications.

The SIM traffic volume and the number of Realtime cases are only updated once a day. Due to technical restrictions, there might be some time shift of the displayed data usage and Realtime cases. ↩↩
Consider that the actual used SIM traffic volume will be displayed only after closing a session. Example: 5 MB are displayed in the DataPortal, but a message has been sent to the customer because the limit of 10 MB has been already reached during the yet open session. ↩

Legal Requirements¶

OEM DataPortal customers (top- or distributor-level) are required by law to inform users of their legal rights and obtain their consent in regards to data protection and privacy. The DataPortal hosts and enables access to the documentation via links, and user consent via banner.

The Tenant:Admin permission set is required to manage data protection and legal documents for the DataPortal, see Tenant.

Note

The Admin of the Tenant subject is a Super Admin that differs from the typical DataPortal Admin because they must have dedicated general knowledge of legal compliance and specific expertise of data privacy.

The standard documentation includes (but is not limited to - dependent on the region):

Required by OEM
- Privacy Policy (PP)
- End User Agreement (EUA)
Provided by Proemion
- Imprint (required by German regulations - provided exclusively by Proemion)
- Privacy Policy template
- End User Agreement (EULA) template
User Tracking (banner) and Consent permission declaration

Note

Privacy Policy and End User Agreement are mandatory regardless of region.

The GDPR Compliance page functions as an information hub for fulfilling your compliance obligations.

The following points are discussed here:

Item	Description
Your Obligations Under The Law	Cookies are needed to ensure the best possible experience of the DataPortal. EULA or End User Licensing Agreement is a legally binding document describing the terms and condition of the access and use. Privacy Policy is a legally binding document describing how you manage the data you collect through the DataPortal.
How we are helping	After you do the initial setup, the DataPortal will ensure that your users accept the cookies and the documents in a legally binding way before being able to use the DataPortal.
Your Next Steps	You only need to provide the documents and the DataPortal will do the rest for you.
Keeping Track of User Consent	The DataPortal will only help you keep track of the consent to documents uploaded in the new Legal links page.
Final Submission Date	If one or all of the documents are missing after the deadline, the DataPortal will use the default legal documents.
FAQ	What is GDPR?: GDPR is a regulation in EU law on data protection and privacy in the European Union (EU) and the European Economic Area (EEA) Can I keep my documents up to date?: If in the future any of these documents need to be updated, you will be able to do so by uploading new copies of them to the DataPortal. Do I need one document in each language?: The DataPortal allows you to upload your documents for all languages supported.

The first time a user logs in and subsequently every time the documents are updated - specifically PP and EULA - they are prompted for their explicit consent before proceeding to use the DataPortal. This also applies to the banner.

Selecting the Reject button automatically signs the user out of the DataPortal.
Selecting the End User License Agreement link opens the document in a separate browser tab.

Figure 3: EULA Example provided by Proemion

User Tracking¶

Consent to user tracking (cookies) by the DataPortal is facilitated by a banner.

TEXT: To be GDPR-compliant make sure you have uploaded your company's Privacy Policy and End-User License Agreement by [date]. If by the date there are no documents uploaded, the two templates in this page will be added automatically to your Login page. Please read the documentation for more details. This banner will disappear after appropriate action is taken.

Configuration¶

If the legal documents have not yet been configured, a prompt appears informing the DataPortal Admin upon login into the system that the documents must be set up and redirecting to the Legal Links menu via Add Legal Documents.

Select Later and a message appears prompting you to include the EULA and a browser note informing you about GDPR compliance requirements.
Select Read the Documentation and you are taken to the GDPR Compliance page (https://dataportal.proemion.com/legal-documentation) where you can read about your obligations and compliance instructions.

In the documentation there is a link - To get started, download the templates - that allows you to download the templates (in .doc format) whereby you can replace the text with that of your own. Once you have made the necessary adjustments, you can upload the links back into the DataPortal as PDF documents.

Document Upload¶

You can add the relevant documents in Settings > Portal Appearance > Legal Links.

In the sections Privacy Policy and the End User License Agreement sections, it is mandatory that you upload the document in the English language first

After uploading the English documents, the Add Translated Documents button appears that allows you to upload the documents in other languages.

Warning

DO NOT USE Login Footer Links from the DataPortal Themes section to serve Privacy Policy, End User License Agreement or other legal compliance/ data privacy documents!

Selecting the Choose File button you can select the document
A successful upload shows a popup message that confirms the document is updated
After successful upload, the Add Translated Document button is now active and you can add translations of each document for localized versions of the DataPortal.

Note

The DataPortal does not validate if the language you uploaded matches the localization!

Imprint¶

Due to legal regulations, it may be necessary to store your own imprint for the respective data portal account. A fictitious example below shows how this can be achieved.

Permission Set Name	Level
Tenancy	Admin

To add an Imprint, select Settings > Portal Appearance > Legal links.
Click on ADD IMPRINT.

Figure 8: Add Imprint button
Complete the imprint details at the pages Contact,Details and Board.

Figure 9: Imprint Details
Check the summary and confirm by click on SUBMIT.

Figure 10: Summary and Submit button

✓ The message Imprint created successfully appears in the upper right corner.

Imprint Usage in Emails¶

The customer imprint will be used in the footer of the following email notifications:

#	Email notification
1	Time fence Breach
2	DTC Notification
3	Maintenance Task
4	Threshold
5	GeoLeas Breach
6	Assignment completed
7	Password reset
8	E-Mail change notification
9	Export of raw data

You can select the checkbox "Show full contact information in email notification" to unhide/hide the address and phone number in the imprint.

Figure 11: Imprint with full contact in Email Example

Note

The customized imprint at the login page is only available for white label customers with customized login URL. All DataPortal standard accounts alternatively can use the login footer link to get redirected to the imprint URL of the corresponding homepage.

To check the imprint settings at the login page for white label accounts, click on the Imprint label below the footer links in the lower left corner at the login page.

Figure 12: Login page

✓ The imprint opens in a second tab.

Figure 13: Imprint details
Click on Back to login to close the imprint window and proceed with the login.

Machine Data Management

Models Management¶

The DataPortal enables the management of machine models so that Admins, can categorize the machines in their organization. The Models page is only visible to organizations that are tenants, typically the OEM.
For more information, see Tenant.

A model represents the type and class of a machine such as Digger 950L or Digger 1070XL. The machine on the DataPortal represents the individual real machine such as Digger 1070XL - S/N 190512
In this section we demonstrate the Model Management dialog.

Read also Model-Based Signals that have an impact on the model's visibility in the DataPortal.

The Models page also contains a link to Asset Types.

Note

Note that only models with assigned PDC, see Create Model - PDC are available for selection in the Provisioning dialog.

Note

The Settings > Administration > Organization Structure > Models tab is deprecated. Models can no longer be placed anywhere in the Organization Tree. Please use the new Model page in Settings > Machine Data Management > Models.

View Models¶

View the existing models in your organization as follows.

Open Settings > Machine Data Management > Models.

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.

Create Model¶

Open Settings > Machine Data Management > Models.
Click the New Machine Model button on the upper right side of the models list to open the Create Model dialog:

#	Item	Description
1	Name	Model identification.
2	Description	Definition of the model.
3	Visibility	Defines the visibility of this model and its Model-Based Signals.
4	Appearance	The model picture will be shown for any machine assigned to this model. NOTE: In case that an individual image for a specific machine was uploaded, the individual machine image will be displayed instead.
5	Asset type for map and list view	Select the icon and label defined in Asset Types that will be displayed in the Machines Overview for the machines assigned to this model. You can then decide if the icon should be displayed instead of the uploaded image.

Click Continue to assign links, machines and PDCs to the created model.

Create Model - Links¶

This option allows administrators the assignment of model-related service documentation and other external resources, which will be displayed in the Machine Master Data.

Note

Note that the Documentation Link feature must be enabled in the Feature Switch.

Figure 3: Example: Machine Master Data Widget with enabled Document Links

If the feature is not enabled, the Links tab does not appear, as illustrated in the following screenshot.

Figure 4: Create Models without Links tab

To add links to models, proceed as follows:

Figure 5: Create Model Dialog - Configure Links

#	Item	Description
1	Language	Choose the language for the Display title. Add additional languages using the + button.
2	Display titel	Enter the name that will appear in the Machine Master Data widget (see image above).
3	URL	Provide the web address of the documentation or other external resources.
4	Add links	Define additional links.

Create Model - Machines¶

Figure 6: Create Model Dialog - Select Machines

Search and select machine(s) to assign them to the model.

Edit Models¶

To Edit an existing model:

Open Settings > Machine Data Management > Models.
Open the 3-dots menu at the end of the model´s row and select Edit model.

The Edit model dialog opens:

#	Item	Description
1	Name	Model identification.
2	Description	Definition of the model.
3	Visibility	Defines the visibility of this model and its Model-Based Signals.
4	Appearance	The model picture will be shown for any machine assigned to this model. NOTE: In case that an individual image for a specific machine was uploaded, the individual machine image will be displayed instead.
5	Asset type for map and list view	Select the icon and label defined in Asset Types that will be displayed in the Machines Overview for the machines assigned to this model. You can then decide if the icon should be displayed instead of the uploaded image.

Note

The trash icon next to the model is disabled if it has assigned machines.

Threshold Configuration¶

Model-based thresholds enable users to evaluate machine use via signal level thresholds. This feature allows you to apply thresholds to many machines with minimal effort.
The Model:Admin permission set is required to use this feature.

Further details about thresholds severity levels, configuration, notification and reporting can be found in the section Threshold Notification.

Users are also able to view signal threshold history in the following visualizations:

History widget
Events widget
Gauge widget
Capacity widget
Signal State widget
Plot Reports
Custom DataPortal events

Configuration¶

Note

Thresholds are only available in the Models tab if the model and the user belong to the same organization. For each machine model, a set of thresholds can be configured per signal.

To configure a threshold for a model, proceed as follows:

Open Settings > Machine Data Management > Models.
Open the 3-dots menu at the end of the model´s row and select Configure Thresholds. The Configure threshold page opens:
Figure 9: Signals field
Click in the Signals field and Add new threshold
The list of signals opens.
Figure 10: Signals list
Select the signal from the list and configure its threshold.
Figure 11: Configure threshold for selected signal

Item	Description
Severity	Select the severity level outside the healthy signal value region.
Trigger Value	Set the signal value for a threshold.
Rearm Value	Set the value where the notification trigger is rearmed.

Edit Threshold for a Single Machine¶

For testing or special circumstances it may be necessary to edit the threshold configuration for a single machine.
Since thresholds are designed for models, the procedure to test thresholds is as follows.
This procedure allows you to configure and view thresholds for a single machine.

Create a special test model without assigning it to a machine.
Assign the PDC to the test model.
Assign the model for testing purposes to a single machine and test the thresholds.

-->

Define the thresholds for this model.

Asset Types¶

Asset Types is a combination of a label and icon used to categorize machine models based on their functionalities, e.g. dumper, excavator, etc.

This allows to filter models by the assigned labels, e.g. on the map, and to have an overview of the available asset types throughout the entire organization/fleet in the Settings > Machine Data Management > Asset Types menu:

Clicking the link See all machines leads you the Machines Overview with the filter already set for the selected asset type.

The Asset Types together with its label and icon is defined by a tenant, typically the OEM (see also Tenant), while the assignment of the asset type to models can be done by any user with Model:Admin permissions, see Requirements.

Requirements¶

The required permission sets are following:

Model:Admin to define asset types only by users within tenant organizations, e.g. OEM organizations.
Model:Admin to assign models to asset types in the Asset Type menu only by users within tenant organizations.
Model:Admin to assign or edit models to asset types in the Model menu (by any user).
No specific permission required to view the assigned asset types on the map or where included within the DataPortal.

Define Asset Types¶

To define a new asset type, proceed as follows.

Open Settings > Machine Data Management > Asset types. Here you can view the already existing asset types, if available.

Click the add icon to open the Asset type details dialog:

#	Item	Description
1	Display title	The label which will be displayed in the Asset Types overview and on the Machines Overview, both Map and List views.
2	Language	Add a new label for each language.
3	Icon	Upload an icon for the asset type.

Now you can proceed with assigning asset types to models.

Assign Asset Types to Models¶

There are two ways to assign models to an asset type. Consider the Requirements.

Assign asset type in Asset Type menu:

Open Settings > Machine Data Management > Asset types.
Click the link See all machines. This opens the Asset type details dialog:

Figure 3: Assign asset type menu
Click the field Usage to open the drop-down menu of available models.
Select the models you want to assign to the asset type.

✓ The model is now assigned to the asset type.

Assign asset type in Models dialog:

You can assign asset types to models in the Create Model and/or Edit Models dialogs and also change or remove them.

Guidelines for Creating Icons¶

The following guidelines are useful when providing asset icons for the DataPortal to make sure they are rendered correctly.

Assets icons are used in the format 24px x 24px on:

map pins in white over contrast backgrount
navigation contrast colour over brand colour background

They are used on a machine model page in a larger format if there is no model image for the machine.

Creating assets¶

When creating your artwork, ensure it conforms to the following:

Recommended size: 24px X 24px, 48px X 48px, 72px X72px

Shape: Full square with no round corners

Format: SVG

Vector: unified shape

Color: unified color (preferably all black)

Padding: leave 2px internally around the image

Background: transparent

If the asset icon is not squared, center its position vertically and/or horizontally (img 2 and 3).

Efficiency Definitions¶

Note

The functionality explained here is an enhancement of the Efficiency widget that has been deprecated, resp. reworked to Efficiency Snapshot and Efficiency History widgets.

Efficiency enables machine owners to calculate and track efficiency for individual machines or for your fleet. The functionality enables the following:

Compare efficiency for individual machines or an entire fleet
View efficiency for an individual machine or an aggregated set of machines (i.e. organization)
Visualize the data as a chart, graph or table.

Note

This feature requires the availability of counter values of work and idle signals/keys on the machine
The total time of these signals is used for calculating the efficiency as follows: work group / (work group + idle group)
More information about the signal keys can be found in the chapter Counter Guard Signals within the Standard Metrics Documentation.

Requirements¶

The Efficiency Definition can be configured by a tenant, typically the OEM
For more information, see Tenant.

The required permission set is Organization:Admin to edit and delete sets of metrics used in efficiency definitions, see Organization Subject.

Configure Efficiency Definitions¶

We begin by creating an efficiency definition. You can do this by selecting Settings > Machine Data Management> Efficiency Definitions and clicking on the Create New button in the top right corner to open the configuration dialog.

#	Item	Description
1	Label	Definition title.
2	Work Group	Signal group that will be calculated for the active operation state of the machine.
3	Signal and Color	Signals chosen as part of the work group. Color designation of the signal.
4	Add Signal	Increase the number of signals used in the group.
5	Idle Group	Signal group that will be calculated for the inactive operation state of the machine.

Once you have configured the efficiency definition, click the Apply button at the bottom of the dialog. You can now see the newly created definition available from the Efficiency control panel.

Glossary¶

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 subject to ISO 15143-3.

There are 2 AEMP interfaces at Proemion that allow

to export information out of our DataPlatform in the AEMP standard way, see also AEMP API.
to pull information into our DataPlatform from 3rd party systems, helping our customers to have all their data in one place. Contact your account manager if you want to get more information on or make use of the Mixed Fleet.

Aggregation¶

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

Note

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

Communication Unit¶

The Communication Unit (CU) is the hardware device - in principle the CANlink mobile series - manufactured by Proemion. The CU is installed, brought online, undergoes configuration and interfaces directly with the DataPlatform via the REST API or the DataPortal.

Dashboard¶

Visualization of machine details like location and other signals on a model/machine level or organization level.

Device¶

The Device is the physical hardware component of the communication unit. This component can be installed, brought online or taken offline.

Geo Data¶

Track

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

The user can see similar tracks using the Machine Map widget.

Machine¶

The machine referred to in our documentation is the vehicle where the device is installed.

Model¶

The collection of features, functionality or characteristic (i.e. small, medium, large) that differentiates a type of machine from another.

Online Mode¶

The Online mode replaces the previously separate Logging and Realtime modes that are only used in some legacy devices. The Online mode connection type combines the functionality of both Logging and Realtime modes. For further information read the section Connection Types.

Organization Units¶

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

Tenant¶

Note

With the Business Units Concept, the first OEM organization in an organization tree automatically becomes its tenant. There is no separate, manually assignable tenant flag.

The tenant is typically the machine manufacturer and thus also the higher-level administrative organizational unit containing most of the organizational assets and configurations. Assets managed at the tenant are Models, PDCs, Signal Catalog, Dashboards, Configuration Bundles, Efficiency Definitions, Machine Share Definitions, Asset Types, VIN/PIN uniqueness, Themes, OEM Name, and Legal Documents.

A tenant organization unit must be of Organization Type OEM and cannot have another tenant above it, i.e. must be a parent organization.

Revoking tenancy is not possible, respectively, revoking tenancy is possible only for newly created organizations.

Time Series Data¶

The following options described are used for time series data selection in the Reports.

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. When configuring Reports, the bucket Second can be selected, if the time range is below 3 hours, i.e. 2h 59 minutes or less, when combined with time range Absolute:

Aggregation¶

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.

Time series data handling¶

You can use the CANlink® mobile to send measured data of signal values via CAN messages from the CAN bus to the DataPlatform
Consider that signals with the same timestamp in one CAN message are stored into individual time-series entries and thus lose their "link" they have in the CAN message
The workflow is as follows:

The signals, i.e. their values, are logged/sent within 1 second, i.e. they get the same time stamp in the CAN message.
The DataPlatform then parses the message by signal first.
When the recorded signals get stored in the long-term database, a de-duplication takes place in the database and redundant values with equal time stamps get deleted
In detail, the first appearance of the signal will be stored, and other entries with the same time stamp and value of that signal will be deleted. Entries with the same timestamp and different values will be retained.

In case you need structured data access similar to tables, you could implement the following workarounds:

Transferring the tables as a file using the CANopen file transfer function, see also File Transfer
The files then can be retrieved via the REST API.
Limiting the rate of transmitting the "table row" CAN messages to an interval >1 sec to ensure different timestamps for the rows but consistent timestamps for the measurement values.
Implementing a DataPump Service to get all measurement values as they are received
For more information, contact our Service and Support.

Service and Support¶

The latest versions of the drivers, software, firmware, and documentation are available at Document Library.

Do you need help or want to report a bug?
Visit Proemion for more information, or raise a ticket via Support.

Firmware Updates and Support¶

To ensure the best performance and security of your devices, we strongly recommend always installing the latest firmware provided by Proemion.

Please note:

We do not provide technical support for issues caused by outdated firmware.
Errors resulting from outdated firmware are considered non-qualified errors and are not covered by warranty or support.

Regular firmware updates are essential to maintaining the functionality of your devices.
If you need assistance with the update process, please contact our Service and Support.

For more information on the Firmware Update, check the device manual of your device at the Document Library.

DataPortal User Manual for SMB

General¶

Introduction

Audience¶

Browser¶

Browser Troubleshooting¶

Login Page¶

Alias Email¶

Alternative method for alias email¶

Password Policy¶

Password Reset¶

Permissions¶

Levels¶

Subjects¶

Subject Descriptions¶

Assignment Subject¶

Contract Subject¶

Dashboard Subject¶

ECU Subject¶

Location Subject¶

Maintenance Task Subject¶

Operational Subject¶

Organization Subject¶

Realtime Subject¶

Report Subject¶

Tenant Subject¶

Theme Subject¶

GeoArea Subject¶

Personal User Settings¶

Date & Time¶

Lab Mode¶

Numbers Formatting¶

Notifications

Subscribe to DataPortal Notifications¶

DTC Notification¶

Notification Content¶

Subscribe to DTC Notifications¶

Threshold Notification¶

Severity Levels¶

Samples¶

Subscribe to Thresholds Notifications¶

Left-side Menu¶

Search¶

Recent Search¶

Search within Map¶

Hierarchical Geo Data¶

Table Options¶

Sort and Filter Table¶

Resize Columns¶

Export Table¶

Important note on rounding¶

Dashboards

Organization Dashboard¶

Organizations¶

Filter by Organizations¶

View as¶

Page Layouts¶

Model Dashboard¶

Machine Model¶

Concept¶

Machines Overview

Machines Overview¶

Filters and Options¶

List and Map Synchronization¶

Reset Icon¶

Filters¶

Table Options¶

3-dots Menu¶

Copy & Share location¶

Copy address¶

Copy coordinates¶

Share static location and Share live location¶

Stop Sharing a Location¶

Map¶

List¶

Signal Overview Panel¶

Unknown Machine Location¶

Machine Page

Introduction¶

Requirements¶