CreateWizardClassObj 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 CreateWizardClassObj client API is used to create classified objects from a node of a classification tree.

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 drill down 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

Classification tree filtering

Parameter 4 default

None

Parameter 4 description

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

This can be used to restrict the availability of the classification nodes for selection based on the optional interfaces present.

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

SPFDesignFile~SPFFileComposition~PROMPT

Parameter 6 description

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 type

String

Parameter 7

Not used

Parameter 8

Workflow processing option

Parameter 8 default

None

Parameter 8 description

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 the object to any workflow.

Parameter 8 type

String

Parameter 9

Not used

Parameter 10

Not used

Parameter 11

Not used

Parameter 12

Additional property to set.

Parameter 12 default

None

Parameter 12 description

Four ~ separated arguments (UID~Text~Method~Boolean) which set the property identified by the UID to True, and invoke the specified method, when the button with the specified text is clicked.

The default value of the fourth argument is False.

For example, if the user specifies SDACreatedAsDraft~Save As Draft~MTH_SOPSPrepareChangeRequest, a Save As Draft button appears on the form and when clicked, the value of the property with the UID SDACreatedAsDraft is set to True, and the SOPSPrepareChangeRequest method is invoked.

Parameter 12 type

String

Parameter 13

RelDef or EdgeDef for search objects

Parameter 13 default

None

Parameter 13 description

Relationship definition or edge definition used for searching objects on the form relationship section.

Parameter 13 type

String

Parameter 14

Columnset for filter criteria search

Parameter 14 default

None

Parameter 14 description

The column set used to display the filter criteria on the form relationship section.

Parameter 14 type

String

Parameter 15

RelDef to create a relation from grid column

Parameter 15 default

None

Parameter 15 description

Relationship definition used to create a relationship between a specific object and the grid column.

Parameter 15 type

String

Parameter 16

RelDefs to find target display items

Parameter 16 default

None

Parameter 16 description

Relationship definitions (separated by ~, prefixed with +) used to find the target display items.

Parameter 16 type

String

Parameter 17

Link properties

Parameter 17 default

None

Parameter 17 description

Link properties, each separated by a comma (,). For example, PropertyDef1~Title1,PropertyDef2~Title2. The property definition is used to set the link property in the relationship between a document and a specific object (for example, a transmittal). The title, separated by a tilde (~), is used to display the column name in the grid.

The Transmittal default file type value in System Options and the Title value must be the same.

Parameter 17 type

String

Parameter 18

Is file attachment mandatory

Parameter 18 default

False

Parameter 18 description

At least one file attachment is mandatory if this flag is set to true

Parameter 18 type

Boolean