View definitions - HxGN SDx - Update 56 - Reference

HxGN SDx Schema Overview

Language
English
Product
HxGN SDx
Search by Category
Reference
SmartPlant Foundation / SDx Version
10

Directed graph definitions are useful for defining a network of objects to be traversed. While the objects resulting from traversing a graph definition (the graph for that graph definition) can be viewed as objects, there is also a desire to see these objects from a flattened perspective.

Viewing objects from a flattened perspective can be useful for

  • Viewing the graph as a table where each row in the table corresponds to one set of objects from the graph

  • Viewing the graph as an Excel data sheet where cells in the data sheet correspond to specific properties from specific objects in the graph

View definitions are used to support this flattening of the directed graph. A view definition includes a selected subset of the complete set of properties that a graph definition exposes.

View definitions are the equivalents of relational database views. A relational database view is a combination of joins and projects where the joins are used to retrieve the desired objects and the projects are used to determine which properties (columns) to include and what to call those properties. The equivalents of relational database joins are directed graph definitions. The projection of this graph data is accomplished using view definitions.

View definitions consist of the following:

  • A starting interface definition.

  • Identification of the directed graph definition for the view definition.

  • A definition of the projection of property definitions from the directed graph definition, including modified display names as needed.

A view definition is based on a directed graph definition and, therefore, like the directed graph definition, has a relationship to its starting interface definition. This interface definition should always be the same interface definition as that for its directed graph definition.

View definitions in SDx

In SDx, view definitions are used to define what properties the users see in the client. When you create ad-hoc reports in SDx, you can also select the view definition that you want to use as the basis for the report as well as the properties from that view definition that you want to include in the report.

You can also use view definitions to create alternate views for classes. To create an alternate view for a class, you must do the following:

  • Create the appropriate class definition in the schema, if necessary

  • Create a method that references the view definition

  • Define user access for the method

  • Associate the method with an interface

For all users who have access to the method, the method shows up on the shortcut menu for all class definitions that realize the interface definition.