Knowledge Base
About DataloyRelease NotesAPI DocumentationJava VMS Documentation
Release 8.0
Release 8.0
  • Knowledge Base
  • Voyage Management System
    • VMS: Step-By-Step Guides
      • Vessels
        • Create Vessels
        • Copy Vessel
        • Find Vessels
        • Voyages & Port Calls
        • Main Vessel Description
        • Speed & Consumption
        • Load & Discharge Rates
          • Manage Load And Discharge Rates
        • Internal Data
        • AIS & Weather Reports
        • AIS-subscription
        • View Vessel Route from Previous Port to Next Port
      • Voyages
        • Create New Voyages
          • Create Voyage Charterer
          • Create Time Charter Out
          • Create Voyage From Template
          • Create Voyage Without Cargo
        • Find Voyages
        • Maintain Voyages
          • Overview
            • Vessel
            • Cargo
            • TC
            • Schedule
            • Profit/Loss Summary
              • Analysis
            • Speed & Consumption
          • Cargo
          • Bunkers
          • Various Cost/Revenue
          • Organisational Data
          • Invoices
          • Related
          • Voyage Functionalities
            • Converting Voyage to Template
            • Change Voyage Status
            • Swap Vessel
            • Configure Voyage as a “Last TC Voyage”
            • Change Voyage Reference Number/Voyage Number and Voyage Starting Year
            • Voyage Comparison
        • TC Voyages
        • Create Laytime Calculations
        • Delete Voyages
        • Voyage Map
        • Voyage Schedule
        • Voyage Edit Schedule
        • Voyage Alternative Routes
        • Voyage Functions
          • Sensitivity Analysis
          • Intake Calculation
        • Long Time Charter (TC) Voyage
        • Voyage Bunkers
      • Cargoes
        • Create New Cargoes
          • Create Cargo
          • Create Cargo From CoA Template
          • Create Cargo on TC Voyages
          • Create Cargo by Importing from Excel
          • Create Cargo From Existing Cargo
        • Find Cargoes
        • Maintain Cargoes
          • Cargo drawer
            • Main Details
            • Sub-cargoes
            • Various Cost/Revenue
            • Commissions
            • Freight Rate Tiers
            • Payment Terms
            • Comments
            • Cargo Drawer Actions
              • Allocate Cargo
              • Change Cargo Status
              • Delete Cargo
              • Relet Cargo
              • Convert Cargo to Relet/Non-Relet
              • Transship and Preship Cargo
              • Transfer Cargo
              • Connect Cargo to CoA
              • Remove CoA from Cargo
        • Template Cargoes
        • Capacity Plan
        • Sub-cargo
        • View Cargo History
      • Port Calls
        • Find Port Calls
        • Maintain Port Calls
          • Days Extra In Port
          • Speed Order
        • Register Noon Reports
        • Register Arrivals
        • Register Berths
        • Register Unberths
        • Register In Port Reports
        • Register Departures
        • Use Cost from Service Orders
          • Automating the Use Cost from Service order
        • Port Call Bunkers and Overview
        • View Service Orders on Port Calls
        • View Bunker Orders on Port Calls
        • View Vessel Reports on Port Calls
        • View Port Log on Port Calls
          • Stoppages
      • Port Costs
        • Find Port Costs
        • Maintain Port Costs
        • View Service Orders of Port Costs
      • Contracts of Affreightment
        • Create Contracts of Affreightment
        • Maintain Contracts of Affreightment
        • Find Contracts of Affreightment
        • Contract of Affreightment Lines
          • Find Contract of Affreightment Lines
          • Create Contract of Affreightment Lines
          • Maintain Contract of Affreightment Lines
          • Template Cargoes
            • Create Template Cargo
            • Maintain Template Cargo
            • Find Template Cargo
      • Time Charter Contracts
        • Create Time Charter Contracts
        • Maintain Time Charter Contracts
          • Duration and Rates
            • Create Duration and Rates
          • Notices
          • Comissions
          • Payment Terms
          • View Speed & Consumption
        • Print Statement of Account
      • Broker Commissions
        • Create Commissions
        • Find Broker Commission
        • Maintain Broker Commission
      • Bunker Orders
        • Create Bunker Orders
          • Create from a port call
          • Create bunker order from scratch
        • Maintain Bunker Orders
        • Stem Bunker Orders
        • Register Delivery Against a Bunker Order
        • Cancel Bunker Order
        • Delete Bunker Order
      • Service Orders
        • Create Service Order
        • Maintain Service Order
        • Delete Service Order
      • Laytime Calculations
        • Create Laytime Calculation
        • Find Laytime Calculation
        • Delete Laytime Calculation
        • Maintain Laytime Calculation
          • Status
          • Drawer Fields
          • Manage Cargo Ports
            • Cargo Port Fields
            • Statement Of Facts
              • Event
            • Timesheet
      • Bills of Lading
        • Create Bills of Lading
        • Attachments
        • Edit Bills of Lading
        • Delete Bills of Lading
        • Print Bills of Lading
        • Print Sea Waybills
      • Offhire
        • Create Offhire
        • Find Offhire
        • Maintain Offhire
          • Delete Offhire
          • Copy Offhire
          • Status
          • Overview
          • Various Cost/Revenue
          • Comments
      • Vessel Reports
        • Find Vessel Reports
        • Create Vessel Reports
      • Voyage Analysis Dashboard
        • Log In
        • Viewing and Managing Deviated Voyages
          • Viewing and Managing Deviated Voyages
          • Viewing Post Voyage Analysis Detail
          • No Freight Received
      • Invoices
        • Invoices List
        • Pending Invoices
        • Assembling Invoices
        • Invoice Drawer
        • Printing Invoices
        • Reversing an Invoice
      • Bunker Transactions
      • Accruals
        • Accruals
          • Batch Post Accruals
          • Generate Accruals
          • Find Accruals
          • Maintain Accruals
        • Bunker Stock Adjustments List
          • Batch Post Bunker Stock Adjustments
          • Bunker Stock Adjustment Drawer
        • Actuals list
        • Time Correction list
      • Status Transitions
      • Webhook Subscriptions
        • Create Webhook Subscription
        • Find Webhook Subscription
        • Maintain Webhook Subscription
          • Overview
          • Notification
      • Setup
        • Users
          • Create Users
            • Create a Vessel Master user
          • Maintain Users
            • Change User Passwords
          • Find Users
          • Disable Users
          • Multi-Factor Authentication (MFA)
            • Guardian Multi-Factor Authentication (MFA)
        • Security Roles
          • Find Security Roles
          • Create Security Role
          • Maintain Security Roles
        • Security Groups
          • Security Group Aliases
          • Find Security Groups
          • Create Security Group
          • Maintain Security Groups
        • System Settings
          • General
          • Invoicing Preferences
        • Data Control
        • Widgets
      • Master Data
        • Banks
        • Bunker Categories
        • Bunker Types
        • Business Partners
          • Manage Business Partners
        • Companies
          • Manage Companies
        • Events
        • Ice Class
        • Individuals
        • Port
        • Restricted Areas
        • Taxes
        • Various Costs and Revenues
        • Vessel Types
      • EU ETS Compliance
      • Attachments
      • Audit Log
      • Comments
      • Notifications
      • Sorting and Filtering Lists
      • Customising List Columns
      • Export to Excel Sheet
      • Widgets
    • Oracle Database Compatibility
  • Fleet Allocation & Scheduling
    • FAS: Step-By-Step Guides
      • Capacity Plan
      • Fleet Plans
        • Open Positions Board
        • Scheduler Board
        • Cargo Management Board
          • Cargo Actions
        • FAS Voyages List
        • FAS Cargoes List
        • Voyage Actions
      • Scenarios
        • Find Scenario
        • Create Scenario
        • Maintain Scenario
        • Copy Scenario
      • Budgets
        • Create Budget Scenario
        • Template Voyages
          • Create Template Voyages
          • Find Template Voyages
          • Maintain Template Voyages
        • Budgeted Voyages
          • Find Budgeted Voyages
          • Bulk Updating Budgeted Voyages
    • Create Voyages (JVMS)
      • Create Commitment
      • Create Commitment from CoA
      • Create Commitment from Voyage Estimate
  • Dataloy Distance Table (DDT)
    • About Dataloy Distances
    • Routing and routing options
    • Custom Point using Latitude and Longitude
    • High-Risk Area (HRA) / Piracy Routing
    • Distances API
    • Distances Change Log
  • Dataloy Systems AS
    • Privacy Policy
    • GDPR Statement
    • Release Notes
Powered by GitBook
On this page
  • Data Controls Module User Documentation
  • Overview
  • Accessing the Module
  • Creating a New Data Control
  • Editing a Data Control
  • Examples

Was this helpful?

Export as PDF
  1. Voyage Management System
  2. VMS: Step-By-Step Guides
  3. Setup

Data Control

PreviousInvoicing PreferencesNextWidgets

Was this helpful?

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.

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.

    • Attribute: The attribute name that links the Dataloy object with the target object.

    • 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 attribute 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.

  3. 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

    • Attribute: 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

    • Attribute: voyageHeader.businessUnit

    • 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 associated with their assigned business units.