CreateObjAndRel client API and its delivered methods - SmartPlant Foundation - Help - Hexagon PPM

SmartPlant Foundation Web Client Help

PPMProductFamily
Asset Information Management
PPMProduct
SmartPlant Foundation
PPMCategory
Help
SPFVersion_custom
2019 (10.0)
Version_SDAConnectorforTruView
(none)

The following CreateObjAndRel client API creates a new object and relate it to a selected object.

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

RelDef to related object

Parameter 2 default

None

Parameter 2 description

The relationship definition, prefixed with + or -, to 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 of the form that will be used to create the object.

Parameter 5 type

String

Parameter 6

File attachment configuration

Parameter 6 default

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 description

SPFDesignFile~SPFFileComposition~PROMPT

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

  • For Desktop Client - The option selected determines whether or not creation or revision wizards should include a workflow page to attach an object. For example, None, which is the default option, indicates that no workflow page appears and no object is attached to a workflow. Other options include Select, SelectRequired, or a named 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 the object to any 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 (Not Supported in the Web Client)

Parameter 10 default

None

Parameter 10 description

The method that will be run on the new object. For complex objects, add ~InterfaceDefUIto identify the object on which the method will be run.

Parameter 10 type

String

The following methods use this client API to create a new object and relate it to another object.

  • APIEPClassDefCreateEntryPoint

  • APIEPInterfaceDefCreateEntryPoint

  • CreatePipeline

  • CreateProcessCaseInCaseCollection

  • DesignBasisQuery_Create

  • InternalXmtlCreateSection

  • SchemaItem_Create

  • SPFWorkflowStepChkLstItem_Create