Contribute to the DSpace Development Fund
The newly established DSpace Development Fund supports the development of new features prioritized by DSpace Governance. For a list of planned features see the fund wiki page.
Date & Location
at 16:00 UTC (11:00am EDT)
As of Dec 17, 2019, the DSpace 7 Entities Working Group is on hiatus and has merged with the DSpace 7 Working Group. This page represents the Notes of the final meeting. The "Task List" and "PRs Needing Review" sections below will be kept up-to-date to allow volunteers to continue reviewing/testing any remaining Entities or OpenAIREv4 PRs. For ongoing DSpace 7.0 development efforts, please see the DSpace Release 7.0 Status and DSpace 7 Working Group.
Location:
Join from PC, Mac, Linux, iOS or Android: https://lyrasis.zoom.us/my/dspace (Meeting ID: 502 527 3040)
Attendees
Actual attendee list will be updated after meeting.
- Tim Donohue - LYRASIS
- Alexander Sulfrian - Freie Universität Berlin
- Lieven Droogmans - Atmire
- Ben Bosman - Atmire
- Paulo Lopes - FCT|FCCN
- Mark H. Wood - IUPUI
- Paulo Graça- FCT|FCCN
- Jose Carvalho - University of Minho
- Dimitris Pierrakos - ARC/OpenAIRE
- Oliver Goldschmidt - Hamburg University of Technology (TUHH)
Agenda
# | Time | Item | Information | Who |
---|---|---|---|---|
1 | 5mins | Quick Reminder | Final DSpace 7 Entities WG meeting : With holidays the next two weeks (24th and 31st), this will be the final DSpace 7 Entities Working Group meeting of 2019. As of Jan 1, this Working Group will disband & work as part of the larger DSpace 7 Working Group.
| |
2 | 5mins | Agenda | Any additional topics to today's agenda? | All |
3 | 15mins | Updates on OpenAIREv4 | Any updates to discuss this week? Work based on:
| All |
4 | 15mins | Wrap-up and Assigning tasks |
|
Current Work
= Highest Priority tasks (please prioritize these reviews/tasks over others). These are tasks with lots of dependencies
= review done, changes were requested or bugs found.
= review done, approved.
= review done, merge conflict or other minor changes requests
1 APPROVAL = pull request only requires a single approval to merge. This is generally reserved for PRs which are either smaller, obvious, and/or bug fixes with tests to prove they work.
Tickets to Resolve
- All JIRA tickets tagged with "Configurable Entities": https://jira.duraspace.org/issues/?jql=project%20%3D%20DS%20AND%20component%20%3D%20%22Configurable%20Entities%22
- Critical Tickets: https://jira.duraspace.org/issues?jql=project%20%3D%20DS%20AND%20priority%20%3D%20Critical%20AND%20component%20%3D%20%22Configurable%20Entities%22
- Major Tickets: https://jira.duraspace.org/issues?jql=project%20%3D%20DS%20AND%20priority%20%3D%20Major%20AND%20component%20%3D%20%22Configurable%20Entities%22
- (HIGH PRIORITY) Bug with performance of Angular (especially with regards to Entities, e.g. in PR#402): https://github.com/DSpace/dspace-angular/issues/458
(REST Contract) There could be more than one Entity reference for external sources https://github.com/DSpace/Rest7Contract/issues/90
PRs Needing Review
- (Angular) Keep virtual metadata on relationship delete https://github.com/DSpace/dspace-angular/pull/530 (Paulo Graça - feedback added, Tim Donohue - feedback added) (8 hours - week of Dec 16)
- (Angular) Virtual metadata on item delete https://github.com/DSpace/dspace-angular/pull/533 ( Paulo Graça - feedback added , Tim Donohue - feedback added) (4 hours - week of Dec 16)
- sample screenshots: pr-533.pdf
- Dependent on #530 (see above). Internal PR to display the differences
- (Angular) Convert external source to entity https://github.com/DSpace/dspace-angular/pull/540 (NEEDS REVIEWERS, ready to review)
- Dependent on #539 (now merged). Internal PR to display the differences
- (Angular) Combining relationships and metadata during submission https://github.com/DSpace/dspace-angular/pull/541 (NEEDS REVIEWERS) (12 hours)
- Dependent on #534 (now merged). Internal PR to display the differences
- (NEW) (Angular) Create relationships as an admin in edit item [WIP] https://github.com/DSpace/dspace-angular/pull/545 (NEEDS REVIEWERS ONCE DEPENDENCIES ARE MERGED) (16 hours left - week of Jan 6)
- Dependent on #540, #539, #531, #530 (see above)
- (COMING SOON) (OpenAIRE4) OpenAIRE API import of entities/metadata (In progress development by Dimitris Pierrakos)
PRs Merged
- (REST Contract) Entity type small changes https://github.com/DSpace/Rest7Contract/pull/95
- (REST) DS-4401 Enforce relational place ordering when place direction is known https://github.com/DSpace/DSpace/pull/2617
- (REST) Get entity type performance improvement https://github.com/DSpace/DSpace/pull/2615
- (REST) Creating a workspace item from an external source https://github.com/DSpace/DSpace/pull/2614
- (REST) Entities submission config https://github.com/DSpace/DSpace/pull/2618
- (REST) Default Entities relationship types used for the demos https://github.com/DSpace/DSpace/pull/2622
- (REST) EntityType by label endpoint and integration tests https://github.com/DSpace/DSpace/pull/2628
- (Angular) Item page entities improvements https://github.com/DSpace/dspace-angular/pull/532
- (OpenAIRE4) OpenAIRE 4 submission forms and virtual metadata https://github.com/DSpace/DSpace/pull/2608
- (OpenAIRE4) OpenAIRE4 adding missing field person.identifier https://github.com/DSpace/DSpace/pull/2621
- (OpenAIRE4) OpenAIRE4 funding agency missing translation https://github.com/DSpace/dspace-angular/pull/542
- (Angular) Create relationships during the submission https://github.com/DSpace/dspace-angular/pull/531
- (OpenAIRE4) OpenAIRE4 oai_openaire metadata format support https://github.com/DSpace/DSpace/pull/2592
- (Angular) Lookup relations - Search external sources https://github.com/DSpace/dspace-angular/pull/539
- (Angular) Reordering related entities in the submission https://github.com/DSpace/dspace-angular/pull/534
Task List
This task list has been updated as of our meeting TODAY. The tasks are numbered for easy reference, but are not necessarily listed in priority order. During this meeting we worked to re-summarize current work status so that we can align this task list with the DSpace 7 Estimation Process (and as such, estimate any we feel should be considered for 7.0 release). NOTE: Keep in mind, just because a task is listed here does NOT guarantee it will be completed for DSpace 7. Some of these tasks may need to be delayed for a future release.
= task considered "completed" (unless bugs or issues are later found)
= task is incomplete or has further work to be done.
= task that may be delayed or postponed for after 7.0.
- Metadata schemas for Entity types (DS-4223).
- (Minor refactor) Decide which metadata field should be used to store Entity Type (DS-4184). Currently, it is stored in "relationship.type". (DEEMED LOWER PRIORITY, but "nice to have" for 7.0 if possible?)
- Creating Relations (between Entities) with CSV Batch Import
- Permissions on Relations (between Entities)
- Discussed on Aug 6
- Early Docs / Notes: https://docs.google.com/document/d/1X0XsppZYOtPtbmq7yXwmu7FbMAfLxxOCONbw0_rl7jY/edit#heading=h.y6qarjnylexl
- Deleting Entities that have existing relations
- Deletion action itself:
- REST Contract: https://github.com/DSpace/Rest7Contract/blob/master/relationships.md#deleting-a-relationship , REST: https://github.com/DSpace/DSpace/pull/2332 , Angular: https://github.com/DSpace/dspace-angular/pull/402
- Early Docs / Notes: https://docs.google.com/document/d/1X0XsppZYOtPtbmq7yXwmu7FbMAfLxxOCONbw0_rl7jY/edit#heading=h.c62y8iqnvlur
- Copy virtual metadata from deleted entity to related entity
- REST Contract: https://github.com/DSpace/Rest7Contract/pull/78
- REST impl: https://github.com/DSpace/DSpace/pull/2577
- Angular Impl (under review): https://github.com/DSpace/dspace-angular/pull/530 and https://github.com/DSpace/dspace-angular/pull/533
- Deletion action itself:
- Dynamic display of Relations
- Submission Integration Tasks
- Creating new Entities using Submission Forms
- Creating relations between two Entities during Submission process
- REST Contract: https://github.com/DSpace/Rest7Contract/pull/64 ,
- REST Impl: https://github.com/DSpace/DSpace/pull/2472
- Angular Impl (under review): https://github.com/DSpace/dspace-angular/pull/531 and https://github.com/DSpace/dspace-angular/pull/534
- Early Docs / Notes: https://docs.google.com/document/d/1X0XsppZYOtPtbmq7yXwmu7FbMAfLxxOCONbw0_rl7jY/edit#heading=h.9aixusqzgcnp
- Search External Sources (includes ORCID integration with Entities)
- REST Contract: https://github.com/DSpace/Rest7Contract/pull/74
- REST Impl: https://github.com/DSpace/DSpace/pull/2560
- Angular Impl (under review): https://github.com/DSpace/dspace-angular/pull/539
- Convert External Sources to an Entity
- If an Admin:
- REST Contract: https://github.com/DSpace/Rest7Contract/pull/82
- REST Impl: https://github.com/DSpace/DSpace/pull/2590
- Angular Impl (under review): https://github.com/DSpace/dspace-angular/pull/540
- If a Submitter (Feature is NOT specific to Entities, as this is simply porting the "Live Import" framework of DSpace 6.x)
- REST Contract: https://github.com/DSpace/Rest7Contract/pull/83
- REST Impl: https://github.com/DSpace/DSpace/pull/2614
- Angular Impl (under review): https://github.com/DSpace/dspace-angular/pull/540
- If an Admin:
- Name Variants
- Create name variants in submission
- REST Impl: https://github.com/DSpace/DSpace/pull/2561
- Angular Impl - this is included as part of https://github.com/DSpace/dspace-angular/pull/531
- Display name variants on Item pages (Angular)
- Create name variants in submission
- OpenAIRE v4 support (using Entities)
- Configuration of Entities needed for OpenAIRE v4: https://github.com/DSpace/DSpace/pull/2575
- Configuration of Metadata fields/schemas needed for OpenAIRE v4: https://github.com/DSpace/DSpace/pull/2576
- Configuration of Submission Input Forms for OpenAIRE v4: https://github.com/DSpace/DSpace/pull/2608
- Configuration of OAI-PMH for OpenAIRE v4: https://github.com/DSpace/DSpace/pull/2592
- Import entities/metadata from OpenAIRE API (using Live Import feature): (coming soon)
- How to display related items on an Item page if that related item is still in workflow approval
- Simply display the related item as plain text metadata (until workflow approval completes).
- Edit Item page integration
- How to display relationships on "edit metadata" tab in UI. How to add relationships on "relationships" tab in UI.
- Angular UI Mockups discussed/approved on Nov 5 and Nov 12.
- Angular relationships tab: https://github.com/DSpace/dspace-angular/pull/517
- Create relationships as an admin in edit item (under review): https://github.com/DSpace/dspace-angular/pull/545
- (DELAYED for 7.1 or later) Relations in AIP Backup & Restore
- (DELAYED for 7.1 or later) Creating Relations in SAF Import (might be postponed for a future release)
- Requires AIP Backup & Restore
- Proposal: https://docs.google.com/document/d/1X0XsppZYOtPtbmq7yXwmu7FbMAfLxxOCONbw0_rl7jY/edit#heading=h.n8ktliibe7kj
- (DELAYED for 7.1 or later) SWORD integration (might be postponed for a future release)
- Requires AIP Backup & Restore, as SWORD uses the same crosswalks / format as AIP.
- Proposal: https://docs.google.com/document/d/1X0XsppZYOtPtbmq7yXwmu7FbMAfLxxOCONbw0_rl7jY/edit#heading=h.xufwyy1ep8h2
- (DELAYED for 7.1 or later) Best Practices around Entities in Collections (NOT: this may just be early documentation). We've suggested in the Preview Release to structure Collections based on Entity Type (Person Collection, Projects Collection, etc). We should better document and formalize these best practices.
- Should we eventually consider hiding these Collections which only serve to store Entity Types?
Notes
- Last meeting of the DSpace 7 Entities Working Group (on indefinite hiatus). Our working group is considered disbanded unless we find a reason to meet later in the year (if any remaining Entities effort is needed later in 2020)
- REST API effort (contract & implementation) for Entities is COMPLETE!
- There are still some outstanding Angular and OpenAIREv4 PRs (see list of "PRs Needing Review" above), but NO MORE FEATURE PRs are expected
- One exception we realized is that Dimitris from OpenAIRE is working on a PR to import metadata from the OpenAIRE API (using the existing "Live Import" framework in DSpace 7). This PR is currently listed as "COMING SOON" above, and should be created by the end of 2019. It can be reviewed by volunteers in 2020.
- Next Steps for still open PRs
- These are considered low priority to review/test in 2020. The main DSpace 7 Working Group will be working in organized sprints to finalize the DSpace 7.0 release, so their priorities will be on general DSpace 7.0 features.
- That said, volunteer developers can continue to review Entities PRs as they see fit. Tim will also review & test them when his time allows (but only after any high priority DSpace 7 PRs are reviewed/tested first)
- As Working Group is no longer meeting, any Entities PR discussion should move to #entities-wg in Slack or GitHub.
- If a small group wants to talk in more detail about a specific PR, the DSpace Meeting Room is always available for an ad hoc PR meeting. These can be organized or requested via Slack or Github.
- These are considered low priority to review/test in 2020. The main DSpace 7 Working Group will be working in organized sprints to finalize the DSpace 7.0 release, so their priorities will be on general DSpace 7.0 features.
- As the Working Group is not meeting any further, the "PRs Needing Review" list & "Task List" sections above should be kept updated to let volunteers know the current status of any remaining Entities PRs.
- Thanks again to all who participated in the DSpace 7 Entities Working Group ! It's been wonderful seeing the passion & energy for both Entities & OpenAIREv4 in DSpace 7. Please consider joining our DSpace 7 Working Group in 2020 (if you have not already) to help us complete the 7.0 release!