SCLBCommunicationManagement 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

This functionality was modified in an update. For more information, see SCLBCommunicationManagement client API (modified in an update).

The SCLBCommunicationManagement client API is used to launch the communication management screen from the To Do list.

Argument

Description

Parameter 1

Title

Parameter 1 default

None

Parameter 1 description

The title of the page

Parameter 1 type

String

Parameter 2

Column Set

Parameter 2 default

None

Parameter 2 description

The UID of the column set used to show the details of the communication item.

Parameter 2 type

String

Parameter 3

Method Used To Launch Markup in Edit Mode, Method Used To Launch Markup in View Mode

Parameter 3 default

None

Parameter 3 description

The UID of the method to launch the file viewer in edit mode and view mode.

Parameter 3 type

String

Parameter 4

Method Used To Manage Communication Item Markup Layers

Parameter 4 default

None

Parameter 4 description

The UID of the method used to manage the file viewer layers on the communication item.

Parameter 4 type

String

Parameter 5

Method Used To Manage Response Markup Layers

Parameter 5 default

None

Parameter 5 description

The UID of the method used to manage response layers.

Parameter 5 type

String

Parameter 6

Create New Technical Query Method

Parameter 6 default

None

Parameter 6 description

The UID of the method used to create a new technical query.

Parameter 6 type

String

Parameter 7

Response Mode

Parameter 7 default

None

Parameter 7 description

The response mode chosen for the communication

  • Prepare - The preparation of the response by the recipient

  • PrepareInternalReviewAction - The documents attached to an internal review action can be edited (offline or online) and checked in by the submitter

  • Respond - The response sent by the recipient (waive and complete)

  • Consolidate - The consolidation of the response by the recipient

  • Compliance - The contractual compliance of the response by the recipient

  • InitialResponse - The initial communication response by the recipient

  • ResponseCompliance - The contractual compliance of the response by the originating company

  • ReceiveResponse - The receipt of the response by the originating company (complete)

  • ReceiveResponseReject - The receipt of the response by the originating company (reject)

  • RespondReject - The response sent by the recipient (reject and complete)

  • ViewOnly - View the communication as read-only

  • Implement - The implementation of the change by the recipient

  • Review - The review of the change by the recipient

Parameter 7 type

String

Parameter 8

Response Primary Classification

Parameter 8 default

None

Parameter 8 description

The primary classification to be used when generating responses.

Parameter 8 type

String

Parameter 9

Response Relationship Definition

Parameter 9 default

None

Parameter 9 description

The relationship between the communication item and the response.

Parameter 9 type

String

Parameter 10

Manage Response or Review Related Items Method

Parameter 10 default

None

Parameter 10 description

UIDs of the methods used to manage related items on the response or review, each separated by a comma (,).

Parameter 10 type

String

Parameter 11

Manage Related Items Methods for the communication object

Parameter 11 default

None

Parameter 11 description

UIDs of the methods used to manage related items on the communication object, each separated by a comma (,).

Parameter 11 type

String

Parameter 12

Update Technical Query object method

Parameter 12 default

None

Parameter 12 description

The UID of the method used to update the technical query.

Parameter 12 type

String

Parameter 13

Method used to manage Review Markup

Parameter 13 default

None

Parameter 13 description

UID of the method used to manage the review markup layers.

Parameter 13 type

String

Parameter 14

Methods used to launch Impact Analysis

Parameter 14 default

None

Parameter 14 description

A comma-separated list of the UIDs of the methods used to launch impact analysis.

Parameter 14 type

String

Parameter 15

Method used to identify Responders

Parameter 15 default

None

Parameter 15 description

UID of the method used to identify responders

Parameter 15 type

String

Parameter 16

Method used to resolve conflicts

Parameter 16 default

None

Parameter 16 description

UID of the method used to resolve conflicts

Parameter 16 type

String

Parameter 17

Set closure reason

Parameter 17 default

False

Parameter 17 description

Used to control the need for a closure reason in the Review Responses screen.

Parameter 17 type

Boolean

SHARED Tip Many methods use this client API. To see the methods in your system that use this client API, find the client API, and select Actions > Relationships > Show Methods.