Fundamentals of Reporting Designer Using OpenPlant Project Administrator CONNECT Edition


Applies To 
Product(s):OpenPlant Modeler
Version(s):

10.07.00.32+

Environment: Windows 8 (64-bit) | Windows 10
Area: OpenPlant Project Administrator
Subarea: Reporting Designer
Original Author:Deepak Singh, Bentley Product advantage Group


Overview

In OpenPlant Project Administrator CONNECT Edition, new Reporting Designer has been introduced that is completely different from V8i reporting tool.

Background

In this wiki article, we will understand about the concept of new report designer that has been introduced for OpenPlant CONNECT suits. The new report designer is based on DevExpress technology. In this wiki article, we will outline the very basics/fundamentals for creation of reports using OpenPlant Project Administrator CONNECT Edition. We will discuss on below mentioned topics.

A. How to create a new report & what are the possible ways to create a new report.

  1. Launch OpenPlant Project Administrator CONNECT Edition.
  2. Select your desired workspace/workset. Pick the suitable application here OpenPlant Modeler, switch to Tools & select Reporting Designer to launch.



  3. Once Reporting Designer is loaded we can see the interface of Reporting Designer.
  4. From left hand, pane under Report Selector we can see the pre-defined template folders as shown below.



  5. Each report folder contains respective report based on disciplines.
  6. Right click on any report to create a New Folder as shown below.



  7. Report creation can be done via two means (Report Via Wizard & Report via File)

New Report via Wizard

  1. Click on New Report > New Report via Wizard.
  2. Enter the desired name & display for report.



  3. Notice that EC Query is showing in red color, this shows that no EC Classes has been selected for this report.
  4. Click on Design to define EC Query for your report.
  5. Search for desired class name, here Piping Component (OpenPlant_3D).
  6. Once selected, click on OK.



    Note: Selected EC Query can be saved as well to be used in future while creating different report.

  7. Notice that under Create Report dialog, we can see the selected Class Name.
  8. Click on OK to proceed further.



  9. Under Report Wizard, select desired report type (here Empty) & click on Finish.



  10. Once completed, created report can be seen under report selector as shown below.
  11. Also, any report can be saved to file for future use in creating report, refer image below.

    New Report via File

    A new report can be created via report file as well. In above section we have noticed that how report can be saved. We can use any saved report to create a report via File.

  1. Click on New Report > Report via File.



  2. This will ask to point to saved report file (*.repx file). Select any saved report file & click on Open.



  3. This will ask to define the report name, define EC Query for this report, refer image below.
  4. Enter desired report name.



  5. For definition of EC Query, we will import existing saved query file (*.ecquery.xml).
  6. Click on Import icon & point to saved ecquery.xml file. Once done click on Open.



  7. Notice that based on import query, classes get loaded & can be seen as shown below.



  8. Click on OK to create report.

B. Page Header & Page Footer

  1. These bands are at the top and bottom of every page in a report. They display information that should be printed on every page.



  2. Bands can be inserted by right clicking on white-space of report & selected desired band type. Refer below image.


  3. From Tool Box, we can select Labels & drag it Page Header section. In the similar fashion, for Page Footer same can be done as shown below.



  4. If we general report from OpenPlant Modeler, we can see result as shown below.


C. Report Header & Report Footer

  1. The Report Header is the report's first band (margins are "out-of-page" zones). Use this band to display the report's name, company logo, date of creation, username, etc.The Report Footer is placed before the Page Footer and Bottom Margin on the report's last page. You can use the Report Footer band for report summaries or conclusions.
  2. From Tool Box, we are choose desired options for our report header & report footer. Sample defined Report Header & Report Footer as shown below.



  3. If we generate report, we can see output as shown below.

D. Group Header & Group Footer

  1. These bands are above and below each group. The Group and Sort Panel create these bands automatically.
  2. From Group and Sort dialog, whenever we Add a Group (here Line Number) then Group Header band will automatically added to report as shown below.



  3. Using Label tool added text (LINE NUMBER) to show the group header. Notice that under Group & Sort dialog, we have option to show/hide group header & footer. Tick option means show & uncheck is hide.
  4. If we generate report we will get result as shown below.

E. Detail Band

  1. The Detail band is printed for every record in a data source unless you filtered the data. Please note that whenever we create a report by default a detail band be there & it can’t be deleted.


F. Adding Data to detail band

  1. Addition of fields, data, and field with data binding can be added to detail band to see the details of report. We can add fields from Field List dialog. To add the fields, select the desired field from Field List & drag it to detail band.

    Sample Report with Fields in Detail Band



    If we generate the report out of it for some piping component placed in OpenPlant Modeler, we will see details as shown below.

See Also

communities.bentley.com/.../how-to-preview-reports-of-placed-components-in-openplant-modeler

Comment or Corrections

Bentley's Technical Support Group requests that you please confine any comments you have on this Wiki entry to this "Comments or Corrections?" section. THANK YOU!