Sitecore XM and XP

Sitecore enables you to edit, manage, store, and deliver cross-channel content with ease with a powerful and intuitive CMS.

This integration allows business users to build personalized landing pages and applications by repurposing content from your Sitecore XM or XP content management system. It also enables developers to use their preferred front-end tools to build these applications.

This section provides guides on how to use Uniform with Sitecore XM/XP.

Add Uniform integration#

Adding the Sitecore XM/XP integration to your Uniform project adds new parameter types that you can add to your Uniform Canvas components. The information in this section applies to the v7.2 (or later) version of the Uniform connector.

Configure Sitecore#

Sitecore must be configured to expose its content to Uniform Canvas.

Configure Sitecore Services Client#

Uniform uses the Sitecore Services Client (SSC) to read content from Sitecore, so SSC must be enabled and configured.

Install Sitecore package#

You must install Uniform Canvas for Sitecore on your Sitecore instances.

Configure Sitecore site#

Canvas will read content from your Sitecore site, but some configuration is needed. This configuration comes in the form of something called site configuration. The Uniform connector on your Sitecore instance uses the site configuration to determine which Uniform functionality to enable. You must create a site configuration for your web app.

1. In Content Editor, navigate to sitecore > system > Uniform > Site Configurations.
2. Add the following item:
   • Template: Site Configuration
   • Name: website

   info

   You use website here because this example uses the default Sitecore site. If you have multiple sites on your Sitecore server you must use the appropriate site name.

3. Add an item using the template Configure Site.
4. Select the child item Configuration.
5. Set the following field values:
   • Inherits: website

   info

   You use website here because this example uses the default Sitecore site. If you have multiple sites on your Sitecore server you must use the appropriate site name.

6. Save the item.
7. Publish the site.

Configure data types cache purge#

Uniform data types come with native support for edge-caching. To ensure content remains current after publishing Sitecore items, configuring the data type purge service is necessary.

1. In Content Editor, navigate to sitecore > system > Uniform > Site Configurations > website > Configuration.

   About this step

   You use website here because this example uses the default Sitecore site. If you have multiple sites on your Sitecore server you must use the appropriate site name.

2. Add an item using the template Configure: Canvas Data Type Purge Service
3. Set the following field values:
   • ProjectId: Uniform project id
   • ApiKey: Uniform API key
   • IncrementalEnabled (optional): true or false

   warning

   You may need a developer to use incremental purge. Read more how to define model dependencies.

   • IncrementalEventsThreshold (optional): defines the number of item events to be processed incrementally; otherwise purge all caches.
   • IncrementalItemsThreshold (optional): defines the number of unique items to be purged incrementally; otherwise purge all caches.
   • IncrementalRequestsThreshold (optional): defines the maximum estimated number of incremental purge requests; otherwise purge all caches.
4. Save the item.

Add integration#

1. In Uniform, open your project.

2. Navigate to the Integrations tab.

3. Scroll to the section Browse Integrations.

4. Click Sitecore.

5. Click Add to project.

   

6. Enter the required values.

7. Enter the required fields.

   Field	Description
   URL of your Sitecore instance	The URL to the root of the Sitecore instance. This must start with https:// (unless your Sitecore instance is running on http://localhost).
   Sitecore API key	Your Sitecore API key (or Uniform.Api.Token if you are using Sitecore 8.2).
   Site configuration name	Your Sitecore site name. This is the name of the site defined in a Sitecore config file. (This value isn't case-sensitive.)

   

8. Click Save.