Install and configure Sitecore Stream for Platform DXP

Version: 10.4

This topic describes how to install, configure, and verify the Sitecore Stream for Platform DXP module. A successful installation enables AI capabilities in Experience Platform.

This walkthrough describes how to:

  1. Download and install the Sitecore Stream for Platform DXP module

  2. Generate the Sitecore Stream client_ID and client_secret

  3. Update the Sitecore Stream connection strings

  4. Configure brand kit integration

  5. Verify the installation

  6. Verify the configuration

Before you begin

  • Ensure you have an active Sitecore Stream license. Contact your Account Manager to get started.

  • Ensure you have Sitecore XM/XP version 10.2 or later.

  • Ensure you have administrative access to your Sitecore instance.

Download and install the Sitecore Stream for Platform DXP module

To enable AI capabilities in Experience Platform, download and install the Sitecore Stream for Platform DXP module.

Important

You can download the module only if you have Sitecore Cloud Portal access and an org ID associated with your Sitecore Stream license.

To download and install the Sitecore Stream for Platform DXP module:

  1. Log in to the Sitecore Cloud Portal.

  2. If you belong to multiple organizations, select the one that contains Sitecore Stream. If already logged in, switch to the appropriate organization.

  3. On the Sitecore Cloud Portal home page, in the Apps section, click the Stream app, then in the right-hand pane, download the Sitecore Stream for Platform DXP installation package. The zip file includes the package and documentation.

  4. On the Sitecore Launchpad, click Control Panel > Administration > Install a package.

    Alternatively, on the Sitecore Desktop, click Start Menu > Development Tools > Installation Wizard.

  5. Follow the steps in the installation wizard.

    Note

    For more details on installing Sitecore Stream for Platform DXP module, refer to the documentation included in the installation package.

Generate the Sitecore Stream client_ID and client_secret

To authenticate Sitecore Stream and configure the connection strings, you must create a new client to generate the client_ID and client_secret for your organization.

To generate the Sitecore Stream client_ID and client_secret:

  1. Log in to the Sitecore Cloud Portal.

  2. If you belong to multiple organizations, select the one that contains Sitecore Stream. If already logged in, switch to the appropriate organization.

  3. On the Sitecore Cloud Portal home page, in the Apps section, click the Stream app, then in the right-hand pane, click Open app.

  4. On the Stream navigation menu, click Admin.

  5. On the Credentials page, click Create credential.

  6. In the Create New Client dialog:

    • In the Label field, enter a name for the client.

    • Optionally, in the Description field, enter a client description.

  7. Click Create. The Client ID and Client Secret fields will be populated.

  8. Copy and save the generated values for client_ID and client_secret, then click Done.

    Warning

    The client_secret is displayed only once and cannot be retrieved later. If lost, you must generate a new authentication client.

Update the Sitecore Stream connection strings

Before using the Sitecore Stream for Platform DXP module, configure the connection strings using your organization's client_ID and client_secret.

To configure the Sitecore Stream connection strings:

  1. Open the C:\inetpub\wwwroot\YourSitecoreCm\App_Config\ConnectionStrings.config file.

  2. Add the following line before the </connectionStrings> closing tag of the XML element:

    RequestResponse
    <add
name="sitecore.aiclient.stream"
connectionString="client_id=YOUR_CLIENT_ID;client_secret=YOUR_CLIENT_SECRET;authority=https://auth.sitecorecloud.io;audience=https://api.sitecorecloud.io"
/>

  3. Replace YOUR_CLIENT_ID and YOUR_CLIENT_SECRET with your actual values generated in Sitecore Cloud Portal.

  4. Save the file.

    Note

    For more details on configuring Sitecore Stream for Platform DXP, refer to the config.md file included in the installation package.

Configure brand kit integration

Note

Brand kits are available only with Stream Premium. To learn more, contact your Account Manager.

Before you can use a brand kit in Experience Platform, your organization must first create one in Sitecore Stream. Stream references the brand kit and draws on the information in the Brand Context, Do's and Don'ts, and Tone of Voice sections to guide content generation that reflects your brand.

To apply a brand kit in Experience Platform:

To configure brand kit integration using your organization ID and brand kit ID:

  1. Log in to the Sitecore Cloud Portal

  2. If you belong to multiple organizations, select the one that contains Sitecore Stream. If already logged in, switch to the appropriate organization.

  3. Get your organization ID from the URL.

    For example: https://portal.sitecorecloud.io/?organization=org_ABCDef123456

    The organization ID is what comes after organization=.

  4. Open the Stream app, go to Brand Kits, and open your brand kit. Then, get the brand kit ID from the URL.

    For example: https://stream.sitecorecloud.io/brandkits/a1234bcd-efg5-678h-910i-jklmnopqrstu

    The brand kit ID is what comes after brandkits/.

  5. Open the C:\inetpub\wwwroot\YourSitecoreCm\App_Config\Sitecore\AiClient\Sitecore.AiClient.config file.

  6. Update the following settings:

    RequestResponse
    <setting name="Sitecore.AiClient.Stream.BrandKitId" value="YOUR_BRANDKIT_ID" />
    RequestResponse
    <setting name="Sitecore.AiClient.Stream.BrandKitReferencePath" value="/api/brands/v1/organizations/YOUR_ORG_ID/brandkits/YOUR_BRANDKIT_ID/references" />

  7. Replace YOUR_ORG_ID and YOUR_BRANDKIT_ID with your actual values.

  8. Save the file.

    Note

    For more details on configuring Sitecore Stream for Platform DXP, refer to the config.md file included in the installation package.

Verify the installation

After completing the installation and configuration, confirm that AI capabilities are available in Experience Platform.

To verify the installation:

  1. Open the Sitecore Launchpad and check if the Stream area is visible.

  2. Ensure that the icons for the following AI features are present: Projects, Assistant, and Brand kits, and verify that you can access each one from the Sitecore Launchpad.

Verify the configuration

After successful installation, you can verify configuration by checking the AI-assisted content generation feature.

To verify the configuration:

  1. Open the Content Editor or Experience Editor.

  2. Verify that the AI icon appears beside supported fields: single-line, multiple-line, and rich-text fields.

  3. Click the AI icon to test that the content generation dialog functionality. If there are no errors, the configuration is correct.

Do you have some feedback for us?

If you have suggestions for improving this article,