Skip to main content
Skip table of contents

FS - 481787905 - Data Governance

Description

A data governance feature is available in SPORIFY. Users can view and manage records' data governance statuses and administrators can manage data governance statuses and integrations settings.

  • A record’s data governance status is initially set to Review. The reviewer can then set a custom status and the approver can thus accept or reject this status. If the approver rejects the status, then the record is set back to Review.

  • If the 4 eyes principle is applied and a record is approved and then rejected, the status is set back to Review.

  • If enabled, data governance is applied after system mapping.

  • Data governance is also applied if manual mapping occurs.

Procedure

Data Governance Workflow Overview

  1. When a record is Pending Review, the relevant reviewer receives a notification.

  2. When the reviewer has reviewed the record, its state becomes Pending Approval.

  3. When a record is pending approval, the relevant approver receives a notification.

  4. If the approver rejects the record, its state is set back to Pending Review and the reviewer receives a notification.

  5. Else, if the approver approves the record, its state is set to Approved.

  6. Otherwise, if the 4 eyes principle is applied and a record is approved and then rejected, its state is set back to Review.

  7. Colour-coding is applied to the data governance process in SPORIFY:

    1. When a record is coded red, it is pending review.

    2. When a record is coded orange, it is pending approval.

    3. When a record is coded green, it has been approved.

Note: For more details about data governance notifications, see FS - 483754047 - Data Governance Notifications.

Manage Data Governance Statuses for Given Records

  1. Login to SPORIFY.

  2. Navigate to one of the following areas:

    1. The record’s relevant source list

    2. The record’s relevant target list

    3. The record’s relevant details screen

      1. For more details, see: https://corrit.atlassian.net/wiki/spaces/SPORIFY/pages/edit-v2/491454492?draftShareId=d54dd982-ad0f-46ce-8e2a-ed9952cf3988, https://corrit.atlassian.net/wiki/spaces/SPORIFY/pages/edit-v2/491520034?draftShareId=fdf19089-136a-46ac-a385-738424ad5304, https://corrit.atlassian.net/wiki/spaces/SPORIFY/pages/edit-v2/491454499?draftShareId=c29b339e-80c3-4967-ad6c-6b38d39fed9e.

  3. Click on the record’s associated data governance (shield) icon.

  4. Depending on the user’s permissions and the current status of the record, the following options are presented:

    1. Enable

      1. Select this to enable governance for the given record.

    2. Disable

      1. Select this to disable governance for the given record.

    3. Govern

      1. Select this to govern the given record.

  5. When Govern is selected, the Data Governance modal is presented.

  6. This modal contains the following:

    1. A heading indicating the current stage of the data governance process for the given record

    2. Record details with a link to the relevant details screen

    3. The record’s current status

      1. Who applied the status and when it was applied is shown for each stage of the process

    4. Status options

  7. When reviewing a record:

    1. Click on the desired status to add to the record.

    2. Insert a comment on the Add Comment modal.

    3. Click Save, else Skip.

  8. When approving a record:

    1. Click on the desired status to add to the record.

    2. If e-signature is switched on:

      1. Insert the relevant username in the Username.

      2. Click Send Verification Code.

      3. Insert the relevant code in the Code field.

      4. Click Save.

    3. Add comment if desired.

    4. Click Save, else Skip.

Manage Data Governance Integration Settings

  1. Login to SPORIFY.

  2. Select Administration on the navigation menu.

  3. Select Data Governance.

  4. Select Integrations.

    1. Expandable sections for Substances, Organisations and Referentials are then presented.

  5. Click on the relevant section’s associated arrow icon to expand it.

  6. Complete the following fields:

    1. Governance Required

      1. This checkbox enables/disables data governance for the given integration.

    2. Assign Reviewers

      1. This drop-down menu allows the administrator to select the users and/or groups who are permitted to review records.

    3. Assign Approvers

      1. This drop-down menu allows the administrator to select the users and/or groups who are permitted to approve records.

    4. 4 Eye Principle

      1. This checkbox enables/disables approvers from approving their own reviews.

      2. When the 4 eye principle is enabled, only a reviewer will be able to apply the status to a record and only an approver will be able to accept or reject it. Both of these actions cannot be performed by the same user, even if said user is part of both the reviewers and approvers list.

      3. When the 4 eye principle is disabled, anyone from the reviewers or approvers list can carry out either step once they are in the reviewers or approvers group.

    5. Enable Governance Where Record Matched

      1. This checkbox enables/disables governance for all matched target records.

    6. e-Signature

      1. This checkbox enables/disables the requirement for users to enter a username and verification code when saving a record.

  7. Click Save to save all changes.

Manage Data Governance Statuses

  1. Login to SPORIFY.

  2. Select Administration on the navigation menu.

  3. Select Data Governance.

  4. Select Governance Status.

  5. To create a new status:

    1. Click the Create New Status button.

    2. Fill in the following fields:

      1. Name (Textbox)

      2. Colour (Colour picker)

      3. Icon (Drop-down menu)

      4. Publish (Checkbox)

      5. Active (Checkbox)

    3. Click Save, else Cancel.

  6. To edit a status (static or user defined):

    1. Select the associated Actions (cog) icon.

    2. Select Edit.

    3. Make the desired changes to the status.

    4. Click Save, else Cancel.

  7. To view a status' history (static or user defined): (Note: This action is currently out of scope but may be applied in the future)

    1. Select the associated Actions icon.

    2. Select History.

    3. Click on the associated Select icon to view a listed action’s history details.

    4. Click Close to exit the modal.

  8. To delete a status (user defined only):

    1. Select the associated Actions icon.

    2. Select Delete.

      1. A modal reading ‘Are you sure?’ then appears.

    3. Click Yes, else Cancel.

Acceptance Criteria

We succeed only if a data governance feature is available in SPORIFY.

  • Verify that SPORIFY’s data governance follows reflects that which is described in the Description chapter of this document.

  • Verify that records' data governance statuses can be viewed via source list screens, target list screens and details pages.

  • Verify that administrators can set data governance integrations settings for their users as described in the Procedure chapter of this document.

  • Verify that administrators with the relevant permissions can create new data governance statuses. Verify that they can also edit and delete currently existing data governance statuses.

  • Verify that the data governance modal can always be accessed, even when the user cannot govern the given record.

  • Verify that data governance updates are presented in the Dashboard Activity Panel.

  • Verify that data governance filters are available on source and target list screens.

  • Verify the link to the history comparison page is available, if comparison data is available for that record.

Related / Alternative Procedure

N/A 

GUI Specification

Purpose of these GUI elements

The purpose of these GUI elements is to facilitate data governance in SPORIFY.

Mockups and Screenshots

SPORIFY Data Governance Rules

Data Governance Modal

Add Comment Modal

Data Governance Settings

Governance Status Screen

Create New Status Modal

Edit Status Modal

Delete Status Pop-Up

GUI Elements

Mockup of GUI Element

Title

Default

Enabled

 Type

Data

Description

Name

Empty

Always

Textbox

String

The status name is inserted here


Icon

Select an Icon

Always

Drop-down menu

Icon

The status icon is selected here

Colour

None selected

Always

Colour picker

Colour

The status icon colour is selected here

Active

True

Always

Checkbox

Boolean

Status is set to active or inactive here

Publish

False

Always

Checkbox

Boolean

Status is set to publish/do not publish here

Available Actions And Commands

Mockup of GUI Element

 Title

Shortcut

Enabled

Type

Role/Permission

Action

Tooltip

Audit Trail

Yes

N/A

Always

Button

Administration - Data Governance

Deletes the associated governance status

N/A

Yes


Cancel

N/A

Always

Button

Administration - Data Governance

Closes the Delete Status modal without deleting the status

N/A

No

Close

N/A

Always

Button

Administration - Data Governance

Closes the Status History modal

N/A

No

Select

N/A

Always

Button

Administration - Data Governance

Expands the associated Action to reveal its history details

N/A

No

Cancel

N/A

Always

Button

Administration - Data Governance

Closes the associated modal without saving changes

N/A

No

Save

N/A

Always

Button

Administration - Data Governance

Saves the associated configuration

N/A

Yes

Create New Status

N/A

Always

Button

Administration - Data Governance

Presents the Create New Status modal

N/A

No

Actions

N/A

Always

Icon

Administration - Data Governance

Presents a list of available actions when selected

N/A

No

Related Documentation and Sources

Specification References

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.