Column Set Cost Report - HxGN SDx - Update 64 - Administration & Configuration

Administration and Configuration of HxGN SDx

Language
English
Product
HxGN SDx
Search by Category
Administration & Configuration
SmartPlant Foundation / SDx Version
10

The Column Set Cost Report quantifies the efficiency of the column sets in the system. When you run the report, it looks at every column set in your system and counts the number of:

  • Properties

  • Relationships

  • Edges

Each item is assigned a value depending on its performance load on the system, with Properties having the lowest value and Edges having the highest.

The total cost assigned to each column set is then calculated as:

(Count of Properties * Value of Properties) + (Count of Relationships * Value of Relationships) + (Count of Edges * Value of Edges)

How do I run the report?

  • Run the report using a GET request in Postman. The command to run the report is:

    http://<server>/<site>/api/v2/SDA/GetColumnSetCostReport

The report is displayed in JSON format, and is ordered in descending order by overall cost. This means that you can easily see the column sets in which optimizations might be made at the top of the report.

Postman is an API platform for building and using APIs. For more information on Postman, see www.postman.com.

What does the Column Set Cost Report look like?

The following is an extract from a Column Set Cost Report:

{

"@odata.context": "http://localhost/sdxserver/api/v2/SDA/$metadata#Collection(Intergraph.SPF.Server.API.ClientSupport.Types.ColumnSetReportDetails)",

"value": [

{

"ColumnSetName": "ColumnItemWithRelListEdit",

"ColumnSetDescription": null,

"ColumnSetCost": 58,

"ColumnSetPropertyCount": 7,

"ColumnSetRelCount": 0,

"ColumnSetEdgeCount": 17

},

{

"ColumnSetName": "SDADocumentVersion",

"ColumnSetDescription": "Document version list view",

"ColumnSetCost": 58,

"ColumnSetPropertyCount": 9,

"ColumnSetRelCount": 8,

"ColumnSetEdgeCount": 11

},

{

"ColumnSetName": "SCLBOutgoingActionCS",

"ColumnSetDescription": "Outgoing action",

"ColumnSetCost": 55,

"ColumnSetPropertyCount": 39,

"ColumnSetRelCount": 8,

"ColumnSetEdgeCount": 0

},

...

}

In this report:

  • ColumnSetCost is the overall cost calculated for the column set.

  • ColumnSetPropertyCount is the count of the number of properties.

  • ColumnSetRelCount is the count of the number of relationships.

  • ColumnSetEdgeCount is the count of the number of edges.