Configure SDx document review matrix - 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

Document review matrices are used to set up lists of recipients for QA Review workflow steps based on properties or relationships of the object in the workflow. Each recipient on the matrix has a Reason For Receipt (RFR), which indicates why the recipient is included.

A document review matrix is a table with recipients and matrix categories. The matrix categories can be based on any property or relationship on the object going down the workflow, such as area, document type, issue purpose, discipline, and so on. Each cell in the table is marked with the reason for receipt for each recipient.

SDxMatrix

Configure a document matrix

To configure a document review matrix in your system, you need to do the following in the Desktop Client:

  1. Model the matrix class.

    • Ensure the matrix class realizes an interface that implies ISPFDistributionMatrix.

  2. Model the row class.

  3. Define a relationship between the two primary interfaces of the matrix and matrix row classes as a specialization of SPFDistributionMatrixRow.

  4. Model the row mapping.

    1. Create an interface for the mapping properties. Make sure this interface implies the ISPFDistributionMapRow interface and is realized by the matrix row class.

    2. Create the mapping properties - these will appear as columns in the matrix table. In the default delivered matrix, Area and Unit are relationship-related properties which should be configured manually in the column set using the SPFColumnItemDependentItem relationship definition. The other columns like Category, Type, and Sub Type are enumerated list properties which are handled automatically by the system.

    3. Map these properties to the properties and/or relationships on the object that will be going down the workflow.

    4. Configure the column set with column items pointing to matrix properties and relate this column set to the SPFClassDefDisplayColumnSet class definition. When you create or copy a matrix, this column set is related to the instance of the matrix using the SPFDistributionMatrixColumnset relationship definition.

    • If the column set is not related, when the user creates a matrix instance, the column sets are generated dynamically and related to the matrix instance.

    • Multiple cardinality relationships can be used to map a workflow item to matrix rows. If the object in the workflow is related to two or more items by a row mapping relationship, then all the related rows will be selected when the matrix is evaluated, and users on each selected matrix row will be included as step recipients.

    • The column items do not support the following data types: UoM, DateTime, YMD, and Double.

When a user right-clicks on a matrix in the Desktop Client, the matrix is built by retrieving the mapping properties for the matrix row. These are on the interfaces implied by ISPFDistributionMapRow. Each property on the matrix row interface is mapped to a property or relationship on the object in the workflow.

If one or more matrices are related to a workflow step, when it starts, the system tests the step matrix condition against the object in the workflow to determine which one to use. If one matches, the mapping properties for the matrix row are determined as above. The values for the matrix look up are then retrieved from the object by traversing from the matrix mapping properties to the related object properties and/or relationship. These values are used to identify the matrix row to use.

Matrix management

Matrices are created like any other object.

Create a new matrix

For information on how to create a matrix, see Create a document review matrix.

Assign matrix recipients

The Assign Recipients form is used to specify the users or roles included in the selected distribution matrix, as well as the action required from each user or role upon receipt of a QA review request. For more information, see Populate the document review matrix.

The following table lists the reason for receipt codes to be used in the matrix based on the action required from each recipient.

Reason for receipt

Code

Recipient

Reviewer

R

Reviews the document or drawing.

Consolidator

CON

Reviews and consolidate the reviews.

Information only reviewer

I

Is informed about the review process but no action is required.

  • You can allow submitted documents to bypass the QA Review workflow by turning off the toggle review mode in the matrices that were created based on the ISDXDocumentReviewMatrix interface definition.

  • The reason for receipts can be configured using the SDXDocumentReviewMatrix class definition and SPFDistributionMatrixRestrictedReasonForReceipt relationship definition.

  • By default, the add recipients search dialog box uses the entry point SAEP_InternalLoginUsersEntryPoint as the default filter to populate the values. Using the filters available, you can further refine the search results. For more information on how to configure these filters, refer Parameter 3 and Parameter 4 in AssignRecipients client API.

To generate reviews by matrix in a project

  • For a new project, select the Generate Reviews by Matrix? check box while creating the project in the New Project page of the Web Client.

  • For an existing project, update the project by selecting the Generate Reviews by Matrix? check box in the Update Project page of the Web Client.

To associate the matrix to a contract

  • For a new contract, select the matrix to generate reviews in the Matrix to generate reviews box in the New Contract page of the Web Client.

  • For an existing contract, update the contract by selecting the matrix to generate reviews in the Matrix to generate reviews box, in the Update Contract page of the Web Client.

For information about the functionality available to a role, see the HxGN SDx Roles matrix.