ReplaceFiles 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 ReplaceFiles client API is used to replace files attached to an object with a new version of the file or to attach new files to an object.

Argument

Description

Parameter 1

Use next major revision for revise

Parameter 1 default

True

Parameter 1 description

Next revision control for revise. By default, it is set to True, which means that the next major revision is honored. If set to False, the next minor revision is honored.

Parameter 1 type

Boolean

Parameter 2

File configuration

Parameter 2 default

SPFDesignFile~SPFFileComposition~PROMPT

Parameter 2 description

The file configuration FileClassDef~FileRelDef~ReferenceAction~SeedFileTemplateDocName. SPFFileComposition is the default relationship definition if none is specified, and the seed file document is optional. Reference file not found actions are CONTINUE | PROMPT | ABORT.

Parameter 2 type

String

Parameter 3

Sign off new revision

Parameter 3 default

False

Parameter 3 description

Signs off the new revision

Parameter 3 type

Boolean

Parameter 4

Columnset

Parameter 4 default

CS_CopyToLocalColumnSet

Parameter 4 description

UID of the column set that will be used on the Replace Files dialog box.

Parameter 4 type

String

Parameter 5

RestrictedFileTypeUIDs

Parameter 5 default

None

Parameter 5 description

The file types are restricted from download or copy during replace files.

Parameter 5 type

String

Parameter 6

Extract Content

Parameter 6 default

None

Parameter 6 description

Content Extractions will be enabled during replace files

Parameter 6 type

Boolean

The following methods use the ReplaceFiles client API to replace files attached to a working or current document objects.

  • ReplaceWorkingDocFiles

  • UpRevCurrentDocReplaceFilesAndSignOff

  • NewUpRevCurrentDocReplaceFilesAndSignOf