In HxGN SDx, reports allow you to search for a type of object in the database and use the properties to filter the results found. Report definitions determine both the type of object that is searched for and the properties of those objects that are returned. For example, you can create a report definition to search for tags based on their properties and return not only properties particular to the tags, but also properties of related objects, such as the names of related units.
Report definitions are equivalent to relational database views, displaying the requested objects, their properties, and their relationships to other objects in the database. Report definitions are the basis for both the ad-hoc and Business Intelligence reporting functionality in HxGN SDx.
The SmartPlant Report Administration module includes an easy-to-use graphical interface that allows you to configure report definitions even if you do not have a detailed understanding of the schema and its terminology. The report definitions are made up of two parts:
View definition - Defines the properties to be extracted for the returned object and any related objects. The view definition also allows you to change the display values for properties, so that you can configure how they will appear in the final report.
Graph Definition - Defines a collection of properties, for both the returned object and any other types of objects in the database to which it is related, from which you can choose those that will be included in the report.
You can create or modify report definitions in the SmartPlant Report Administration module using the Report Administration Wizard. This wizard allows you to view properties of an object and navigate the relationships between that object and others in the database, exposing properties of the objects on the other end. The resulting collection of properties is called a graph definition.
The process of creating a new report definition with this wizard includes the following steps:
-
Create a new report definition and select an example object from a list
-
Refine the access options
-
Expand the relationships in a tree view to navigate to related objects
-
Select the properties of related objects found on each relationship expansion
-
Save the report definition hierarchy result and view the relationships displayed in the graph definition