SE-AMA - 2017
This is the wiki for our project, the Sharing Editor, for the course INF5750 - Open Source Development.
Name SE-AMA explained:
- SE - Sharing Editor
- AMA - Alexander, Magnus, Andrei
- Alexander Wandrup (alexanow)
- Andrei Eismont (andreiei)
- Magnus Biong Nordin (magnubn)
Project Description Requirements
For our assignment we chose to work on the Sharing Editor.
The assignment states that we are to create an application for DHIS that lets the user multi-select any number of metadata objects within a selected category, and then edit the sharing configuration of that metadata all at once. The app should be able to apply read/write, read only or no access to the "public access" property. The primary goal of this app as we see it is to provide the user with an intuitive and quick way to edit sharing configuration in bulk. To achieve this, we will apply many of the same principles/designs on which the DHIS app Maintenance was built on. More on that later.
The main menu of the application will consist of a tree-like view of all (or what we can manage) objects that have sharing configurations. Sub-categories are nested. For example, if you chose data element, the tree will expand and display three options: data element, data element group, and data element group set. Chose any of the three, and begin your editing.
For search we'll be using a template not dissimilar to the one currently used by Maintenance when creating a new data element, or a new set etc. There'll be two selection windows: one will, for example, display every single data element in a scrollable view, and the other window displays the chosen elements. In both windows the user has the option to multi-select and add, multi-select and remove, and select- and remove all.
Anything the user types will filter the output in the windows to display valid search results. Certain objects such as data elements have specific properties that can be selected to narrow down the search field, such as selecting the domain type or value type. This feature will be implemented for objects that have additional properties.
From the nested-tree menu the user will be able to select data elements, groups, data sets, programmers, dashboards and much else. A minimal requirement is to be be able to work with only a select few of the sharable objects. Ideally, there should be support for all. This is a specification we will strive to achieve but, as of right now, we intend to take it one step at a time and just make sure we don't accidentally or purposely fall of a cliff.
Structured similarly, there'll also be support to edit user groups.
When editing the sharing configuration for dashboards, we will need not only to alter the setting for the dashboard itself, but all of its view also, as well as all the tables or charts those views have and every element inside those charts or tables. This is considerably more work than the rest of the objects and we recon will be the primary challenge during development.
Finally, it should be possible to both completely overwrite existing sharing settings or modify the existing sharing settings. It will therefore be possible to alter a read-only setting to write and read, despite the object marked as "read only".
- React. None of us had any previous experience in front-end development, and because React was shown during class - as well as being one of the two frameworks presented during one of the guest lecture by Accenture (the other being Angular), we naturally levitated towards React.
Open Source Projects Used
- material-ui. A great majority of the component designs from material-ui were similar if not identical to the ones implemented in DHIS2. In addition to being ascetically pleasing, we wanted the design to also be consistent with other DHIS application, primarily the Maintenance app.
- Licensing. Discuss the implications (if any) on the product you are development from the software licenses of the frameworks and libraries you are using.
Division of labour
During the initial development, we intend to work together as a group so that everyone understands how DHIS works, how React works, and how those two interact. This we feel ensures that every member of group gets the appropriate knowledge in all tools, and that any empty seat can be filled by another member should the other be indisposed.
When we have a solid foundation that we can build upon, then we can divide the tasks accordingly, depending on time and where our strengths or wishes lie.
- Wiki up and running
- Chosen assignment
- Overview of the product to be developed
- Proposed architecture of the app
- Broad timeline for development (in form of milestones)
- Link to project repository
- The app's interface up and running
- No more features will be added after this milestone
- The app should be completely finished
- Completed and delivered
Our main goal with this app is to keep it simplistic and easy to use.
Documented Learning During Project
Link to Repository
The repository is private.