ExecuteGraphicReport client API - SmartPlant Foundation - IM Update 46 - Help - Hexagon

SmartPlant Foundation Web Client Help

Language
English
Product
SmartPlant Foundation
Search by Category
Help
SmartPlant Foundation / SDx Version
10

The ExecuteGraphicReport client API is used to run a selected graphic report.

Argument

Description

Parameter 1

Display mode (OPEN or FRAME)

Parameter 1 default

FRAME

Parameter 1 description

If set to OPEN, a URL to the results will be displayed in a separate browser window. If set to FRAME, the URL will open in an internal frame in the Desktop Client.

Parameter 1 type

String

Parameter 2

Display markups

Parameter 2 default

True

Parameter 2 description

If set to True, markups associated with the document will be displayed automatically. If set to False, markups will not be displayed.

Parameter 2 type

Boolean

Parameter 3

Document query interface

Parameter 3 default

ISPFTEFPublishedDocRevision

Parameter 3 description

Interface used to find drawings or models to run the graphic report on.

Parameter 3 type

String

Parameter 4

Query filter - property comparison

Parameter 4 default

None

Parameter 4 description

Criteria that must be met by an object for it to be returned by the report.

Parameter 4 type

String

Parameter 5

Configuration Behaviour

Parameter 5 default

None

Parameter 5 description

Indicates what configurations will be queried for results.

NullConfigQuery - Queries once for null configuration objects.

IgnoreConfigFilter - Always queries selected configurations and their parent configurations.

Blank - Queries with regular configuration filtering, using the current user's query scope.

Parameter 5 type

String

The ExecuteGraphicReport method uses the ExecuteGraphicReport client API to run a graphic report.