Data Control

Data Controls Module User Documentation

WARNING: The Data Controls module is a powerful feature that significantly impacts data access within the system. Ensure you fully understand its functionality and potential consequences before making any changes. Improper configuration may result in unintended data access or restrictions.

Test new Data Controls thoroughly in a non-production environment before implementing them in the live system.

Overview

The Data Controls module is an administrative tool used for creating and editing Data Controls. These controls manage user access to specific data within the system, such as limiting access to voyages connected with the user's business units.

The Data Controls module now allows multiple attributes to be associated with a single Data Control. When more than one attribute is configured, the system evaluates them using OR logic, giving administrators more flexibility in defining access rules.

Accessing the Module

Upon opening the Data Controls module, administrators will see a list of existing Data Controls.

Creating a New Data Control

To create a new Data Control:

1. Click the plus (+) button above the list of Data Controls.

2. A modal will appear with the following fields:

   • Object: The Dataloy object to which the access control will be applied.

   • Attributes: A list of attribute names that link the Dataloy object with the target object. Multiple attributes can be selected, and the system will evaluate them using OR logic.

   • Matcher Target: Defines the Dataloy object to be used as the target object.

   • Matcher Attribute Target: Specifies the attribute in the matcher target object to be used against the attributes of the object.

   • Security Roles: A list of Security Roles to which the Data Control will be applied. If none are selected, the Data Control will apply to all users.

   
3. Fill in the required information and click "Confirm" to save the new Data Control.

Editing a Data Control

To edit an existing Data Control:

1. Click on the desired Data Control in the list.

2. A drawer will open, displaying the current settings for the selected Data Control.

1. Make the necessary changes in the "Overview" tab.

Examples

Here are some examples of how Data Controls can be used:

1. Vessel Master Access Control:

   • Object: Voyage

   • Attributes: voyageHeader.vesselCodes.masterUser

   • Matcher Target: User

   • Matcher Attribute Target: key

   • Data Control Role Values: MASTER_ONLINE_VESSEL

   In this example, users with the "MASTER_ONLINE_VESSEL" security role will only be able to access voyages where the voyage's master user matches their user key.

2. Business Unit Access Control:

   • Object: Voyage

   • Attributes: voyageHeader.businessUnit, voyageHeader.key

   • Matcher Target: User

   • Matcher Attribute Target: businessUnits

   • Data Control Role Values: BUSINESS_UNIT_MANAGER

   This control would restrict users with the “BUSINESS_UNIT_MANAGER” role to only access voyages where either the voyage’s business unit or the voyage’s key matches one of their assigned business units, since multiple attributes are evaluated using OR logic.