Help Center

Menu

Managing component sets

Components must be added to a component set to be available for use on a Squiz Content Management site. This page explains how to create a component set, add components to it, edit component set details, and delete a set from the Component Service.

Create a component set

Component sets are created on the Squiz DXP instance.

To create a component set:

  1. Load the Squiz DXP URL — https://dxp.squiz.cloud — in a web browser.

  2. Login using the credentials for your DXP instance.

  3. Click the Component Service button in the DXP dashboard.

  4. Click the Component sets option in the navigation panel.

    component sets create new set
    Figure 1. The Component sets page in the Component service

  5. Click the Create new set button.

    The Create a new component set dialog loads.

    component sets create new set create a new component set dialog
    Figure 2. The Create a new component set dialog

  6. Enter appropriate details in the Create a new component set dialog.

    Name

    the name of the component set.

    For this tutorial component, replace the initials, AB, with your own initials.

    ID

    the component set’s unique identifier.

    The component set ID can only consist of alphanumeric characters and hyphens.

    Description

    One to two sentences describing the purpose and utility of the component set.

  7. Click the Create set button.

    The new component set is added to the list on the Component set page.

  8. Click the Component set name to load the set.

    component set components ab set
    Figure 3. The ‘Components (AB)’ component set page

    Note the newly-created component sets contain no components.

Add a component to a component set

To add a component to a component set:

  1. Load the Squiz DXP URL — https://dxp.squiz.cloud — in a web browser.

  2. Login using the credentials for your DXP instance.

  3. Click the Component Service button in the DXP dashboard.

  4. Click the Component sets option in the navigation panel.

    component sets create new set
    Figure 4. The Component sets page in the Component service

  5. Click the Add to set button.

    The initial Add to set dialog loads.

  6. Select the component to add from the presented component list.

    component set add to set
    Figure 5. The initial Add to set dialog.

    The top-right of the dialog allows for filtering the list of available components in the search field.

  7. Click the Add to set button.

    A second Add to set dialog loads.

    component set add to set dialog 2
    Figure 6. The second Add to set dialog.

  8. Configure the component.

    • Set Which versions can be rendered? to All versions.

    • Set Which versions can editors add to page? to Latest available.

    • Leave Exclude specific versions as is.

  9. Click the Add to set button.

    The component is added to the component set.

    component set add to set set added
    Figure 7. A Component set showing the just-added component as in the set.

Edit a component set

You can change the display name and description of a component set after it has been created.

To edit a component set:

  1. Load the Squiz DXP URL — https://dxp.squiz.cloud — in a web browser.

  2. Login using the credentials for your DXP instance.

  3. Click the Component Service button in the DXP dashboard.

  4. Click the Component sets option in the navigation panel.

  5. Click the component set name to open the set detail page.

  6. Click the more actions menu (⋯) in the set header, then select Edit.

    Screen capture of the component set detail page more actions menu (⋯)
    Figure 8. The more actions menu (⋯) on the component set detail page, with Edit highlighted.

The Edit set dialog loads.

  1. Update the Name and Description fields as required, then click Save.

    Screen capture of the Edit set dialog with Name and Description fields.
    Figure 9. The Edit set dialog with Name and Description fields.

A Changes saved confirmation appears when the update is successful.

The ID shown under the set title on the detail page is not editable. The component set ID is permanent and cannot be changed from the DXP Console.

Delete a component set

You can remove a component set you no longer need from the Component Service.

To delete a component set:

  1. Load the Squiz DXP URL — https://dxp.squiz.cloud — in a web browser.

  2. Login using the credentials for your DXP instance.

  3. Click the Component Service button in the DXP dashboard.

  4. Click the Component sets option in the navigation panel.

  5. Click the component set name to open the set detail page.

  6. Click the more actions menu (⋯) in the set header, then select Delete.

    Screen capture of the component set detail page more actions menu (⋯)
    Figure 10. The more actions menu (⋯) on the component set detail page, with Delete highlighted.

The Delete set dialog loads with the following message:

Deleting a set will mean all its components and layouts will no longer be available to be added to any sites using this set. Components and layouts already in use will remain as is. Are you sure you want to delete this set?

  1. To confirm, click Delete.

    Screen capture of the Delete set confirmation dialog.
    Figure 11. The Delete set confirmation dialog.

  2. To cancel, click Cancel or close the dialog.

What happens when you delete a set

When you delete a component set:

  • The set no longer appears in the Component sets list in the Component Service.

  • Components and layouts from that set that are already in use on Content Management pages continue to work.

  • Components and layouts from that set can no longer be added to sites through that set.

  • If you create a new component set using the same ID as a deleted set, the system may append an integer to the ID because the previous set still exists internally.

Deleting a set does not remove its components or layouts from pages that already use them. To stop using a component or layout on new pages, remove it from the relevant component sets first, or delete the component or layout separately.

Next Step: Connect the Component Service and the Squiz Content Management system.