ReclassifyObject 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 ReclassifyObject client API is used to create methods to change the classification of any classified object.

Argument

Description

Parameter 1

Show confirm changes page

Parameter 1 default

True

Parameter 1 description

If set to True, displays any changes to the objects as a result of the reclassification in a confirmation dialog box. If set to False, the changes are committed without a confirmation dialog box.

Parameter 1 type

Boolean

Parameter 2

Allow ClassDef change

Parameter 2 default

False

Parameter 2 description

Indicates whether to allow reclassification if the target class definition is different from the original. If set to FALSE, the reclassification will not be allowed. If set to TRUE, the reclassification is allowed.

Parameter 2 type

Boolean

Parameter 3

Top classification

Parameter 3 default

None

Parameter 3 description

The top-level classification for displaying in the tree.

Parameter 3 type

String

Parameter 4

ENS handling

Parameter 4 default

None

Parameter 4 description

Handle changes to ENS based on reclassification. For example, full renaming or retain ENS name.

Parameter 4 type

String

Parameter 5

Form purpose

Parameter 5 default

None

Parameter 5 description

The mode in which to prompt for any missing data (usually Update).

Parameter 5 type

String

Parameter 6

Classification tree filtering

Parameter 6 default

None

Parameter 6 description

A ~ (tilde) separated list of interfaces to filter for in the classification tree.

Parameter 6 type

String

The ReclassifyObject client API has an updated argument 6. You can restrict the availability of classification tree nodes in the hierarchy tree by selecting an interface definition in the Reclassify form that you can use to filter the classifications. This behavior is now consistent with the create method.

The ReclassifiyDocument method uses the ReclassifyObject client API to change the classification of a document.