Revise client API - HxGN SDx - Update 63 - Administration & Configuration

Administration and Configuration of HxGN SDx

Language
English
Product
HxGN SDx
Search by Category
Administration & Configuration
SmartPlant Foundation / SDx Version
10

The Revise client API is used to revise documents.

Argument

Description

Parameter 1

Title

Parameter 1 default

None

Parameter 1 description

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

Parameter 1 type

String

Parameter 2

Copy files

Parameter 2 default

True

Parameter 2 description

If set to True, attached files are copied to the new revision. If set to False, the files attached to the previous revision are not to copied to the new revision.

Parameter 2 type

Boolean

Parameter 3

Show hidden files

Parameter 3 default

False

Parameter 3 description

Set to true to allow selection of hidden files (Non-viewable and Non-editable files)

Parameter 3 type

Boolean

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

Parameter 5

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

Parameter 5 default

None

Parameter 5 description

The details of the secondary class to create and its relationship to the parent class definition, separated using a ~

Parameter 5 type

String

Parameter 6

Events to subscribe to on cross config revise (Not Supported in the Web Client)

Parameter 6 default

None

Parameter 6 description

Comma separated list of events to create subscriptions to the origin object when revising into a sub configuration

Parameter 6 type

String

Parameter 7

Events to subscribe to when claiming related data (Not Supported in the Web Client)

Parameter 7 default

None

Parameter 7 description

Comma separated list of events to create subscriptions to the origin object when claiming related data

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

Update References after revise (Not Supported in the Web Client)

Parameter 9 default

True

Parameter 9 description

If set to True, reference relationships are updated after the revise operation is complete. If set to False, the reference relationships are not updated.

Parameter 9 type

Boolean

Parameter 10

Column set to present Claimable Items (Not Supported in the Web Client)

Parameter 10 default

None

Parameter 10 description

The name of the column set to present items to be claimed.

Parameter 10 type

String

Parameter 11

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

Parameter 11 default

True~True

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

String

Parameter 12

Use next major revision for revise

Parameter 12 default

True

Parameter 12 description

Revision control for revise to next major or minor revision.

  • If set to True, the next major revision is created.

  • If set to False, the next minor revision is created.

Parameter 12 type

Boolean

Parameter 13

Run in asynchronous mode for bulk revise (Not Supported in the Web Client)

Parameter 13 default

True

Parameter 13 description

If set to True, the bulk revise process runs in an asynchronous mode and a revise notification object for monitoring the revise status gets created. If set to False, no notification object gets created.

Parameter 13 type

Boolean

Parameter 14

Revise column set for invalid documents (Not Supported in the Web Client)

Parameter 14 default

ReviseInvalidDocColumnSet

Parameter 14 description

The revise column set for invalid documents

Parameter 14 type

String

Parameter 15

RestrictedFileTypeUIDs

Parameter 15 default

None

Parameter 15 description

The file types are restricted from download or copy during revise.

Parameter 15 type

String

The following methods use the Revise client API to revise specific types of documents.

  • RevisionRevise

  • SPFDatasheetDocumentRevisionRevise

  • SPFLLALineListRecordDocumentRevisionRevise

  • TemplateRevisionRevise