InsertHistRev 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 InsertHistRev client API is used to insert a new revision of a document between existing revisions.

Argument

Description

Parameter 1

Title

Parameter 1 default

None

Parameter 1 description

The title of the dialog box that allows you to provide information about the new historical revision.

Parameter 1 type

String

Parameter 2

Delete local files configuration

Parameter 2 default

True~True

Parameter 2 description

Two separate options, connected with a ~, to control whether local files are deleted when attached to the new revision and placed in the vault and whether or not the check box to control the deletion of files is exposed on the dialog box.

Parameter 2 type

String

Parameter 3

Not used.

Parameter 4

File attachment configuration

Parameter 4 default

SPFDesignFile~SPFFileComposition~PROMPT

Parameter 4 description

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

Parameter 4 type

String

The InsertHistoricalRev method uses the InsertHistRev client API to add a new revision between existing revisions of a document.