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

Overview

A collection is an ordered set of assets. There are multiple scenarios related to modifications of collections.

1. The linked assets get modified

2. New assets are added to a collection

3. Existing assets are removed from the collection

4. Metadata of the collection is modified

A collection can also be trackable or non-trackable, and assets within them also may be trackable or non-trackable within the collection. Certificates may also be attached to trackable collections.

This page details the system behavior in these different scenarios.

Trackable Collections

Examples of trackable collections are Courses and Programs. In addition courses also typically have certificate attached to them. Following sections detail the functionality related to trackable collections.

Linking asset to a collection

When an asset is linked to a trackable collection, there should be an option to specify if the asset 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 trackable collection will have an attribute “Locked” 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 locked, the overall status of the collection progress is not shown to the users as the collection might be undergoing modifications.

This attribute can be updated by the creator 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-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 deleted.

Common Functionality

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

Modification of an asset linked to a collection

When an asset is published, system checks if any collection is pointing to this learning asset. 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”. The dialog should show the list of collections (names and ids in sourcing repo) to which the learning asset is linked to.

When an asset linked to a collection (trackable or non-trackable), is published, the new version of the asset should NOT automatically get linked to the collection.

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

When a collection is getting edited, in case there are newer versions available for some of the linked assets, the editor should indicate the same. There is an option to update to the latest version.

As described in the previous section, version update can only happen in case the asset is non-trackable in the collection.

Deleting an asset linked to a collection

If an asset is linked to one or more collections, the asset cannot be deleted. The user is given an appropriate message with the list of collections to which the asset is linked.