Task Group Activity Sort Order
- Documentation
- Nadine Burroughs
This page covers the ways in which Activity Instances are sorted within a Task Group on a Learning Plan Instance.
1. Overview
Activity Sort Order is an Activity Setting on the Task Group edit modal that determines the order in which activities are added and displayed on the Task Group within a Learning Plan Instance. There are five Activity Sort Order options to select from:
Pre-added first, then in according to Activity Display Order [Jump to Topic]
Pre-added first, then according to Activity End Date [Jump to Topic]
Pre-added first, then according to Activity Type [Jump to Topic]
Pre-added first, then in order added to the Learning Plan [Jump to Topic]
Custom (by Task Instance Sort Order) [Jump to Topic]
2. Configuration
Task Groups are created on Learning Plan Definitions. To edit the Activity Sort Order of a Task Group, the Admin would need to click on the “Edit Group” button of the Task Group. The Activity Sort Order is configurable within a dropdown selection under the Activity Settings area of the Edit Group modal.
3. Activity Sort Order Options
I. Pre-added first, then according to Activity Display Order
Display Order is a numeric-type Intrinsic Attribute on the Activity Definition. By default, all activity definitions have a Display Order of 0. By exposing the Display Order as an editable field on the Create Activity Workflow, users can edit the Display Order to be any integer value.
When the Activity Sort Order is set to “Pre-added first, then according to Activity Display Order”, Activity Instances within that group are sorted from lowest to highest based on their Display Order. If no Display Order is set, then the order defaults to “Pre-added first, then in order added to the Learning Plan.”
II. Pre-added first, then according to Activity End Date
Sorting by Activity End Date is not compatible with the v1 (Legacy) Learning Plan Display Mode. The Learning Plan Definition must be set to the v2 (“Next Generation”) Learning Plan Display Mode in order to utilize the Activity End Date Sort Order setting.
Activity End Date is a date-type Intrinsic Attribute on the Activity Instance that references the “End Date” date-type Intrinsic Attribute on the Activity Definition. By default, the Activity End Date is empty.
When the Activity Sort Order is set to “Pre-added first, then according to Activity End Date”, Activity Instances within that group are sorted from oldest to newest based on their Activity End Date. If no Activity End Date is set, then those Activity Instances are sorted to the bottom and are sorted based on the order added to the Learning Plan.
III. Pre-added first, then according to Activity Type
The Activity Type specifies the Create Activity Workflow Definition and Complete Activity Workflow Definition that govern the creation and use of Activity data. Each Activity Type requires a Title, and all Activity Types are sorted alphabetically by default on the Activity Type List Page.
When the Activity Sort Order is set to “Pre-added first, then according to Activity Type”, Activity Instances within that group are sorted alphabetically based on the Activity Type Title. The sort order mirrors the default sort order on the Activity Type List Page.
IV. Pre-added first, then in order added to the Learning Plan
This is the default sort order for all Task Groups on a Learning Plan Definition. When the Activity Sort Order is set to “Pre-added first, then in order added to the Learning Plan”, Activity Instances within that group are sorted first by the pre-added activity (or activities) as they are listed on the Task Group Definition of the Learning Plan, then by the order in which they are added to the Learning Plan with each new activity added to the bottom of the Task Group.
V. Custom (by Task Instance Sort Order)
This selection is reserved for Admin who need a specific Activity Sort Order to cover their use case. A customization would need to be created in the backend to support this sort order option.
If this option is selected without a customization implemented, then the sort order will default to “Pre-added first, then in order added to the Learning Plan” with one caveat. When this option is selected, any subsequent changes to the order of pre-added activities on a Task Group Definition will not be reflected on already existing Learning Plan Instances' Task Groups.