CreateSignObjectFromSelectedObjects 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 CreateSignObjectFromSelectedObjects client API is used to create a new object and relate it to multiple selected objects.

Argument

Description

Parameter 1

ClassDef (or Relationship to ClassDef) to create

Parameter 1 default

None

Parameter 1 description

The class definition of the new object to be created or the relationship definition to the class definition, if the new object is a classified object.

Parameter 1 type

String

Parameter 2

Relationship to create

Parameter 2 default

None

Parameter 2 description

The relationship definition to create between the selected objects and the new object being created.

Parameter 2 type

String

Parameter 3

Not used

Parameter 4

Not used

Parameter 5

Not used

Parameter 6

Not used

Parameter 7

Not used

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

Not used

Parameter 10

Not used

Parameter 11

Not used

Parameter 11 default

Specific UID of classification (if classified)

Parameter 11 description

The UID of the specific classification for the object to be created. This parameter is optional and used only if the new object being created is a classified object.

This parameter is not currently supported for methods used in the Desktop Client but is supported in the Web Client.

Parameter 11 type

String

Parameter 12

Not used

Parameter 13

RelDef or EdgeDef for search objects

Parameter 13 default

None

Parameter 13 description

Relationship definition or edge definition used for searching for objects in 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 in the form relationship section.

Parameter 14 type

String

The SDACreateDocumentSignatureRequest method uses the CreateSignObjectFromSelectedObjects client API.