.. _Migrating Legacy Libraries:

Migrate Legacy Libraries to the New Library Environment
#######################################################

.. tags:: educator, how-to

In Verawood, Legacy libraries will no longer be supported. They are being
replaced with the :ref:`new, fully-featured Library experience <Ulmo Libraries>`
introduced in Sumac. The new feature allows you to create any type of content in
a library - including content blocks, units, subsections and sections. All
content can be reused across courses. To take full advantage of the new
features, and to continue using the content in your Legacy Libraries, migrate
your Legacy Libraries.

.. contents::
   :local:
   :depth: 1

.. _Migrate Legacy Libraries:

Migrate Legacy Libraries
************************

#. Click on the Legacy Libraries tab on Studio Home. You will see a button to
   :guilabel:`Review Legacy Libraries`.

   ..  image:: /_images/educator_how_tos/migrate_legacy_library_review.png
       :alt: The "Review Legacy Libraries" button appears in a warning panel above the list of Legacy Libraries.

#. Select which Library you wish to migrate. Click the checkbox next to the
   Library title to select a Library. You may choose one Library at a time, or
   multiple Libraries at once.

   .. note::

      You can use the search bar to find libraries by keyword, or the filter to scope your view to unmigrated libraries.
   
   Click :guilabel:`Next`.

   ..  image:: /_images/educator_how_tos/migrate_legacy_library_select.png
      :alt: The Migrate Legacy Libraries screen, including a search box, filter for migration status, and a list of Legacy Libraries.

#. *IF* you wish to migrate your Legacy Library to a brand new Library, click :guilabel:`+ Create New Library`.

   ..  image:: /_images/educator_how_tos/migrate_legacy_new_library.png
      :alt: The "Select Destination" screen, with the "Create New Library" button highlighted.
   
   Provide the new Library a name, organization and ID and click :guilabel:`Create`, then click :guilabel:`Next`.

   ..  image:: /_images/educator_how_tos/migrate_legacy_library_new_details.png
       :alt: The "Create New Library" screen, with name, organization, and ID fields visible.

#. *IF* you wish to migrate your Legacy Library to an existing Library, click
   the radio button next to the title of the Library you wish to select and
   click :guilabel:`Next`.

#. Review the migration details and click :guilabel:`Confirm`.

   ..  image:: /_images/educator_how_tos/migrate_legacy_library_confirm.png
       :alt: The Confirm screen, indicating which library/libraries have been selected and their destination.

#. You will be redirected away from the Legacy Library environment to the new
   Library environment. Your Legacy content will now be populated in the new
   Library.


.. _Navigate Migrated Library:

Navigate your new Library
*************************

#. All of the content from your Legacy Library is viewable from the “All
   Content” tab. If you migrated more than one Legacy Library, all of the
   content from each Legacy Library can be viewed in aggregate.

   ..  image:: /_images/educator_how_tos/migrate_legacy_library_navigation.png
       :alt: The landing page for the newly-created Library, with each migrated Legacy Library showing as a distinct collection.

#. Each Legacy Library can also be viewed as a separate collection within the
   new Library. Click on the Collections tab to view each of your Legacy
   Libraries.

   .. admonition:: Publish Migrated Content

      All migrated content is created in the "Draft" state in the new Library. It must be :ref:`published <Publish Library content>` in order to be reused in courses. 

   ..  image:: /_images/educator_how_tos/migrate_legacy_library_collections.png
       :alt: The "Collections" tab of the newly created Library, with each migrated Legacy Library showing as a distinct collection.

.. _Confirm Legacy Migration:

Confirm Legacy migrations are complete
**************************************

#. Navigate to the Legacy Libraries tab on Studio Home. Each migrated Library will contain a redirect link.

   ..  image:: /_images/educator_how_tos/migrate_legacy_library_complete.png
       :alt: The Legacy Libraries homescreen. Each migrated Legacy Library contains an indicator on its card that it's been migrated.

.. _Update Legacy References:

Update course content referenced in Legacy Libraries
****************************************************

#. Navigate to the unit page of the course that references Legacy Library
   content. You will see a notification that the Library is no longer supported
   and needs to be updated in order to sync any future content changes. Click
   “update reference”.
   
   .. note::

      Content in the Library must be :ref:`published <Publish Library content>` before any references can be synced.

   ..  image:: /_images/educator_how_tos/migrate_legacy_library_sync_content.png
       :alt: The Studio Unit page of a piece of content that uses content from a Legacy Library. There is a link to "Update reference" from the Legacy Library to the New Library.

#. You will now see the content referenced in the course. Any future changes
   made to the referenced content can now be synced to the course using the :ref:`Sync Content workflows <Sync a Library update to your course>`.

   ..  image:: /_images/educator_how_tos/migrate_legacy_library_sync_content_complete.png
       :alt: The unit page after the reference has been updated. At this point, there is no indication that the content used to link to a Legacy Library.


.. seealso::

    :ref:`Publish Library content`

    :ref:`Create a New Library`

    :ref:`Create and edit content in a Library`

    :ref:`Create and edit units in a Library`

    :ref:`Search for content in a Library`

    :ref:`Use content sidebars to manage content`

    :ref:`Add Library content to a course`

    :ref:`Sync a Library update to your course`

    :ref:`Add users to Libraries`


**Maintenance chart**

+--------------+-------------------------------+----------------+---------------------------------------------------+
| Review Date  | Working Group Reviewer        |   Release      |Test situation                                     |
+--------------+-------------------------------+----------------+---------------------------------------------------+
|2025-12-05    | Product WG                    | Ulmo           |  Pass                                             |
+--------------+-------------------------------+----------------+---------------------------------------------------+