View source for Proposals/Outcomes portfolio/Outcomes infrastructure in a group collection

<h2 id="-outcomes-infrastructure-in-the-group-collection">&#39;Outcomes&#39; infrastructure in the group collection</h2>
<p>[https://bugs.launchpad.net/mahara/+bug/1991603 Wishlist item]</p>
<h3 id="high-level-overview">High level overview</h3>
<ul>
<li>Create the &#39;Manage outcomes&#39; page infrastructure (&#39;Manage outcomes – group admin only&#39; mock-up) </li>
<li>Create the outcomes overview page and infrastructure</li>
<li>Allow for the direct editing of fields</li>
<li>Allow for the clicking of icons to complete outcomes and activities</li>
<li>Create new pages (activities) from this page and set them up</li>
<li>Pull in activity information from the individual pages</li>
<li>Respect permissions for the different types of group members and who can edit or only see what</li>
</ul>
<h3 id="details">Details</h3>
<h4 id="mock-up-reference-set-up-the-outcomes-collection-group-admin-only-">Mock-up reference: &#39;Set up the outcomes collection - group admin only&#39;</h4>
<p><strong>Who?</strong> As a group admin...</p>
<p><strong>What?</strong> I want to be able to set up an outcomes collection...</p>
<p><strong>Why?</strong> So that group tutors or I can add activities and prepare everything for the group member to get started.</p>
<p>The collection is set up in a group for a particular group member by a group admin. The numbered list refers to the bullets in the mock-up &#39;Set up the outcomes collection - group admin only&#39;.</p>
[[File:Set up the outcomes collection - group admin only updated.png|alt=|left|frame]]
<ol>
<li>[no change] Collection name: Title of the outcomes portfolio. You can choose that freely, but might want to establish a convention to differentiate between the different plans that a group member may have.</li>
<li>Per default, the option &#39;Outcomes portfolio&#39; is set to &#39;Yes&#39;. This is done automatically when the institution selected to work with outcomes portfolios (see section &#39;Outcomes portfolio setting and database tables&#39;).</li>
<li>You can select the outcomes category from which all outcomes within the collection shall take their outcome type. If there is only one category, the category is displayed without the drop-down menu.</li>
<li>Clicking the 'Continue' button takes you to a new page where you can manage the outcomes.
</li>
</ol>
<p>Additional changes (not pictured):</p>
<ol>
<li>Option &#39;Manage outcomes&#39; is accessible from the collection settings screen and also on the &#39;Portfolios&#39; overview page when clicking the &#39;More options&#39; icon on a collection for group admins only.</li>
<li>Option &#39;Manage pages&#39; is not available from the collection settings screen or via the &#39;More options&#39; icon on a collection on the &#39;Portfolios&#39; overview page to avoid pages from being added to or removed from the collection outside of the outcomes framework. It can also not be reached by URL.</li>
</ol>
<blockquote>
<p>Out of scope: Be able to add regular portfolio pages to the collection and not only activity pages.</p>
</blockquote>
<h4 id="mock-up-reference-manage-outcomes-group-admin-only-">Mock-up reference: &#39;Manage outcomes - group admin only&#39;</h4>
<p><strong>Who?</strong> As a group admin...</p>
<p><strong>What?</strong> I want to enter the outcomes for a group member&#39;s outcomes portfolio...</p>
<p><strong>Why?</strong> To prepare the collaboration space for group tutors and group members.</p>
<ul>
<li>The Mahara collection creation process will be used.</li>
<li>Outcomes are set up and modified, but interactions primarily performed by group tutors are done in &#39;Display&#39; mode.</li>
<li>In phase 1, we don&#39;t anticipate being able to move outcomes around but would expect that they are set up in order.</li>
<li>Outcomes can be deleted.</li>
</ul>
<p>The numbered list refers to the bullets in the mock-up &#39;Manage outcomes - group admin only&#39;. Group tutors and group members do not have access to this page.</p>

[[File:Manage outcomes - group admin only.png|frame|left]]
<blockquote>
<p>Notes: </p>
<ul>
<li>One outcome field set is set up per default as that is the minimum that is required.</li>
<li>collection_outcome table: ID, collection ID, short title, full title, outcome type ID, support (boolean), progress (text), completed (boolean), section that shows the ID from the &#39;collection_view&#39; table of the &#39;section&#39; there. This &#39;section&#39; is needed in here in case we delete an outcome or in future want to re-order outcomes.</li>
<li>Collection_view table: create new column &#39;section&#39; that in this case states the outcome ID to which the page belongs (section ID is the ID of the ID from the collection_outcome table.</li>
<li>Each outcome is its own Pieform and has its own &#39;Save&#39; button that is not displayed though.</li>
</ul>
</blockquote>
<ol>
<li>Outcomes are auto numbered to distinguish them. When an outcome is deleted, the number is automatically updated (on page load).</li>
<li>Short title: Short title for the outcome as that becomes the page title. Suggested: 70 character limit. This field is mandatory.</li>
<li>Full title: The full name of the outcome text. Suggested: 255 character limit.</li>
<li><p>Outcome type: Select list with the abbreviation of the outcome and the colour along with the full title of the type (see section &#39;Outcomes portfolio setting and database tables&#39;). This can be done with a <span> in the select option.</p>
<blockquote>
<p>If no outcome type is selected, don&#39;t display the field on the outcomes overview page.</p>
</blockquote>
</li>
<li><p>Link to &#39;Add an outcome&#39; (not a button).</p>
</li>
<li><p>Click the &#39;Delete&#39; button to delete the outcome.</p>
<ul>
<li>The &#39;Delete&#39; button tooltip or aria text takes the short title of the outcome to know which outcome is to be deleted, e.g. Delete outcome &#39;Short title of the outcome&#39;.</li>
<li>There is a confirmation modal as safeguard on deletion.</li>
<li>When an outcome has activities associatedd with it, the outcome can&#39;t be deleted because the target pages would need to be deleted first. This is stated in the modal that comes up when attempting to delete an outcome.</li>
<li>When an outcome is deleted, AJAX comes into play that updates the number for &#39;Outcome 1&#39;, &#39;Outcome 2&#39; etc but that number is actually not saved to the database as it&#39;s not important.</li>
<li>We need to make sure that we can&#39;t delete the first outcome  because there must be at least one outcome in the collection or it&#39;s not possible to add pages.</li>
</ul>
</li>
<li><p>Click the &#39;Save&#39; button to be taken to the display page of the outcomes overview page. clicking that button submits all Pieforms at once and takes you to the display page of the outcomes overview page. If you have unsaved changes, a modal comes up telling you that.</p>
</li>
</ol>
<h4 id="mock-up-reference-outcomes-overview-page-in-progress-group-tutors-and-group-admin-">Mock-up reference: &#39;Outcomes overview page in progress – group tutors and group admin&#39;</h4>
<p><strong>Who?</strong> As a group tutor or group admin...</p>
<p><strong>What?</strong> I want to see all outcomes and activities in one place...</p>
<p><strong>Why?</strong> So that I have a quick overview of all the outcomes and activities for this group member to quickly note at which outcome we left off and which activity is next up.</p>
<blockquote>
<p>Note: It&#39;s a pseudo page like portfolio completion.</p>
</blockquote>
<p>The numbered list refers to the bullets in the mock-up &#39;Outcomes overview page in progress – group tutors and group admin&#39;.</p>
[[File:Outcomes overview page in progress - group tutors and group admins.png|frame|left]]
<ol>
<li>[no change] Title of the outcomes portfolio that was added when the outcomes collection was created. It can be changed at any time.</li>
<li>Title of this page: Ideally, this is fixed for everybody like we do for SmartEvidence and portfolio completion. → Outcomes</li>
<li>&#39;Configure&#39; button: Allows you to add and update outcomes on the collection settings screen for outcomes (see mock-up &#39;Manage outcomes - group admin only&#39;). Only group admins see that. Group tutors and group members don&#39;t.</li>
<li>Overall completion of outcomes: Progress bar across all currently available outcomes (similar to the progress bar on the portfolio completion page, just not for individual pages but for the outcomes).</li>
<li>Each outcome is collapsed so that only the short title of the outcome is displayed that concisely states what it is about. Our normal collapsable panel rules apply in terms of styling.</li>
<li><p>Group admins and group tutors can click an icon to mark the outcome as completed. A tooltip states that it&#39;s been completed along with the short title of the outcome. This icon with its hover state is the same as for the &#39;Sign-off&#39; block for consistency.</p>
<blockquote>
<p>There are only two states: Incomplete and completed. The icon is ticked manually as it is not guaranteed that all activities will already have been added. There is a confirmation modal to confirm the ticking. It can be set to &#39;Incomplete&#39; again though by the group tutor or group admin if more activities need to be added.
No need to display who set the outcome to completed, but log the who and when in the database.</p>
</blockquote>
<ul>
<li>Tooltip for incompleted: Click to mark outcome &#39;Short title of the outcome&#39; as completed.</li>
<li>Tooltip for completed: Outcome &#39;Short title of the outcome&#39; has been completed. Click to reset.</li>
<li>Confirmation modal to confirm the ticking. It can be set to &#39;Incomplete&#39; again though if more targets need to be added, again with a confirmation modal.</li>
<li>No need to display who set the outcome to completed, but log the who and when in the database.</li>
<li>Add a span around the icon so that it can be targeted and doesn&#39;t uncollapse it. It needs an ID as well so that we can map it to the outcome.</li>
</ul>
</li>
<li><p>Click the outcome to expand the panel and see the details for that outcome. </p>
</li>
<li><p>A circle icon displays that the outcome is not yet completed. That is the same as in the &#39;Sign-off&#39; block. A tooltip will also state that and includes the short title of the outcome. To mark the outcome as completed, click the icon and a modal is displayed to confirm this. The tickbox icon can be clicked to reset the completion if anything needs to be added. Only the latest change to &#39;Yes&#39; will be recorded in the database.</p>
<blockquote>
<p>A group member sees a bar icon because they are not able to perform an action. See mock-up &#39;Outcomes overview page in progress – group member&#39;</p>
</blockquote>
</li>
<li><p>The full outcome text from the &#39;Full title&#39; of the outcome when it was set up. </p>
</li>
<li><p>The outcome type is displayed with its short code and the background colour that is defined in the stylesheet. A help icon states all available outcome types in their long form.</p>
<blockquote>
<p>If no outcome type was selected, don&#39;t display the field.</p>
</blockquote>
</li>
<li><p>Activities: Table that shows all the activities, i.e. the separate pages. These are Mahara portfolio pages for which a new type is created (see section &#39;Activity page infrastructure&#39;).</p>
<blockquote>
<p>Activity titles are added automatically when a new activity is added to this outcome as page and the viewer returns to this overview page.
If someone places an activity page before the last page of a different outcome, it doesn&#39;t result in it being associated with that outcome. It will still be linked to the outcome in which it was created.</p>
</blockquote>
</li>
<li><p>The link to the activity takes you to the page of the activity for easy access (similar to portfolio completion page). </p>
<ul>
<li>While the activity has not yet been completed, everyone goes into &#39;Edit&#39; mode of the page. This is to ensure that group members, group tutors, and group admins don&#39;t have an extra click to update checkpoints.</li>
<li>Once the activity has been completed, everyone goes to the &#39;Display&#39; mode of the page.</li>
</ul>
<blockquote>
<p>Out of scope: If someone changes the order of the outcomes, it also changes the order in which they are displayed on this page.</p>
</blockquote>
</li>
<li><p>&#39;Sign-off&#39;, i.e. status of the activity: That is pulled through from the activity page and can be updated directly here (like on &#39;Portfolio completion&#39; for sign-off as it is the sign-off functionality). No additional info is provided here, i.e. who and when they signed off. That is accessible on the activity page. A tooltip mentions though the state of the activity.</p>
</li>
<li><p>&#39;Add activity&#39;: </p>
<ul>
<li>Clicking the button sets up a new page in this collection where you can fill in all the activity information.</li>
<li>Need to ensure that the link can&#39;t be manipulated so that you can&#39;t create the page in somebody else&#39;s collection.</li>
<li>On returning to the outcomes overview page, you will see the new activity added.</li>
</ul>
</li>
<li><p>Support taking place: This is a Yes/No switch whose status is saved immediately. No tracking of previous status changes would take place. Once the outcome is marked as &#39;Completed&#39;, the status can&#39;t be changed any more and only the word &#39;Yes&#39; (or &#39;No&#39;) is displayed instead of the switch.</p>
<blockquote>
<p>No need to display who changed the status, but log the who and when in the database.</p>
</blockquote>
</li>
<li><p>Progress: </p>
<ul>
<li>It&#39;s a plain text field with 3 rows shown, but could be expanded.</li>
<li>Text is saved when the &#39;Save&#39; button is pressed.</li>
<li>We&#39;ll need to ensure that they can&#39;t navigate away before the text has been saved, i.e. a browser modal is to be displayed when there are unsaved changes.</li>
<li>Once the outcome is marked as &#39;Completed&#39;, the text can&#39;t be changed any more. Display who made the last change and when once the outcome has been completed. </li>
</ul>
</li>
</ol>
<p>All pages are added in order in which they are set up via the outcomes overview page into the collection. Once the pages are in, there is no distinction or separation between them to which outcome they belong. The link is made through the text on the activity page itself. The main navigation to the pages is anticipated to be via the outcomes overview page.</p>
<blockquote>
<p>The collection navigation at the top of the collection displays the pages in order as they appear on this overview page if all outcomes were uncollapsed, no matter their outcome. Out of scope: Adding the outcome as heading into the drop-down menu.</p>
</blockquote>
<h4 id="mock-up-reference-outcomes-overview-page-completed-group-tutor-and-group-admin-">Mock-up reference: &#39;Outcomes overview page completed – group tutor and group admin&#39;</h4>
<p><strong>Who?</strong> As group tutor and group admin...</p>
<p><strong>What?</strong> I want to track outcomes and activitys on one page...</p>
<p><strong>Why?</strong> So I can see a quick overview to know what to work on with the group member.</p>
<p>The numbered list refers to the bullets in the mock-up &#39;Outcomes overview page completed – group tutor and group admin&#39;.</p>
[[File:Outcomes overview page completed - group tutor and group admin.png|frame|left]]
<ol>
<li>Only group admins see the &#39;Configure&#39; button, but group tutors and group admins can mark outcomes as completed.</li>
<li>Support taking place: No switch as the info has been locked in once the outcome was set to &#39;Completed&#39;.</li>
<li>Progress: No editable text as the info has been locked in once the outcome was set to &#39;Completed&#39;.. The name and time of the person who last edited the field is displayed.</li>
</ol>
<blockquote>
<p>The button &#39;+ Add activity&#39; is not available any more.</p>
<p>If the outcome is reset to &#39;Not completed&#39;, then &#39;Support taking place&#39; and &#39;Progress&#39; are unlocked and additional activity pages can be added.</p>
</blockquote>
<h4 id="mock-up-reference-outcomes-overview-page-in-progress-group-member-">Mock-up reference: &#39;Outcomes overview page in progress – group member&#39;</h4>
<p><strong>Who?</strong> As a group member...</p>
<p><strong>What?</strong> I want to see the outcomes overview page...</p>
<p><strong>Why?</strong> So I know what I will be working on.</p>
<p>The numbered list refers to the bullets in the mock-up &#39;Outcomes overview page in progress – group member&#39;.</p>
[[File:Outcomes overview page in progress - group member.png|frame|left]]
<ol>
<li>Group member cannot see the configuration button nor will they be able to give access to the collection.</li>
<li>Since they cannot mark an outcome (or activity) as completed, the line icon represents that there is generally something that could be done, but they are not allowed to. This is accompanied by a tooltip, similarly to the &#39;Sign-off&#39; functionality.</li>
<li>Support taking place: Group member only see the information displayed, but doesn&#39;t have a switch available.</li>
<li>Progress: The text is displayed without the potential to edit it. The name of the group tutor or group admin who wrote the text is displayed along with the time when they edited it.</li>
</ol>
<h4 id="mock-up-reference-outcomes-overview-page-completed-group-member-">Mock-up reference: &#39;Outcomes overview page completed - group member&#39;</h4>
<p><strong>Who?</strong> As a group member...</p>
<p><strong>What?</strong> I want to see my progress across all outcomes...</p>
<p><strong>Why?</strong> So that I can be proud of my work and having finished my outcome.</p>
<p>The text refers to &#39;Outcomes overview page completed – group member&#39;.</p>
<p>The only big difference to what group tutors and group admins see is that the group member can&#39;t mark an outcome as completed.</p>
[[File:Outcomes overview page completed - group member.png|frame|left]]