CopyObj client API - SmartPlant Foundation - IM Update 48 - Help - Hexagon

Parameter 1

Title

Parameter 1 default

None

Parameter 1 description

The title to appear at the top of the form opened using this method.

Parameter 1 type

string

Parameter 2

Copy files (Not Supported in Web Client)

Parameter 2 default

True

Parameter 2 description

True indicates that copies of any files attached to the object being copied should be created and attached to the new object. False indicates that files attached to the original object should not be copied to the new one.

Parameter 2 type

Boolean

Parameter 3

Show hidden files (Not Supported in Web Client)

Parameter 3 default

False

Parameter 3 description

When set to True, this allows the selection of files marked as non-viewable or non-editable. When set to False, those files will not appear to the user.

Parameter 3 type

Boolean

Parameter 4

File attachment configuration (Not Supported in the Web Client)

Parameter 4 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 4 description

SPFDesignFile~SPFFileComposition~PROMPT

Parameter 4 type

String

Parameter 5

Details of secondary class (Not Supported in the Web Client)

Parameter 5 default

None

Parameter 5 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 5 type

String

Parameter 6

Delete local files configuration (Not Supported in the Web Client)

Parameter 6 default

True~True

Parameter 6 description

Includes two options, separated by a ~, to control whether local files are deleted when attached and whether to expose the option for deleting local files on the form used for creation.

Parameter 6 type

String

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