Help with defining handles, specification by family

• Tutorial

Tutorial

This tutorial describes how to set up a common data schema for equipment belonging to the same family, as well as the mechanisms to easily create multiple instances from this schema, using an Office script.

Although it is possible to define different handles for equipment within the same family, It is not uncommon to want to formalize an identical data schema for equipment belonging to this family.

In this tutorial, we'll see how, using an Office script (prerequisite: access to an Office subscription), It is possible to simplify the definition of equipment families as well as the creation of different instances of equipment from the same family, while being able to specify the particularities of each.

Prerequisites: Import the instantiation automation script into Excel

In order to be able to use the features presented in the rest of this tutorial, you need to download:

• The basic Excel Immersive declaration file: Immersive-FichierExemple.xlsx
• The automation Excel script at this address: XXX

Once downloaded, open the basic Immersive Excel file and then import the automation script by clicking Automatiser > Tous les scripts > Afficher plus de Scripts > Immersive – Instanciation.osts > Ouvrir.

The script is now added to your workbook and can be run later.

Declaration of a new equipment family

An asset family represents a group of assets that share a common structure or behavior.

For example, all temperature sensors in a building have one temperature variable and another as long as the doors have a variable representing whether they are open or closed.

Example: Defining a New Equipment Family

In our example, we will therefore declare a new family "Temperature sensor", to do this, simply duplicate the "New Family" sheet of our basic Immersive Excel and rename it to "Temperature Sensor".

Once duplicated and renamed, our Excel sheet exposes the different columns that allow To declare new variables associated with the different sensors.

Adding Variables to a Family

Each row in a family's sheet represents a variable, and each column represents a data associated with this variable. (The values in red represent the mandatory data to be reported for a variable, the others in black remain quite optional).

• Property : The name of the variable
• Property reference : A business code
• Interoperability ID
• Path / Chemin
• Type
• Physical Quantity
• Unit
• Automatic status
• Options
• Badge / Criticality
• Priority

Example: Definition of 2 variables

Creating Device Instances

An asset instance represents a piece of equipment in a family, for example, the temperature sensor in the bedroom or the temperature sensor in the living room.

To specify a new instance, simply go to the "Instances" Excel sheet.

Each row in the instance sheet represents a new equipment instance and each column represents a piece of data associated with that equipment.

Example: Creating 2 Asset Instances

Script execution

Once the families and instances are defined, simply run the automation script, which will merge the definitions of instances with the definitions of families.

To run the script, make sure you are in the Automatiser and click on Executer.

The result of the build can be found in the Data.

Once this step has been completed, it is possible to import the equipment From the immersive back office as explained in this tutorial: link to Excel import

Additional Column Specification

It is quite common to have to set specific values for instances. In order to meet this need, simply add a column in the instance sheet.