OpenPlant PowerPID How to Add Service Key-in that Drives Component
OpenPlant PowerPID How to Add Service Key-in that Drives Component Template at Placement and Post Placement Version 1.0 February 27, 2012 How to Add Service Key-in that Drives Component Template at Placement and Post Placement Trademarks Bentley, the “B” Bentley logo, MicroStation, ProjectWise and AutoPLANT are registered trademarks of Bentley Systems, Inc or Bentley Software, Inc. Microsoft, Windows and SQL Server are registered trademarks of Microsoft Corporation. AutoCAD is a registered trademark of Autodesk, Inc. Oracle 11g, 10g and Oracle 9i are registered trademarks of Oracle Corporation. Other brands and product names are the trademarks of their respective owners. Copyrights © 2010 Bentley Systems, Incorporated No part of this document may be reproduced, translated, or transmitted in any form or by an means, electronic or mechanical, for any purpose without the express written permission of Bentley Systems, Inc, and then only on the condition that this notice is included in any such reproduction. No information as to the contents of this document may be communicated to any third party without the prior written consent of Bentley Systems, Inc. Information in this document is subject to change without notice and does not represent a commitment on the part of Bentley Systems, Inc. Bentley Systems, Inc. is not liable for errors contained in this document or for incidental or consequential damages in connection with furnishing or use of this material. Including software, file formats, and audiovisual displays; may only be used pursuant to applicable software license agreement contains confidential and proprietary information of Bentley Systems, Inc. and/or third parties which is protected by copyright and trade secret law and may not be provided otherwise made available without proper authorization. RESTRICTED RIGHTS LEGENDS Use, duplication, or disclosure by the government is subject to restrictions as set forth in subparagraph (c)(1)(ii) of the Right in Technical Data and Computer Software clause in DFARS 252.227-7013 or subparagraphs (c)(1) and (2) of the Commercial Computer Software – Restricted Rights in 48 CFR 52.227-19 as applicable. Unpublished – rights reserved under the Copyright Laws of the United States and International treaties. Downloaded files from Bentley-related Internet websites and files included on MySELECT CDs are subject to the legal terms, conditions, policies and usage restrictions posted on the website(s), which may significantly alter the rights granted in the license agreement included with these materials. Version 1.0 February 27, 2012 Page 2 of 18 Copyright © 2010 Bentley Systems, Inc. Do Not Duplicate How to Add Service Key-in that Drives Component Template at Placement and Post Placement Document Version History Version Date Author Comments 1.0 Tony DeRosa Initial Release 02/01/2012 Reviewed By Date Approved By Date Software Versions Application Name Version OpenPlant PowerPID 08.11.09.26 (SS4 and higher) Bentley Class Editor From PowerPID install Version 1.0 February 27, 2012 Page 3 of 18 Copyright © 2010 Bentley Systems, Inc. Do Not Duplicate How to Add Service Key-in that Drives Component Template at Placement and Post Placement Table of Contents Assumptions prior to starting ........................................................................................................................................5 OpenPlant Power PID and Schema Editing ................................................................................................................5 Class and Project Information ...............................................................................................................................5 Objective ........................................................................................................................................................................5 General Overview of Required Administrative Task ..................................................................................................5 OpenPlant PowerPID Schemas ..............................................................................................................................5 Verifying the default BMF schema ................................................................................................................................6 Setting the EQUIPMENT and NOZZLE classes to use the Value Key-in ..........................................................................7 Modify the Existing SERVICE Property ...........................................................................................................................8 Modifying the SERVICE property on the EQUIPMENT class ......................................................................................8 Modifying the SERVICE property on the NOZZLE class ..............................................................................................9 Adding the New SERVICE_NAME Property to Class.....................................................................................................11 Adding the SERVICE_NAME property on the EQUIPMENT class .............................................................................11 Adding the SERVICE_NAME property on the NOZZLE class .....................................................................................11 Setting the Nozzle Dialog to Display at the Time of Placement ..................................................................................13 Creating the New Template in the DGNLib file............................................................................................................14 Testing the Results.......................................................................................................................................................16 Notes ...........................................................................................................................................................................18 Version 1.0 February 27, 2012 Page 4 of 18 Copyright © 2010 Bentley Systems, Inc. Do Not Duplicate How to Add Service Key-in that Drives Component Template at Placement and Post Placement Assumptions prior to starting OpenPlant Power PID and Schema Editing Class and Project Information Note: A general understanding and use of the Class Editor. A good understanding of OpenPlant PowerPID schemas is also assumed. Objective This session will cover the process of using an existing Associated Item (In this case SERVICE) to use a specific MicroStation template from a DGNLib file. This will allow the user to select SERVICE and set the value as desired and have the piece of equipment adopt a specific template that controls color, line weight and linestyle of that equipment. It will also allow this value to automatically be passed to related nozzles so they adopt the same template. Additionally if the user changes the value for SERVICE the equipment and related nozzles will update accordingly. This will only work with an ASSOCIATED PROPERTY and not a standard common property such as Description. Note: This procedure is for EQUIPMENT only and a separate slightly different approach is required for Pipe Lines/Runs and related in line components. General Overview of Required Administrative Task OpenPlant PowerPID Schemas Verify the BMF default schema. Set the class for equipment and nozzle to use the Value Key-ins. Modify the existing SERVICE property. Add the new SERVICE_NAME property. Set the Nozzle dialog to display at time of placement. Modify the template DGNLib file and add the new templates. Version 1.0 February 27, 2012 Page 5 of 18 Copyright © 2010 Bentley Systems, Inc. Do Not Duplicate How to Add Service Key-in that Drives Component Template at Placement and Post Placement Verifying the default BMF schema Load the Class Editor From within the Class Editor load the bmf.01.02.ecschema.xml schema Expand the Classes node tree in the left hand pane and verify that the class names shown below are present in the schema. These will be there in SS4 and higher but depending on previous customizations you may not be working with an SS4 version of the schema. Version 1.0 February 27, 2012 Page 6 of 18 Copyright © 2010 Bentley Systems, Inc. Do Not Duplicate How to Add Service Key-in that Drives Component Template at Placement and Post Placement Setting the EQUIPMENT and NOZZLE classes to use the Value Key-in Load the Class Editor From within the Class Editor load the OpenPlant_PID.01.02.ecschema.xml file located in the project schemas folder to be modified. Once loaded right click on the schema and from the context menu select Supplement Schema… and pick the OpenPlant_PID_Supplemental_Imperial.01.02.ecschema.xml file. Expand the tree in the left hand pane and pick on the EQUIPMENT class. Alternatively you can use the search tool to locate the class. Right click on the EQUIPMENT node in the left hand panel and from the context menu select Custom Attributes Add/Remove… Add the Value Property Template attribute and fill it in as shown below. Repeat this process for the NOZZLE class as shown below. Save the schemas. Version 1.0 February 27, 2012 Page 7 of 18 Copyright © 2010 Bentley Systems, Inc. Do Not Duplicate How to Add Service Key-in that Drives Component Template at Placement and Post Placement Modify the Existing SERVICE Property Modifying the SERVICE property on the EQUIPMENT class Continuing in the Class Editor Select the EQUIPMENT class in the left hand panel, in the right hand panel pick on the Properties tab. Navigate to the Service property and modify it as shown below adding the Value keyin attribute and the Set the active associated item (This is a BMF prefixed custom attribute). MAKE SURE TO ADD both of the custom attributes to the Supplemental schema. You may also have to add the BMF Notify Related Component of Property Value Change custom attribute if it does not already exist. Save the schema Version 1.0 February 27, 2012 Page 8 of 18 Copyright © 2010 Bentley Systems, Inc. Do Not Duplicate How to Add Service Key-in that Drives Component Template at Placement and Post Placement Modifying the SERVICE property on the NOZZLE class Continuing in the Class Editor Select the NOZZLE class in the left hand panel, in the right hand panel pick on the Properties tab. Navigate to the Service property and modify it as shown below adding the Value keyin attribute and the Set the active associated item (This is a BMF prefixed custom attribute). MAKE SURE TO ADD both of the custom attributes to the Supplemental schema. Version 1.0 February 27, 2012 Page 9 of 18 Copyright © 2010 Bentley Systems, Inc. Do Not Duplicate How to Add Service Key-in that Drives Component Template at Placement and Post Placement Save the schemas Version 1.0 February 27, 2012 Page 10 of 18 Copyright © 2010 Bentley Systems, Inc. Do Not Duplicate How to Add Service Key-in that Drives Component Template at Placement and Post Placement Adding the New SERVICE_NAME Property to Class Adding the SERVICE_NAME property on the EQUIPMENT class Continuing in the Class Editor Select the EQUIPMENT class in the left hand panel, in the right hand panel pick on the Properties tab. From the properties tab pick the Add… button and add a new property named SERVICE_NAME. To this new property add the Value key-in attribute and Notify Related Component of Property Value Change custom attributes as shown below. Save the schema. Adding the SERVICE_NAME property on the NOZZLE class Continuing in the Class Editor Select the NOZZLE class in the left hand panel, in the right hand panel pick on the Properties tab. From the properties tab pick the Add… button and add a new property named SERVICE_NAME. To this new property add the Value key-in attribute as shown below. Version 1.0 February 27, 2012 Page 11 of 18 Copyright © 2010 Bentley Systems, Inc. Do Not Duplicate How to Add Service Key-in that Drives Component Template at Placement and Post Placement Save the schema. Version 1.0 February 27, 2012 Page 12 of 18 Copyright © 2010 Bentley Systems, Inc. Do Not Duplicate How to Add Service Key-in that Drives Component Template at Placement and Post Placement Setting the Nozzle Dialog to Display at the Time of Placement Continuing in the Class Editor In the left hand panel select the NOZZLE class. Make sure the Class tab is active in the right hand panel. Locate the Tag Display Prompt Custom attribute and edit so that SyncWithTagDisplayVariable is set to TRUE as shown below. Save the schemas. Version 1.0 February 27, 2012 Page 13 of 18 Copyright © 2010 Bentley Systems, Inc. Do Not Duplicate How to Add Service Key-in that Drives Component Template at Placement and Post Placement Creating the New Template in the DGNLib file. Load OpenPlant PowerPID. From the startup dialog change the file type to DGN Libraries. Navigate to the project specific dgnlibs folder and load the PIDProjectTemplates.dgnlib file. From the menu select Element > Element Templates. In the Element Templates dialog expand the PIDProject Templates dgnlib node. Pick on the node and then pick on the New Template Group tool and add a new group named States. (NOTE THIS NAME IS CRITICAL as it matches the current key-in values set in the schemas.) Now that the States group is created pick on the States node and pick the New Template icon. Name the new template New. Repeat this process two more times and add the Existing and Future templates. For the sake of making them different select each template and set the Colors property to be different for each one. Version 1.0 February 27, 2012 Page 14 of 18 Copyright © 2010 Bentley Systems, Inc. Do Not Duplicate How to Add Service Key-in that Drives Component Template at Placement and Post Placement Exit the DGNLib file. Version 1.0 February 27, 2012 Page 15 of 18 Copyright © 2010 Bentley Systems, Inc. Do Not Duplicate How to Add Service Key-in that Drives Component Template at Placement and Post Placement Testing the Results Launch OpenPlant PowerPID. Create a new PID file. Add three new services to the file. Add “New”, “Existing” and “Future”. Insert a Vessel. Place the vessel and from the Tag Dialog set the Service to Future. o Notice the tank inserts based on the template settings as defined in the schema. In this c a s e i t s h o w s i n g r e e n Add a Nozzle to the vessel. o Note the Nozzle adopts the same template as the vessel and displays in the green color. Version 1.0 February 27, 2012 Page 16 of 18 Copyright © 2010 Bentley Systems, Inc. Do Not Duplicate How to Add Service Key-in that Drives Component Template at Placement and Post Placement Now edit the vessel and change the Service to “New”. o Note the vessel and the nozzle update to the correct template settings. In this case the vessel and the nozzle colors are set to red. Version 1.0 February 27, 2012 Page 17 of 18 Copyright © 2010 Bentley Systems, Inc. Do Not Duplicate How to Add Service Key-in that Drives Component Template at Placement and Post Placement Notes Version 1.0 February 27, 2012 Page 18 of 18 Copyright © 2010 Bentley Systems, Inc. Do Not Duplicate
© Copyright 2024