CreateRegisterDocumentObj 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 CreateRegisterDocumentObj client API is used to create a register document object.

Argument

Description

Parameter 1

RelDef to navigate to the ClassDef

Parameter 1 default

None

Parameter 1 description

The relationship definition used to navigate class definition and to derive the class definition of the classified object being created.

Parameter 1 type

String

Parameter 2

Allow classification tree drilldown

Parameter 2 default

True

Parameter 2 description

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

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

The relationship definition (prefixed with a + or -) from the starting object to the related object,

Parameter 4 type

String

Parameter 5

Title

Parameter 5 default

None

Parameter 5 description

The title that will appear at the top of the dialog box provided.

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 other is specified. 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

  • 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

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

Parameter 11

CreateSnapShot

Parameter 11 default

True

Parameter 11 description

If set to True, a first snapshot of the register document is created along with the document. If set to False, no snapshot is created automatically.

Parameter 11 type

Boolean

The CreateRegisterDocument method uses the CreateRegisterDocumentObj client API to create a register document.