Asset Manager en
Asset Manager en
___________________
Introduction to "Asset
___________________
Manager" 2
___________________
Data model in "Asset
Manager" 3
MindSphere
User interface "Asset
Manager" 4
Asset Manager ___________________
User Rights in "Asset
5
Manager"
___________________
Tenants and subtenants in
"Asset Manager" 6
System Manual
7
___________________
Workflow for creating assets
8
___________________
Creating aspects
9
___________________
Using types
10
___________________
Creating assets
Configuring MindConnect
Element plugin 11
03/2019
V1801.Mar/2019.1
Legal information
Warning notice system
This manual contains notices you have to observe in order to ensure your personal safety, as well as to prevent
damage to property. The notices referring to your personal safety are highlighted in the manual by a safety alert
symbol, notices referring only to property damage have no safety alert symbol. These notices shown below are
graded according to the degree of danger.
DANGER
indicates that death or severe personal injury will result if proper precautions are not taken.
WARNING
indicates that death or severe personal injury may result if proper precautions are not taken.
CAUTION
indicates that minor personal injury can result if proper precautions are not taken.
NOTICE
indicates that property damage can result if proper precautions are not taken.
If more than one degree of danger is present, the warning notice representing the highest degree of danger will
be used. A notice warning of injury to persons with a safety alert symbol may also include a warning relating to
property damage.
Qualified Personnel
The product/system described in this documentation may be operated only by personnel qualified for the specific
task in accordance with the relevant documentation, in particular its warning notices and safety instructions.
Qualified personnel are those who, based on their training and experience, are capable of identifying risks and
avoiding potential hazards when working with these products/systems.
Proper use of Siemens products
Note the following:
WARNING
Siemens products may only be used for the applications described in the catalog and in the relevant technical
documentation. If products and components from other manufacturers are used, these must be recommended
or approved by Siemens. Proper transport, storage, installation, assembly, commissioning, operation and
maintenance are required to ensure that the products operate safely and without any problems. The permissible
ambient conditions must be complied with. The information in the relevant documentation must be observed.
Trademarks
All names identified by ® are registered trademarks of Siemens AG. The remaining trademarks in this publication
may be trademarks whose use by third parties for their own purposes could violate the rights of the owner.
Disclaimer of Liability
We have reviewed the contents of this publication to ensure consistency with the hardware and software
described. Since variance cannot be precluded entirely, we cannot guarantee full consistency. However, the
information in this publication is reviewed regularly and any necessary corrections are included in subsequent
editions.
Asset Manager
System Manual, 03/2019, V1801.Mar/2019.1 3
Asset Manager is a component of MindSphere, the industrial IoT platform from Siemens. In
the Asset Manager, you model the structure of an industrial process using assets, types and
aspects.
The following video shows a short introduction for Asset Manager:
Asset Manager
System Manual, 03/2019, V1801.Mar/2019.1 4
Document history 1
Version Date Changes Link
V1801.Mar/2019.1 2019-03-11 Added link to MindConnect Introduction MindConnect
Lib firewall/proxy settings. LIB (Page 33)
Added open asset in Fleet User interface "Asset Man-
Manager in user interface. ager" (Page 10)
Added new image browser "Types" user interface
function in type user inter- (Page 22)
face.
Added new chapter "Creat- Creating a new type
ing a new type". (Page 28)
Added new screenshot for User interface "Asset Man-
basic settings of assets. ager" (Page 10)
V1801.CW.EU1.K1203 2018-12-03 Update of screenshots of User Rights in "Asset Man-
user interfaces. ager" (Page 12)
"Aspects" user interface
(Page 17)
User interface "Asset Man-
ager" (Page 10)
"Types" user interface
(Page 22)
Update of user rights table. User Rights in "Asset Man-
ager" (Page 12)
Added classification notice to Creating an asset (Page 31)
create asset section.
Added aspect configuration Creating aspects (Page 16)
size limit.
V1801.CW.EU1.K1113 2018-11-13 Update of "Aspect user inter- "Aspects" user interface
face" and parameter table (Page 17)
with the following new pa-
rameter:
• Dynamic aspects
• Static aspects
• Default value
The how to connect a Mind- MindConnect Nano/IoT
Connect Element section 2040 plugin (Page 33)
was removed. You can find
the detailed steps in the
Getting Connected docu-
mentation.
Asset Manager
5 System Manual, 03/2019, V1801.Mar/2019.1
Document history
Asset Manager
6 System Manual, 03/2019, V1801.Mar/2019.1
Introduction to "Asset Manager" 2
Asset Manager is a component of MindSphere, the industrial IoT platform from Siemens. In
Asset Manager you model the structure of an industrial process using assets, types and
aspects.
Asset Manager offers the following functions for this:
● Create and configure assets
● Generate templates for assets and aspects (so-called "types")
● Create aspects and variables for data evaluation
● Using plugins to connect MindConnect elements with MindSphere ("onboarding")
● Define data sources and data points in MindConnect plugins
● Link data sources with aspects and variables ("data mapping") in MindConnect plugins
Note
How to get started
You can find a detailed example scenario on how to connect MindConnect devices and
configure Asset Manager in the document Getting Connected to MindSphere
(https://documentation.mindsphere.io/).
Asset Manager
System Manual, 03/2019, V1801.Mar/2019.1 7
Data model in "Asset Manager" 3
This chapter describes the data model of Asset Manager within MindSphere. The data model
will show you what processes are necessary to connect and use your asset data in
MindSphere.
Definition asset
An asset is a digital representation of a machine or an automation system with one or
multiple automation units (e.g. PLC) connected to MindSphere.
MindSphere data collection and data provisioning is based on so called (virtual) assets. This
can be anything like a pump, motor, PLC, an entire tool machine, a production line, a robot,
a crane, a car, a windmill and so on. The data of an asset is collected and sent to
MindSphere to make that data available for further processing and analytics.
Definition aspect
Aspects are a data modeling mechanisms for assets. Aspects group related data points
based on their logical association. For example: The pump skid has an aspect e.g.
"Energy_consumption" that contains the datapoints: "power", "current", "voltage" etc. Aspect
is specified in Asset Manager and its name can be freely chosen, but should have
conjunction to datapoints and a physical asset. An aspect can consist of several variables.
Asset Manager
8 System Manual, 03/2019, V1801.Mar/2019.1
Data model in "Asset Manager"
Data model
The following graphic shows the data model in Asset Manager:
In Asset Manager devices like MindConnect Nano are defined as the data source. The
device sends data points to MindSphere. These data points must be connected to the
aspects and variables. Asset Manager uses aspects and variables as data containers.
Within MindSphere you add data points to a data source to collect the data, for example from
a control unit. In the next step you have to link the data points to the respective variables of
an aspect.
You can set the data mapping in the MindConnect Element plugin (Page 33).
To enable data connecting and in order to use your data in MindSphere you have to fulfill the
following processes:
● Onboarding: Onboarding is the process of attaching a MindConnect Element to
MindSphere.
● Data mapping: Data mapping matches variables of an aspect with the respective data
points of a data source.
Asset Manager
System Manual, 03/2019, V1801.Mar/2019.1 9
User interface "Asset Manager" 4
You operate Asset Manager using the "navigation area", the "selection list" and the "asset
detail view".
Asset Manager
10 System Manual, 03/2019, V1801.Mar/2019.1
User interface "Asset Manager"
Start Screen
① Navigation area
② Parent asset
③ Creates a new asset
④ Search entry
⑤ Selection list
⑥ Hierarchy
⑦ Asset detail view
⑧ Operating tools
⑨ Advanced operating tools:
• Move asset
• Open selected asset in Fleet Manager in a new tab
• Delete asset
Asset Manager
System Manual, 03/2019, V1801.Mar/2019.1 11
User Rights in "Asset Manager" 5
The user rights depend on the following default roles:
● TenantAdmin
● StandardUser
● SubtenantUser
The following table shows the permissions:
Right Role
TenantAdmin StandardUser SubtenantUser
Delete assets ✓
Delete assets of type BasicHierarchy ✓ ✓ ✓
and derived
Create assets in tenant2) ✓ ✓
Create assets in subtenant2) ✓ ✓ ✓
Edit assets in tenant ✓ ✓
Edit assets in subtenant1) ✓ ✓ ✓
Move assets in tenant ✓ ✓
Move assets in subtenant1) ✓ ✓ ✓
Add child assets ✓ ✓
Add child assets in subtenant1) ✓ ✓ ✓
Navigate to Fleet Manager ✓ ✓ ✓
Create types in tenant ✓
Create types in subtenant ✓
Edit types ✓
Delete types ✓
Create aspects in tenant ✓
Create aspects in subtenant ✓
Edit aspects ✓
Delete aspects ✓
Set values for direct variables ✓
1) Subtenants can move and edit assets of type BasicHierarchy and derived including (Geo) location
on all assets.
2) StandardUser and SubtenantUser can only create assets of type BasicHierarchy and derived.
Asset Manager
12 System Manual, 03/2019, V1801.Mar/2019.1
Tenants and subtenants in "Asset Manager" 6
6.1 Using subtenants in "Asset Manager"
You can access Asset Manager as a tenant or a subtenant. You find more information about
tenants and how to create a subtenant in the Settings documentation
(https://documentation.mindsphere.io/resources/html/settings/en-US/index.html).
A subtenant allows an isolated data view on assets for customers of a tenant. Furthermore,
the tenant admin is in charge of creating assets for the subtenant or moving some assets
from the tenant to the subtenant. A subtenant groups users that can only access assets that
are explicitly assigned to the subtenant.
Delete subtenants
You can delete a subtenant in Settings or with the Tenant Management Service API.
A tenant can delete a subtenant. The subtenant users then have no access to the subtenant.
The subtenant and the asset structure of the subtenant will still displayed in the user
interface. The tenant can then move or delete the assets.
Asset Manager
System Manual, 03/2019, V1801.Mar/2019.1 13
Tenants and subtenants in "Asset Manager"
6.1 Using subtenants in "Asset Manager"
Finally, every subtenant user sees the assigned asset with the sensor data of the wind
turbines in Mindsphere.
Asset Manager
14 System Manual, 03/2019, V1801.Mar/2019.1
Workflow for creating assets 7
In Asset Manager, an asset is based on a type. The type consists of aspects and variables.
In order to use your data in MindSphere you have to create an asset for the onboarding
process. This asset represents the data connection to your MindConnect Element in Asset
Manager. Within this asset you have to proceed with data mapping to use your data as
aspects and variables. With this step you enable the data connection to your physical asset.
You can find more information about the data model in chapter Data model in "Asset
Manager" (Page 8).
To enable data mapping, you have to use an asset type that is based on a core type. The
core type contains a plugin to enable the data connection to MindSphere. You can find more
information about types in chapter Using types (Page 21).
Once the aspects and variables are linked to a MindConnect Element, they can be used for
several assets.
To configure your custom asset, you have to create your own type with the required aspects
and variables. Subsequently you can derive your custom asset from this type.
Asset Manager
15 System Manual, 03/2019, V1801.Mar/2019.1
Creating aspects 8
Within the "Aspects" tab you can create aspects with variables. An aspect can consist of
several variables. In Asset Manager every aspect has a name and a specific ID. Once an
aspect has been created, it can be used for multiple assets. The maximum configuration size
of an aspect is 200,000 bytes.
Asset Manager
16 System Manual, 03/2019, V1801.Mar/2019.1
Creating aspects
8.1 "Aspects" user interface
Start screen
You operate the "Aspects" user interface using the "navigation area", the "selection list" and
the "detail view". In the "Aspects" tab you can create aspects with variables.
① Navigation area
② Creates a new aspect
③ Search field entry
④ Selection list
⑤ Detail view
⑥ Edit or delete aspect
Asset Manager
System Manual, 03/2019, V1801.Mar/2019.1 17
Creating aspects
8.1 "Aspects" user interface
① Aspect information
② Choose aspect category
③ Opens a new bar to add variable to aspect
④ Deletes variable from aspect
⑤ Variable details
⑥ Saves or cancel changes
Note
Edit aspect information and variable
Once you have created the aspect information, you cannot rename and edit the Type ID,
Name and the Description.
Once you have saved the variables, you cannot remove or edit the variable.
Asset Manager
18 System Manual, 03/2019, V1801.Mar/2019.1
Creating aspects
8.1 "Aspects" user interface
Parameter Description
Type ID ID of the aspect in the format [Tenant prefix].[Aspect name].
Name Name of the aspect.
Description Description of the aspect.
Choose category Select one of the following options:
• Dynamic: Dynamic aspects are used for time series data, e. g. power consumption.
• Static: Static aspects data are used for static data, e. g. serial number of an asset.
Variable name Name of the variable. It is not allowed to use the following variable name:
• aspects
• description
• etag
• externalId
• extends
• hierarchyModel
• id
• legalName
• name
• organizationType
• tenant
• parentTypeId
• properties
• propertySets
• sameAs
• scope
• url
• variables
Furthermore the variable name must not start with a number and has to be alphanumeric. The
variable name has also to be unique within the aspect.
Data type • BOOLEAN: Variable that stores one of two possible values: true (TRUE) or false (FALSE)
• INT: Variable that stores an integer up to 32 bits.
• LONG: Variable that stores an integer up to 64 bits.
• DOUBLE: Variable that stores a decimal up to 64 bits.
• STRING: Variable that stores a string up to 255 characters (usually text).
• BIG_STRING: Variable that stores a string up to 100,000 characters.
• TIMESTAMP: Variable that stores a time value. This variable needs to be entered in the fol-
lowing format: [YYYY-MM-DDTHH:MM:SS+hh:mm]
With "Static" the data type BIG_STRING is not available. You can set default values that are vali-
dated according to the data type and length (for string values).
Unit Unit of variable.
Asset Manager
System Manual, 03/2019, V1801.Mar/2019.1 19
Creating aspects
8.2 Creating a new aspect
Parameter Description
Maximum length Maximum length of the variable value (only with data type "STRING" and "BIG_STRING").
Default value Default values are only available for a static aspect. Default values can be predefined values from
manufacturers, e. g. maximum rotation speed and are validated according to datatype and length.
Note
Variable data
The input fields of the variable details validate the content. You can activate the input check
for example with <Enter>. If the entry is not valid the edit box is marked red and a message
appears when clicking in the edit box.
Asset Manager
20 System Manual, 03/2019, V1801.Mar/2019.1
Using types 9
9.1 Introduction to using types
A type is a pre-configured template for an asset. Assets take on the properties of the type on
which they are based. Within the type you can define which aspects are integrated into the
template.
With a type you can create a template, for example, for several wind turbines and then link
them to your aspects. When creating a new asset, you can use the created type.
To make it easier to identify your type, you can import images up to 5 MB in size. You can
choose from an image list all images uploaded to the tenant.
Type variables
Within types you can also define and use variables. With the type variables you can store
and use asset values which are not time series specific.The following list shows examples of
possible asset values:
● Serial number of the asset
● Date of installation
● Date of last maintenance
● Color
● Width, length and height
● Revision-number of the asset
The type variable can be used as an additional identifier for your asset. You will see the type
variable in the asset basic settings of the "Asset" tab. In the basic settings, you can set a
new value or reset to the default value by clearing the set value.
Th following image shows the variable input field in the asset basic settings:
Asset Manager
21 System Manual, 03/2019, V1801.Mar/2019.1
Using types
9.2 "Types" user interface
Start screen
You operate the "Types" user interface using the "navigation area", the "selection list" and
the "detail view of type".
① Navigation area
② Creates a new type
③ Search field entry
④ Selecting list
⑤ Type hierarchy
⑥ Detail view of type
Asset Manager
22 System Manual, 03/2019, V1801.Mar/2019.1
Using types
9.2 "Types" user interface
⑦ • Edit type
• Add derived type
• Delete type
Asset Manager
System Manual, 03/2019, V1801.Mar/2019.1 23
Using types
9.2 "Types" user interface
① Type information
Asset Manager
24 System Manual, 03/2019, V1801.Mar/2019.1
Using types
9.2 "Types" user interface
② Image navigation:
• Open a local explorer to add an image
• Delete the image
• Browse already on the tenant uploaded images
③ Opens a new bar to add variable to aspect
④ Variable details
⑤ Deletes variable from type
⑥ Adds an aspect to type or open a window to browse aspects
⑦ Aspect details
Note
Edit type information
Once you have created the type information, you cannot rename and edit the Parent Type,
Type ID, Name and the Description.
Parameter Description
Parent type Parent type according to the hierarchical structure.
ID ID of the type in the format [Tenant prefix].[type name].
Name Name of the type.
Description Description of the type.
Asset Manager
System Manual, 03/2019, V1801.Mar/2019.1 25
Using types
9.2 "Types" user interface
Parameter Description
Variable name Name of the variable. It is not allowed to use the following variable name:
• aspects
• description
• etag
• externalId
• extends
• hierarchyModel
• id
• legalName
• name
• organizationType
• tenant
• parentTypeId
• properties
• propertySets
• sameAs
• scope
• url
• variables
Furthermore the variable name must not start with a number and has to be alphanumeric. The
variable name has to be unique and differ from aspect name .
Data type • BOOLEAN: Variable that stores one of two possible values: true (TRUE) or false (FALSE)
• INT: Variable that stores an integer up to 32 bits.
• LONG: Variable that stores an integer up to 64 bits.
• DOUBLE: Variable that stores a decimal up to 64 bits.
• STRING: Variable that stores a string up to 255 characters (usually text).
• BIG_STRING: Variable that stores a string up to 100,000 characters.
• TIMESTAMP: Variable that stores a time value.
Unit Unit of variable.
Maximum length Maximum length of the variable value (only with data type "STRING" and "BIG_STRING").
Default value Default value is validated by the data type
Aspect name Name of the aspect. You can find more information about aspects in chapter Creating aspects
(Page 16).
Aspect type Choose aspect type for respective aspect from dropdown menu. You can find more information
about aspects in chapter Creating aspects (Page 16).
Asset Manager
26 System Manual, 03/2019, V1801.Mar/2019.1
Using types
9.3 Predefined types
Note
Inline editing
After entering an entry to the variable details, you have to validate it. You validate the entry
for example with <Enter>. If the entry is not valid the edit box is marked red and a message
appears.
Type Application
BasicAgent Template for creating agent-based assets. You can use this template to connect
MindConnect Elements.
BasicApplication Template for creating application-based assets. You can use this template to
connect other applications.
BasicDevice Template for creating device-based assets.
BasicHierarchy Template for creating hierarchy-based assets.
Within the pre-defined templates, you can create new types and use templates such as
MindConnect Nano.
You can find more information on pre-defined types in the developer documentation
(https://developer.mindsphere.io/apis/advanced-assetmanagement/api-assetmanagement-
references-basictypes.html).
Asset Manager
System Manual, 03/2019, V1801.Mar/2019.1 27
Using types
9.4 Creating a new type
Prerequisite
● You have created an aspect with variables.
Procedure
In order to create a new type, proceed as follows:
1. Click "Types" in the navigation area.
2. To create a new type, click "Create type".
3. Enter a name and description for the type, e. g. "Windturbine".
4. In order to add an image, open the image bar and click "Choose".
Your local file browser opens to select an image.
Note
Image list
In order to browse already uploaded images to your tenant, you can use the image list.
Click "Browse" to open the image list and choose an image to add.
5. In order to add a variable, open the variable bar and click "Add variable".
6. Enter the variable data.
7. In order to add an aspect, open the aspect bar and click "Add aspect".
8. Enter a name for the new type aspect and choose an aspect from the dropdown menu.
Note
Browse aspects
In order to browse all available aspects click "Browse aspects".
• You can select multiple aspects by activating the checkboxes.
• You can create multiple instances of one aspect by entering the number in the input
field.
Result
You have created a type. You can now select this type when creating a new asset in the
"Assets" tab.
Asset Manager
28 System Manual, 03/2019, V1801.Mar/2019.1
Creating assets 10
10.1 "Asset" user interface
You operate assets using the "navigation area", the "selection list" and the "asset detail
view".
① Navigation area
② Creates a new asset
③ Search entry
④ Selection list
⑤ Hierarchy
⑥ Edit basic settings of the asset
⑦ Add a child asset to selected asset
Asset Manager
29 System Manual, 03/2019, V1801.Mar/2019.1
Creating assets
10.1 "Asset" user interface
Basic settings
The basic settings show you the details of your asset's direct variables and aspects:
Asset Manager
30 System Manual, 03/2019, V1801.Mar/2019.1
Creating assets
10.2 Creating an asset
Procedure
In order to create an asset, proceed as follows:
1. Click "Assets" in the navigation area.
2. To create a new asset click .
The asset type overview window is opened.
3. Select the respective asset type for your new asset, e. g. "Windturbine".
4. Enter a name and the data for the asset, e. g. "Windturbine1".
5. Choose the time zone of the asset.
6. Confirm the entries with "Save".
Asset Manager
System Manual, 03/2019, V1801.Mar/2019.1 31
Creating assets
10.2 Creating an asset
Result
The new asset is now available in the selection list.
Asset Manager
32 System Manual, 03/2019, V1801.Mar/2019.1
Configuring MindConnect Element plugin 11
11.1 MindConnect Nano/IoT 2040 plugin
To connect a MindConnect Element you have to configure it with the respective
MindConnect Element plugin. You can find the MindConnect plugin in the asset detail view.
Connecting a MindConnect Element to MindSphere involves the following steps:
Onboarding
● Create asset with MindConnect type
● Create connection to the MindConnect Element
● Perform network configuration
● Onboard with configuration file
Data mapping
● Add data source
● Add data point
● Connecting data point and variable
You can find detailed information for these steps and on how to connect a MindConnect
Element in the Getting Connected documentation.
(https://documentation.mindsphere.io/resources/html/getting-connected/en-US/index.html)
Asset Manager
33 System Manual, 03/2019, V1801.Mar/2019.1
Configuring MindConnect Element plugin
11.2 MindConnect LIB plugin
You can find more information about MIndConnect LIB in the Developer Documentation
(https://developer.mindsphere.io/resources/mindconnect-lib/resources-mclib-overview.html).
More information about firewall and proxy rules can be found in the section Firewall/Proxy
rules for MindSphere (https://documentation.mindsphere.io/resources/html/getting-
connected/en-US/116790679307.html)in the Getting Connected documentation.
Security profile
MindConnect LIB creates secure connectivity from an onsite device to MindSphere.
You can choose between the following security profiles:
● RSA 3072
● Shared Secret
Requirement
● You have created an asset and an aspect.
● You have enabled the connection to the MindConnect LIB.
Procedure
To add a data source to an asset of type MindConnect LIB, follow these steps:
1. Click on the asset in the "Assets" tab, e. g. "Wind turbine".
2. Click on the plugin icon, e. g. "MindConnect LIB".
Asset Manager
34 System Manual, 03/2019, V1801.Mar/2019.1
Configuring MindConnect Element plugin
11.2 MindConnect LIB plugin
Result
You have now created a new data source. The new data source is available at the asset
details of your MindConnect LIB.
Requirement
● You have created a data source.
Procedure
To add a data point to a data source, e. g. "RotationSpeed", follow these steps:
1. Click on the asset in the "Assets" tab, e. g. "Wind turbine".
2. Click on the asset icon, e. g. "MindConnect LIB".
3. To edit the data source you have to click on "Enter edit mode".
– Edit functions appear next to the data source.
4. Click on "Add data point".
5. Enter data point data.
Note
• The units and data types specified here will need to match exactly with the aspects
and variables. If they are different, the variable cannot be connected to the data point.
Result
The new data point is available at the data source.
Asset Manager
System Manual, 03/2019, V1801.Mar/2019.1 35
Configuring MindConnect Element plugin
11.2 MindConnect LIB plugin
Requirement
You have created an asset based on your desired aspect and type.
Procedure
To map a variable to a data point, e. g. "RotationSpeed", follow these steps:
1. Click on the asset in the "Assets" tab, e. g. "Wind tubrine".
2. Click on the MindConnect LIB plugin, e. g. "MindConnect LIB".
3. Click on the tab"Data mappings".
4. Select the data point you want to map and click "Link variable".
The following graphic shows the "Link variable" option:
Asset Manager
36 System Manual, 03/2019, V1801.Mar/2019.1
Configuring MindConnect Element plugin
11.2 MindConnect LIB plugin
5. Select the previously created asset and click "Accept", e. g. "Wind turbine".
Note
• In order to select a different asset click "Change".
• In order to show only compatible assets, you can active the filter "Only compatible".
Asset Manager
System Manual, 03/2019, V1801.Mar/2019.1 37
Configuring MindConnect Element plugin
11.2 MindConnect LIB plugin
Note
Only units and data types that match exactly with the aspects and variables are available.
If they are different, the aspect can’t be connected to the data point(also case sensitive).
Result
The data point is now mapped to the variable.
The following graphic shows a mapped variable:
Asset Manager
38 System Manual, 03/2019, V1801.Mar/2019.1