ViewBatchRenditionLog client API - HxGN SDx - Update 63 - Administration & Configuration

Administration and Configuration of HxGN SDx

Language
English
Product
HxGN SDx
Search by Category
Administration & Configuration
SmartPlant Foundation / SDx Version
10

The ViewBatchRenditionLog client API is used to configure viewing of an object, such as the batch renditions log file or a merged PDF file.

Argument

Description

Parameter 1

RelDef/EdgeDef UID

Parameter 1 default

None

Parameter 1 description

The relationship definition/ edge definition UID to the object to be viewed. For example, +SPFNotificationBatchRenditionLogFile or -SPFMergedRenditionComposition.

Parameter 1 type

String

Parameter 2

ColumnSet

Parameter 2 default

CS_SPFObject

Parameter 2 description

Name of the column set used to display the properties of viewable objects if the RelDef/EdgeDef UID parameter returns more than one object. If not set, the default is CS_SPFObject.

Parameter 2 type

None

The following methods use the ViewBatchRenditionLog client API to view a batch rendition log or a merged rendition.

  • ViewBatchRenditionLog

  • ViewMergedRendition

  • ChildDocumentDiscoveryTask_ViewDocumentDiscoveryLog

  • DocumentDiscoverytask_ViewDocumentDiscoveryLog

  • ViewReport

  • ViewReoprtFromSelectedObject

  • ViewWebGLSchedulerTaskProcessLog