Model Configuration¶
Given below are the steps an asset administrator needs to follow in order to carry out the mapping and importing process.
Steps to map and import data¶
1. Add a new model header¶
Before you begin: Make sure you have a service profile set up. Navigate to Solution Manager > XD Integration & Visualization > Profile Configuration to view the existing profiles and their connected views.
-
Navigate to Solution Manager > XD Integration & Visualization > Model Configuration.
-
Click New Model Configuration.
-
Select the
Profile ID
of the profile you previously chose from the Profile Configuration page. A correspondingModel ID
is automatically populated. -
Add a relevant description and click OK.
2. Upload a model file¶
-
Click Upload Model Files.
-
In the pop-up that appears, click Browse and upload the model file that you need to translate.
-
Click Upload. The translation process is now triggered and the state shifts from
New
toReady for Translation
. The states that follow these, i.e.,Translation In Progress
,Translation Completed
orTranslation Failed
, andReady for Mapping
are modified automatically in a sequence via a background job. In order to find out which state it is currently in, you can click on the refresh icon.If the file upload is successful, the following confirmation will appear.
Note: The supported file formats are
IFC
,RVT
,DWG
,STP
,STL
,NWD
, andSTL
.Note: The translation process explained above translates the uploaded model file into readable metadata to be used in the upcoming steps.
3. Select the view for data migration¶
Once the process state becomes Ready for Mapping
, follow the steps below to select the view to which the data from the model file needs to be migrated.
-
Add a target entity by clicking on the plus icon. The dropdown lists the view names that are active for the service profile you choose while adding a new model header.
Note: For target entities, you can view their corresponding migration job by clicking on View Migration Job. You can also click Transition to New to bring the record back to the initial state and start the import process again.
-
Out of one or more views you added in the Target Entities section, select the view that you need the data to be imported to in the Target Selector section.
4. Map the entities¶
Now you can map the entities in the table view that appears. Read the hints given below to map different types of data.
Note: Make sure all the mandatory fields are mapped before importing the data.
-
For the fields for which the value of the Mapping Data Type column is not null, the possible values are enumeration, lookup, or reference. These values can be mapped using the
Mapping Data Type
dropdown option in the Override With column.-
Selecting this option populates the related enumeration value in the Mapping Value column in a dropdown from which you can choose the value you require.
Note: Make sure you fill the Mapping Value column for fields with the Override With value as
Mapping Data Type
. Similarly, the Mapping Value field needs to be filled if the Override With value isCustom Value
as well. Otherwise, it throws an error. -
If the field is of the
reference
data type and another field is referenced under Reference Related Columns, first fill the Override With and Mapping Value columns of the field mentioned in the Reference Related Columns. The dropdown for the actual field will then be populated based on the specified Mapping Value.Note: If the Override With or Mapping Value cells of the referenced column name are modified, a warning appears to convey that the values of the other cells that have this value referenced will be cleared after the modification. If you click OK, the cell contents in the Mapping Value and Override With columns for the fields that have this value referenced are cleared automatically.
-
-
If the field is a sequence based column, select
Sequence
in the Override With column. This generates a dummy sequence in the import process. If the respective mapped column has a pre-deployment configured to fetch the actual value, it will be replaced with the actual value when data is imported. Otherwise, the generated dummy sequence is imported. The Connected Views can then be made active or inactive, and Process Details can be added and modified for each connected view from the Solution Manager > XD Integration and Visualization > Profile Configuration page. -
If you choose
Property Path
in the Override With column and map it to a Property Path that does not match the data type of the field, it throws an error while importing the data. Note that for theProperty Path
type, the validation occurs only while the import process takes place, so in case the mapping is not done correctly and you encounter an error, you need to go back to the Model Configuration page and correct the mapping first.Note: Make sure you fill the Property Path column for fields with the Override With value as
Property Path
. Otherwise, it throws an error.
5. Import Data¶
Once all the mandatory fields are filled, you can import the data into the target view. Given below are the steps to be followed for the import process.
To import data without AI mapping suggestions¶
-
Click on View Name and then click on the Import Data button that appears.
A table preview appears so that it is easier to visualize the data that is about to be imported.
-
Click Initialize Data Import to begin the import process.
To import data with AI mapping suggestions¶
-
Click Suggest Mappings.
-
Choose the relevant Recipe (there is only one model available for now). The corresponding Metric values are populated (you can select cosine similarity, dot product, or euclidean distance). You can also choose a Similarity Percentage.
-
Click the Generate Mapping button to populate the mapping suggestions in the AI Suggested Mapping column.
-
Use the toggle button on the Keep AI Suggestion column to choose an AI mapping suggestion over an existing mapping.
-
Alternatively, you can choose the Merge and Keep button to accept the AI mappings suggestions for all the fields that do not currently have any mappings. You can choose the Replace All button to replace all the available mappings with the new mapping suggestions. The Reset Selection button disables all the toggle buttons.
Note: While accepting AI mapping suggestions for a large number of records at once, it is recommended to go through the preview table and ensure that all the suggested mappings are precise to your requirement.
-
Click Complete Mapping.
-
Now follow the steps to import data mentioned in the previous step.
Note: While accepting AI mapping suggestions, if the AI suggestion replaces a value that is referenced in one or more columns, it throws a warning. Make sure that either the referenced values are retained or their references in the other columns are modified for a successful import.
Making New Revisions of Existing Models¶
You can make a revision of an existing model configuration. This will create a new version with or without the existing mappings based on your choice.
-
Click New Revision.
-
Toggle the button if you wish to retain the mappings from the previous version and click OK.
-
Upload the model file by clicking on Upload Model Files.
-
Click Browse in the pop-up that appears and choose the model file.
-
Click Upload.
Note: The mappings of the previous version will not be retained in the new version for fields that have the value of the Override With column as
Property Path
. This is because theProperty Path
appears only after the model file is translated.