Create a client API report - SmartPlant Foundation - IM Update 48 - 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)
  1. Click File > New > Report.

  2. Select the type Client APIs from the list, and click OK.

  3. Select all the check boxes to include all properties in the report.

    • You can send the report output to a list view, to a file in Excel, Word, ASCII, Excel Register, and other formats, or to a custom reporting application if your system administrator has set up such a configuration.

    • If you specify Excel or Excel Register as the destination file type, you can use an existing Excel file as a template to format the report.

  4. Set the sort and search options for each property, as necessary.

    • You can set the report to sort properties in ascending or descending order. You can also set a value for each property by right-clicking or left-clicking the Sort Order column so that properties are sorted in the order you have defined:

      • By right-clicking the column, the greatest value incremented by one is assigned to the property.

      • By left-clicking the column, the greatest value incremented by one is assigned to the property, meanwhile a spin box is shown, allowing you to change the value.

    • You can define search criteria for each property by clicking in the Criteria column. For more information about setting criteria to filter report results, see Define filter criteria for an Adhoc report.

    • You can allow users to specify search criteria for a property each time the report is run by setting the Prompt option to True. You cannot define criteria for a report and set the report to prompt the user for a value. These two features are mutually exclusive.

  5. For a quick view of the report, click Apply. You can view the report and return to the Edit Report Definition dialog box to make changes.

  6. To save the report definition, click Save.

  7. Specify details for the saved report, and click OK. To run the report and exit the report definition, click OK on the Edit Report Definition dialog box.