Example: Mapping for Retrieve - Intergraph Smart 3D - Administration

Intergraph Smart 3D Integration

Language
English
Product
Intergraph Smart 3D
Subproduct
Integration
Search by Category
Administration & Configuration
Smart 3D Version
11 (2016)

This example describes how to extend two existing enumerated lists (also called codelists or select lists) and an existing property definition, and how to update the retrieve mapping for Smart 3D.

The following is an overview of the steps in this example.

  1. Verify the enumerated lists and the property definitions in the SmartPlant schema.

    • Enumerated Lists: Fluid system, EngSys

    • Property Definitions: SystemCode, EngineeringSys

  2. Regenerate component schemas.

  3. Add the new information to the Smart 3D Catalog.

  4. Generate the design basis, and regenerate views and the Reports database.

  5. Check the properties in Smart 3D.

Verify Information in the SmartPlant 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 select Launch Schema Editor.

  3. On the Set Active Configuration dialog box, select the version of the schema that you want to view.

  4. Click OK to set the configuration, and open the Schema Editor.

  5. In the Schema Editor, click Workflows > Overall Workflows.

  6. Beside the Another Schema File button, click View, and then open the schema in one of the editors. In this example, choose Editor.

  7. Expand EnumListType, and find the Fluid system node.

  8. Right-click Fluid system, and select View Fluid system on the shortcut menu.

  9. Expand the Corrosive node, and verify the four fluid codes.

    For Smart 3D retrieve mapping, the Name and Long description provided here for the enumerate list values do not matter. You can explicitly map codelist values for Compare with Design Basis, which allows codelist values not to match to the SmartPlant schema number for the value to be retrieved.

    Short Description

    Long Description

    Number

    KA

    (KA) Ammonia, Anhydrous

    10101

    KC

    (KC) Caustic

    10102

    KP

    (KP) Process Chemical

    10103

    KW

    (KW) Ammonia, Aqueous

    10104

  10. Click Cancel to close the Edit Enumerated List dialog box.

  11. In the tree view, expand EnumListType.

  12. Right-click EngSys, and select Edit EngSys on the shortcut menu.

  13. Verify the properties for the EngSys enumerated list, and then click Cancel.

  14. Click Filter in the tree view, and select Properties from the Select list.

  15. In the tree view, expand the Property Def list.

  16. Right-click SystemCode, and select Edit System Code on the shortcut menu.

  17. Verify the attributes of the system code property, and then click Cancel.

  18. In the tree view, find the EngineeringSys property.

  19. Right-click EngineeringSys, and select Edit Engineering System property on the shortcut menu.

  20. Verify the attributes of the engineering system property, such as that it is scoped by the enumerated list EngSys, and then click Cancel.

  21. Click File > Close to close the Schema Editor.

Regenerate the Component Schemas

The component schemas of other authoring tools are used to create the retrieve map file for Smart 3D. To ensure that the new properties and enumerated lists are included in the appropriate component schema or schemas, regenerate the component schemas from the SmartPlant Foundation Desktop Client.

  1. In the Desktop Client, click Find > Integration > Schema Documents.

  2. Click OK to find all schema documents.

  3. Right-click the CMF file, and select Regenerate Schema Files on the shortcut menu.

Add Information to the Catalog Database

This section describes modifying the Catalog Database by editing Excel workbooks and bulkloading the changes. You can also add or modify Catalog data using the Catalog task user interface. For more information, see the Catalog User's Guide.

  1. Make a copy of the original AllCodeLists.xls file, which is located at [Product Directory]\CatalogData\BulkLoad\DataFiles on the Smart 3D server.

  2. Open the copy of AllCodeLists.xls to add the new fluid code object.

  3. Locate the Fluid Code worksheet.

  4. Under Gas Fluid System, insert the following Corrosive data:

  5. Be sure to add an A in the first column on the left. The letter A indicates the Bulkload utility will add the value during the bulkload process.

  6. When you are finished, save the file.

  7. Add two properties called SystemCode and EngineeringSystem to a custom interface file. In this example, this file is named EFCustomProps.xls and looks like the illustration below:

    The CustomClassInterfaceList sheet is shown below:

  8. Add the EngineeringSystem codelist. In this example, the file name is EFCustomCodeList.xls.

  9. Save the changes, and close Excel.

Bulk Load Data

  1. Click Start > All Programs > Intergraph Smart 3D > Database Tools > Bulkload Reference Data to open the Bulkload utility.

  2. In the Bulkload utility, click Add beside the Excel codelist files field. Browse to the folder where your codelist files are located. In this example, the file names are AllCodeLists.xls and EFCustomCodeLists.xls.

  3. Under Bulkload mode, select Append, modify, or delete records in existing catalog.

  4. Under Catalog information and Schema information, select your Catalog database server, Catalog database, Catalog schema database server, and Catalog schema database.

  5. Specify a path and file name for the log file.

  6. Specify the SharedContent folder in the Symbol and custom program file location field.

  7. Click Load.

  8. After the first load operation is complete, run the bulkload utility again for the custom properties file. Remove the two codelist files from the window using the Delete button, and add the property file to the Excel files section using the Add button. The file name is EFCustomProps.xls.

  9. Change the mode to Append to existing catalog. The other settings will remain the same.

  10. Click Load.

  11. After the bulkload process is complete, click Close.

    For more information about Bulkloading, see the Reference Data Guide.

Generate Design Basis and Views

  1. Click Start > All Programs > Intergraph Smart 3D > Project Management.

  2. Expand Reference Data.

  3. Right-click the catalog, and select Generate Design Basis on the shortcut menu.

  4. Click in the Select Component Schemas Path dialog box to browse to the folder where the component schemas are located, and click OK.

    Remove the read-only properties of all the xml files located at \\server\SharedContent\Xml\DesignBasisSchemas

  5. When the regeneration of the design basis is complete, generate the views for the database by selecting the plant, and clicking Tools > Synchronize Model with Catalog.

  6. On the Synchronize Model with Catalog dialog box, review the information for the Model database and the Catalog Schema database. Only select Regenerate views. Clear all other options.

  7. Click OK.

  8. When the process is complete, right-click the plant, and select Regenerate Reports Database.

  9. Confirm the information for the Reports database and the Reports schema database, and click OK.

    The following message appears when the process is complete.

  10. Click File > Exit to close the Project Management task.

Check the Properties in the Model

  1. Click All Programs > Intergraph Smart 3D > Smart 3D.

  2. Open a session that includes pipe runs.

  3. Switch the locate filter in the upper left to Piping Runs.

  4. Right-click a pipe run in the model, and select Properties on the shortcut menu.

  5. In the Standard category, verify that the System Code and the Engineering System properties appear in the dialog box. Make sure that for Engineering System, the codelist entries appear.

  6. Click OK to close the properties dialog box.

  7. To check the Fluid System, switch the locate filter in the upper left to Pipelines.

  8. Right-click a pipeline in the model, and select Properties on the shortcut menu. Verify that Corrosive appears in the Fluid Requirement box and that the added values are available in the Fluid Type box.