ManageSignedFiles 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 ManageSignedFiles client API is used to attach signed files or delete signed files from documents.

Argument

Description

Parameter 1

Class name

Parameter 1 default

None

Parameter 1 description

The class definition name of the file object that has to be created.

Parameter 1 type

String

Parameter 2

Reference file not found action

Parameter 2 default

PROMPT

Parameter 2 description

The options are ABORT, CONTINUE, and PROMPT.

Parameter 2 type

String

Parameter 3

Not used

Parameter 4

ColumnSet

Parameter 4 default

CS_CopyToLocalColumnSet

Parameter 4 description

The name of the column set used to display signed files to attach or delete.

Parameter 4 type

String

Parameter 5

Not used

Parameter 6

AttachSignedFile

Parameter 6 default

False

Parameter 6 description

Used to switch between the File Management and the Signed File Management screens.

  • If the value is True, the system shows the Signed File Management screen.

  • If the value is False, the system shows the File Management screen.

Parameter 6 type

Boolean

Parameter 7

DeleteExistingSignedFileRelationship

Parameter 7 default

False

Parameter 7 description

Controls whether to show the terminate relationship option in the user interface. If the option is selected, the signed file is deleted from the system.

Parameter 7 type

Boolean

The SDxManageSignedFiles method uses the ManageSignedFiles client API.