Asset data models

The data models of the core components of IBM® IoT Connected Vehicle Insights are designed and optimized for specific business logic objectives. To handle these objectives, the data models of the Vehicle Data Hub (VDH), Context Mapping, Agent system, and Asset Management components differ slightly from each other. To ensure that the data can successfully flow throughout the components of IBM IoT Connected Vehicle Insights, some data mapping is required for each service instance. Information is provided for mapping the Asset Management component, which uses the IBM Maximo®Asset Management data model, to the IBM IoT Connected Vehicle Insights Java™ data model.

The following tables show how the Maximo Asset Management data model is mapped to the IBM IoT Connected Vehicle InsightsJava™ data model.

Vehicle data model mappings

Asset attribute Asset data type Vehicle attribute Data type Remarks
ASSET.SITEID:ASSET.ASSETNUM or ASSET.IOTCVALTMOID ALN vehicle_id String To form the vehicle ID, both the SITEID and ASSETNUM attributes are concatenated, and separated by a colon (:) character. When the attribute IOTCVUSEALTID is set to true, specify IOTCVALTMOID as the vehicle ID.
ASSET.STATUS ALN status String None
ASSET.ASSETUID BIGINT n_vehicle_id Long None
ASSET.IOTCVTYPE ALN vehicle_type Integer Convert to an integer, by using the internal value of the synonym domain from the external value. For more information, see the related link at the end of the topic.
ASSET.IOTCVUSAGE ALN vehicle_usage Integer Convert to an integer, by using the internal value of the synonym domain from the external value. For more information, see the related link at the end of the topic.
ASSET.IOTCVWIDTH INTEGER vehicle_width Integer None
ASSET.IOTCVHEIGHT INTEGER vehicle_height Integer None
ASSET.IOTCVMODEL ALN vehicle_model String None
ASSET.SERIALNUM ALN vehicle_serial_number String None
ASSET.ASSETUSERCUST.PERSON.PERSONUID BIGINT n_driver_id Long None
ASSET.ASSETUSERCUST.PERSONID UPPER driver_id String None
ASSET.PLUSPCUSTOMER.PLUSPCUSTOMERID BIGINT n_tenant_id Long When null in asset data, the value is set to "0".
ASSET.PLUSPCUSTOMER.CUSTOMER UPPER tenant_id String When null in asset data, the value is set to "public".
ASSET.SITE.SITEUID BIGINT region_id Integer None
ASSET.IOTCVMAP.IOTCVMAPID BIGINT map_id Long None
ASSET.IOTCVMAP.VENDOR ALN map_vendor_name String None
ASSET.IOTCVMAP.VERSION ALN map_version String None
ASSET.ASSETSPEC.ATTRID or ASSET.ASSETSPEC.ATTRID:ASSET.ASSETSPEC.SECTION ALN props.key String When the SECTION attribute is set to null, the key is generated by the ASSETSPEC.ATTRID attribute. Otherwise, to form the key, the ATTRID, and SECTION attributes are concatenated, and separated by a colon (:) character.
ASSET.ASSETSPEC.ALNVALUE or ASSET.ASSETSPEC.TABLEVALUE or ASSET.ASSETSPEC.NUMVALUE ALN or DECIMAL props.value String The NUMVALUE attribute is converted to a string.
ASSET.CHANGEDATE DATETIME last_modified Timestamp None
ASSET.ASSETNUM ALN assetnum String None
ASSET.SITEID ALN site_id String None
ASSET.IOTCVHWVER ALN hardwareversion String None
ASSET.IOTCVFWVER ALN firmwareversion String None
ASSET.ASSETTYPE ALN assettype String None

Driver data model mappings

Asset attribute Asset data type Driver attribute Data type Remarks
PERSON.PERSONID UPPER driver_id String None
PERSON.PERSONUID BIGINT n_driver_id Long None
PERSON.DISPLAYNAME ALN driver_name String None
PERSON.STATUS ALN status String None
PERSON.SITE.SITEUID BIGINT region_id Long None
PERSON.IOTCVCHANGEDATE DATETIME last_updated Timestamp None
PERSON.PLUSPCUSTOMER.PLUSPCUSTOMERID BIGINT n_tenant_id Long When null in asset data, the value is set to "0".
PERSON.PLUSPCUSTOMER.CUSTOMER UPPER tenant_id String When null in asset data, the value is set to "public".

GIS map data model mappings

Asset attribute Asset data type Map attribute Data type Remarks
IOTCVMAP.IOTCVMAPID BIGINT map_id Long None
IOTCVMAP.DEFAULTMAP YORN default_map Boolean None
IOTCVMAP.VERSION ALN map_version String None
IOTCVMAP.VENDOR ALN map_vendor_name String None
IOTCVMAP.PREVIOUSMAPID Long prev_map_id Long None
IOTCVMAP.FORMAT ALN map_format String None
IOTCVMAP.FILE ALN map_file String None
IOTCVMAP.URL ALN map_url String None
IOTCVMAP.VEHICLES BIGINT num_of_vehicle Integer None
IOTCVMAP.CHANGEDATE DATETIME last_modified Timestamp None
IOTCVMAP.CREATEDATE DATETIME created_time Timestamp None
IOTCVMAP.ORGID ALN None None Required in Maximo Asset Management but not used in Dynamic Map Manager (DMM) and the Vehicle Data Hub (VDH).

Event type data model mappings

Asset attribute Asset data type Event Type attribute Data type Remarks
ASSETATTRIBUTE.ASSETATTRIBUTEID BIGINT event_type_id Long None
ASSETATTRIBUTE.ASSETATTRID UPPER event_type String None
ASSETATTRIBUTE.DESCRIPTION ALN event_desc String None
ASSETATTRIBUTE.IOTCVCATEGORY ALN event_category String None
ASSETATTRIBUTE.IOTCVAFFECTTYPE ALN event_affected_type Integer Convert to an integer, by using the internal value of the synonym domain from the external value. For more information, see the related link at the end of the topic.

Tenant data model mappings

Asset attribute Asset data type Tenant attribute Data type
PLUSPCUSTOMER.CUSTOMER UPPER tenant_id String
PLUSPCUSTOMER.PLUSPCUSTOMERID BIGINT n_tenant_id Long
PLUSPCUSTOMER.IOTCVPLAN ALN plan String

Rule data model mappings

Asset attribute Asset data type Rule attribute Data type Remarks
IOTCVRULE.RULENUM UPPER rule_name String None
IOTCVRULE.IOTCVRULEID BIGINT rule_id Long None
IOTCVRULE.TYPE ALN rule_type Integer Convert to an integer, by using the internal value of the synonym domain from the external value. For more information, see the related link at the end of the topic.
IOTCVRULE.DESCRIPTION ALN rule_desc String None
IOTCVRULE.PLUSPCUSTOMER.PLUSPCUSTOMERID BIGINT n_tenant_id Long When set to null in asset data, the value is set to "0".
IOTCVRULE.PLUSPCUSTOMER.CUSTOMER UPPER tenant_id String When set to null in asset data, the value is set to "public".
IOTCVRULE.RULE CLOB rule_xml String None

More information

For more information about the IBM IoT Connected Vehicle Insights asset data model, see Synonym domains.