Using the Graph Expansion API in a Query - SmartPlant Foundation - IM Update 44 - Customization & Programming - Hexagon

SmartPlant Foundation Customization

Language
English
Product
SmartPlant Foundation
Search by Category
Customization & Programming
SmartPlant Foundation / SDx Version
10

The Graph Expansion API was redesigned in Data Access Layer (DAL) for SmartPlant Foundation 2018 (7.0). This provides a more flexible way to query and expand the results graphically from data stored in the SmartPlant Foundation database.

You can use the Graph Expansion API to build up a graph expansion query to return data in three ways:

  • Full query expansion - The data is returned in a StructuredObjectCollection, which contains IObject results.

  • Partial query expansion - The data is returned in a LightReportingObjectCollection, which contains specific column sets of object results.

  • Count query expansion - The data is returned in a simple count of the objects at each graph node.

In each graph expansion type, a graph expansion request can be configured so that:

  • A graph expansion instance is created from a given graph UID.

  • Starting objects for the expansion can be optionally supplied.

  • Criteria for each graph node can be optionally applied.

  • The results properties for each graph node can be optionally configured for a partial query expansion only.

The following sections describe how you can build up graph expansion queries using the Graph Expansion API and includes some examples of key concepts.