Create and Map New String Properties Starting in the SmartPlant 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)

The following procedure applies to authoring tools that have metadata adapters. For more information, see Before You Begin Mapping for Tools with Metadata Adapters.

When you add new properties starting in the SmartPlant schema, the authoring tool metadata adapter uses classes exposed in the tool map schema to determine where the property can be placed in the authoring tool metadata. In some cases, the tool map schema does not totally represent the tool data model, and because of this, classes available to add properties to in the authoring tool may not be available in the tool map schema. For example, if you want to add a property to the Plant Item table in the Smart P&ID data dictionary so that all plant item types in Smart P&ID inherit the property, you must define the new property in Smart P&ID Data Dictionary Manager, not in the Schema Editor. However, if you want to define a new property on a map class that exists in the tool map schema, you can use the following procedure to do so.

Load the Tool Map Schema and Open a Map Class Definition

  1. In the Desktop Client, set your scope for the applicable plant, and then find the CMF file.

  2. Right-click the CMF file, and then select Edit > Check Out to display the Check Out dialog.

  3. Select OK.

  4. In the New Items window, right-click the new version of the CMF file, and select Launch Schema Editor.

  5. On the Set Active Configurations dialog, select the schema version that you want to view.For more options, select Advanced.

  6. Select OK to set the configuration.

  • The CMF file must be checked in to SmartPlant Foundation before users can publish from an authoring tool.

  • By default, changes to the SmartPlant Schema are written to all versions managed by the CMF file. Although you can choose to write changes to only selected versions, we do not recommend doing so.

    If you choose to view one version of the schema (Specify configurations to display window) but write changes to all versions (Set Configurations for new objects window), an information window appears when you select OK, indicating that you will be prompted with every change to the schema to confirm that you want to write the changes to all versions. Select OK to continue.

  1. In the Schema Editor, synchronize the authoring tool map schema for which you want to define mapping. For more information, see Synchronize Tool Metadata with the Tool Map Schema.

  2. In the Map Environment, expand the Tool node, and then expand the node for the appropriate authoring tool.

  3. Under the authoring tool node in the tree view, expand Loaded Map Schemas and the <Authoring Tool> Tool Schema node to display contents of the authoring tool map schema.

  4. To add a new property, expand the Map Classes node, and double-click the tool map class to which you want to add the new property.

Add the New Property to the SmartPlant Schema

Before you add new properties to the SmartPlant schema, you need to verify that the properties or properties that have equivalent meanings do not already exist.

  1. If you want to start by defining publish mapping for the new property, click the Publish tab.

    If you only want to define retrieve mapping for the enumerated property, you can click the Retrieve tab instead. The procedure for adding properties and mapping is the same.

  2. Above Unmapped SmartPlant properties on the right side of the dialog box, click New SmartPlant Property Definition on the toolbar.

    Mapping_MapProperty_AddtoSchema

  3. In the New Property Definition dialog box, define the new SmartPlant schema property, and click OK to create the property definition. For more information, see Create a Property Definition.

    • In the Scoped by property type box, be sure to select string as the property type for the new string property.

    • When you click OK, the new property appears in the Unmapped SmartPlant properties table in the Edit Map Class Definition dialog box.

Add the New Property to the Tool Map Schema and Metadata

  1. Above Unmapped application properties on the left side of the dialog box, click New Map Property Definition on the toolbar.

  2. In the New Map Property dialog box, type the name and any other information that you want to define for the new map property definition, and click OK to create it.

    • By default, the authoring tool metadata adapter supplies the tool identifier (OID) and the name for the map property definition. You can change the default name, which is always a number, by selecting the existing number and typing the name you want.

    • In the Select criteria box, you can define the criteria that the tool adapter uses to select or identify objects for this tool property definition. Some authoring tool metadata adapters define this information by default. See the mapping rules for your authoring tool for how to set the value for this property.

    • In the Process criteria box, you can define the criteria that the adapter uses to process objects that are instances of this tool property definition. Some authoring tool metadata adapters define this information by default. See the mapping rules for your authoring tool for how to set the value for this property.

      For example, if the tool adapter must do a conversion on an enumerated list or the unit of measure for a property before the property is published, use the Process criteria box to specify the method used for the conversion, for example, EFAdapter.EnumConversions.

    • By default, the software creates the relationship between the map class definition you selected to edit and the new map property definition. You can see which map class definition exposes the map property definition in the Exposed by map classes box.

    • You can change the property category for the new map property definition in the Category box. Changing the property category displays other properties that you can define for the new map property definition.

    • When you click OK, the new map property definition is added to the Unmapped application properties table in the Edit Map Class Definition dialog box.

For some authoring tools, such as Smart Instrumentation, changes to the metadata in the tool database are made automatically when you add the object to the tool map schema. For other authoring tools, changes are only saved when you click File > Save > Tool Schema File command in the Schema Editor to save the tool map schema. This allows you to cancel your changes when you are adding new tool properties, enumerated lists, or enumerated entries before you save the tool map schema. For more information, see Mapping with Metadata Adapters.

Map Tool Property to the SmartPlant Schema Property

  1. In the Unmapped application properties table, select the tool map property definition that you want to map.

  2. In the Unmapped SmartPlant properties table, select the SmartPlant property definition that you want to map.

  3. On the toolbar, click Map .

    SHARED Tip The mapping you defined appears in the mapped objects table at the bottom of the dialog box.

  4. If you want to define both publish and retrieve mapping for the enumerated list entry, click the Retrieve tab, and repeat steps 1-3 in this procedure.

  5. Click OK in the Edit Map Class Definition dialog box.

Defining mapping for an object does not necessarily mean that you can publish and retrieve that object. The authoring tool adapter determines the objects that you can publish and retrieve. For more information, see rules for your authoring tool in the tool documentation.

Save the Tool Map Schema and Schema Extensions File

  • Click File > Save > All Modified Files to save the SmartPlant schema extensions and the tool map schema. For some tools, saving the tool map schema also saves changes to the tool metadata database.

  • When you close the Schema Editor, the software prompts you to save your connection information, user interface options, and loaded tool map schemas to a session file. Select Yes in the message box to save the session file so that you can use it to return to this working environment. However, you should not open a session file after launching the CMF file from the Desktop Client.

  • If you save changes to the CMF file or a tool map schema but did not validate the changes before exiting, the software displays an information message to remind you that the file contains changes that have not been validated. Select OK to dismiss the message.

  • If you make changes to the SmartPlant schema, you must load the changes into the SmartPlant Foundation database.

Propagating the New Property to Other Authoring Tools Using Compare

  • After you add new objects to the SmartPlant schema, do a compare with other authoring tool map schemas to identify changes that need to be made in the other authoring tools and then add new objects and define mapping in the Map Environment. For more information, see Compare a Tool Map Schema to the SmartPlant Schema.