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

SmartPlant Foundation Help

Language
English
Product
SmartPlant Foundation
Search by Category
Help
SmartPlant Foundation / SDx Version
10
SmartPlant Markup Plus Version
10.0 (2019)
Smart Review Version
2020 (15.0)

The GenMultiDatasheets client API is used to enable generation of multiple datasheets of process instruments.

Argument

Description

Parameter 1

Datasheet Definition UID

Parameter 1 default

None

Parameter 1 description

The UID of the datasheet definition that will be used to generate the datasheet

Parameter 1 type

String

Parameter 2

Directory path

Parameter 2 default

None

Parameter 2 description

The directory where the datasheet will be generated

Parameter 2 type

String

Parameter 3

UseClassificationBasedTemplate

Parameter 3 default

False

Parameter 3 description

If True, the datasheet definition is determined based on tag classification, and the cover sheet template is determined by the datasheet definition on the method. If False, the datasheet definition and the cover sheet templates are both determined by the datasheet definition defined on the method.

If this parameter is set to True, but no datasheet definition is defined for the tag classification, then the system uses the datasheet defined on the datasheet generation method for the tag.

Parameter 3 type

Boolean

Parameter 4

Datasheet Type (IPD, PID etc.)

Parameter 4 default

None

Parameter 4 description

Specifies the type of datasheet to be generated, such as IPD, Dev, or user-defined datasheet types.

If this value is NULL and the UseClassificationBasedTemplate argument is set to True, the system will use the template defined on the method. If this value is NULL and the UseClassificationBasedTemplate argument is set to False, the system will generate all the datasheet types based on the datasheet definition defined on the method.

Parameter 4 type

String

No delivered methods use this client API.