2010 Bentley Systems Incorporated www bentley co m
© 2010 Bentley Systems, Incorporated www. bentley. co m Designing e. B Reports Asset. Wise Training Series
• Reports are for gathering data for analysis – Emphasis on display to aid analysis – Column Sorting to organize data – Metadata used to filter out uninteresting objects • Searches are for finding objects to work on – Goal is often to find just one hit 2 | WWW. BENTLEY. COM © 2010 Bentley Systems, Incorporated Reports versus Searches
• Create the report object • Build the query – Decide which columns to display – Set up filtering criteria • Fine-tune the display of columns – Set the order, visibility, width, labels, etc • Adjust the user interface – Parameter entry – Optional criteria – Hotlinks in results 3 | WWW. BENTLEY. COM © 2010 Bentley Systems, Incorporated Report design overview
Launches Report Designer 4 | WWW. BENTLEY. COM © 2010 Bentley Systems, Incorporated Creating Reports in e. B Director
Sequence Area Hints Area Search String (e. QL) Hint Topics 5 | WWW. BENTLEY. COM © 2010 Bentley Systems, Incorporated e. B Report Designer
Primary Object Columns to display Filter Criteria Column sorting 6 | WWW. BENTLEY. COM © 2010 Bentley Systems, Incorporated Anatomy of an e. QL query
Keywords in upper case Commas between columns No comma at end of SELECT Single quotes for text Dot notation for related properties 7 | WWW. BENTLEY. COM Extra spaces & returns OK © 2010 Bentley Systems, Incorporated Query syntax
Start typing Pop-up menu displays choices 8 | WWW. BENTLEY. COM © 2010 Bentley Systems, Incorporated Auto-completion for object properties
(cont) Place cursor ‚ Double-click hint text ƒ Property added to e. QL 9 | WWW. BENTLEY. COM © 2010 Bentley Systems, Incorporated Auto-completion for object properties
Goal Create a report for documents in the Specification class 10 | WWW. BENTLEY. COM © 2010 Bentley Systems, Incorporated Exercise: creating reports
© 2010 Bentley Systems, Incorporated Specifying attribute values Double-click Value for that attribute Attribute Name Scope for the attribute (usually Global) 11 | WWW. BENTLEY. COM
Related Object 12 | WWW. BENTLEY. COM Attribute of Related Object © 2010 Bentley Systems, Incorporated Specifying attribute values of related objects
• Use Is. Template property in WHERE clause • Is. Template = ‘N’ • Is. Template = ‘Y’ • Example: 13 | WWW. BENTLEY. COM © 2010 Bentley Systems, Incorporated Avoiding template retrieval
• Show Full Date • Use special date format • Show year only 14 | WWW. BENTLEY. COM © 2010 Bentley Systems, Incorporated Adjusting date display
• One year since the effective date • Seven days before today • Two months from the date in an attribute 15 | WWW. BENTLEY. COM © 2010 Bentley Systems, Incorporated Calculating dates
• Specify null values • Negation • Finding Docs with both. pdf and. dwg files • String manipulation 16 | WWW. BENTLEY. COM © 2010 Bentley Systems, Incorporated Other e. QL tricks
• Some e. B Properties have two forms: – A display name for the user interface – An internal e. B code • Property Use e. B code in names WHERE clause Display e. B Codes Document Approved Not Approved Planned A N P Change Request Approved Completed Draft Expedited Proposed Rejected Cancelled A C D E P R X Person, Organization Active Not Active A N Approval. Status 17 | WWW. BENTLEY. COM © 2010 Bentley Systems, Incorporated Display names versus e. B codes
Property to be translated 18 | WWW. BENTLEY. COM Translation from Code to Name © 2010 Bentley Systems, Incorporated Quick Info button translates e. B codes
• DISPLAY_NAME() converts e. B codes to names • Use in SELECT to display names in report results DISPLAY_NAME function Friendly name 19 | WWW. BENTLEY. COM © 2010 Bentley Systems, Incorporated Display names for e. B codes
• Parameters are placeholders in a query • Users supply values for placeholders when they run the report • Parameters use @ prefix in e. QL • Parameter name is whatever you choose • Example: 20 | WWW. BENTLEY. COM © 2010 Bentley Systems, Incorporated Adding parameters to a query
Fill in values 21 | WWW. BENTLEY. COM © 2010 Bentley Systems, Incorporated Query parameters: what the user sees
@Approval from e. QL Display name Input validation 22 | WWW. BENTLEY. COM © 2010 Bentley Systems, Incorporated Formatting the display of parameters
User-defined values Mini-search System-defined values Initial value 23 | WWW. BENTLEY. COM © 2010 Bentley Systems, Incorporated Setting up lists for parameter values
• e. B can supply values for: – Current user id: $Session. Person. Id – Current date: $Today • Called “Built-in fields” in Report Designer • Like parameters where e. B supplies the values • Example: Show docs I created today 24 | WWW. BENTLEY. COM © 2010 Bentley Systems, Incorporated Using run-time values in a query
• Allows user to choose which criteria to include in query Enter Description Choose Criteria 25 | WWW. BENTLEY. COM © 2010 Bentley Systems, Incorporated Making criteria optional
• Unchecked criteria are omitted from the query Optional criteria 26 | WWW. BENTLEY. COM © 2010 Bentley Systems, Incorporated Display of optional criteria
e. QL property Column label 27 | WWW. BENTLEY. COM © 2010 Bentley Systems, Incorporated Adjusting column labels
• Drag & drop to adjust columns 28 | WWW. BENTLEY. COM © 2010 Bentley Systems, Incorporated Adjusting column order
© 2010 Bentley Systems, Incorporated Adjusting column width Pixels Divide remaining space equally 29 | WWW. BENTLEY. COM
• “Properties for the Report” makes whole row a hyperlink • “Properties for column” makes column text a hyperlink • Include IDs in e. QL SELECT for objects to be hyperlinked Uncheck to hide IDs Person hyperlink for selected column Row hyperlink 30 | WWW. BENTLEY. COM © 2010 Bentley Systems, Incorporated Creating hyperlinks for report entries
Goal Create a report for documents in the Specification class created by you Extra credit: Add a criteria to search on an attribute value supplied by the user 31 | WWW. BENTLEY. COM © 2010 Bentley Systems, Incorporated Exercise: creating reports
• Choose object type 32 | WWW. BENTLEY. COM © 2010 Bentley Systems, Incorporated Creating reports via wizard
• Add search terms Add Criteria Delete Criteria Specify Criteria 33 | WWW. BENTLEY. COM © 2010 Bentley Systems, Incorporated Creating reports via wizard (cont)
• Choose columns to display Object Properties Object Custom Attributes Properties of Related Objects 34 | WWW. BENTLEY. COM © 2010 Bentley Systems, Incorporated Creating reports via wizard (cont)
• Set up column sorting Add From List 35 | WWW. BENTLEY. COM © 2010 Bentley Systems, Incorporated Creating reports via wizard (cont)
• Adjust column order, labels, and widths Width in Pixels 0 for default width 36 | WWW. BENTLEY. COM © 2010 Bentley Systems, Incorporated Creating reports via wizard (cont)
• Final formatted report 37 | WWW. BENTLEY. COM © 2010 Bentley Systems, Incorporated Creating reports via wizard (cont)
Expand to view results Select to see auto filing rules 38 | WWW. BENTLEY. COM © 2010 Bentley Systems, Incorporated Auto-filing folders
• Primary and dependent objects in e. B • Walk-through of e. B Director and e. B Web • Creating a logon account • How to create simple and advanced searches 39 | WWW. BENTLEY. COM © 2010 Bentley Systems, Incorporated What we’ve covered
- Slides: 39