CreateClassObjAndLoad 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 CreateClassObjAndLoad client API create new classified objects and uploads them into a Data Validator workflow.

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

Indicate 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 + or -, to the related object.

Parameter 4 type

String

Parameter 5

Title

Parameter 5 default

none

Parameter 5 description

The title that will appear on the form for creating the new classified 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

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 (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 ~InterfaceDefUI to identify the object on which the method will be run.

Parameter 10 type

String

Parameter 11

Not used

Parameter 12

Maximum Number of Control Files

Parameter 12 default

1

Parameter 12 description

Specifies the maximum number of control files that may be selected.

Parameter 12 type

Integer

Parameter 13

Show File Upload page

Parameter 13 default

False

Parameter 13 description

Boolean to control whether to show the file upload page in the wizard.

Parameter 13 type

Boolean

Parameter 14

Show Configuration Selection Page

Parameter 14 default

False

Parameter 14 description

Boolean to control whether to show the configuration selection page in the wizard.

Parameter 14 type

Boolean

To see methods that use this client API in the system, find the client API in Desktop Client, right-click it, and click Show Methods.