Smart P&ID Example: Mapping a New Complex Property Starting in the Tool - Intergraph Smart P&ID - Help - Intergraph

Intergraph Smart P&ID Help

Language
English
Product
Intergraph Smart P&ID
Search by Category
Help
Smart P&ID Version
9 (2019)
Smart Engineering Manager Version
10 (2019)
SmartSketch Version
10.0(2018)

The following sections illustrate how to add and define mapping for a new complex property called Engineering System and its enumerated list entries starting in Data Dictionary Manager.

Before You Extend the Smart P&ID Database

  1. Make a backup of the SmartPlant Foundation site database and any vaults for the site.

  2. Create a backup of Smart P&ID, including a database backup from the plant level with reference data, an application-level data dictionary template (DDT), and a backup of the SPPIDDataMap.xml file located in the SmartPlant resources directory.

Create the New Engineering System Property in Data Dictionary Manager

  1. Select Start > All Programs > Intergraph Smart Admin > Data Dictionary Manager.

  2. Connect to the appropriate plant server for Smart P&ID.

  3. Select Select List on the left side of the Data Dictionary Manager window.

  4. In the first empty row in the Select List table, type EngSys as the name.

  5. Select None from the Dependent List.

  6. Select Select Entry on the left side of the Data Dictionary Manager window.

  7. Under Selected List, select EngSys.

  8. In the first empty row, create a new entry with a value of AA and a short value of Steam Gen & Fired Htr, Water/Steam Side.

    8CompAAAddedMOD

  9. Select Add Row, and enter the following values, creating a new row for each:

    Value

    Short Value

    BA

    Steam Generator and Fired Heater, Air/Gas Side

    CA

    Ammonia/Urea

    DC

    Crude Oil Production

    EA

    Auxiliary AC Power Systems

    8CompListAdded

  10. Select Database Tables on the left of the dialog, and select Plant Item from the list in the middle.

    8SimpleDDOpen

  11. Select Edit > Add Property .

  12. In the Add Property dialog, create a new property with the following information:

    Property

    Value

    Name

    EngSystem

    Display Name

    Engineering System

    Data Type

    Select List

    Select List

    EngSys

    Default Value

    None

    Category

    Process

  13. Select OK.

  14. Select File > Save.

  15. Select File > Exit.

Launch Schema Editor and Synchronize the Tool Map Schema

The ICustomInterface must be realized by the class definitions that represent objects in this authoring tool that will be publishing or retrieving the custom property. If you have not configured ICustomInterface, see Creating a New Interface for Mapping Examples for more information.

  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, select File > SmartPlant > Edit Engineering Tool Options, and select SMARTPLANTPID from the list of authoring tools to load the Smart P&ID tool map schema.

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

  3. In each row in the Synchronize dialog, the values in the tool database and tool map schema columns indicate actions to correct inconsistencies between the tool metadata and tool map schema. Select the appropriate action in each row, and then select OK.

    • Each row represents a discrepancy between the tool database and the tool map schema.

    • Default actions are blue when the Synchronize dialog displays. However, if you select a different option, it will become blue instead.

    • In many cases, only one operation is supported to synchronize the tool database and tool map schema. For example, if a new property was found in the database, the metadata adapter can add the property to the tool map schema, but it cannot remove the property from the tool database.

      8SEEngSysSynch

Add the New Enumerated List to the SmartPlant Schema and Map

  1. In the Map Environment, expand Smart P&ID > Loaded Map Schemas > Smart P&ID Tool Schema.

  2. Expand Map Enumerated Lists, and right-click EngSys.

  3. On the shortcut menu, select Edit EngSys.

  4. In the Edit Map Enumerated List Definition dialog, select the Advanced tab.

  5. At the bottom of the dialog, select New SmartPlant Enumerated List with Correlated Entries. This process creates an enumerated list in the SmartPlant schema with the same name and values as the list in the tool map schema. Additionally, the software will automatically map all the enumerations for publish. A dialog will suggest that you can map the enumeration for retrieve as well. Select Yes to create both publish and retrieve mapping relationships, or No to create only publish mapping relationships

    AutoCorrelateAndMagicButton

  6. Select OK in the Create Enumerated List and Entries dialog. Depending on your selections on the Set Active Configurations dialog when you launched the Schema Editor, you might be prompted to confirm that you want to create the new list and enumerations in multiple versions of the schema.

  7. In the Edit Map Enumerated List Definition dialog, select OK.

  8. In the Map Enumerated Lists node, right-click EngSys.

  9. On the shortcut menu, select Edit EngSys.

  10. In the Edit Map Enumerated List Definition dialog, select the Publish tab.

  11. Under SmartPlant in the upper right window, right-click EngSys.

  12. On the shortcut menu, select Edit <UID>.

  13. Select each entry, and under Overview, edit the number to match the values in the following table:

    Name/Short Description

    Number

    AA

    10111

    BA

    10112

    CA

    10113

    DC

    10114

    EA

    10115

    EditEngSys2

  14. Select OK.

The modification of the Number value of each enumeration is required for Smart 3D, which will determine the actual value assigned to each enumeration. No other authoring tools use this value.

Add the New Property to the SmartPlant Schema

  1. In the Map Classes node, right-click InstrLoop.

  2. On the shortcut menu, select Edit InstrLoop.

  3. Select the Publish tab.

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

  5. In the New Property Definition dialog box, define the new SmartPlant schema EngineeringSys property.

    CreateEngSysPropertyInScheEdDLG

    • In the Exposed by interface definitions box, click Browse, and select ICustomInterface as the interface definition that exposes this property.

    • In the Scoped by property type box, select EngSys.

  6. Click OK.

  7. Under Unmapped application properties, select EngSystem.

  8. Under Unmapped SmartPlant properties, select EngineeringSys.

  9. On the toolbar, select Map .

If the EngineeringSys property does not appear in the Unmapped SmartPlant properties list after you created it and exposed it on the ICustomInterface interface definition, check the ICustomInterface definition to make sure that it is realized by the PIDInstrumentLoop class definition and implied by the IInstrumentLoop interface.

SHARED Tip The view definition that creates the list of unmapped properties is generated by the software the first time you access the Edit form for a map class for each Schema Editor session. So, if you view the list, leave it, and make changes, such as adding additional interfaces to the class definition to which the map class is mapped, the changes you made will not appear when you return to this form because the view definition is not updated or regenerated. You will see the changes during your next Schema Editor session.

Map the EngSys Property for Additional Map Class Definitions

Because multiple Smart P&ID classes inherited the EngSystem property, you can create additional mapping so that other objects can publish the property.

  1. In the tree view, right-click Instrument, and then select Edit Instrument on the shortcut menu.

  2. Select the Publish tab.

  3. Under Unmapped application properties, select EngSystem.

  4. Under Unmapped SmartPlant properties, select EngineeringSys.

  5. On the toolbar, select Map .

  6. Repeat steps 1-5 in this section to map the EngSys property for all Smart P&ID map class definitions that represent objects for which you want to publish this property.

SHARED Tip To create a retrieve mapping relationship for a property, follow the same steps on the Retrieve tab.

Save the Tool Map Schema and SmartPlant Schema Changes

  • Select File > Save All Modified Files to save the SmartPlant schema changes (CMF file) and the tool map schema.

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

  • Additionally, if you made changes to the SmartPlant schema, you should regenerate the component schemas for the site before testing any publish or retrieve mapping relationships.