Exercise: Map Custom Properties and Convert to SIOs - Intergraph Smart 3D - Administration & Configuration

Intergraph Smart 3D Export PDS to Smart 3D
Language
English
Product
Intergraph Smart 3D
Subproduct
Plant Design System
Search by Category
Administration & Configuration
Smart 3D Version
12.1 (2019)

This exercise shows how to map PDS 3D custom property so that it can be translated by Smart Interop Publisher and then converted to a Smart Interop Object for import into Smart 3D. You will see how to create both a new PDS 3D property and a new interface to which the custom property matches and can be mapped. The workflow below uses an example custom piping segment property called process_code. You can replace process_code with your own custom property and use the steps as a guideline to map your custom property to either an existing PDS 3D interface or a new interface.

About this Exercise

Key components and information used in the example include:

  • PDS custom property name: process_code (for a piping segment - string data type)

  • New mapped property name in PDS 3D schema: Process_Code

  • New interface name in PDS 3D schema: IRunCustomProperties

  • Applications: PDS, Smart Interop Publisher, SmartPlant Schema Editor, Smart 3D Generate Smart Interop Object Utility

  • Spreadsheets and schema files:

    • PDS3DToolMapSchema.xml and PDSComponent.xml - delivered with PDS in the config folder under the PD_Shell installation folder. The PDS3DToolMapSchema.xml schema file replicates the PDS schema in an .xml format. The PDS 3D project creation software copies these files into the project folder for any new projects. Make sure these files are in your PDS project folder. Also, the delivered .xls files allow you to set measurements,

    • CustomPDStoR3DMapping.xls - delivered with Smart Interop Publisher.

Before You Begin

  1. Create a project in PDS containing the model and any custom properties to export to Smart 3D.

  2. Copy the PDS3DToolMapSchema.xml, PDSComponent.xml, and required measurement spreadsheet files to your project config folder. See Set up the Project and Data.

Process Summary

The mapping workflow can be organized into the following main steps:

  1. Map the custom property to the PDS 3D schema.

    You can review the PDS schema and use an existing property and interface for the mapping. However, if there is no available interface or property that matches your custom property, this exercise shows you how to accomplish mapping by creating a new interface and property in the PDS schema.

    1. Start the Schema Editor: Start > Intergraph SmartPlant Foundation > SmartPlant Schema Component > SmartPlant Schema Editor > Developer.

    2. On the Workflows dialog box, click the Schema tab, and then click Open.

    3. Navigate to your PDS project folder and select P3DComponent.xml.

    4. On the Tool Schema tab, click Open.

    5. Navigate to your PDS project folder, and then select the PDS3DToolMapSchema file.

    6. Click View to open the P3DComponent.xml file in the Schema Editor.

    7. Under the ClassDef node, locate and expand the PDS_Dwg_Piperun node.

    8. To create the new interface, expand the PDS_Dwg_PipeRun classdef and right-click Realized Interface Definitions. Select Create InterfaceDef.

    9. On the left side of the New Interface Definition dialog box, type the new interface name, IRunCustomProperties. Type a brief description and the display name. Select a property category such as Miscellaneous.

    10. On the right side of the New Interface Definition dialog box, select IObject for Implies interface definitions and IPipeRun for Implied by interface definition. Click OK to finish.

    11. To create the new property, locate and expand the new IRunCustomProperties interface under Realized Interface Definitions. Right-click Exposed Property Definitions and select Create PropertyDef.

    12. On the New Property Definition dialog box, type Process_Code as the new property name. Enter the information below, and then click OK to close the dialog box.

      • Description: Process Code

      • Display name: Process Code

      • Exposed by interface definition: IRunCustomProperties

      • Scoped by property type: string

      • Needs further analysis: False

    13. Select File > Save > Schema File to save the new interface and property in your PDSComponent schema file. If you do not save, your new interface and custom property do not display for mapping.

    14. Close the current form to go back to the main Workflows dialog box.

    15. Click View to open the PDS3DToolMapSchema tool schema file in the Schema Editor.

      Map custom property to the PDS new interface and property

      Now you are ready to map the custom property process_code in the PDS tool schema to the new Process_Code property in the PDS Component schema.

    16. Under SPMapClassDef, locate PDS3DPipingSegment, and then right-click Edit PDS3DPipingSegment.

    17. Click the Overview tab, and then click Graphical Publish Mapping.

    18. On the Show Mapping for PDS3DPipingSegment dialog box, locate IRunCustomProperties > Process_Code under Dynamic Schema Views on the right side of the dialog box.

    19. Locate the custom process_code under PDS3DToolMapSchema.xml on the left side of the dialog box, and then drag the custom Process_Code to the new PDS process_code property to create the MapPropertyToPropertyDef relation.

    20. Click OK to close the dialog box, and then OK again to close Edit Map Class Definition.

    21. Select File > Tool Map Schema to save the mapping.

  2. Export the PDS model.

    1. Export your your PDS model. See Generate the ZVF/XML Data Files.

    2. Check the exported model .zvf and .xml files to make sure the new interface and property were exported. For example, use an XML editor and open the generated .xml file:

  3. Map and translate with Smart Interop Publisher.

    Before you translate your PDS files, you must map the custom PDS 3D property process_code to a normalized interop schema (also referred to as a SPIOP or ISIP schema) property so that the custom property can be translated to Smart Interop Object and imported into Smart 3D. Smart Interop Publisher delivers a set of format-specific default mapping files and corresponding custom mapping template files. The default installation folder for these files is [Install drive]:\Program Files\SmartPlant\Interop Publisher\3DInteropMappingFiles. See Review the delivered mapping files.

    1. To map your custom property:

      1. Review the PDSToR3DMapping.xls default mapping file to see the classes and properties that are currently mapped.

      2. Make a copy of the customPDSToR3DMapping.xls file in the \CustomMappingFiles folder, and place the file in another folder location.

      3. Open the customPDSToR3DMapping.xls file, and insert a new row in the ClassMap sheet.

      4. Enter PDS_Dwg_PipeRun as the PDS 3D Source Class and CR3DPipeRun as the ISIP Target Class.

      5. On the PropertyMap sheet, enter PDS_Dwg_PipeRun again as the PDS 3D Source Class, IRunCustomProperties as the Source Interface, and Process_Code as the Source Property. The 'source' in the custom mapping is the PDS 3D data.

      6. You can enter any interface name and property name, but we recommend following the 'IJR3D' prefix naming convention for the interface. For this example, enter IJR3DRunCustomProperties for the Target Interface and ProcessCode as the Target Property.

      7. Save your edits and close the spreadsheet file. For more details, see Edit the custom mapping template file.

    2. Open or create your Smart Interop Publisher project:

      1. Open the Smart Interop Publisher application. If you do not already have a project, create one with a defined shared content folder. See Create a project.

      2. Go to your PDS project folder and copy your updated PDSComponent.xml file to the shared content folder you selected for your Smart Interop Publisher project.

      3. From the Smart Interop Publisher Projects view, right-click your project and select Settings > Translation.

      4. Click New in the Select or Create Settings Group list.

      5. Type PDSGroup as the name of your translation settings group.

      6. Go to the PDS 3D Options translation settings and change the path of the Schema option to point to your PDS component schema.

      7. Save your translation settings.

    3. To translate your PDS model .zvf file:

      1. From the Smart Interop Publisher Source Files grid in the Smart Models view, add the generated .zvf file as a source file. An example .zvf file in the Source Files grid is shown below.

      2. Select the .zvf file and right-click Translate.

      3. On the Translate dialog box, enter a Smart Model name 100_pipea2m1 for your source file and the folder location.

      4. Select the Custom mapping option and the location of your custom mapping file.

      5. Select the PDSGroup as your Settings Group.

      6. Click Translate.

  4. Map to Smart 3D SIO schema and import.

    To map the custom Process_Code custom property now in the ISIP schema to the Smart 3D SIO schema, make sure you have a Smart 3D property to can map your custom property. In this example, ProcessCode is the corresponding Smart 3D SIO property.

    1. Locate the SPIOPtoSIOMapping file in the Smart 3D shared content folder. The default location is [install drive]:Program Files (x86)\Smart 3D\3DRefData\SharedContent\Data\Reference3DComponents.

    2. Go to the ClassMap sheet, and find the class mapping for CR3DPipeRun that is mapped to CUSIOPipeRun. Any new custom classes must be added here.

    3. Select the PropertyMap sheet. Column B is source class and column D is source property. Columns E and F are the SIO interfaces and properties.

    4. Locate the CR3DPipeRun class and insert a blank row to add a new CR3DPipeRun entry. You do not have to specify the source interface in column C; just enter the ProcessCode ISIP property for the source property in column D.

    5. Enter IJRunCustomProperties into column E for the custom interface and ProcessCode in Column F for the mapped SIO property.

    6. Save your edits and close the SIO mapping file.

    7. Use the Generate Smart Interop Object utility in Smart 3D to import the Smart Model data into the Smart 3D database as Smart Interop Objects.

    8. Click Start > Intergraph Smart 3D > Generate SIO to open the Generate SIO Utility.

    9. In the Source Folder, select the folder that contains the generated Smart Model files 100_pipea2m1.zvf and .mdb2 data to convert to Smart Interop Objects.

      1. Select the model in which to create the Smart Interop Objects.

      2. Select the permission group to which to assign the Smart Interop Objects. You can copy the extracted PDS model data files to individual folders based on discipline. While generating the SIO objects, you can individually select these folders and load them with the respective permission group

    10. Click Generate.

      When the process is complete, a message displays in the Status box. To view processing results, click View Log before closing the utility.

    11. Open the 100_pipea2m1.zvf model in Smart 3D to verify that the custom property is imported into SIOPipeRun as shown in the example below. For more information, see Generate and Import Smart Interop Objects.