API extension to add cases to the QCAT database¶

This is a project to add as well as update cases to the WOCAT SLM database by external applications running on other systems.
Those external applications connect through a Restful API.
For this, the existing API has to be extended by endpoints to upload data.

See the specified requirements in the wiki for more information.

Terms:¶

• Configuration: an empty paper based questionnaire, e.g. 'Technology' or 'Approach'
• case: the contents / filled in data for a configuration.
• In the tasks, tags are used to indicate whether a tag is "Required" or "Improvement"
• User Story: This is more a kind of a work package. Its description should be understandable for non-developers. User stories can contain several development tasks
• Task: a development task which is a part of a larger user story. work time estimations are made on task level. User stories show just the sum of all tasks as estimated time.

• See the Agile board for ongoing development tasks

This project asks for an adaptation of the questionnaire.
In the QCAT application the questionnaires are represented by configurations.
For such an adaptation we have to enable the versioning of the configurations which was already considered at the project start.
More information about the configuration versioning can be found on the following wiki page: Versioning of Configurations

Terms:¶

• Configuration: an empty paper based questionnaire, e.g. 'Technology' or 'Approach'
• Data/questionnaire: the contents / filled in data for a configuration.
• In the tasks, tags are used to indicate whether a tag is "Required" or "Improvement"
• User Story: This is more a kind of a work package. Its description should be understandable for non-developers. User stories can contain several development tasks
• Task: a development task which is a part of a larger user story. work time estimations are made on task level. User stories show just the sum of all tasks as estimated time.

Overview of affected areas¶

Below you see list of user stories and tasks related to the Carbon Benefit Project. On the right side below you see a box showing the overall estimated time sum.

• See the agile board for user stories (Work Packages), ordered by priority: https://redmine.cde.unibe.ch/agile/board?project_id=qcat&query_id=29

• See all required tasks and the corresponding estimated time: https://redmine.cde.unibe.ch/projects/qcat/issues?query_id=30 (modify tag filter to show all / improvement tasks)

User stories / Issues¶

QCAT¶

Features which Wocat core/Plus and UNCCD do share

QCAT common features
Those are features which will be available in WOCAT core as well as in UNCCD application:

• Versioning
• Review/Approval Workflow
• Webservices