CreateObjModal client API - HxGN SDx - Update 64 - Administration & Configuration

Administration and Configuration of HxGN SDx

Language
English
Product
HxGN SDx
Search by Category
Administration & Configuration
SmartPlant Foundation / SDx Version
10

The CreateObjModal client API is used to invoke the create form in a modal window to create an object in the tag types hierarchy.

Argument

Description

Parameter 1

ClassDef of object to be created

Parameter 1 default

None

Parameter 1 description

The class definition of the object to be created.

Parameter 1 type

String

Parameter 2

Relationship Definition to related object

Parameter 2 default

None

Parameter 2 description

RelDef to related object (prefixed +/- from the relatedobject)

Parameter 2 type

String

Parameter 3

Not used

Parameter 4

Not used

Parameter 5

Title

Parameter 5 default

None

Parameter 5 description

The title of the form that will be used 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 RelDef 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

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

Workflow processing option - options are Select, SelectRequired or a named workflow

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

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

Not used

Parameter 12

Additional property to set (Not supported in the Desktop Client)

Parameter 12 default

None

Parameter 12 description

Four ~ separated options (UID~Text~Method~Boolean) UID of the additional property to be set from client on button click, button text and method to invoke,True value Navigates to next screen even no workflow attached to object.

Parameter 12 type

String

Parameter 13 type

Not used

Parameter 14 type

Not used

Parameter 15

Is file attachment mandatory

Parameter 15 default

False

Parameter 15 description

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

Parameter 15 type

Boolean

Parameter 16 type

Not used

Parameter 17

Create Form UID

Parameter 17 default

None

Parameter 17 description

UID of the create form (if this is configured then this form will be launched during create). Supported in Web Client only

When configured, the selected create form is launched during the create object process.

Parameter 17 type

String

The existing navigation listener is used to invoke the CreateObjModal API from the new MFE application repository built for the Tag Types hierarchy.

The following methods use this client API to invoke the create form in a modal window to create an object in the tag types hierarchy

  • ConfigureEnumTypes

  • CreateInterfaceDefModel

  • CreateSDxSchemaChangeRequestModal