SCLBQualityAssuranceReview 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 SCLBQualityAssuranceReview client API is used to perform and consolidate a quality assurance review.

Argument

Description

Parameter 1

Column Set UID

Parameter 1 default

None

Parameter 1 description

UID of the column set used to show the brief details of the document

Parameter 1 type

String

Parameter 2

Title

Parameter 2 default

None

Parameter 2 description

The title of the page

Parameter 2 type

String

Parameter 3

Create Technical Query Method

Parameter 3 default

None

Parameter 3 description

UID of the method used to create a technical query

Parameter 3 type

String

Parameter 4

Markup Method Used To Launch Markup from Hyperlink

Parameter 4 default

MTH_SCLBFileViewNavigateWithOutgoingAction

Parameter 4 description

UID of the method used to launch the file viewer from a hyperlink

Parameter 4 type

String

Parameter 5

Markup Method Used To Launch Markup From Supporting Information

Parameter 5 default

MTH_FileViewNavigate

Parameter 5 description

UID of the method used to launch the file viewer from supporting information

Parameter 5 type

String

Parameter 6

Create Action Method

Parameter 6 default

MTH_SCLBCreateDocumentReviewOutgoingAction

Parameter 6 description

UID of the method used to create actions

Parameter 6 type

String

Parameter 7

UpdateActionMethod

Parameter 7 default

MTH_SCLBUpdateAction

Parameter 7 description

UID of the method used to update actions

Parameter 7 type

String

Parameter 8

Edit Comment Method

Parameter 8 default

MTH_SDACommentUpdate

Parameter 8 description

UID of the method used to edit comments

Parameter 8 type

String

Parameter 9

Mode

Parameter 9 default

None

Parameter 9 description

Possible options are:

  • ViewOnly - View general information about the document

  • Review - Review the document

  • Consolidate - Consolidate the reviews

  • Reconsolidate - Reconsolidate reviews if consolidation is rejected

  • Compliance - Accept or reject the consolidation

Parameter 9 type

String

Parameter 10

Manage Action Markup Layers Method

Parameter 10 default

None

Parameter 10 description

UID of the method used to manage layers on the action

Parameter 10 type

String

Parameter 11

Manage Action Markup Layers Method View Only

Parameter 11 default

None

Parameter 11 description

UID of the method used to manage read-only layers on the action

Parameter 11 type

String

Parameter 12

Manage Document Markup Layers Method

Parameter 12 default

None

Parameter 12 description

UID of the method used to manage layers on the document

Parameter 12 type

String

Parameter 13

Manage Action Draft Rejected

Parameter 13 default

None

Parameter 13 description

UID of DRAFT REJECTED state, the issue state of action

Parameter 13 type

String

Parameter 14

Manage Action Related Items Method

Parameter 14 default

None

Parameter 14 description

UID of the method used to manage related items on an QA document review action

Parameter 14 type

String

Parameter 15

Manage Review Or Comment Related Items Method

Parameter 15 default

None

Parameter 15 description

UID of the method used to manage related items on a QA document review or comment

Parameter 15 type

String

Parameter 16

Return Code Mandatory

Parameter 16 default

False

Parameter 16 description

Used to control the need for a return code in the consolidation/re-consolidation screens

Parameter 16 type

Boolean

The following methods use the SCLBQualityAssuranceReview client API to conduct or consolidate a quality assurance review.

  • SCLBQAConsolidation

  • SCLBQAReview

  • ComplianceReview

  • Reconsolidate