Help Center

Menu

DXP services

The DXP services page lets you view and use Squiz DXP functions that apply to Content Management instances.

Component Service

As a System Administrator, you can make component sets globally available to all sites on a Content Management instance.

First specify a Globally available Matrix API Identifier for your instance.

Then specify the Globally available component sets for all sites in your instance.

Prior to September 2024, Content Management instances may have had an API identifier or core component sets configured as part of system provisioning for your Squiz DXP organization.

As of September 2024, Content Management instances do not have an API identifier or Component Sets set when provisioned.

Globally available Matrix API Identifier

The Globally available Matrix API Identifier is used by Squiz Component Service to connect your Content Management instance to your Component Service instance. It provides the necessary read-only API authentication gateway for your Squiz DXP organization’s Component Service instance.

About site and global API identifiers

Each API identifier is provisioned through a token generated using the Content API.

The security approach for all Content API tokens is that the most restrictive token wins, not the most permissive token. The site asset configuration for the API Identifier will therefore always override the globally available API identifier. The reason for this behavior is that the scope of a Content API token applied at a Site level might be more restrictive than the global API identifier.

Create a key

As a Squiz DXP System Administrator, you can manage Matrix API Identifiers within the Squiz DXP Component Service capability tile.

To create an identifier you first need to generate an API token through the Content API. Create a token with the appropriate permission scope for your entire site before attempting this procedure.

To create a Matrix API Identifier key that applies globally to your Content Management instance:

  1. Load https://dxp.squiz.cloud/ and sign in using your provided Squiz DXP credentials.

  2. Click Component Service  Matrix API Identifiers.

  3. Click Add Matrix API Identifier.

  4. Complete the form fields:

    Identifier Name

    The descriptive identifier name to associate with the key, which you set in the identifier field in Content Management.

    API URL

    The root URL of your Content Management instance. The URL is https://[instance-name].matrix.squiz.cloud/ where [instance-name] is the friendly name of the Content Management instance.

    API KEY

    Paste in the API key you generated using the Content API.

  5. Click Create.

  6. On the Matrix API Identifier dashboard, copy the Identifier Name you just created.

  7. Back on the Content Management DXP services screen, click Edit.

  8. Paste the Identifier Name into the Globally available Matrix API Identifier field.

  9. Click Save.

Globally available component sets

Globally available component sets appear on all assets that offer a Content screen.

Every Squiz DXP Organization has starter component sets available for use. The starter sets provide access to all Squiz-supplied components. You can decide to add the starter sets, along with any custom component sets to your Content Management instance globally. The combination of starter and custom component sets you select lets all sites in your instance get access to the same core set of components.

You can make additional component sets available at the site asset level if you need to. However, you can not remove globally available sets from a site asset. Keep this in mind when you are deciding what global component sets to configure.

Component sets are managed through the Squiz Content Management tile in the Squiz DXP Admin Console.

Explore starter component sets

To explore Squiz Core Components and Squiz DXP Enabler sets available to your Content Management instance:

  1. Load https://dxp.squiz.cloud/ and sign in using your provided Squiz DXP credentials.

  2. Click Component Service  All components.

  3. Locate the Squiz Core Components and Squiz DXP Enablers component sets.

    Core components that are available for all Squiz DXP instances
    1 squiz-base-components

    Contains components commonly used by content authors to create website pages.

    2 squiz-dxp-core

    Contains components designed to connect other Squiz DXP services to your site and solve common website challenges such as embedding a form or managing cookie consent.

  4. Click the tile to explore the components contained in each set.

Make a starter component set available to all sites

To add a starter component set globally to your Content Management instance:

  1. Take note of your chosen starter component set names listed in Explore starter component sets.

    squiz base components

  2. Click system configuration System Configuration  DXP Services menu.

  3. Click Edit on the DXP services screen.

  4. Paste the squiz-base-components or squiz-dxp-core component set name you decided upon into the Globally available component sets field.

    globally available component sets
    Specify as many starter component sets as you need in this step.

  5. Use the arrows to adjust the order in which the component sets appear in the Content screens of standard page assets.

  6. Click Save.

The component sets are now available globally for content editors in your Content Management instance.

Use these steps to add other component sets from your DXP organization to the Content Management instance.

Reports

This option lets system administrators download a report containing all Squiz DXP components within the Squiz Content Management instance.

Components used on Content page assets are not included in this report.

Select the DXP component report Download button to download the component report to your computer.