You can configure Microsoft Excel reports to be run on SPFTEFSharedObjects. Users can select a single shared object or multiple shared objects in the list view and call this report from the right-click menu. The report is viewed in Microsoft Excel, and the reports highlight the inconsistent properties. See Viewing inconsistency reports in Microsoft Excel for more information about running the report.
The SmartPlant Foundation database includes the following methods for creating inconsistency reports for viewing published data. However, by default these methods are not associated with any access groups. To make these methods available to users, you must associate the methods with one or more access groups.
-
InstrumentConfigurationInconsistenciesByDocument
-
CDWEquConfigurationInconsistenciesByQuery
-
CDWInsConfigurationInconsistenciesByQuery
-
SharedEquConfigurationInconsistenciesByQuery
-
SharedInsConfigurationInconsistenciesByQuery
Configuring the report
Use the InconsistencyReport client API to configure the report to be run from the right-click menu of one or more shared objects.
Use the InconsistencyReportWithStartingObject client API to configure the report to be run from any object that has shared objects related to it. Valid objects include published documents and configuration items, such as plants, areas, or units.
For more information about the arguments of both client APIs, see InconsistencyReport client API and InconsistencyReportWithStartingObject client API.
Creating a Microsoft Excel template
When creating a custom template, you must rename one of worksheet name to ReportTemplate. The ReportTemplate worksheet acts as the starting page to load the inconsistent data.
You can create your own template file in Microsoft Excel, which is used to format the output of the report. For an example template, see the delivered template, Inconsistencies Report Template. The following named cells can be used to specify where the information will be displayed. At run-time, the named cell is replaced with the actual data from the report. If the named cell is not specified, then the software does not populate the information.
|
Named cell |
Description |
|---|---|
|
REPORT_HEADER |
Displays the header of the report, which is specified on the method. |
|
REPORT_USER |
Displays the user who created the report. |
|
REPORT_CONFIG |
Displays the current user configuration. |
|
REPORT_DATE |
Displays the date the report was created. |
|
REPORT_DOMAIN |
Displays the domain name, which is specified as criteria for inconsistency report generation. |
|
REPORT_TAGTYPES |
Displays the tag type (example: Instrument, equipment.), which is specified as criteria for inconsistency report generation. |
|
REPORT_START |
Indicates the first cell to be used to start writing the report data. Data is populated downwards and to the right of this cell. |
-
Create a template file in Microsoft Excel.
-
To create a new template document, select Document Category > Template Documents > Excel Template Document in the tree view.
-
Right-click Excel Template Document and click New Template Document.
-
Attach the Microsoft Excel file to the new template document.
-
Modify the method you created using the InconsistencyReport client API. Assign the new template to the Report Template Name argument (argument 3).