Sanjay Kumar
Oct 8, 2022
  883
(6 votes)

Delete unused properties and content types in CMS 12

The purpose of this blog is to delete unused properties, content references, and content types programmatically and keep clean content.

Problem: I have created a block type (e.g. TeaserBlock) and using this block created multiple contents and used it in different places, but after some time the requirement was changed and I removed this block type completely from the code. So for cleanup, we need to remove this block type from the Admin --> Content Types area in CMS because it no longer exists. But when I tried to delete it, we got content reference warnings because we already created content using a specific block type and added those references at many places (e.g. Main Content Area of other pages).

Then the question comes to mind how to delete it? So I tried the following solution and fixed it.

Solution

We have two options two remove the missing content type and its references:

  1. Remove all references from each content type and then delete it from the Admin -> Content Types area. - This is a time-consuming activity because you need to visit and delete each content type (moving and emptying the Trash folder).
  2. Write the code and clean up it programmatically.

I am using the second (2) option to achieve this.

Where do you write the code? I will suggest in the Initialization Module or create a Schedule Job to delete the unused properties and content types. It’s totally up to you  :)

Delete the missing properties which are no longer exist in the code for Content Type (PageType/BlockType): (e.g. TeaserBlock -> Sub Title)

 private void DeleteUnUsedProperties()
 {
            var pageTypeRepository = ServiceLocator.Current.GetInstance<IContentTypeRepository<PageType>>();
            var propertyDefinitionRepository = ServiceLocator.Current.GetInstance<IPropertyDefinitionRepository>();
            foreach (var type in pageTypeRepository.List())
            {
                foreach (var property in type.PropertyDefinitions)
                {
                    if (property != null && !property.ExistsOnModel)
                    {
                        propertyDefinitionRepository.Delete(property);
                    }
                }

               this.DeleteContentType(type);
            }

            var blockTypeRepository = ServiceLocator.Current.GetInstance<IContentTypeRepository<BlockType>>();
            foreach (var type in blockTypeRepository.List())
            {
                foreach (var property in type.PropertyDefinitions)
                {
                    if (property != null && !property.ExistsOnModel)
                    {                     
                        propertyDefinitionRepository.Delete(property);
                    }
                }

                this.DeleteContentType(type);
            }
        }

Delete the content references and missing content type (e.g. TeaserBlock)

  private void DeleteContentType(ContentType contentType)
  {
            if (contentType.ModelType != null)
            {
                return;
            }

            if (contentType.Saved != null &&
                contentType.Created.HasValue &&
                contentType.Created.Value.Year > 2021 &&
                contentType.IsAvailable)
            {
                // Find and deletes the content based on type.
                var contentModelUsage = ServiceLocator.Current.GetInstance<IContentModelUsage>();
                var contentUsages = contentModelUsage.ListContentOfContentType(contentType);
                var contentReferences = contentUsages
                    .Select(x => x.ContentLink.ToReferenceWithoutVersion())
                    .Distinct();

                var contentRepository = ServiceLocator.Current.GetInstance<IContentRepository>();
                foreach (var contentItem in contentReferences)
                {
                    contentRepository.Delete(contentItem, true, EPiServer.Security.AccessLevel.NoAccess);
                }

                // Delete type of content.
                var contentTypeRepository = ServiceLocator.Current.GetInstance<IContentTypeRepository>();
                if (contentType.ID > 4)
                {
                    contentTypeRepository.Delete(contentType.ID);
                }
            }
  }

Note: CotentType.ID > 4 means this will exclude the system/predefined page types e.g. Root Page.

Please leave your feedback in the comment box.

Thanks for your visit!

Oct 08, 2022

Comments

Mark Stott
Mark Stott Oct 9, 2022 10:03 PM

The agency I'm with has recently performed a major rebrand for an existing Optimizely client and we ended up doing something very similar using the MigrationStep functionality.  In the case of content types we were removing, we used their original GUIDs that were defined within source code to then retrieve their type from the IContentTypeRepository, but otherwise performed the same actions.

Great article, it's a shame the UI doesn't let you clean up in use content types easier.

Praful Jangid
Praful Jangid Oct 11, 2022 10:09 AM

Nice work, keep doing the great work.

Jonas Boman
Jonas Boman Oct 14, 2022 07:17 AM

Great article Sanjay! Thanks for taking the time for writing it up!

Siddharth Gupta
Siddharth Gupta Oct 17, 2022 01:51 PM

Nice artilce Sanjay, something very handy for sure!

Please login to comment.
Latest blogs
How to use CacheTagHelper with content areas in Optimizely CMS 12

I might be going out on a limb here - if you have a better solution, feel very free to share it!  Upgrading your Optimizely web application from .N...

Andreas J | Dec 2, 2022

The 1001st Piece in your 1000 Piece Puzzle: .NET Default Interface Functions

I was recently working with a client who wanted a reasonably large subsystem added to Optimizely that would add automated management to their...

Greg J | Nov 28, 2022 | Syndicated blog

Video Demonstration, creating a CMS12 Alloy Sample Site

Hey All Below you will find a quick video demonstration on how to install a local version of Alloy Sample based on CMS12 / .Net 6. As you will see ...

Minesh Shah (Netcel) | Nov 28, 2022

How to create an admin user I Optimizely CMS – with Episerver CLI

In this blog post I’ll show how to create an admin user for Optimizely CMS in a new environment where you don’t have access to the admin interface.

Ove Lartelius | Nov 28, 2022 | Syndicated blog