BlueBrain / BlueBrain/nexus

Properties Plugin: ability to configure a list of properties to present for a specific kind of KG resource

Open
#3,392 0 comments 0 reactions 0 assignees View on GitHub
design feature fusion fusion-plugin
Dominant language
Scala
Stars
301
Forks
76
PR merge metrics
No merged PRs in 30d

Description

This is the summary of a preliminary discussion with @jdcourcol

### Description
Building a custom plugin for each relevant type of resources in the KG is a time consuming activity.
Could we design a **configurable** plugin that could present a list of arbitrary properties, some of which could be editable by the user.

Some custom plugins have been created for specific data types:
- MINDS metadata
- Circuit
- SimulationCampaign
- Simulation

### Preliminary Acceptance Criteria
- A developer can configure the plugin so that it will be presented for a given entity type (e.g. DetailedCircuit, Simulation, NeuronMorphology, ...)
- The configuration will include for a given property to be presented:
- Its label in the UI
- How the value can be found (e.g. dev friendly path through the RDF graph assuming we start from the resource ?self)
- single and multiple values should be supported for a given property
- its type in order to present it appropriately (e.g. date, file path, person, ontology value, KG Resource...)
- for KG Resource, the user should be able to navigate to this resource
- if the user can copy the value to clipboard
- if the user can edit the value
- where the allowed values are coming from (e.g. static, query, ...)
- Some guidance about the layout of the data (e.g. columns, ordering, ...)
- Actions that can be taken by the user on this entity
- example: open a new tab with a templated URL using the KG resource Self

TODO
- Discuss the idea with the team once Loris has joined
- Collect specific examples of configuration for important BBP resource types
- Refine feature set
- Design and validate
- Create implementation issues
- Implement

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.