Install and configure Sitecore Stream for Platform DXP
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:
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.
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:
-
If you belong to multiple organizations, select the one that contains Sitecore Stream. If already logged in, switch to the correct organization.
-
On the Sitecore Cloud Portal home page, in the Sitecore Cloud section, choose your Stream instance.
-
In the right-hand pane, click Sitecore Stream for Platform DXP to download latest module package. The downloaded zip file contains both the installation package and the documentation.
-
After the download is complete, extract the zip file to a local folder. It includes:
-
SitecorePackage - the installation package zip file you will upload to XP or XM in the next step.
-
docs - a folder containing reference documentation in Markdown format.
-
-
To install the module in Sitecore XM or XP, use the SitecorePackage zip file:
-
On the Sitecore Launchpad, click Control Panel > Administration > Install a package.
-
On the Sitecore Desktop, click Start Menu > Development Tools > Installation Wizard.
-
-
Follow the steps in the installation wizard to complete the setup.
NoteFor more details on installing Sitecore Stream for Platform DXP module, see the documentation included in the downloaded zip file.
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:
-
If you belong to multiple organizations, select the one that contains Sitecore Stream. If already logged in, switch to the appropriate organization.
-
On the Sitecore Cloud Portal home page, in the Apps section, click the Stream app, then in the right-hand pane, click Open app.
-
On the Stream navigation menu, click Admin.
-
On the XP/XM keys page, click Create credential.
-
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.
-
-
Click Create. The Client ID and Client Secret fields will be populated.
-
Copy and save the generated values for
client_IDandclient_secret, then click Done.WarningThe
client_secretis 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:
-
Open the
C:\inetpub\wwwroot\YourSitecoreCm\App_Config\ConnectionStrings.configfile. -
Add the following line before the
</connectionStrings>closing tag of the XML element: -
Replace
YOUR_CLIENT_IDandYOUR_CLIENT_SECRETwith your actual values generated in Sitecore Cloud Portal. -
Save the file.
NoteFor more details on configuring Sitecore Stream for Platform DXP, refer to the
config.mdfile included in the installation package.
Configure brand kit integration
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:
-
If you're using Stream DXP module version 1.0, follow the instructions below to configure a brand kit using your
organization IDandbrand kit ID. -
For later versions, use the procedure to apply a brand kit directly from the Stream dialog.
To configure brand kit integration using your organization ID and brand kit ID:
-
If you belong to multiple organizations, select the one that contains Sitecore Stream. If already logged in, switch to the appropriate organization.
-
Get your
organization IDfrom the URL.For example:
https://portal.sitecorecloud.io/?organization=org_ABCDef123456The
organization IDis what comes afterorganization=. -
Open the Stream app, go to Brand Kits, and open your brand kit. Then, get the
brand kit IDfrom the URL.For example:
https://stream.sitecorecloud.io/brandkits/a1234bcd-efg5-678h-910i-jklmnopqrstuThe
brand kit IDis what comes afterbrandkits/. -
Open the
C:\inetpub\wwwroot\YourSitecoreCm\App_Config\Sitecore\AiClient\Sitecore.AiClient.configfile. -
Update the following settings:
-
Replace
YOUR_ORG_IDandYOUR_BRANDKIT_IDwith your actual values. -
Save the file.
NoteFor more details on configuring Sitecore Stream for Platform DXP, refer to the
config.mdfile 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:
-
Open the Sitecore Launchpad and check if the Stream area is visible.
-
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.
NoteProjects is available with the Stream Free tier, while Assistant and Brand kits require a Stream Premium subscription. To learn more, contact your Account Manager.
If your organization uses the Stream Free tier, the two Premium features will appear disabled in the Launchpad.
Verify the configuration
After successful installation, you can verify configuration by checking the AI-assisted content generation feature.
To verify the configuration:
-
Open the Content Editor or Experience Editor.
-
Verify that the AI icon
appears beside supported fields: single-line, multiple-line, and rich-text fields. -
Click the AI icon
to test the content generation dialog functionality. If there are no errors, the configuration is correct.