Install Uniform connector

info

The information in this section applies to the v7.2 (or later) version of the Uniform for Sitecore connector.

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

  1. If SSC isn't enabled, you must enable it. The following is an example of a config file that enables SSC:
    <?xml version="1.0" encoding="utf-8" ?> <configuration xmlns:patch="http://www.sitecore.net/xmlconfig/"> <sitecore> <settings> <setting name="Sitecore.Services.AllowAnonymousUser" value="true" /> <setting name="Sitecore.Services.AllowItemServiceAnonymousUser" value="true" /> <setting name="Sitecore.Services.SecurityPolicy" value="Sitecore.Services.Infrastructure.Web.Http.Security.ServicesOnPolicy, Sitecore.Services.Infrastructure" /> </settings> <api> <services> <configuration type="Sitecore.Services.Infrastructure.Configuration.ServicesConfiguration, Sitecore.Services.Infrastructure"> <filters> <filter desc="requiredApiKeyAttribute">Sitecore.Services.Infrastructure.Security.RequiredApiKeyAttribute, Sitecore.Services.Infrastructure</filter> </filters> </configuration> </services> </api> </sitecore> </configuration>
  2. In Sitecore, open Content Editor.
  3. Open the master database
  4. Navigate to sitecore > system > Settings > Services > API Keys.
  5. Add the following item:
    • Template: API Key
    • Name: Uniform API Key
  6. Set the following field values:
    • CORS Origins: https://uniform.app
    • Allowed Controllers: Sitecore.Services.Infrastructure.*
    • Impersonation User: Name of a Sitecore user with access to site items, /sitecore/system/Languages, /sitecore/templates and /sitecore/system/Uniform (for example, sitecore\admin)
  7. Save the item.
  8. Publish the item.
  9. Note the item ID. This is your Sitecore API key. You will need this value later.

tip

We also recommend that the user sitecore\servicesAPI have permissions configured that explicitly deny access to the remaining parts of content tree. This is the account SSC uses by default for calls when an API key isn't specified.

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

info

Uniform provides a Sitecore installation package. Contact the support team for this package, or if you need instructions for alternative installation options.

tip

Uniform Canvas for Sitecore must be installed on your content management (CM) and content delivery (CD) instances.

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.

tip

Site configuration can be created using Sitecore configuration files or Sitecore items. These instructions use Sitecore items. The config file approach is recommended for production environments, but using Sitecore items may be easier for some users during development and testing.

  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.

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.

info

You can skip this step if you don't intend to utilize data types.

tip

Site configuration can be created using Sitecore configuration files or Sitecore items. These instructions use Sitecore items. The config file approach is recommended for production environments, but using Sitecore items may be easier for some users during development and testing.

warning

This functionality requires latest v7.2-patch-2 version of the Uniform connector (Sitecore package named Uniform Canvas v7.2.230517-1 Upgrade Package for UFS v7.2) which needs to be installed on top of previously installed v7.2 or v7.2-patch-1 (Sitecore package named Uniform Canvas v7.2.23XXXX for Sitecore 8.2.0-10.3.0). If you use .NET SDK please make sure to update your dependencies per packages.config

  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
    • Archetypes (optional): defines the list of archetypes to purge. Supported values: sitecoreItem, sitecoreItemByPath. Default: [sitecoreItem]

    info

    If you intend to utilize Sitecore Item by Path, you need to register sitecoreItem and sitecoreItemByPath archetypes here.

    • 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.

Last modified
Next
2. Install & configure integration