CreateClassObjFromClassWithPropertyOverrides 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 CreateClassObjFromClassWithPropertyOverrides client API is used to configure a shortcut menu on a classification tree node to create classified objects with specified property overrides.

Argument

Description

Parameter 1

RelDef to navigate to the ClassDef

Parameter 1 default

None

Parameter 1 description

Relationship definition to navigate to the class definition. Used to derive the class definition to create from the classification object.

Parameter 1 type

String

Parameter 2

Allow classification tree drilldown

Parameter 2 default

True

Parameter 2 description

Allows (True) or prevents (False) the user from drilling further down the tree. If this is false, then the classification selection page of the wizard is skipped.

Parameter 2 type

Boolean

Parameter 3

UID of classification

Parameter 3 default

None

Parameter 3 description

Classification tree node to display in the classification selection page of the wizard. If no sub classifications exist, the wizard skips this first page.

Parameter 3 type

String

Parameter 4

RelDef to related object

Parameter 4 default

Nine

Parameter 4 description

Relationship definition to the related object, prefixed with a + or -

Parameter 4 type

String

Parameter 5

Title

Parameter 5 default

None

Parameter 5 description

The title of the form that will appear for creating a new 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

  • For Desktop Client - The option selected determines whether or not creation or revision wizards should include a workflow page to choose a workflow to attach to the object. For example, None, which is the default option, indicates that no workflow page appears and no workflow is attached to the object. Other options include Select, SelectRequired, or a named workflow. For more information on the options, see Configure create object to attach workflow.

  • For Web Client - There is no workflow selection in the create pages. The Web Client chooses the applicable workflow unless a named workflow is specified. However, if more than one applicable workflow is found, the software does not attach any workflow to the object.

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

No delivered methods use this client API.