dataall icon indicating copy to clipboard operation
dataall copied to clipboard

Metadata Form Enforcement

Open SofiaSazonova opened this issue 4 months ago • 3 comments

Enforcement

Metadata forms can be obligatory to fill in on different levels. User can select the metadata form and entity types, that should have this form attached. Enforcement affects selected entity types on all lower levels hierarchically.

Table E.1. Metadata form enforcement rule

Field Description Type Possible Values
Metadata Form Identifier of metadata form, that is enforced String URI of existing form
Metadata Form Version number of version, that is enforced Int
Level Level of affected entities. All lower levels will be affected. String From table E.2
Home Entity Uri If level is not global, the Uri of the entity under which the MF is enforced String
Entity Types Entity type affected by this enforcement Array [String] Identifiers of data.all entities types (table E.2)
Severity String Obligatory/Recommended

Table E.2. Metadata form levels’ hierarchy

meta levels

Who can enforce:

  • Data.all admins can enforce any form on any level across the platform. They have full control over metadata form enforcement.
  • Owners/admins of the data can enforce forms for this levels and levels below in the hierarchy. For example, an org admin can enforce a form for the org, all teams in that org, all environments in the org, all datasets in those environments, etc.
  • Share approvers and requestors can enforce forms for a specific share they are involved with. However, they can only delete enforcement rules they created themselves - they cannot delete rules created by others

So in summary, enforcement capabilities cascade along with administrative privileges in the hierarchy. Global admins have full control, org/env admins can enforce for their sphere and below, dataset admins for the datasets and items in it, and share requesters and approvers for a specific share.

How we enforce?

  1. When MF is enforced, but entity misses it, on entity page there is a HUGE reminder about it.
  2. If MF is mandatory, than NO actions are allowed until required MF is attached | 2.1. Orgs:
  • :no_entry: invite/remove groups
  • :no_entry: link envs
  • :no_entry: edit info

2.2. Envs

  • :no_entry: invite/remove
  • :no_entry: add consumption roles
  • :no_entry: add datasets
  • :no_entry: edit info

2.3. Datasets

  • :no_entry: data actions (lauch crawler, add folders, delete tables, syncing data)
  • :no_entry: create new shares. Existing shares are intact
  • :no_entry: edit info

SofiaSazonova avatar Oct 28 '24 14:10 SofiaSazonova