ExportObjectStructure 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 ExportObjectStructure client API is used to configure the offline export and archive of an object file path 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

Target type

Parameter 3 default

Vault

Parameter 3 description

Target location type to define the type of target location. Possible values: VAULT, FILESYSTEMPATH

Parameter 3 type

String

Parameter 4

Target location

Parameter 4 default

None

Parameter 4 description

Target location, which can be a file system path or a valid vault name.

Parameter 4 type

String

Parameter 5

Export Alternate Rendition copies only

Parameter 5 default

False

Parameter 5 description

Indicates whether to export alternate rendition copies only

Parameter 5 type

Boolean

Parameter 6

Export reference files

Parameter 6 default

False

Parameter 6 description

Indicates whether to export related reference files

Parameter 6 type

Boolean

Parameter 7

Compressed

Parameter 7 default

False

Parameter 7 description

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

Parameter 7 type

Boolean

Parameter 8

Notify when completed

Parameter 8 default

NO

Parameter 8 description

Indicates whether the user should be notified when the task is complete.

Parameter 8 type

String

Parameter 9

Export metadata

Parameter 9 default

False

Parameter 9 description

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

Parameter 9 type

Boolean

Parameter 10

Relate zip file

Parameter 10 default

False

Parameter 10 description

Indicates whether a design file should be created and related to the source object.

Parameter 10 type

Boolean

Parameter 11

File share expiry days

Parameter 11 default

None

Parameter 11 description

File share expiry days

Parameter 11 type

Integer

Parameter 12

Delete share file

Parameter 12 default

False

Parameter 12 description

Indicates whether the file should be deleted by the scheduler task after file share expiry days.

Parameter 12 type

Boolean

Parameter 13

Edge to share files

Parameter 13 default

None

Parameter 13 description

Edge definition from the source object to the files that need to be shared.

Parameter 13 type

String

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

  • ExportObjectStructure

  • ExportExtXmtlStructure

  • ExportIntXmtlStructure

  • ExportTransmittalStructure