Skip to content

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.

  1. Navigate to Solution Manager > XD Integration & Visualization > Model Configuration.

  2. Click New Model Configuration.

  3. Select the Profile ID of the profile you previously chose from the Profile Configuration page. A corresponding Model ID is automatically populated.

  4. Add a relevant description and click OK.

2. Upload a model file

  1. Click Upload Model Files.

  2. In the pop-up that appears, click Browse and upload the model file that you need to translate.

  3. Click Upload. The translation process is now triggered and the state shifts from New to Ready for Translation. The states that follow these, i.e., Translation In Progress, Translation Completed or Translation Failed, and Ready 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, and STEP.

    Note: The translation process explained above translates the uploaded model file into readable metadata to be used in the upcoming steps.

    Note: If the translation process fails, a corresponding error message appears in the Model Activity Logs panel. Click on the file icon in the Activity Log column to view the detailed log.

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.

Note: The maximum data length allowed is 4000. If a property exceeds 4000 characters, a warning appears in the Model Activity Logs and the data beyond this limit will automatically be truncated. Click on the file icon in the Activity Log column to view the detailed log.

  1. 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.

    In the Target Entities panel, using the toggle button, you can change the hierarchy tree structure based on the view. Only one view can be selected at a given time.

    Note: For target entities, you can view their corresponding migration job by clicking on View Migration Job. You can also click Transition Back and choose to either bring the record back to the initial state and start the import process again, or complete mapping.

Once you choose the target view, you can view the related objects in a hierarchical tree structure on the left panel by clicking on Expand. This represents all the objects related to the model with their parent-child associations.

You can view the 3D View and the Staging Log related to each object by expanding the parent nodes and traversing the structure as shown below.

You can also edit mappings in the Target Definition column with the property values relevant to that particular object by clicking on the edit icon as shown below. This option applies when the property values of the objects differ from those of the root node.

Modify the required data and click on Edit Data.

Note: The values that will be migrated can be seen in the Property Value column of the table.

Note: All the validations that apply to the root node also apply to objects at all levels.

You can also exclude certain objects from the model. When you migrate the model, the excluded objects will not be migrated.

Note: Excluding an object that has child nodes will result in its child nodes being automatically excluded too.

Excluded objects will be grey in color as shown below.

In order to revert the exclusion, refresh the screen.

Clicking on the Revert Exclusion button will undo the object elimination.

4. Map the entities

Now you can map the entities in the table view that appears below. 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 is Custom 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: 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 by manually mapping entities

  1. Map the entities manually in the Target Definition tab and click Complete Mapping.

  2. Click OK in the pop-up that appears.

    Note: If you have edited any property values of objects, you can choose to retain the edited values or use the original values using the toggle button, Keep Edited Vaues in the pop-up before completing the mapping. This toggle will only be enabled if you have edited values.

  3. Select the View Name and then click on the Import Data button that appears.

To import data with AI mapping suggestions

  1. Click Suggest Mappings.

  2. 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.

  3. Click the Generate Mapping button to populate the mapping suggestions in the AI Suggested Mapping column.

  4. Use the toggle button on the Keep AI Suggestion column to choose an AI mapping suggestion over an existing mapping.

  5. 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.

  6. Click Complete Mapping.

  7. 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.

To import data using templates

  1. After mapping all the entities, if you want to save those mappings as a template, you can use the Save as Template option.

  2. You can either select a new template by entering a name in the Template Name / Replace Existing field or override an existing template by selecting an existing template from the dropdown.

  3. Click OK.

You can view your newly created or modified template in Solution Manager > XD Integration and Visualization > Model Mapping Template.

You can also choose to copy the mappings from a template while mapping the entities.

  1. Click Copy from Template

  2. Choose a template you want to copy the mappings from in the Template Name dropdown.

    Note: Only the fields that have a Valid column as Yes will be copied.

  3. Click OK

You can now click Complete Mapping to confirm the mapped entities.

Error Validation

Once the mapping is complete, you can run the error validation background job by clicking Run Error Validation.

Once the background job is executed successfully, you can view its staging log entries in the Staging Log tab.

By selecting a record and clicking on Structural Columns, you are redirected to the related object. This is to enable easy identification of the node that is associated with the log record.

There are three types of Status shown here: - Warning - Error - Info

Errors related to the business logic are indicated using Error. These will cause a failure during migration.

Warnings are a result of attempting to modify a record that we previously migrated from a different model.

An information log is created whenever you try to replace an existing object of the target which was not migrated from xDiv.

You can also check which object the error is from by expanding and navigating through the tree on the left panel. Root node will have all the logs (Errors, Warnings, Info) for all the objects while each object will only show the errors related to that particular object.

Errors are depicted in red color while the rest of the objects remain green.

If there are warnings, errors, or both, in the staging log of a target entity, while trying to import data, the user is asked to confirm their action as shown below using two different confirmation pop-ups.

For Warnings:

For Errors:

State Transitions Throughout the Flow

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.

  1. Click New Revision.

  2. Toggle the button if you wish to retain the mappings from the previous version and click OK.

  3. Upload the model file by clicking on Upload Model Files.

  4. Click Browse in the pop-up that appears and choose the model file.

  5. 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 the Property Path appears only after the model file is translated.