Smart P&ID Example: Mapping New Enumerated List Entries Starting in the SmartPlant Schema - Intergraph Smart P&ID - Administration & Configuration - Hexagon PPM

SmartPlant Enterprise SmartPlant Adapter for Smart P&ID (2019)

Language
English
Product
Intergraph Smart P&ID
Search by Category
Administration & Configuration
SmartPlant Foundation / SDx Version
10
Smart P&ID Version
9 (2019)

The following topic provides an example of adding and defining mapping for a new enumerated list called Corrosive and its entries to the hierarchical Fluid System enumerated list starting in the SmartPlant schema.

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.

Launch Schema Editor and Load the Smart P&ID Tool Map Schema

  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 click Edit > Check Out.

  3. Click OK in the Check Out dialog box.

  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 box, select the schema version that you want to view.

  6. Click OK to set the configuration.

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

    • For more options, click Advanced on the Set Active Configuration dialog box.

    • By default, changes to the SmartPlant Schema are written to all versions managed by the CMF file. You can choose to write changes to only selected versions; however, that is not recommended.

    • 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 click 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. Click OK to continue.

  7. In the Schema Editor, click File > SmartPlant > Edit Engineering Tool Options, and select SMARTPLANTPID from the list of authoring tools to load the Smart P&ID tool map schema.

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

  9. In each row in the Synchronize dialog box, 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 click OK.

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

    • Default actions are blue when the Synchronize dialog box appears. 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.

Verify that the Corrosive Enumerated List Does Not Already Exist in the Schema

  1. In the Map Environment window, select the Schema tab.

  2. Find the Fluid system enumerated list in the tree view.

  3. Right-click the Fluid system node, and then click View FluidSystems.

  4. In the Edit Enumerated List dialog box, review the existing list entries.

    Note that Corrosive does not exist in the Fluid system list.

  5. Next, check to be sure that there are not any fluid code entries with the same meaning as the one you want to add.

Add the New Corrosive List to the SmartPlant Schema

  1. In the Map Environment, return to the Tool tab.

  2. Expand SMARTPLANTPID > Loaded Map Schemas > SmartPlant P&ID Tool Schema.

  3. Expand the Map Enumerated Lists node, and double-click Fluid System.

  4. Select the Publish tab.

  5. In the SmartPlant schema tree view on the right side of the Publish tab, right-click any entry under the Fluid system node, and then click Create New EnumListType on the shortcut menu.

  6. In the New Enumerated List dialog box, type Corrosive as the short description of the new list, Corrosive Fluid System as the long description, and 10100 as the number.

  7. Click New Child Entry, and create a fluid code of KA with a description of (KA) Ammonia, Anhydrous.

  8. Repeat step 7 for each fluid code in the following list, and click OK.

    Fluid Code (Short Description)

    Long Description

    KA

    (KA) Ammonia, Anhydrous

    KC

    (KC) Caustic

    KP

    (KP) Process Chemical

    KW

    (KW) Ammonia, Aqueous

Add the New Corrosive List to the Smart P&ID Tool Map Schema and Map

  1. In the authoring tool map schema tree view on the left side of the Publish tab, right-click any entry under the Fluid system node, and then click Create New SPMapEnumDef.

  2. In the New SPMapEnumDef dialog box, type Corrosive in the Name field.

  3. Type Corrosive Fluid System in the Description box, and then click OK.

  4. The new list appears in the Unmapped application enumerations table.

  5. In the Unmapped application enumerations list, select Corrosive.

  6. In the Unmapped SmartPlant enumerations list, select Corrosive.

  7. Click Map .

  8. Click OK.

Add Entries to the Fluid Code List and Map

  1. In the Map Environment, double-click Fluid Code under the Map Enumerated Lists node.

  2. On the Edit Map Enumerated List Definition dialog box, click the Publish tab.

  3. Above Unmapped SmartPlant enumerations on the right side of the dialog box, click New Application Enumeration on the toolbar.

  4. In the New SPMapEnumDef dialog box, create a fluid code of KA with a description of (KA) Ammonia, Anhydrous.

  5. Repeat steps 3 and 4 for each fluid code in the following list:

    Fluid Code (Short Description)

    Long Description

    KA

    (KA) Ammonia, Anhydrous

    KC

    (KC) Caustic

    KP

    (KP) Process Chemical

    KW

    (KW) Ammonia, Aqueous

  6. Click the Advanced tab.

  7. Under Map enumerated list definition, browse to fluid code KA.

  8. In the Constrained by box, click Browse, and select Corrosive as the dependent fluid code enum entry. This value is saved in the tool map schema and ensures that the Corrosive fluid system enum entry is defined as the Dependent value of the selected fluid code in the Data Dictionary.

  9. Repeat step 8 for each of the fluid code enum entries KC, KP, and KW.

  10. Click the Publish tab.

  11. In the Unmapped application enumerations table, select a fluid code that you defined.

  12. In the Unmapped SmartPlant enumerations table, select the corresponding fluid code from the SmartPlant schema.

  13. Click Map .

  14. Repeat steps 5-7 for each enumerated entry in the Fluid Code list.

Save the Tool Map Schema and SmartPlant Schema Changes

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

Review New Corrosive List in Data Dictionary Manager

  1. Click Start > All Programs > Intergraph Smart Engineering Manager > Data Dictionary Manager.

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

  3. Click Select Entry.

  4. In the Selected list box, select Fluid System, and review the new Corrosive entry in the table.

  5. In the Selected list box, click Fluid Code, and in the Dependent Value column for each of the new fluid codes, select Corrosive as the fluid system value.

  6. Review the entries that you added in the table.