Synchronize Tool Metadata with the Tool Map Schema - Integration - Update 44 - Help - Hexagon

Integration Help

Language
English
Product
Integration
Search by Category
Help
Smart 3D Version
12.1 (2019)
Smart Construction Version
2019(7.0)
SmartPlant Foundation / SDx Version
10
Smart Electrical Version
2019 (9.0)
Smart Materials/Smart Reference Data Version
2020 (10.0)
Smart P&ID Version
9 (2019)
Smart Review Version
2020 (15.0)
Smart Engineering Manager Version
10 (2019)
Smart Interop Publisher Version
13.1 (2019 R1)
Smart Isometrics Version
7.0(2019)
Spoolgen Version
9.0(2019)

After you check out the SmartPlant schema CMF file from the Desktop Client and launch the Schema Editor, you can synchronize your tool metadata with the tool map schema.

  1. In the Set Active Configurations dialog box, select the schema version or versions that you want to look at, and click OK.

    SHARED Tip By default, the changes you make are applied to all versions of the schema managed by the CMF file, to support forward and backward compatibility between versions of the software. Click Advanced to view the Set Configurations for new objects window, where you can select a specific version to which to write changes.

  2. In the Schema Editor, click File > SmartPlant > Edit Engineering Tool Options.

    SHARED Tip A message box appears if authoring tools without metadata adapters are registered with the SmartPlant Foundation plant. Mapping for these authoring tools can be defined by opening their tool map schemas.

  3. Under Engineering application/map schema, select the authoring tool and tool map schema that you want to work with in the Schema Editor.

    • You can load multiple tool map schemas and metadata by repeating steps 2 and 3 for each authoring tool.

    • The authoring tool that you want to define mapping for must be registered with the SmartPlant Foundation site and plant from which you checked out the SmartPlant schema CMF file to appear in the Engineering application/map schema list.

  4. Under Startup options, select the Load map schema and Connect to application schema check boxes.

    Mapping_ConnectionWizard_ToolsList

    SHARED Tip For specific details about what types of objects that you can edit in the authoring tool via the metadata adapter and how save works for the tool's metadata adapter, select a tool and then click the Details button.

  5. To synchronize additional tool schemas at the same time, repeat steps 4-5 for each authoring tool that you want to synchronize.

  6. Click Finish to review synchronization details in the Synchronize dialog box.

    • Connecting to the metadata adapter and generating a comparison of the tool metadata and the tool map schema can be a time consuming task, depending on your computer memory and processor speed.

    • When you click Finish, the Schema Editor generates a tool schema from the tool metadata in the tool database and compares it to the tool map schema file.

    • If no changes have been made to the authoring tool metadata or the tool map schema since you installed the software, there may no differences to synchronize.

    • Once you are familiar with synchronization and the default actions for the authoring tool you are working with, you may want to select the Automatically synchronize schemas check box before you click Finish to avoid reviewing synchronization results every time you load a tool map schema and tool metadata.

  7. In the Synchronize dialog box, select the appropriate action in the <Tool> Database or <Tool Map Schema Path> column in the appropriate row for the change to update inconsistencies between the tool metadata and tool map schema. Default actions appear in blue in the appropriate column and row for each difference.

    • Some applications do not support both possible synchronization actions that appear in the Synchronization dialog box. For example, Smart P&ID does not support deleting existing properties or enumerated lists. If properties exist in the Smart P&ID tool metadata that are not in the tool map schema, then the missing properties must be added to the tool map schema. They cannot be deleted from the tool metadata database.

    • If you select a synchronization action that is not supported by the selected authoring tool, the Schema Editor displays a message box to let you know that the action is not supported.

    SHARED Tip You can export the synchronize instructions to Microsoft Excel by clicking Save to Excel. Saving to a spreadsheet allows you to sort, filter, and share synchronization information.

  8. Click OK to synchronize the tool map schema and tool metadata.

    • If you selected more than one tool map schema to synchronize, repeat steps 7-8 for each authoring tool that you selected.

    • After you synchronize the last tool map schema, the Map Environment appears.

  • If an error occurs during the synchronization process, a Messages dialog box provides information about the changes that failed. Click Save Message to File to save the information displayed in the dialog box to track down and resolve the issues. You can choose a location in which to save the file.

  • Once the synchronization process has been successfully completed, you can click the View Adapter Log button to view a file with information about the changes made.