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

131633735691.png

Navigation area

Creates a new aspect

Search field entry

Selection list

Detail view

Edit or delete aspect

Create new aspect settings

To open the new aspect dialog click 119344113931.png.

133584583691.png

Aspect information

Choose aspect category

  • Add variable: Opens a new bar to add variable to aspect

  • Import variables: Opens local browser to upload a file

  • Delete all: Deletes all created variables

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.

Once you have saved the variables, you cannot remove or edit the variable.

Parameters of new aspect settings

The following table describes the parameters of the new aspect settings:

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

  • tenantFlag

  • tenant

  • parentTypeId

  • properties

  • propertySets

  • sameAs

  • scope

  • sharerTenantID

  • url

  • variables

Furthermore the variable name must not start with a number, has to be alphanumeric and must not end with "_qa" or "_qc". 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 following 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 validated according to the data type and length (for string values).

Unit

Unit of variable.

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.