Resource MetaData
- Rustam Negmetov
- Andrew Estrada
- Mary DelPiano
Figma Link
User Story
As a RethinkEd content creator, I need to create or edit a Resource so that I can provide more resources for the Lesson Library.
UI Description
Title
Description: The name or headline of the resource.
Required: Yes.
Type of Input: Text field.
Validation Criteria: Must contain at least 3 characters and no more than 255 characters. It should accurately reflect the content or subject of the resource to ensure easy identification and searchability.
Short Description
Description: A concise summary of the resource, highlighting its main points or features.
Required: No.
Type of Input: Textarea.
Type
Description: The category that best describes the nature or format of the resource.
Required: Yes.
Type of Input: Dropdown menu.
Dropdown Values:
Video
Document
Image
Keywords
Description: User-defined tags or keywords that describe the resource, aiding in search and categorization. After input, the text is parsed into individual words or phrases, each displayed as a removable tag.
Required: No.
Type of Input: Text input with tag conversion.
Validation Criteria:
Input is free-form text, converted into tags upon submission or pressing the enter key.
Each tag is visually represented in a way that allows for easy removal, typically with an "x" or similar icon in the corner of the tag.
There's no strict minimum, but ideally, a limit on the maximum number of keywords (e.g., 10 to 20) to prevent over-tagging and maintain focus.
Special characters might be restricted or allowed based on the tagging system's design and the search functionality's capabilities.
User Interaction and Validation Notes
Title and Short Description fields are required to proceed. These fields are crucial for basic identification and understanding of the resource.
For the Type field, users must select from the predefined options. This ensures consistency and reliability in filtering and searching resources across the platform.
The Keywords field is designed to enhance searchability and categorization. Users can type keywords, which, upon submission or pressing the enter key, become individual tags. Each tag should be removable, offering flexibility in refining the resource's descriptors.
Validation for text fields should include checks for prohibited characters or patterns that might interfere with the system's functionality or the database's integrity.
For the "Resource Metadata" functionality within the Resource Builder section, the workflow is a crucial aspect that dictates how users interact with both new and existing resources.
This workflow ensures that the system is intuitive and that users with the appropriate permissions can effectively manage resource metadata. Below is a detailed description of the workflow process:
Resource Metadata Workflow Description
Accessing the Page:
When a user navigates to the "Resource Metadata" page, they can either be creating a new resource or editing an existing one. The system differentiates these scenarios based on whether a resource ID is provided (for editing) or not (for creating).
Initial State:
New Resource: If the user is adding a new resource, all fields on the "Resource Metadata" page are presented as empty, ready for the user to input the new information.
Existing Resource: If the user is editing an existing resource, the system retrieves all current metadata for that resource from the server and populates the fields accordingly. This ensures that the user can see the existing information and make any necessary updates.
Editing Metadata:
Users can make changes to any of the metadata fields, regardless of whether they are creating a new resource or editing an existing one. This includes updating the title, short description, type, and keywords, among others.
For the Keywords field, users can add new keywords or remove existing ones by clicking on the "x" or similar icon on the tag representation of each keyword.
Validation and Feedback:
Before submission, the system validates all input based on the specified criteria for each field. If any field does not meet its validation requirements, the system displays an appropriate error message, prompting the user to correct the input.
This step ensures data integrity and prevents the submission of incomplete or incorrect metadata.
Saving Changes:
Once all fields are correctly filled out and validated, the user can save the changes by clicking the "Save" button.
Upon saving, the system updates the resource's metadata on the server. For new resources, this action creates a new record; for existing resources, it updates the existing record with the new metadata.
Access Control:
The form for editing or adding metadata is accessible only to users who have the "Edit Resources" permission. This ensures that only authorized personnel can modify resource information, maintaining the integrity and security of the content on the portal.
Confirmation and Redirect:
After successfully saving the metadata, the user may receive a confirmation message, and the system could redirect them to either the resource listing page, the resource detail view, or another relevant page. This action provides clear feedback that the operation was successful and guides the user on what to do next.
Conclusion
This workflow emphasizes user-friendly interaction, data integrity, and proper access control, ensuring that the Resource Metadata management process is efficient, secure, and intuitive. It accommodates both the creation of new resources and the modification of existing ones, with clear pathways and feedback mechanisms for users throughout the process.