The InconsistencyReport client API is used to create methods that can generate reports from the shortcut menus of objects.
Argument |
Description |
---|---|
Parameter 1 |
Report header |
Parameter 1 default |
Inconsistency Report |
Parameter 1 description |
The title to appear on the report. |
Parameter 1 type |
String |
Parameter 2 |
Report template name |
Parameter 2 default |
Inconsistencies Report With Summary Template |
Parameter 2 description |
The Microsoft Excel template to use for the report. |
Parameter 2 type |
String |
Parameter 3 |
Freeze panes |
Parameter 3 default |
True |
Parameter 3 description |
If set to True, keeps the first two columns of the worksheet static while the rest of the worksheet scrolls. If set to False, unlocks all rows and columns to scroll through the entire worksheet. |
Parameter 3 type |
Boolean |
Parameter 4 |
Show inconsistent properties only |
Parameter 4 default |
False |
Parameter 4 description |
If set to True, the report shows only inconsistent properties. If set to False, the report shows all properties. |
Parameter 4 type |
Boolean |
Parameter 5 |
Show inconsistent objects only |
Parameter 5 default |
True |
Parameter 5 description |
If set to True, the report shows only the objects that have inconsistent properties. If set to False, the report shows all the objects. |
Parameter 5 type |
Boolean |
Parameter 6 |
View in portrait orientation |
Parameter 6 default |
True |
Parameter 6 description |
If set to True, the properties are arranged vertically in a portrait orientation, with each property represented in a different row. If set to False, the properties are arranged horizontally in a landscape orientation, with each property represented in a different column. |
Parameter 6 type |
Boolean |
Parameter 7 |
Not used |
Parameter 8 |
Categorize objects based on Class Definition (per sheet) |
Parameter 8 default |
True |
Parameter 8 description |
If set to True, the objects are grouped by class definition in different sheets. If set to False, all objects are displayed in a single sheet. |
Parameter 8 type |
Boolean |
Parameter 9 |
Inconsistency type |
Parameter 9 default |
PUBLISHED |
Parameter 9 description |
Type PUBLISHED to generate reports across the published data, or type CONFIGURATIONS to generate reports for concurrent engineering. |
Parameter 9 type |
String |
Parameter 10 |
Include only mapped CDW properties |
Parameter 10 default |
True |
Parameter 10 description |
If set to True, the report includes only mapped CDW properties. If set to False, the report includes all the object properties. For this argument to be used, the site must be CDW enabled and the Inconsistency Type parameter must be set to PUBLISHED. |
Parameter 10 type |
Boolean |
Parameter 11 |
Present options dialog box |
Parameter 11 default |
False |
Parameter 11 description |
If set to True, the Inconsistency Report Options dialog box appears. You can select the report options in the Show Report By and Report Options sections. If set to False, the report options set by the administrator on the method are used for report generation. |
Parameter 11 type |
Boolean |
Parameter 12 |
Domain name for query |
Parameter 12 default |
None |
Parameter 12 description |
A comma-separated list of the domains to be included in the query for data. For Inconsistency type = PUBLISHED, specify at least two published domains or leave this parameter blank to compare all published domains. For Inconsistency type = CONFIGURATIONS, specify at least one domain. Optionally, append ",SELECT" to allow the user to select a domain when the report is generated. Such as PID,SP3D,IIC,ELE,SELECT |
Parameter 12 type |
String |
Parameter 13 |
Show consolidated name and description for each property |
Parameter 13 default |
False |
Parameter 1 description |
If set to True, the consolidated name and description will be shown for each property of the object. If set to False, the consolidated name and description is shown only once for each object. This parameter applies only if the inconsistency report type parameter is set as PUBLISHED. |
Parameter 13 type |
Boolean |
Parameter 14 |
Exclude specified CDW properties |
Parameter 14 default |
None |
Parameter 14 description |
Properties to exclude from the report. Specify as a comma separated list of UIDs for the CDW properties. This applies to CDW-enabled sites, and the user cannot modify the report during generation. If the Name and Description are included in the list, they are ignored. Specify "ClassDefinition" to exclude the ClassDefinition property from the report for all the objects. Example: SPFCDWInstrTagPrefix,SPFCDWFlowDirection,SPFCDWNominalDiameter |
Parameter 14 type |
String |
The following methods use the InconsistencyReport client API to generate reports that display consistent information across domains or configuration.
-
InconsistencyReport
-
ConfigurationInconsistencies