Use case overview
- Priority: Medium
- Status: Draft
Describe use case
A clear and concise description of a use case supported by BIG outputs (DCTAP and/or SHACL).
As a cataloger using a BIBFRAME editor, I would like the editor to warn me that my description is missing data that is required if applicable using the BIG shape sh:Warnings.
Preconditions (Optional)
List conditions that must be true before this use case can begin.
Required if applicable information needs to be defined in SHACL using sh:Warning for each of the entity types that have templates/forms for creating or updating a description.
Describe expected behavior in related systems
A clear and concise description of related system behavior
Using the BIG SHACL, the editor would compare the description provided by the cataloger against the applicable BIG SHACL before saving the data. If the description does not conform to BIG shape definitions based on sh:Warnings, the cataloger would be asked if they are sure they want to save the description and would be notified which fields are missing values and might require changes.
Post conditions (Optional)
Success post conditions
What should be true after successful completion?
Catalogers should feel confident that they are meeting the minimal requirements for describing a particular entity type because the required fields have been filled out accordingly to requirements in SHACL.
Failure post conditions
What should be true if the use case fails?
The editor implementation fails if the cataloger is able to save a record without being warned that they are not meeting the minimal descriptive requirements (if applicable) for the entity/ies they are describing in the BF Editor.
Main success scenario
What steps or conditions would this use case be considered to be a success?
If the editor uses validation, it ensures that we have a consistent shape for the minimal description, and support interoperability between various systems consuming this data.
Additional context
Add any other context or screenshots about the features you are requesting.
Note, BIBFRAME editors like Sinopia and Marva use templates to drive form and data requirements. Template creators need to be aware of the BIG requirements if they want their data to validate against these shapes. This issue is closely related to #1.
Use case overview
Describe use case
A clear and concise description of a use case supported by BIG outputs (DCTAP and/or SHACL).
As a cataloger using a BIBFRAME editor, I would like the editor to warn me that my description is missing data that is required if applicable using the BIG shape sh:Warnings.
Preconditions (Optional)
List conditions that must be true before this use case can begin.
Required if applicable information needs to be defined in SHACL using sh:Warning for each of the entity types that have templates/forms for creating or updating a description.
Describe expected behavior in related systems
A clear and concise description of related system behavior
Using the BIG SHACL, the editor would compare the description provided by the cataloger against the applicable BIG SHACL before saving the data. If the description does not conform to BIG shape definitions based on sh:Warnings, the cataloger would be asked if they are sure they want to save the description and would be notified which fields are missing values and might require changes.
Post conditions (Optional)
Success post conditions
What should be true after successful completion?
Catalogers should feel confident that they are meeting the minimal requirements for describing a particular entity type because the required fields have been filled out accordingly to requirements in SHACL.
Failure post conditions
What should be true if the use case fails?
The editor implementation fails if the cataloger is able to save a record without being warned that they are not meeting the minimal descriptive requirements (if applicable) for the entity/ies they are describing in the BF Editor.
Main success scenario
What steps or conditions would this use case be considered to be a success?
If the editor uses validation, it ensures that we have a consistent shape for the minimal description, and support interoperability between various systems consuming this data.
Additional context
Add any other context or screenshots about the features you are requesting.
Note, BIBFRAME editors like Sinopia and Marva use templates to drive form and data requirements. Template creators need to be aware of the BIG requirements if they want their data to validate against these shapes. This issue is closely related to #1.