Export 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 Export client API is used to create a method for exporting data out of the database and into an external file.

Argument

Description

Parameter 1

Bypass RelDef access control

Parameter 1 default

True

Parameter 1 description

If set to True, indicates that you want to bypass relationship definition access control and have the ability to export any related objects. If set to False, relationship definition access control is enforced and you can only expand relationships in the Export dialog box to which you have access.

Parameter 1 type

Boolean

Parameter 2

GraphDef

Parameter 2 default

None

Parameter 2 description

The graph definition for structure to export. This is optional.

Parameter 2 type

String

Parameter 3

Split Files by Container ID

Parameter 3 default

True

Parameter 3 description

If set to True, indicates that files are split by their container IDs. False indicates that there are single files for ADMIN, SCHEMA, and DATA objects. This is optional.

Parameter 3 type

Boolean

The following methods use the Export client API to export data from the database to an external file.

  • ExportData

  • ExportForm

  • ExportMethod

  • ExportTemplate