Introduction
HDC needs to import and export data to/from multiple different data sources like design systems, management systems, electronic and paper documents. This data not only comes in different formats, but also, quite often, different means of identification are used. Identifiers can be incompatible or stored under different property fields.
In HDC, each of such identifiable systems or data sources are called EID. EID is actually a set of rules that describes how the objects should be identified and matched, as well as how to map (translate) their metadata to a common structure in HDC. The mapping works both ways during import and export.
As the import of data shifted from manual procedures to high-volume automated import, it became clear that not only mistakes but simply different object ID rules in various data sources make it necessary to handle multiple ID systems while communicating HDC with external world.
Data inside external domain is not case sensitive.
This means that casing for object classes, class fields and layers names will not be checked.
So for example: source class Arkitekt can be added to HDC External Domain as ARKITEKT and they will be matched as one.
External Information Domains panel
External Information Domains are used to define Object classes, Object Mapping, Layer Mapping and Object Identity rules used by specific external system.
Columns:
- Domain ID - unique ID,
- Name - name of domain,
- Is Live - states if domain points to other online, service configured in Live Data Source tab,
- Public - stated if other HDC functions can use this domain (for example: copy object IDs).
After creation of external domain you can click it's name to see detailed rules for this domain starting from Object Classes tab.
Export and import External Domain configuration
It is now possible to export chosen External Domain Configuration with all it's mapping to file in JSON or XML format.
In TDXM panel, click on External Information Domains panel to get list of all external domains.
Select a domain, than click on Export button and choose file format of export. This will download a file with configuration of selected domain to your disc.
To import domain configuration create new domain, select it and click on Import button to chose file with exported configuration.
- All object classes and their fields from exported domain will be added to new domain on Object Classes tab.
- Entries on Object Mappings tab will only be added when target class/fields are present of course in destination DB (in case import is done in different DB/application)
- Same goes for Global Layers mapping - target global layer must exists.
- All Private layers mapping will be added with set of permissions if same users in destination DB are present as in exported one (matched by username).
- Live Data Source configuration is not exported.
Object Classes tab
The first step in defining an EID configuration is to outline all object classes and their metadata fields in the given external system.
For instance, when importing data from an IFC source, we might have an object called IfcSpace.
Another data source (EID) would be based on the Fi2 standard with a similar object named Fi2Space. Both of these object names would then be mapped (translated) to the same object class in HDC.
Object Mapping tab
In this section, you can define:
Source Class (External) - the source class in external domain data from which the data should be taken
Target Class (HDC) - the class to which the source class object should be mapped
Conditional Field - used to filter objects. For example, when there are multiple objects of the same class with different subtypes stored as field values, they can be mapped to independent classes based on that field and conditional value.
Conditional Value - the value used for filtering
Class Fields Mapping
Source Class (External) - a class containing data; it can be a parent class in the source system.
Source Field - field in the source object (external)
Target Field - field in target object class (HDC)
Boolean values handling
When importing data to Boolean type of field in HDC, we now accepts four pairs:
true/false
yes/no
on/off
1/0
Other (incorrect) values will be omitted and there will be an error in object log regarding this object.
Please also note that in HDC database, values for boolean fields will be saved only as true or false regardless of what was sent.
If the external data source contains graphical information, we can specify how the information stored on specific layers will be handled.
Items stored on a particular source layer can be transferred to one of the Global Layers in HDC and will then adhere to the same rules concerning accessibility and style.
Layer Mapping tab
TDXM has the capability to combine layers from imported packages (source layers) with layers in HDC database (destination layers).
It is possible to merge source layers with global and/or private destination layers. This configuration can be done on the Layer Mapping tab.
There are two panels on this tab:
Global Layers panel
Private Layers panel
They allow the user to define global and private layer mapping respectively.
Global Layers panel
On this panel, one can add or delete global layer mapping definition (see Layers).
Add global layer mapping definition
To add global layer mapping definition:
Press Add button. Global Layer Mapping dialog box will appear on the screen.
Type the name of the source layer to be imported by TDXM in the Source Layer text box.
Select an existing global layer from the Target Global Layer dropdown menu.
Check or leave unchecked the Apply Style option.
Accept your selection.
Apply Style
Individual entities' (spots, spot groups, etc.) styles on the source global layer will be overwritten with the target global layer style.
Before starting, it is necessary to define global layers in the Administration window: Administration/Drawings/Global Layers.
Deleting Global Layer Mapping Definition
To delete a global layer mapping definition, follow these steps:
Select the global layer mapping definition from the list.
Click on the Delete button.
Private Layers Panel
This panel allows users to add or delete private layer mapping definitions (see Layers) and grant permissions for different users to view and edit private layers.
If the system receives a layer that is not mapped by the Global Layers mapping, it is added as a private layer even if there is no mapping for it.
Adding a Private Layer Mapping Definition
To add a global layer mapping definition:
Click the Add button. The Private Layer Mapping dialog box will appear on the screen.
Type the name of the source layer to be imported by TDXM in the Source Layer text box.
Type the name of the destination layer in the Target Local Layer text box.
Select the owner of the new private layer using the Owner user picker.
Accept your selection.
After adding local (private) layer mapping use Grant permissions button to set who can see and edit data on this layer.
We can map all private layers that come to our system so that they all have the same owner and set of rights.
To achieve this, add a new private layer mapping and fill in the Source Layer field and Target Local Layer field with the %DEFAULT% value.
This will ensure that all unmapped layers have chosen owners and sets of rights.
Before starting, it is necessary to define the Users Administration window at: Administration/Users/Groups/Users.
Deleting a Private Layer Mapping Definition
To delete a private layer mapping definition:
Select the private layer mapping definition from the list.
Click on the Delete button.
Granting Permissions to Private Layer
To grant permissions to a target private layer:
Select the private layer mapping definition from the list.
Click on the Grant permissions button. A dialog box titled "Grant permissions for layer" will appear.
Define permission for viewing and editing, then click accept.
Object identity is an important part of the EID specification, as it specifies which part of the incoming metadata should be utilized to identify the object within that domain, both presently and in the future.
Each object can possess multiple identification numbers, such as GUIDs, which are recognized by a specific external system. This capability enables HDC to identify the object in case an update is transmitted during the subsequent data exchange session.
Object Identity (TOBIS) Tab
The TOBIS (Tessel OBject Identity Server) serves as a tool for managing GUIDs and other IDs associated with a single object across various data sources (External Domains).
The Object Identity tab allows users to designate object fields that function as GUIDs or IDs within external domains. This information will then be utilized to match objects or locate them based on their external identity fields.
There are two panels on this tab:
Object Classes panel
Identity Fields panel
Object Classes panel
This panel contains list of object classes defined in this external domain. To define object classes in selected external domain use Object Classes tab.
Identity Fields panel
On this panel one can add or delete identity fields.
Add identity field
To add identity field:
Press Add button. Select Identity field dialog box will appear on the screen:
Select identity field you want to add from list of fields defined for selected object class.
Accept selection.
To add multiple identity fields repeat this task.
Delete identity field
To delete identity field:
Select identity field on the list.
Click Delete button.
Please note that Delete button will remove field from list of external indentity fields, but will not delete this field from list of fields for this object class.
Live Data Source tab
EID with Live Data Source enabled means that HDC is configured to receive and send data directly to selected external system.
In most cases, that requires a simple connector plugin that implements specific authentication method as well as knows how to exchange data with given endpoint.
