OpenPlant | AutoPLANT Wiki How to Map Custom Properties with Database

How to Map Custom Properties with Database

Applies To
Product(s):	OpenPlant PID
Version(s):	08.11.10.XXX
Environment:	Windows 7/8.1/10 (64 bit)
Area:	Installation-Configuration
Subarea:	Database
Original Author:	Harpreet Singh, Bentley Product Advantage Group

Background

This article will cover the fundamentals of mapping a custom/existing EC property with Database field.

To note : the order in which you load the schemas is important.

You must first load the ...projectname\schemas\PlantProjectSchema01.01_AutoPLANT_PIW01.06 schema file

followed by the ...projectname\schemas\OpenPlantPID.01.06 schema file

A. Add field in Database Table:

Let’s say we have added a property (VENDOR_SUPPLIED) on the EQUIPMENT class and we want to map it to the database field VENDOR in EQUIP Table.

Steps To Accomplish:

Launch Project Administrator.
Expand the <Project Name> node.
Expand Database node and select ‘Databases’ option.
Select PROJDATA in the right window and click Edit Tables option.
Select EQUIP table in the below dialog box and click Edit button.
In the next dialog, uncheck “Protected” option (if checked) and click Table design.
Add a new field VENDOR and set the Data Type to ‘Text’.
Save the changes and exit from MS-Access and Project Administrator.

B. Add mapping in schema:

Steps To Accomplish:

Open Class Editor.
Go to Database Mapping>Open.
In the below dialog box, browse to (Operating System Local_Root)\Bentley\PowerPID (SELECTseries 5)\WorkSpace\Projects\OPPowerPID_Metric\Dataset\schemas\PlantProjectSchema01.06_AutoPLANT_PIW01.06 directory and click OK.
Click ‘Edit Database Structure’ button as shown below.
Select the existing Database Mapping and click Remove.
Click Load and type PLANTPROJECT_DATABASEMAPPING in the Name field.
Select the provider:

a. For MS-ACCESS database>Microsoft Access Provider
b. For SQL database> Microsoft SQL Server .Net Provider
c. For Oracle Database>Oracle.Net Provider
Select the PROJDATA.mdb file from AutoPLANT project folder C:\ProgramData\Bentley\Plant V8i\Bentley Plant V8i Projects\SAMPLE_METRIC\Projdata and click TEST.
Once the structure is loaded, select EQUIPMENT class in Summary tab.
Expand EQUIPMENT class and select Vessel class under CONTAINER on the left side of the window.
In the properties tab, scroll down and select VENDOR_SUPPLIED property.

As highlighted in the picture, it is showing that this property is currently not mapped. If a property is mapped there is a green color drum in front of Property name. Also it shows the mapping in the property section down below:
Click the edit button on the property section.
In the Edit property mapping dialog, select EQUIP from the drop down menu on the left side.
Now select VENDOR from the drop down menu on the right side and click OK.
Save the changes and launch OPPID.

Note: Currently mappings are not inherited from the Parent class to child classes, therefore, user need to map the properties at the child classes as well.

Verify the result:

Place a Vessel in the model and add key-in value in the Vendor Supplied field.
Synchronize the drawing with database.
Once the drawing is synchronized with the database, launch Data Manager and open the Equipment List view.
You will need to add the Vendor field to the view.
Once the Vendor field is added, open the view and check the vendor field.

Case II

Background:

In OpenPlant PID, user wants to have FACILITY property for Flow Element. When user places any flow element on pipeline and synchronizes from drawing to database. User is unable to get that FACILITY input in Data Manager. User’s requirement is to map FACILITY property in Data Manager.

Steps to Accomplish:

Launch Project Administrator.
Expand Your Project, here Metric project, then Database, go to Databases, select PROJDATA and click on Edit Tables
Select INSTR, go to Edit, click on Table Design, add IFACILITY, Save and click Ok, see below images.
Close Project Administrator.
Launch Class Editor.
Load OpenPlant_PID.01.07.ecschema
Supplement with OpenPlant_PID_Supplemental_Imperial.01.07.ecschema
Navigate to Flow Element, switch to Properties, click on Add and select New.
Fill below data.
Right click on FACILITY property to add Custom Attribute.
Add Category custom attributes to FACILITY Property.
Fill below Information.
Save all the changes.
Continue Class editor and go to Database Mapping, select open and click OK.
After loading, click on Edit Database Structure in Summary and Remove existing PLANTPROJECT_DATABASEMAPPING.
Now, click on Load
Fill below Data, check Test Connection, click OK and close the dialog.
Now, click on Flow Element, switch to properties, Select FACILITY and click on Edit in Property Mapping Information.
Select INSTR and IFACILITY from the dropdown and click OK.
Save Database Mapping and close Class Editor.
Launch Data Manager.
Expand views and click on Instrument List – Flow Element, right click and select Edit.
Click on Design.
Select IFACILITY field from INSTR Source Table, click on Right Arrow and OK.
Close Data Manager.
Launch OpenPlant PID , Create new file (Metric unit) and place pipeline and flow nozzle.
Synchronize from Drawing to Database.
Verify Instrument List – Flow Element view in Data Manager.
Expand Tables and check INSTR. You can see Facility table and its Input separately in Data Manager.