4Science / DSpace

This repository contains the 4Science optimized DSpace & DSpace-CRIS distribution.
https://wiki.lyrasis.org/display/DSPACECRIS/
BSD 3-Clause "New" or "Revised" License
42 stars 61 forks source link

Draft: Yet another Implementation of an organization unit tree #383

Closed floriangantner closed 5 months ago

floriangantner commented 1 year ago

References

Add references/links to any related issues or PRs. These may include:

Description

Short summary of changes (1-2 sentences).

In honour to our universities tradition to create special tree's fulfilling our stakeholder requirements (see https://github.com/4Science/DSpace/pull/119) we provide this draft of our tree.

Instructions for Reviewers

List of changes in this PR:

Configuration Settings:

orgunittree.xml -> org.dspace.uniba.orgunittree.OrgunittreeService Property Type Description
entity String Name of the entityType which are displayed, e.g. OrgUnit. All entities of this type are considered in the tree and fetched from the itemService when constructing the tree.
generalcondition Filter Condition which the node has to fulfill to be part of the tree, e.g. visible by anonymous
rootcondition Filter Condition which the node has to fulfill to be some of the root nodes, e.g. no metadatafield pointing to the upper OrgUnit
verticalrelationfield String Metadatafield which contains the authority information about the parent / upper Orgunit
onlyAnonymous boolean if enabled only anonymous readable results are shown and considered in the metrics
metricsconfiguration List<OrgUnittreeMetricsConfiguration> , List of metrics which are calculated for each node
-> org.dspace.uniba.orgunittree.OrgunittreeMetricsConfiguration Property Type Description
shortname String unique name of the metrics node. It is may referenced by other OrgunittreeMetrics or in the frontend rendering configuration
query String solrquery containing {0} the uuid of the item, e.g. oairecerif.author.affiliation_authority:{0}. If aggregation is enabled, the name of the subordinated OrgunittreeMetrics has to be specified.
aggregate boolean if enabled this node aggregates values from subordinated nodes and counts them together.

Include guidance for how to test or review your PR. This may include: steps to reproduce a bug, screenshots or description of a new feature, or reasons behind specific changes.

Checklist

This checklist provides a reminder of what we are going to look for when reviewing your PR. You need not complete this checklist prior to creating your PR (draft PRs are always welcome). If you are unsure about an item in the checklist, don't hesitate to ask. We're here to help!

floriangantner commented 6 months ago

Aligned to 2023.02.02 Release