The interfaces used in SmartPlant Business Intelligence are shown in the following model.
Details of the properties and functionality exposed by these interfaces used in the Business Intelligence module are given in the following sections.
ISPFViewDef
This interface is responsible for identifying the view definition that is related to the report.
ISPFColumnSet
This interface is responsible for identifying which column set will be used for the report drill down.
ISPFAccessGroup
This interface is responsible for identifying who can access and run the report.
ISPFOwningGroup
This interface is responsible for identifying who can administer the report definition.
ISPFBIReport
This interface contains the structure and properties for the report. The following properties are found on this interface.
Name |
Description |
Set on |
---|---|---|
SPFBIRptTitle |
Report title |
Create/Edit Report Definition wizard. |
SPFBIRptIgnoreZeroCounts |
Ignore zero count groupings/series groupings. |
Create/Edit Report Definition wizard. |
SPFBIDDEnabled |
If drill down to list view is enabled on the report |
Create/Edit Report Definition wizard. |
SPFBIRptPageSize |
The number of records to retrieve when drilling down |
Create/Edit Report Definition wizard. |
SPFBIRptXAxisLabel |
The X-axis label |
Create/Edit Report Definition wizard. |
SPFBIRptYAxisLabel |
The Y-axis label |
Create/Edit Report Definition wizard. |
ISPFBIReportPrompt
This interface indicates if a prompt is required for a property. The following properties are found on this interface.
Name |
Description |
Set on |
---|---|---|
SPFBIRptPrmptViewDefProp |
The name of the property. |
Create/Edit Report Definition wizard. |
ISPFBIReportCriteria
This interface contains the structure and properties to build criteria for the report. The following properties are found on this interface.
Name |
Description |
Set on |
---|---|---|
ISPFBIReportCriteriaS |
Describes the shared interface which contains the criteria. |
Code. |
ISPFReportGroupItem
This interface contains the label that is displayed as part of the report grouping/series grouping. The following properties are found on this interface.
Name |
Description |
Set on |
---|---|---|
SPFBIRptGrpItmLbl |
The label for the grouping/series grouping. |
Create/Edit Report Definition wizard. |
ISPFReportGroupItemDetail
This interface contains the label that is displayed as part of the report grouping/series grouping. The following properties are found on this interface.
Name |
Description |
Set on |
---|---|---|
SPFBIRptGrpItmDtlUseRTValues |
Determines if groupings/series groupings should be created at run time. |
Create/Edit Report Definition wizard. |
ISPFBIReportCriteriaS |
Describes the shared interface which contains the criteria for the grouping. |
Code. |
ISPFBIReportCriteriaS
This interface contains the common structure used to define report criteria. The following properties are found on this interface.
Name |
Description |
Set on |
---|---|---|
SPFBIRptCriteriaViewDefProp |
The name of the property. |
Create/Edit Report Definition wizard. |
SPFBIRptCrtrValue |
The value for the criteria. |
Create/Edit Report Definition wizard. |