Help Center

Menu

Asset Bank

Squiz has built an integration with Asset Bank using existing Squiz DXP features.

This integration enables users to use imagery managed in external digital asset managers within their page content.

Users can configure the integration to use Asset Bank with their DXP components.

The integration works with squizimage and squizlink Component input fields, as well as Component WYSIWYG Link and Image.

Anywhere an image or link is used in a formatted text or as an image or link is included in a component, you can select an image from Asset Bank as a source.

Create the Asset Bank authorization application

You need to create an authorization application in Asset Bank and obtain the necessary credentials to pass through to the DAM integration configuration in Squiz DXP.

The application provides the necessary authentication information for these integration points:

Create the Asset Bank authorization application

Read the Asset Bank API Documentation for the latest vendor configuration documentation.

  1. Navigate to the Admin  System  API area and click Add new OAuth2 credentials.

  2. Fill in the form:

    Name

    Squiz Content Management Integration

    Description

    Squiz API credentials for integrating with Squiz Content Management.

    Client ID

    Click Generate to generate the client ID automatically.

    Secret

    Click Generate to generate the secret automatically.

    Redirect URIs

    Copy the URI from Step 15: Authorization Redirect URI and replace MATRIX with the actual CMS domain.

  3. Copy the values for Client ID and Secret to a temporary location so you can add them into the Squiz DXP configuration settings.

  4. Save the form.

Set the URL signing secret

Make sure URL signing is enabled or the integration may not work as expected.

For AssetBank to return a valid URL for a file, you also need to configure the secret key for URL signing.

  1. Navigate to the Admin  System  API page.

  2. Click Manage your API settings.

  3. Set the Secret key for URL Signing.

Squiz DXP Configuration

To present Asset Bank as a Digital Asset Management (DAM) option, Asset Bank must be integrated through the DXP configuration settings page.

This procedure assumes you have the Admin, Developer, or Owner role required to undertake this task.

All steps and fields in this procedure are required except where noted.

  1. Navigate to Configuration  DAM integrations

    configuration dam integrations
    Figure 1. Configuration page with DAM integrations highlighted.

  2. Click the add_circle_outline Add DAM button.

    configuration dam integrations add dam
    Figure 2. DAM integrations page with ⊕ Add DAM button highlighted.

    The ⊕ Add DAM dialog appears.

    configuration dam integrations add dam modal
    Figure 3. ⊕ Add DAM dialog.

  3. Provide a Friendly name for the integration.

    Choose a name that is descriptive and memorable. Generic names are challenging to manage in greater numbers.

  4. Select Asset Bank from the Integration type drop-down and then click Add.

  5. On the Details section confirm the Friendly name.

    This field automatically takes the value provided previously in the ⊕ Add DAM dialog.

    integration name details box
    Figure 4. Add DAM details.

  6. Select Asset Bank from the drop-down list in the Integration type field.

Configure the render settings

  1. Provide the sign-in details for your Asset Bank instance based on the configuration made in Create the Asset Bank authorization application:

    integration name render settings
    Figure 5. Render settings dialog.
    Auth URL

    This URL is used to redirect the user to the authorization application endpoint in the front-end authorization flow.

    The format is as follows: https://ASSETBANK_URL/oauth/authorize.

    Replace ASSETBANK_URL with the root domain from step 9.

    Client ID

    This is the Client ID for the front-end application authorization flow.

    Client Secret

    This is the secret for the front-end application authorization flow.

Configuration settings

integration name configuration settngs

  1. Supply the root domain for your Asset Bank instance in the DAM domain field.

  2. Add (or confirm) the Scopes available to the integration.

  3. Provide the Access token URL.

    This is the URL to the token endpoint to retrieve an access token which can be used to authorize API requests in machine to machine flow.

    The format is as follows: https://ASSETBANK_URL/oauth/token.

    Replace ASSETBANK_URL with the root domain from step 9.

  4. Copy the Client ID you saved in Create the Asset Bank authorization application and paste the value into the Render settings  Client ID field.

  5. Copy the Client Secret you saved in Create the Asset Bank authorization application and paste the value into the Render settings  Client Secret field.

Enable the integration

  1. Toggle this switch to enable the integration.

integration name enable integration
Figure 6. Enable integrations toggle.
Authorization redirect URI

  1. Supply an Authorization redirect URI

    integration name auth redirect
    Figure 7. Authorization redirect URI.

How Content editors use the Asset Bank integration

  1. Navigate to a content page asset that has a component that uses an image or link. Alternatively, add such a component to a new page.

  2. Click the Choose image button, and you will be presented with the following options:

    • Matrix

    • Asset Bank

  3. Select the Asset Bank option.

  4. Sign in to the service if prompted. Click the button and a window will open to allow you to sign in.

  5. After authentication, you will be returned to your content page, and the files from Asset Bank will be available to select and fill.

Image varieties

Original and thumbnail image varieties are automatically retrieved from Asset Bank and made available when selecting an image to insert into yourcontent.