Help Center

Menu

Delete components

This procedure outlines the steps and requirements for deleting components from the Component Service.

The same requirements apply to Components at Edge components. They are removed from the service and component sets in the same way as any other Component Service component. The runtime changes, but the deletion process does not.

Prerequisites

  • Only Owners, Admins, and Developers can delete components.

  • A component must be removed from all component sets before deletion is allowed.

  • If a component is used on a Content Page, the deletion will fail.

  • If a component is used on a Standard Page, the deletion will succeed but an error will be shown in the Administration UI and on rendered frontend pages.

  • It is essential to check if the component is referenced in any content before attempting to delete it. This includes pages in the Trash.

How to delete components

  1. Check component usage.

    Run a component report, available through DXP services, to identify whether the component is used on any Standard Page assets.

  2. Clear references.

    If the component is in use, clear those references before attempting deletion.

  3. Attempt deletion.

    Try to delete the component from the Component Service.

  4. Error handling.

    If the deletion fails, check the error message.

    If it indicates that the component is in use, clear references and try again.

Troubleshooting

The Component Service does not track the usage of components in Squiz CMS instances. Therefore, removing a component still in use will lead to an error.

The following HTML comment will be added to the output frontend HTML when a component is deleted:

<!-- component-name 1.2.3 not in set set-name -->