Applies To
Product(s):	OpenPlant PID CONNECT Edition
Version(s):	10.06.00.23+
Environment:	Windows 8.1/10 (64-bit)
Area:	Ribbon Customization
Subarea:	Custom Ribbons
Original Author:	Deepak Singh,Bentley Product Advantage Group

In OpenPlant PID CONNECT Edition, requirement is to create a custom tool group, custom tool button that will enlist custom added components into gallery.

Background

In this wiki article, we will see the implementation that needs to be done to create a new custom ribbon group, custom tool button. Upon evoking custom added button, it should enlist custom added component to gallery. To achieve this requirement, we will do changes as mentioned below.

• Implement a variable to write debug ribbon file.
• Add a custom ribbon for group & Add a custom new button.
• Add a new ribbon under PID Gallery Components node.

Steps to Accomplish

A. Implement a variable to write debug ribbon file.

1. Launch OpenPlant PID CONNECT Edition in your desired workset.
2. Open PIDProjectSymbols.dgnlib from desired workset location & click on Open.
   
   
   
   
3. From Search Ribbon, search for Configuration variables.
   
   
   
   
4. Under Configuration Variables Ribbon, Click on New to add a new variable as shown below.
   
   
   
   
5. Enter variable name as DebugGalleryGroupNames & value as 1. Click on OK, refer image below.
   
   
   
   
6. Once done, click on OK again to Configuration Variables This will pop an Alert message, click on No. Refer image below.
   
   
   
   No says that added config variable will be active only for the current active session. If we click on Yes, each time doing some modification to ribbon will create a debug file.

B. Add a custom ribbon for group & Add a custom new button.

1. From OpenPlant PID CONNECT Edition, right click on white-space of ribbon & select Customize Ribbon. Refer image below.
   
   
   
   
2. Under Customize Ribbon Dialog, from right hand pane (Customize the Ribbon section). Expand OpenPlant PID node and further expand Piping In this exercise we will add a custom group under Piping ribbon. Refer image below.
   
   
   
   
3. Right click on Piping node & select Add New Group. Refer image as shown below.
   
   
   
   
4. Enter desired group name here Bentley Custom Tool Group. Refer image below.
   
   
   
   
5. Right click on created group name & select “Add New Button” as shown below.
   
   
   
   
6. Enter desired button name here Bentley Custom Valves
   
   
   
   Note: To make this button functional, we need to create a new group under PID Gallery Components & add components into it. Once done we will enter required key-in for our created tool button.
   
   
7. For added button, from Properties, select Size as Large & click on Icon Name to define your custom icon. Refer image below.
   
   
   
   
8. Under Define Icon for Tool dialog, select mode as Import Selected Icons & click on Refer image below.
   
   
   
   
9. Import your *.icon file & click on Done. Once completed imported icon will start enlisting.
10. Click on imported icon & select OK, refer image below.
    
    
11. Click on Apply, it will start showing the selected icon for custom added button. Refer image below.

C. Add a new ribbon under PID Gallery Components node

1. From Customize Ribbon dialog, go to PID Gallery Components node.
2. Right mouse & select Add a New Group as shown below.
   
   
   
   
3. Enter desired group name here Custom Project Valve.
4. From Left hand side, select the desired component that needs to be added.
5. Select the component & click on Add. Once done click on Apply, refer sequential steps as shown below.
   
   
   
   
6. Notice that in message bar Gallery Debug file is created.
7. Click on message bar & open the DebugGalleyGroupNames.txt file from mentioned file location.
   
   
   
   
8. Open DebugGalleryGroupNames.txt file name & search for added Group Name (under PID Gallery Components) here Custom Project Valve.
9. Copy the highlighted command name as shown below. Please note that based on defined group name, command line will vary.
   
   
   
   
10. Switch to OpenPlant PID CONNECT Edition, from Customize Ribbon Expand the added tool button under Piping parent node. From Properties, enter Key-in value as shown below.
    
    Key-in: Besm MenuContext<copied command line from text file>
    
    
    
    
11. Click on Apply.
12. Once done, Close the Customize Ribbon dialog.
13. Notice that based on changes, custom added ribbon, custom tool button, tool icon & gallery component can be seen to OpenPlant PID CONNECT Edition application
    
    

See Also

communities.bentley.com/.../openplant-pid-connect

Still a Problem?

If above problem still persists, then please create a Service Request and contact the Bentley Product Advantage group.  Please include a list of all relevant details to get in depth analysis for a solution or workaround.