Asset Onboarding¶

The Bx onboarding process involves creating assets in Lifecycle Twin or Data Setup, or mapping existing assets.

Mappable Entities¶

Scenario 1: Lifecycle Twin configured, No data in Data Setup¶

In this scenario, Lifecycle Twin (LCT) contains the building structure hierarchy (buildings, floors, rooms) and components. Typically, data comes from a BIM model, which is then cleaned up and enriched in LCT. There is no building structure data in Data Setup

Onboarding Steps¶

1. query data from Lifecycle Twin
2. create entity in Data Setup
3. map created entity with the existing LCT entity

Data should be created in the following order: Building -> Floor -> Room -> Equipment.

Endpoints to query building assets can be found on the asset management page

    {"in":{"Category.Id":["id1", "id2", "idN"]}}

To create a building structure in Data Setup, refer to the Building Structure API

After an asset has been created in Bx, obtain the ID of the created entity. Use this ID to map the LCT asset with the Bx asset.

To map an asset, update the LCT entity and set the property BxEntityId with the ID of the created entity in Data Setup.

Example

PUT /facilities/{facilityId}

Headers:

Body:

{
    "BxEntityId": "45902784-c0e8-430c-87fe-1454dd82b88c"
}

Specification and schema can be found in the API Reference

After creating equipment, in Data Setup application the equipment needs to be mapped with points

Scenario 2. Data Setup configured, Lifecycle Twin is not¶

This scenario assumes that the building structure is already configured in Data Setup, but LCT is empty, and the customer does not intend to use a BIM model.

The steps are the similar to the Scenario 1, but the data needs to be queried from Data Setup and created in Lifecycle Twin

To query a building structure in Data Setup, refer to the Building Structure API

To create and asset in Lifecycle Twin use the relevant POST endpoint, described on the asset management page.

Example of building creation

POST /facilities

Headers:

Body:

{
    {
    "Name": "Building 1",
    "Description": ""    
}
}

In case of successful creation, Id of the newly created asset will be returned:

{
    "Value": "5696bfb4-f07f-4b59-94d0-ba30dd4ede34"
}

Use this Id to map the existing Bx asset with the LCT asset, using the PUT request, described in the Scenario 1

Same Id must be used to create the child assets, for example, to create Component, Building Id as well as Room Id needs to be passed.

{
    "Name": "AC-OU-1",
    "Facility": {
        "Id": "c1920de1-30a8-4d5f-a7a7-88a3a22df115"
    },
    "Locations": [
        {
            "Id": "9540ce11-48a2-4cf5-ac3a-b2ebf324abd2"
        }
    ],
    "CustomFileds": [
        {
            "Id": "c1920de1-30a8-4d5f-a7a7-88a3a22df115",
            "Value": "Poor"
        }
    ]
}

Scenario 3¶

Data Setup and Lifecycle Twin are both configured and have some building structure and equipment/components.

Data Setup is considered as master source. The scenario doesn't assume any asset creation. The existing entities needs to be mapped.

Typical workflow:

• query all building from Data Setup
• find corresponding buildings in LCT. It can be found based on name or any other available property in both systems. Exact fields depends on the data quality and customer's configuration
• map the Bx building with Lifecycle Twin building, using the PUT request, as described in Scenario 1
• Do the same steps with other entities: floors, rooms, components

Refer to the asset management page and Building Structure API to query the data from both systems