This page details the functionality related to the modification of collection assets.

...

Linking asset to a collection

When an asset is linked The objective of this is to enable having “optional” assets in a trackable collection. System will not include the progress of an optional asset in the calculation of the overall progress of the trackable collection. Reference reading material within a course is an example for this.

To enable this capability, as part of linking asset to a trackable collection, there should be system provides an option (through UI and API) to specify if whether the asset “Is optional” - Yes or No. Default value is trackable as part of the collection or not.

An asset which is by itself trackable can be linked to a trackable or non-trackable collection.

When a trackable asset is linked to a trackable collection, then the asset automatically becomes trackable as part of that trackable collection.

Locking a trackable collection

A “No”.

Locking a trackable collection

The objective of this is to enable trackable collections to be modified/extended over a period of time, even after publishing them - without impacting the progress tracking. This is to support use cases where modules (sub-folders) within a course are periodically updated. Users can start consuming the modules as and when published. But the calculation of progress tracking happens only once the course is published with all the modules.

To enable the above, any trackable collection will have an attribute “Locked” “Calculate progress ” that can take values of “Yes” or “No”. By default it is set to “No”. This attribute is used to ensure the trackable collection is locked for modifications and the status of collection consumption can be tracked. Until the collection is lockedAs long as the value is “No”, the overall status of the collection progress is not shown to the users as the calculated, because the collection might be undergoing modifications. This attribute can be updated by the creator . Hence no certificates are generated.

Once the all the content is added to the collection, creator can change value from “No” to “Yes”.

Modification of collection

Once a trackable collection is published, the collection can be modified. Following has to be taken care when modifying a collection

1. Modifying the name, description of collection is allowed.

2. “Locked” attribute once set to “Yes” cannot be changed.

3. If the attribute “Locked” is “Yes” for a collection

   1. Adding a new asset to the collection is allowed only if the asset is NOT set as trackable in the collection

   2. Updating the version of a linked asset is NOT allowed in case the asset is set as trackable in the collection

   3. Updating the version of a linked asset is allowed in case the asset is not set as trackable

   4. Removing an asset from the collection is NOT allowed

4. If the attribute “Locked” is “No” for a collection

   1. Adding a new asset to the collection is allowed

   2. Updating the version of a linked asset is NOT allowed in case the asset is set as trackable in the collection, when linking to the collection.

   3. Updating the version of a linked asset is allowed in case the asset is not set as trackable

   4. Removing an asset from the collection is NOT allowed

Deleting a collection

A trackable collection once published cannot be deleted.

Adding certificate

Adding a certificate to a trackable collection doe not happen during the creation of the collection and hence not part of the sourcing flow. The option of specifying when to issue a certificate should be part of adding certificate and not part of creation flow.

Non-trackable Collections

Digital Textbooks, Playlists are typically non-trackable collections.

Linking asset to a collection

When an asset is linked to a non-trackable collection, there should NOT be any option to specify if the asset is trackable or not within the collection. However the asset itself can be trackable.

Modification of collection

Once a non-Appropriate warning is shown to the user when modifying this value. The same is shown to the reviewer when publishing the collection. Once the value is changed to “Yes” and the collection is published, system calculates the progress based on the rules set for progress calculation.

Once a trackable collection is published with “Calculate progress” value set to true, the collection can no longer be modified.

Modification of collection

Once a trackable collection is published, the collection can be modified only if the “Calculate Progress” value is set to “No”. If the “Calculate Progress” value is set to “Yes”, the collection can no longer be modified.

This has to be enabled both at the UI as well as in API.

Deleting a collection

Once a trackable collection is published, the collection can be modified. Following has to be taken care when modifying a collection

1. Modifying the metadata of collection is allowed

2. Adding a new asset to the collection is allowed

3. Removing an asset from the collection is allowed

4. Updating the version of a linked asset is allowed

Deleting a collection

A non-trackable collection can be deleteddeleted only if the “Calculate Progress” value is set to “No”. If the “Calculate Progress” value is set to “Yes”, the collection cannot be deleted.

This has to be enabled both at the UI as well as in API.

Common Functionality

This section details the common functionality across trackable and non-trackable collections.

Modification of an asset linked to a collection

Publish asset flow

1. When an asset is published, system checks if there is any collection

...

1. (draft or live), pointing to this

...

1. asset.

2. If so, while approval, it shows a dialog saying “This is currently linked to one or more collections. Please republish the collections to reflect the new version in the collection”.

   1. The dialog

...

1. 1. shows the list of collections (names

...

1. 1. , ids and status of each collection in sourcing repo) to which the learning asset is linked to.

...

1. The new version of the asset

...

1. is NOT automatically

...

1. linked to the collection.

...

1. For a collection to reflect the new version - the collection has to be modified, the newer version is explicitly updated and collection republished.

Edit collection flow

1. When a

...

1. user opens a collection in editor for modification, system checks if there are newer versions

...

1. present for

...

1. one or more of the linked assets

...

1. .

2. In case there are newer versions present, editor indicates the same using a popup when the collection is opened.

   1. The popup has linked assets name and option to update to latest

   2. User can select one or more assets (or Select All) and update to latest.

   3. The latest version of the selected assets are linked to the collection.

3. The assets with newer version are also indicated in the folder hierarchy (with a different color)

   1. Clicking on the asset node will preview the older version.

   2. There is an option to update the version to latest.

   3. If user selects the option to update the version to latest, the latest version is linked to the collection and the preview reflects the latest version.

4. In case there are newer versions present, editor indicates the same using a popup when the collection is submitted for review. There are options to “Cancel submit” and “Proceed to submit”. “Cancel submit” brings back the user to the editor. “Proceed to submit” will submit the collection for review.

Review collection flow

1. When a user opens a collection for review, system checks if there are newer versions present for one or more of the linked assets.

2. In case there are newer versions present, editor indicates the same using a popup when the collection is opened. The popup has linked assets name (for view only).

3. The above popup is also shown when user choses “Publish” option. There are options to “Cancel publish” and “Proceed to publish”. “Cancel publish” brings back the user to the review page. “Proceed to publish” will publish the collection.

Deleting an asset linked to a collection

...