CreateObjAndRelFromMarkup 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 CreateObjAndRelFromMarkup client API is used to create class objects and relate these using action pins.

Argument

Description

Parameter 1

Create ClassDef

Parameter 1 default

None

Parameter 1 description

Class definition of the object to be created

Parameter 1 type

String

Parameter 2

RelDef to related object

Parameter 2 default

None

Parameter 2 description

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

Parameter 2 type

String

Parameter 3

Not used

Parameter 4

Not used

Parameter 5

Title

Parameter 5 default

None

Parameter 5 description

The title at the top of the form used to create the new 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

None

Parameter 9 default

None

Parameter 9 description

Complex Graphs are used to indicate the objects derived from the server side that creates relationships to link the objects together.

Parameter 9 type

None

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

No delivered methods use this client API.