Outcomes portfolio (1): Settings and database tables

Bug #1991601 reported by Kristina Hoeppner
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
Mahara
Fix Released
Wishlist
Cecilia Vela Gurovic

Bug Description

Part of the outcomes portfolio blueprint: https://blueprints.launchpad.net/mahara/+spec/outcomes-portfolio

Better formatting: https://wiki.mahara.org/wiki/Proposals/Outcomes_portfolio/Settings_and_database_tables

# Outcomes portfolio setting and database tables

## High level overview

* Create the 'Outcomes portfolio' option as institution setting so that it can be available for groups created in that institution
* Create database tables for outcome types and subjects to record necessary details such as short names and colour code classes where appropriate.

> The colours are defined via classes in the stylesheet in the code, not on the interface.

## Details

1. Create the 'Outcomes portfolio' option in the institution settings with rules as for portfolio completion and SmartEvidence, i.e. if somebody is in multiple institutions, they see it if at least one of their institutions has it turned on.
    * It can be used in conjunction with portfolio completion and SmartEvidence.
    * It has characteristics of the portfolio completion page (rather than SmartEvidence), i.e. it should be possible in the future to add further blocks to that special first page.
    * It will be the very first page if portfolio completion and / or SmartEvidence are selected as well.
    * Initially, it is only available on the group level (group owned collections), but be open to future plans to have it available on personal, institution, and site level as well
    * Add a new field 'outcomes' into the collection table
2. New database tables for 'Outcome category' (lang string 'Outcome category') and 'Outcome subject' (lang string 'Subject'). These are hard-coded / inserted into the DB for each institution. It is not possible (at this stage) to add or change them via the admin interface. The key value should be a number. The category is created to future proof the functionality for when different outcome portfolios are created that require different outcome types either within one institution or across different institutions.
    * 1 table for outcome categories (outcome_category): ID, outcome category title [up to 100 characters], institution ID; e.g. here the category would be 'Foundation' (in the future, this could be displayed in the admin interface, but currently is out of scope)
    * 1 table for outcome types (outcome_type): ID, outcome category ID as foreign key, title of the outcome type [up to 100 characters], abbreviation of the outcome type [up to 10 characters], outcome type background colour which refers to a class that is saved in here and defined in SCSS as a colour (background and border) in ``theme/raw/sass/components/_outcomes.scss`` where we will keep all the outcomes classes.
    * 1 table for subject categories: ID, subject category name [up to 100 characters], institution ID, e.g. here the category would be 'Subject' (in the future, this could be displayed in the admin interface, but currently is out of scope)
    * 1 table for subjects: ID, subject category ID as foreign key, title of the subject [up to 100 characters], abbreviation of the subject [up to 10 characters]

description: updated
summary: - Outcomes portfolio (1): Setting and database tables
+ Outcomes portfolio (1): Settings and database tables
description: updated
Changed in mahara:
assignee: nobody → Cecilia Vela Gurovic (ceciliavg)
status: Confirmed → In Progress
Revision history for this message
Mahara Bot (dev-mahara) wrote : A patch has been submitted for review
Revision history for this message
Mahara Bot (dev-mahara) wrote :
Revision history for this message
Mahara Bot (dev-mahara) wrote :
Revision history for this message
Mahara Bot (dev-mahara) wrote : A change has been merged

Reviewed: https://reviews.mahara.org/c/mahara/+/13309
Committed: https://git.mahara.org/mahara/mahara/commit/59621799eb5a8b2dc1c1d8247c7e0ad9ee0c8448
Submitter: "Robert Lyon <email address hidden>"
Branch: main

commit 59621799eb5a8b2dc1c1d8247c7e0ad9ee0c8448
Author: Cecilia Vela Gurovic <email address hidden>
Date: Thu Oct 27 15:30:36 2022 +1300

Bug 1991601: Outcomes portfolio (1): Settings and database tables

Change-Id: I3bc9dc62c7b0d8d132fd132a9aa960c9e1d2b148

Revision history for this message
Mahara Bot (dev-mahara) wrote :

Reviewed: https://reviews.mahara.org/c/mahara/+/13374
Committed: https://git.mahara.org/mahara/mahara/commit/5f1a555bb66d0cf57df460c606ca1f87c3c5a92a
Submitter: "Robert Lyon <email address hidden>"
Branch: main

commit 5f1a555bb66d0cf57df460c606ca1f87c3c5a92a
Author: Cecilia Vela Gurovic <email address hidden>
Date: Tue Nov 1 10:01:30 2022 +1300

Bug 1991601: Outcomes portfolio (1): Adding institution setting

Change-Id: I761b03fe3a48b05647413160bf4840a127c80ee1

Revision history for this message
Mahara Bot (dev-mahara) wrote :

Reviewed: https://reviews.mahara.org/c/mahara/+/13546
Committed: https://git.mahara.org/mahara/mahara/commit/7ec833179841ea16ce391fc46cd83a52ddee1362
Submitter: "Robert Lyon <email address hidden>"
Branch: main

commit 7ec833179841ea16ce391fc46cd83a52ddee1362
Author: Cecilia Vela Gurovic <email address hidden>
Date: Wed Dec 7 13:09:54 2022 +1300

Bug 1991601: Outcomes portfolio (1): Populate outcome tables script

format of the files: csv
one file for 'outcome subjects' and one file for 'outcome types'

usage:

- to clean data from tables
sudo -u www-data php htdocs/admin/cli/populate_outcome_tables.php -d
or
sudo -u www-data php htdocs/admin/cli/populate_outcome_tables.php --delete

- to add data to subject tables
sudo -u www-data php htdocs/admin/cli/populate_outcome_tables.php -s=/tmp/outcomes_subjects_tables.csv
or
sudo -u www-data php htdocs/admin/cli/populate_outcome_tables.php --subjectfile=/tmp/outcomes_subjects_tables.csv

- to add data to type tables
sudo -u www-data php htdocs/admin/cli/populate_outcome_tables.php -t=/tmp/outcomes_types_tables.csv
or
sudo -u www-data php htdocs/admin/cli/populate_outcome_tables.php --typefile=/tmp/outcomes_types_tables.csv

Change-Id: I5fff89f1e7b60078649cca58a90a6441723615c7

Robert Lyon (robertl-9)
Changed in mahara:
status: In Progress → Fix Committed
Revision history for this message
Mahara Bot (dev-mahara) wrote : A patch has been submitted for review
tags: added: newfeature
Revision history for this message
Mahara Bot (dev-mahara) wrote : A change has been merged

Reviewed: https://reviews.mahara.org/c/mahara/+/13661
Committed: https://git.mahara.org/mahara/mahara/commit/d69e39f9783a769bdabeb3cbdc42655ed778669a
Submitter: "Robert Lyon <email address hidden>"
Branch: main

commit d69e39f9783a769bdabeb3cbdc42655ed778669a
Author: Robert Lyon <email address hidden>
Date: Wed Jan 25 10:06:44 2023 +1300

Bug 1991601: Outcomes portfolio (1): Adjusting the population script

Change-Id: Iafebcdb86c159b0e3f9292d9abd779e5eca0c2a0
Signed-off-by: Robert Lyon <email address hidden>

Robert Lyon (robertl-9)
Changed in mahara:
status: Fix Committed → Fix Released
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Related blueprints

Remote bug watches

Bug watches keep track of this bug in other bug trackers.