Metadata form Userguide #1596
Metadata form Userguide #1596
Conversation
There was a problem hiding this comment.
the names for mf_create and mf_list are wrongly defined. mf_create should be mf_list and viceversa.
There was a problem hiding this comment.
I left some comments but basically they can be summarize as:
- as a new user I do not understand the permission model on metadata forms. What does "required" access mean, who can use the forms, who can edit the forms, what do I see in the list Metadata forms
- as a new user, I am not sure about the implications of each visibility type, and which entities can have metadata forms attached
- I am also missing some info about the lifecycle: what happens when a metadata form is edited, can we delete them if there are entities with attachments, also not clear that a metadata form can be dettached (I had to go until the end of the end)
| 2. Once form is created, the owners can add enforcement rules (see the section below). | ||
| 3. All changes in metadata form can be performed only by its owner. | ||
| 4. Metadata form can be attached to an entity by the user with sufficient permissions. Permissions are given by the owner or admin of the entity. | ||
| 5. Attached metadata forms can be edited or deleted by any user with sufficient permissions. |
There was a problem hiding this comment.
What happens then when the metadata form is edited or deleted and it is attached to entities?
|
|
||
| **Introduction** | ||
|
|
||
| Metadata forms allow users to add structured contextual information to various entities in the data.all platform. By creating and attaching metadata forms, user can standardize and enrich metadata in a customizable way. |
There was a problem hiding this comment.
This happens a couple of times in the file, we use "user" without any article (a/an/the) which I think might be a small grammar error
|
|
||
| - Global visibility means the metadata form is visible and attachable to any entity by all users across the platform | ||
| - Organization/Environment-Wide visibility limits the form to a specific organization/environment - it can only be seen by members of this organization/environment and attached to entities in that organization/environment | ||
| - Team-Only visibility restricts the form to just members of a specific team, but does not restrict to which entities it can be attached to |
There was a problem hiding this comment.
Could a team-only visibility form be attached to datasets in different environments if the team is the same?
There was a problem hiding this comment.
Maybe we should clarify that, to avoid questions
| The same visibility restrictions apply to the attached metadata form. E.g. is userA can see Metadata Form A, but can't see Metadata Forms B, and both of these | ||
| metadata forms attached to the dataset (attachedA and attachedB), so userA can view attachedA, but can not view attachedB. | ||
|
|
||
| **Metadata Form lifecycle and usage** |
There was a problem hiding this comment.
We are mixing lifecycle and permissions. lifecycle is just: create, add enforcement rules (optional or mandatory?), attach and then a comment on delete and edit
permissions: the whole point 1. then enforcement rules/edit/delete = only form owners, attach=depends on visibility right?
|
|
||
| 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. | ||
|
|
||
| **View Metadata Forms** |
There was a problem hiding this comment.
Shouldn't this be part of the visibility paragraph? Maybe here you can reference that section above
There was a problem hiding this comment.
It's not about visibility. It's particularly enforcement.
Feature or Bugfix
Detail
Relates
Security
Please answer the questions below briefly where applicable, or write
N/A. Based onOWASP 10.
fetching data from storage outside the application (e.g. a database, an S3 bucket)?
evalor similar functions are used?By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.