Overview

To create a new property & make its field editable for any component or fittings at the time of placement in OpenPlant Modeler.

Problem Description

User requirement was to add a new property and inside the Modify Component dialog box, user should be able to fill in the desired information.Below steps illustrates on adding new Property & defining custom attribute to a new property in schema to make it available for editing. Few new properties like XYZ, ABC needed to add inside specific Categories like Operating Conditions/Design Conditions etc. Below steps will aid user to achieve the desired configuration, explaining each methods. 

Steps to Resolve

Adding a New Property Under PIPING_COMPONENT Class

1. In Class editor, Open "OpenPlant_CustomAttributes.08.11.ecschema.xml" schema to get the desired custom attribute on certain class, as it contains the list of Custom Attributes.
   This schema can be found by navigating below path - %Project Root%\WorkSpace\OPModeler\schemas
   
   
2. Again open "OpenPlant_3D.01.07.ecschema.xml" and supplement it with "OpenPlant_3D_Supplemental_Modelingviews.01.04.ecschema.xml" schema. 
   
   Above schema can be found by navigating below project path:
   %ProjectRoot%\DataSet\Schemas. For More information on supplementing schemas click here>>>>
   
   
3. Locate the PIPING_COMPONENT class. User may also use binocular option & write directly the class name if known and do a search. See image below. 
   
   
   
   Note -To Notice, these properties are created under Piping component, hence it should get displayed when piping component classes are used & only get displayed under element information. To display any property under pipeline level, property should get created under Pipeline (PIPING_NETWORK_SYSTEM) class. 
   
   
4. Click on Properties Tab, which contains list of default properties available on certain class. 
5. To Create a new property, click on Add.. option like displayed in image below. 
   
   
   
   
6. By default a Property with name property gets created to be edited by user as per project instance data name.
   
   
   
   
7. Enter Name, DisplayLabel, and TypeName (Datatype format), as defined for instance data. Say XYZ to be displayed under category Operating Conditions tab. 
   
   
   
   
8. Add Custom attribute Category on new property XYZ. User can copy this from any existing property in the list. say WALL_THICKNESS here. See image below. 
   
   
   
   
9. Copy it from WALL_THICKNESS property. 
   
   
   
   
10. Pull Category custom attribute to down for selection and click on copy. 
    
    
    Note -Define Location to OpenPlant_3D_supplemental_ModelingViews.01.07
    
    
11. Paste it on new XYZ property. See image below. 
    
    
    
    
12. Custom attribute gets added to new property XYZ. See image below. 
    
    
    
    
13. Save & Close schema. 

 Add new property ABC inside EQUIPMENT class under Design Conditions tab. 

1. User need to add the property under Primary schema level. Since other existing properties has been defined under it. 
2. Open OpenPlant.01.07.ecschema.xml. Supplement it with OpenPlant_Supplemental_Units_Metric.01.07.ecschema.
   
   
3. Navigate to EQUIPMENT class, check existing properties present under design Conditions tab, say LOWER_LIMIT_DESIGN_PRESSURE
   
   
   
   
4. One easier way is to copy the existing property and paste it & modify it for desired use. 
   
   
   
   
   
   
5. Rename copied property as desired, say ABC here. See image below.
   
   
   
   
6. Save Schema. 
7. Launch OpenPlant Modeler. 
8. Place Equipment and enter data. See results below. 
   
   

Adding Units to Properties

1. For Some design parameter unit or suffix may require to add /remove or modify which can be further added using Add Units option. See image below. 
   
   
   
2. Select the desired units if needed to change. 
   Note -Click these links to refer Remove Units>>>> & Modify Units >>>> from existing properties. 

To Make New Property Field editable. 

1. To create new property field Editable, add Custom Attribute "Property Display Status" and assign the location like shown in image below.
   
   
   
   Note- Ignore adding the custom attribute again, if it is already present on some properties. 
   
   
2. Set the value for both fields as per requirement.
   
   
   
   Note – User can use options provided under this field like to Hide, Read & editable as per requirement in OpenPlant Modeler.
   
   
3. Save & Close schema.
   
   
4. Launch OpenPlant Modeler & verify results.
   
   For Pipe:
   

See Also

See Video