CreateClassObjAndRelWithPropertyOverrides client API - SmartPlant Foundation - IM Update 46 - 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 CreateClassObjAndRelWithPropertyOverrides client API is used to configure a shortcut menu method on an object to create a classified object with specified property overrides and relate it to the selected object.

Argument

Description

Parameter 1

RelDef to navigate to the ClassDef

Parameter 1 default

None

Parameter 1 description

The relationship definition used to navigate class definition and to derive the class definition of the classified object being created,

Parameter 1 type

String

Parameter 2

Allow classification tree drilldown

Parameter 2 default

True

Parameter 2 description

Indicate whether to allow the display of a classification tree drilldown when creating the new object.

Parameter 2 type

Boolean

Parameter 3

UID of classification

Parameter 3 default

None

Parameter 3 description

The unique identification number (UID) of the top classification on the selection page that can be expanded to select the classification required.

Parameter 3 type

String

Parameter 4

RelDef to related object

Parameter 4 default

None

Parameter 4 description

The relationship definition, prefixed with + or -, to the related object.

Parameter 4 type

String

Parameter 5

Title

Parameter 5 default

None

Parameter 5 description

The title that will appear on the form for creating the new classified object.

Parameter 5 type

String

Parameter 6

File attachment configuration

Parameter 6 default

File attachment configuration (optional) FileClassDef~FileRelDef~ReferenceAction~SeedFileTemplateDocName. SPFFileComposition is the default relationship definition if none other is specified. The seed file document is optional. Reference file not found actions are CONTINUE|PROMPT|ABORT.

Parameter 6 description

SPFDesignFile~SPFFileComposition~PROMPT

Parameter 6 type

String

Parameter 7

Details of secondary class

Parameter 7 default

None

Parameter 7 description

Details of the secondary class to create and its relationship to the parent class definition specified in Argument 1. Use ~ as a separator.

Parameter 7 type

String

Parameter 8

Workflow processing option

Parameter 8 default

None

Parameter 8 description

Indicates whether creation should include a screen for the selection of a workflow. Options include Select, SelectRequired, or a named workflow.

Parameter 8 type

String

Parameter 9

Classification tree filtering

Parameter 9 default

None

Parameter 9 description

A ~ separated list of interfaces to perform classification tree filtering (optional)

Parameter 9 type

String

Parameter 10

Property overrides

Parameter 10 default

None

Parameter 10 description

A ~ separated list that defines a property on a specified interface to be updated. Should be in the following format: Interface.Property.Value~Interface.Property.Value

Parameter 10 type

String

The following methods use the CreateClassObjAndRelWithPropertyOverrides client API to create a classified object and relate it to another object in the system.

  • CreateIPDDatasheetDocument

  • CreateSPFLLALineLIstRecordDocument