Creating and extending reports - SmartPlant Foundation - IM Update 46 - Help - Hexagon

SmartPlant Foundation Help

Language
English
Product
SmartPlant Foundation
Search by Category
Help
SmartPlant Foundation / SDx Version
10
SmartPlant Markup Plus Version
10.0 (2019)
Smart Review Version
2020 (15.0)

Ad hoc reports

New objects can be added to an ad hoc report by modifying the graph definition in the Schema Editor.

The order in which the properties are displayed in ad hoc reports can be changed by modifying the view definition in the Schema Editor.

Here is a four-and-a-half minute video that shows you how to generate a new report from the Desktop Client. It also shows how to create a new method for a saved report, associate a new method with an access group, and create a menu and menu item.

Extending CSV report date format

The default date formats for the ad hoc report CSV output style can be configured to a different date format by extending the DateTimeFormat enumerated list and adding a new date format entry that is displayed when the DateTimeFormat option is selected in the CSV settings.

The following date time formats are delivered with the software:

  • dd-MMM-yy

  • dd-MMM-yy HH:mm:ss

  • dd-MMM-yyyy

  • dd-MMM-yyyy HH:mm:ss

  • dd-MM-yyyy

  • dd-MM-yyyy HH:mm:ss

  • MM-dd-yyyy

  • MM-dd-yyyy HH:mm:ss

  • yyyy-MM-dd

  • yyyy-MM-dd HH:mm:ss

For more information on the CSV report output style, see Reports.

For more information on how to extend an enumerated list, see Extending the SmartPlant Schema.

Saved reports

To add more details to an existing report, it is necessary to add a new edge definition by extending the view definition for that report.

Editing a report definition

Use the following steps to edit a report to add new properties and create a new template:

  1. Edit the view definition for the report, and add the new properties.

  2. Open the report in the Edit Report Definitions dialog box. The new properties are displayed.

  3. Select the required defaults, such as sort order and criteria.

  4. Check out the template document for the report.

  5. Edit the template (see New report template configuration).

  6. Check in the template.

Example of editing a report

The following example shows how to add a new edge definition (for the local file path) to the DocVersionViewDef report type.

  1. In the Schema Editor, open the graph definition that the DocVersionViewDef report uses (DocVersionStructure in this example).

  2. Create the new edge definition and extend the graph definition to include a new edge definition.

  3. Save the edited graph definition.

  4. Open the view definition that the report is based on (DocVersionViewDef in this example).

  5. Extend the view definition to use the properties from the edge definition created above and add the relevant captions.

    Graph edge name

    Interface

    Property

    Name

    Category

    All files

    ISPFFile

    SPFLocalPath

    SPFLocalPath

    All Files

  6. Import the updated schema back into the database. The new report detail option (SPFLocalPath) appears in the Edit Report Definition dialog box.

  7. Set the report ownership as required. See Graph definition configuration for details.

See Also

View definition configuration