1. SitecoreAI DAM

Connect SitecoreAI DAM to Scrunch

Early access

This feature is currently available only to select Sitecore organizations. Reach out to your account or partner manager if you'd like to take part or want to learn more about Scrunch. References to SitecoreAI DAM in this topic also apply to Sitecore Content Hub.

By connecting your SitecoreAI DAM environment to Scrunch, Scrunch users can start working with the content stored in SitecoreAI DAM directly in Knowledge Studio. Connecting involves the following steps:

  1. Create a SitecoreAI DAM API key
  2. Add the API key in Scrunch
  3. Test access - make sure SitecoreAI DAM items appear in Scrunch.
Before you begin
  • Make sure you have a SitecoreAI DAM license and a Scrunch license.
  • In SitecoreAI DAM, you must be a Superuser to create users and API keys.
  • In Scrunch, you must have the following for the brand you want to work with:
    • Editor permission, which allows you to create integrations. You have this permission if Integrations appears in the Brand settings section.
    • Knowledge Studio enabled. It is enabled if Knowledge Studio appears in the Brand Settings section. If it doesn't appear, contact Scrunch Support.

Create a SitecoreAI DAM API key

Connecting SitecoreAI DAM to Scrunch involves creating an API key for a specific SitecoreAI DAM user. This user provides the connection to Scrunch.

When creating or selecting this user, keep the following considerations in mind:

  • We recommend that you use a dedicated API user in SitecoreAI DAM with access limited to the content you want to be accessible in Knowledge Studio.
  • Scrunch can only access the DAM content that this SitecoreAI DAM user can access. If you change the user's access by, for example, changing the group policies, that also impacts what content Scrunch can access.
  • If the user can't access an item in SitecoreAI DAM, that item will not be available in Scrunch.
  • If you delete this SitecoreAI DAM user or their API key, the connection to Scrunch stops working.
  • To revoke Scrunch's access to SitecoreAI DAM, delete the user's API key.

To create the API key:

  1. Log in to SitecoreAI DAM as a Superuser.

  2. In your web browser's address bar, find and note the base URL of your SitecoreAI DAM environment. Don't include paths or a trailing slash.

    Example base URL: https://your-environment.sitecore.cloud

  3. Go to Manage > Users.

  4. Either create a new user for this connection, such as Scrunch.KnowledgeStudio, or choose an existing user.

  5. Review the user's access to DAM content, such as the user's group policies. Scrunch will only be able to access the content that this DAM user can access.

  6. For the user you want to use as the connection, click API token > New token.

  7. Copy the API key because you won't be able to view it in SitecoreAI DAM again.

Add the API key in Scrunch

To add the SitecoreAI DAM API key in Scrunch:

  1. Log in to Scrunch and select the brand you want to work with.
  2. In Brand Settings, click Integrations > SitecoreAI DAM > Manage.
  3. Enter a descriptive name, such as SitecoreAI DAM assets, and then click Continue.
  4. In the Connection section:
    1. In the Instance URL field, enter your SitecoreAI DAM base URL.
    2. In the API key field, enter your SitecoreAI DAM API key.
    3. Click Connect SitecoreAI DAM. Scrunch validates the credentials with a test API request. If the request succeeds, the integration status changes to Connected.

Test access

To test that Scrunch can access SitecoreAI DAM content:

  1. In Scrunch, in Brand Settings, click Knowledge Studio.

  2. Check that the SitecoreAI DAM ACTIVE badge appears under the page title. If it doesn't appear, see the troubleshooting steps.

  3. Click New document.

  4. Enter a descriptive name, such as TEST - SitecoreAI DAM, and then click Continue.

  5. In the source picker modal, make sure at least one document appears where the Provider is SitecoreAI DAM. If no documents appear, see the troubleshooting steps.

    If at least one such document appears, you've successfully connected SitecoreAI DAM to Scrunch and made DAM content available in Knowledge Studio. You can now delete the test document. Knowledge Studio users can now start working with DAM content in Knowledge Studio.

Troubleshooting

Connection badge is missing

In Scrunch, on the Knowledge Studio page, the SitecoreAI DAM ACTIVE badge under the page title indicates that the connection between SitecoreAI DAM and Scrunch is live.

If the badge doesn't appear, the connection is not live.

To fix the issue:

  • Make sure the SitecoreAI DAM user exists. If the issue persists, delete the user's API key, create a new one, and add the new API key in Scrunch.

DAM documents don't appear

If SitecoreAI DAM and Scrunch are connected but no SitecoreAI DAM documents appear in the Knowledge Studio source picker modal, that's because the SitecoreAI DAM user doesn't have access to DAM content.

To fix the issue:

  • Review the user's group policies to make sure the user can access content. Then, in the source picker modal in Scrunch Knowledge Studio, click Refresh to load the documents again.

Manage the connection

You can manage the connection between SitecoreAI DAM and Scrunch in both applications.

In SitecoreAI DAM > Manage > Users, you can:

  • Revoke Scrunch's access to SitecoreAI DAM by deleting the user's API key.
  • Create a new API key for the user. You'll then need to add the new API key in Scrunch.

In Scrunch > Integrations > SitecoreAI DAM > Manage, you can:

  • Validate the connection to test that the API key still works and the connection is live.
  • Disconnect to remove the connection and delete the stored API key from Scrunch. After disconnecting, previously synced sources still appear in Knowledge Studio but will not receive updates until you reconnect and refresh the sources.
  • Connect again by entering a valid SitecoreAI DAM API key.
If you have suggestions for improving this article, let us know!