CreateClassObjAndRelFromMarkup 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 CreateClassObjAndRelFromMarkup client API is used to create class objects and relate them for display in the View and Markup window using action pins.

Argument

Description

Parameter 1

RelDef to navigate to the ClassDef

Parameter 1 default

None

Parameter 1 description

Relationship definitions 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

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

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

Relationship definition to the related object (prefixed +/- from the related object)

Parameter 4 type

String

Parameter 5

Title

Parameter 5 default

None

Parameter 5 description

The title at the top of the form that opens to allow you to create the 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 specified and the seed file document is optional. Reference file not found actions are CONTINUE | PROMPT | ABORT

Parameter 6 type

String

Parameter 7

Details of secondary class (Not Supported in the Web Client)

Parameter 7 default

None

Parameter 7 description

Details of secondary class to create and its relationship to parent class definition (arg1) (~ 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

Post method name (Not Supported in the Web Client)

Parameter 10 default

None

Parameter 10 description

Post method name - will run this method on the new object. For complex objects add ~InterfaceDefUID to identify the object on which it is run.

Parameter 10 type

String

Parameter 11

Symbol name

Parameter 11 default

None

Parameter 11 description

File name of the symbol without the extension, for example, GreenActionPin. This is used to link objects by placing the symbol on a markup layer.

Parameter 11 type

String

Parameter 12

Columnset for action pin details

Parameter 12 default

CS_SPFObject

Parameter 12 description

Column set that specifies the list of properties to be displayed as action pin details in the markup layer.

Parameter 12 type

String

Parameter 13

Interface for action pin

Parameter 13 default

None

Parameter 13 description

Interface name to create an action pin.

Parameter 13 type

String

SHARED Tip To see methods that use this client API in the system, find the client API in Desktop Client, right-click it, and click Show Methods.