Reports are based on view definitions that are in turn based on graph definitions. The graph definition is a collection of edge definitions that represents a path through the data model. Edge definitions can be seen as relationships between modeled objects.
Details of the properties and functionality exposed by these interfaces are given in the sections that follow.
ISPFAccessGroup interface
This interface holds the groups that can access the IViewDef interface. See the Roles, domains, and access groups for more details.
IViewDef interface
This interface holds the view definition path that describes which interfaces and properties the interface will use.
The following properties are found on this interface.
|
Name |
Description |
Set on |
|---|---|---|
|
GraphDefnUID |
The graph definition unique identification; the UID of the graph definition on which this view definition is based |
Set in the Schema Editor |
|
ViewPropsDefn |
The sub set of properties to view (from the objects exposed) |
Set in the Schema Editor |
SPFViewDefAccessGroup relationship definition
This relationship links the view definition and the access group. Only those users who are assigned to roles containing the access group can run a report using this view definition.
SPFAdhocReportViewDef relationship definition
Links the view definition to the saved report.
SPFAdhocReport class
This class is a saved report and holds the properties that were set when the report definition was saved.
ISPFAdhocReport interface
Used to hold properties which are set at the point of creating the new report.
The following properties are found on this interface.
|
Name |
Description |
Set on |
|---|---|---|
|
SPFReportOutputTo |
Type of report output (This is a fixed set of option supplied with the SmartPlant Foundation core model. The options are: New Window, Word, Excel, HTML, XHTML and Custom Report.) |
Edit Report Definition form |
|
SPFReportSelectedTemplate |
The report template used (optional) |
Edit Report Definition form |
|
SPFShowLatestValuesOnly |
Show only the latest values of the properties found |
Edit Report Definition form |
Functionality configured on ISPFAdhocReport
The following commands are configured on this interface; Archive Files (archives the files attached to the report), Change Owner and Owning Group, Edit Report Definition, Run Report, Terminate, and Update.
ISPFSupportItem
Used to link these interfaces to folders.
SPFReportReportDetail relationship definition
Links the saved report to the report details.
SPFReportDetail class
One of these classes is created for each view definition detail included at the point the report was saved.
ISPFReportDetail interface
This interface holds the ad hoc report details, (that is, the structure of the report).
The following properties are found on this interface.
|
Name |
Description |
Set on |
|---|---|---|
|
SPFRptDetEdge |
Report detail edge definition |
Edit Report Definition form |
|
SPFRptDetInterface |
Describes which interface this piece of data comes from |
Code |
|
SPFRptDetName |
The source property definition |
Code |
|
SPFRptDetDisplayAs |
The name to be displayed in the report |
Can edit on the Report Definition form |
|
SPFRptDetSortOrder |
Report detail sort order |
Edit Report Definition form |
|
SPFRptDetCriteria |
Report detail criteria definition |
Edit Report Definition form |
|
SPFRptDetOutput |
Whether this item will be displayed on the report |
Edit Report Definition form |
|
SPFRptDetPrompt |
Prompt user for a value at report run time |
Edit Report Definition form |
|
SPFRptDetColumn |
Report detail columns |
Edit Report Definition form |
|
SPFRptDetSortAscending |
Sort ascending |
Edit Report Definition form |
Functionality configured on ISPFReportDetail
Basic commands such as Copy, Terminate, and Update are configured on this interface.
ISPFWorkflowItem interface
ISPFOwnedObj interface
See Object ownership.
ISPFDataAccessGroup interface
Saved reports are owned objects. The owner can be a user or owning group of a report, and only the owner can run the report. Note also that the user must have access to the underlying view definition as well.
To run the report, the user must be in a role in the owning group of the saved report and the access group of its view definition.
See Roles, domains, and access groups for more details.
ISPFSubscribableItem
For information about this interface definition, see Infrastructure Model.
ISPFSupportItem
For information about this interface definition, see Infrastructure Model.