SDAManageDataTree 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 SDAManageDataTree client API is used to manage the display of classifications and their relationships in the Tree.

Argument

Description

Parameter 1

Class Definition

Parameter 1 description

Class definition UID of the sub classifications

Parameter 1 type

String

Parameter 1 default

None

Parameter 2

Relationship Definition

Parameter 2 description

The relationship definition between the parent and children in the data tree

Parameter 2 type

String

Parameter default

None

Parameter 3

Title

Parameter 3 description

The title of the data tree

Parameter 3 type

String

Parameter 3 default

None

Parameter 4

EnableDragDrop

Parameter 4 description

Enables the drag and drop operation

Parameter 4 type

Boolean

Parameter 4 default

False

Parameter 5

Relationships for tabs

Parameter 5 description

The relation definitions from parent to PBS/data items (except file compositions), separated by comma (prefixed +/- to the relationship)

Relationships to file compositions should be provided in parameter 14

Parameter 5 type

String

Parameter 5 default

None

Parameter 6

Column set for tabs

Parameter 6 description

Column sets for the PBS/data items

Parameter 6 type

String

Parameter 6 default

CS_SPFObject

Parameter 7

ColumnSetsForHeader

Parameter 7 description

Column sets for the header items

Parameter 7 type

String

Parameter 7 default

CS_SPFObject

Parameter 8

Menu options for APIs

Parameter 8 description

Menu options for APIs to documents separated by (,) and filters separated by tildes (~)

Parameter 8 type

String

Parameter 8 default

None

Parameter 9

Relate Items Method UID

Parameter 9 description

Method to relate items to the source object

Parameter 9 type

String

Parameter 9 default

None

Parameter 10

Markup Method UID

Parameter 10 description

Method used to launch View and Markup

Parameter 10 type

String

Parameter 10 default

None

Parameter 11

Show grid actions menu.

Parameter 11 description

Enables the Action menu in the grid

Parameter 11 type

Boolean

Parameter 11 default

None

Parameter 12

Manage or view data book.

Parameter 12 description

Makes the data book manageable when set to true

Parameter 12 type

Boolean

Parameter 12 default

None

Parameter 13

Method to create a chapter.

Parameter 13 description

Method to create a chapter from a data book or chapter

Parameter 13 type

String

Parameter 13 default

None

Parameter 14

Document relationships for tabs with column sets

Parameter 14 description

The relation definitions from parent to file compositions with column sets separated by colons (such as data books to documents), separated by comma (prefixed +/- to the relationship)

For example, EDG_ChapterCompositionToLatestVersion:CS_FDWDocumentVersion,+exampleReldef:examplecolumnset

Parameter 14 type

String

Parameter 14 default

None

Parameter 15

Method to create handover request

Parameter 15 description

Method to create a handover request from the Manage Data Book page.

Parameter 15 type

String

Parameter 15 default

None

Parameter 16

Method to update handover request

Parameter 16 description

Method to update the handover request from the Rework Handover Request page.

Parameter 16 type

String

Parameter 16 default

None

Parameter 17

Review mode

Parameter 17 description

When set, users will see only certain features enabled on the Manage Data Book page. This can be set to:

  • ReviewHandover

  • ReworkHandover

  • ViewHandover

Parameter 17 type

String

Parameter 17 default

None

Parameter 18

Handover ColumnSet UID

Parameter 18 description

Column set to display the handover request details.

Parameter 18 type

String

Parameter 18 default

None

The following methods use this client API to manage how the classification and relationship data is displayed in the Tree.

  • SDAManageDatabook

  • SDAViewChapters

  • SDAViewDatabook

  • SDAViewHandoverDatabook

  • SDxReviewHandoverRequest

  • SDxReworkHandoverRequest

  • SDxViewHandover