ExportObjectStructureLocal client API - SmartPlant Foundation - IM Update 48 - 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 ExportObjectStructureLocal client API is used to configure the online export of an object structure.

Argument

Description

Parameter 1

GraphDef for structure export

Parameter 1 default

None

Parameter 1 description

Graph definition to expand the object structure to get all the files.

Parameter 1 type

String

Parameter 2

Adhoc report name

Parameter 2 default

None

Parameter 2 description

Ad hoc report name to navigate the exported structure.

Parameter 2 type

String

Parameter 3

Export Alternate Rendition copies only

Parameter 3 default

False

Parameter 3 description

Indicates whether to export alternate rendition copies only

Parameter 3 type

Boolean

Parameter 4

Export reference files

Parameter 4 default

False

Parameter 4 description

Indicates whether to export related reference files

Parameter 4 type

Boolean

Parameter 5

Compress the exported structure

Parameter 5 default

False

Parameter 5 description

Indicates whether to compress the results of the exported local file path structure in a zip file

Parameter 5 type

Boolean

Parameter 6

Export metadata

Parameter 6 default

False

Parameter 6 description

Indicates whether the object's metadata should be exported with the data.

Parameter 6 type

Boolean

The following methods use the ExportObjectStructure client API to export an object structure.

  • ExportObjectStructureLocal

  • ExportExtXmtlStructureLocal

  • ExportIntXmtlStructureLocal

  • SDAExportXmtlDocsLocal