Deprecating metadata configurations in your catalog (CTK)
This topic provides a walk through for deprecating your metadata elements by transitioning them to a deprecated state within your catalog. This process involves using the pre-configured Deprecated MDP collection, optionally organizing subcollections for specific resource types, and transitioning resources to a deprecated state.
Why would I do this?
Directly deleting metadata elements can result in irreversible loss of valuable information and complicate future catalog configurations. To address this, we introduce a deprecation method that allows you to safely archive these resources. This ensures their data remains intact for potential future use and restoration.
STEP 1: Accessing the Deprecated MDP collection
Note
Perform this task in the Catalog Configuration organization.
Your catalog includes a built-in Deprecated MDP сollection designed to centralize all metadata elements you intend to deprecate. This collection serves as the primary repository for deprecated configurations, ensuring their organized management and future accessibility.
By default, you can assign all deprecated metadata elements to this collection. However, you can optionally create subcollections within it to better structure and manage specific types of metadata resources.
To locate the Deprecated MDP collection:
On the Organization profile page, go to the Collections tab.
Locate the Deprecated MDP collection in the list.
Use this collection as the central repository for your deprecated metadata configurations.
STEP 2: (Optional) Preparing the Deprecated MDP subcollections
Note
Perform this task in the Catalog Configuration organization.
To organize your deprecated metadata elements effectively, you need to create subcollections within the Deprecated MDP collection. Each subcollection will correspond to a specific type of metadata element, such as Fields, Sections, Resource types, etc.
To create a Deprecated Metadata Subcollection:
Go to the Deprecated MDP collection page.
Click New resource and select Subcollection. The Create a new resource page opens.
On the Create a new resource page, select Collection type and click Continue.
The Create a new Collection page opens.
In the Configure fields tab, provide an appropriate title for your subcollection, such as:
Deprecated - Metadata fields (for fields).
Deprecated - Sections (for sections).
Deprecated - Resource types (for resource types).
Click Continue. The creation page is closed and you are taken to your new subcollection page.
Repeat the process to create additional subcollections for each type of custom metadata resource you wish to manage. Adjust the titles as needed to reflect the type of metadata being deprecated.
As a result, the Deprecated MDP collection will serve as a centralized repository for managing deprecated elements, with each subcollection clearly segregating different types of metadata. This structure ensures easy access, better organization, and scalability as your needs evolve.
STEP 3: Deprecating your metadata resources
Note
Perform this task in the Catalog Configuration organization.
Safely remove metadata elements from their active roles without permanently deleting them. This step involves re-assigning these elements to the Deprecated collection, preserving their data for potential future use.
To deprecate your metadata resources:
On the Organization profile page, locate the metadata resource (Field, Section, Resource type, etc.) you want to deprecate.
On the metadata resource page, in the Overview tab, click Edit.
The Edit window opens.
In the Edit window, from the Collections dropdown, unselect the Metadata profile collection.
After disassociating the resource from the Metadata profile collection, you need to assign it to the relevant Deprecated collection.
From the Collections dropdown, select the relevant Deprecated collection.
Click Save changes.
Publish the changes
See: Publishing changes.
View the results
Following this process, the deprecated metadata elements are removed from their previous active roles and are now housed within the designated Deprecated collections. This allows for their preservation and the possibility of restoring them in the future if needed.
How do I restore the metadata resource assignation?
To restore the metadata resource assignation, reverse the deprecation process by removing it from the Deprecated collection, re-associating the resource with its original Metadata profile collection, and Publishing your changes.