Prerequisites for Using Prepublish Check

Answer

Before using Prepublish checks, you must have the appropriate Siteimprove subscription, user access, and any required integrations, plugins, API credentials, browser extensions, or platform permissions depending on how you plan to use Prepublish.

Summary

There are a number of Prerequisites required to use the Prepublish checks, as listed below. The specific requirements depend on whether you are using CMS plugins, the API, Optimizely CMP, or Email Governance integrations.

Feature Overview

Prepublish checks can be used through various Siteimprove integrations, CMS plugins, APIs, and content platforms. Each implementation has specific requirements, such as subscriptions, user access, API credentials, plugin support, browser extensions, or third-party platform access.

Prerequisites

Prepublish or Email Governance subscription under Siteimprove Account

Required for: All Integrations or data sources that utilize Prepublish.

• The Email Governance integration requires an Email Governance subscription, and all other integrations that use Prepublish require a Prepublish subscription. If you are not sure if you have the required subscription, contact Siteimprove.

User access to the Siteimprove platform

Required for: All Integrations or data sources that utilize Prepublish.

• User access to the Siteimprove platform is required as you will need to log in to your Siteimprove account via the CMS plugin, Optimizely CMP, or Email Governance Integrations.
• You also need Siteimprove user access to create API keys to be used with the API or in CMS plugins to link to the API and Prepublish subscription.

API Key credentials

Required for: CMS Plugins and API

• To enable Prepublish or to access the API, you’ll also need a Siteimprove API key. Follow the instructions in the article How to connect to the Siteimprove API.
• For the CMS plugins, we recommend that the user associated with the API key is not specific to a certain person and that the user has either Account Owner or Administrator level permissions in the Siteimprove platform.
• The Content endpoints in the API are strictly intended to be used for Prepublish checks (i.e., Content Checks).

CMS plugin with Prepublish functionality available

Required for: CMS Plugins

• Make sure you have installed the latest version of Siteimprove’s CMS plugin supporting the Prepublish check feature.
• See the Prepublish Supported Plugins, Integrations, and Data Sources section of this page or refer to the documentation for specific plugins accessible via links on the Siteimprove CMS Plugin Page to determine whether a particular plugin supports Prepublish or not.
• Follow the steps in the Help Center article How to set up the plugin and in the particular plugin's installation and usage guides accessible via links on the Siteimprove CMS Plugin Page under the specific plugin page's installation or user guide tab.

Enable Prepublish functionality in the CMS plugin

Required for: CMS Plugins

• You will have to enable the Prepublish functionality when configuring the plugin. For details, please refer to the particular plugin's installation and usage guides accessible via links on the Siteimprove CMS Plugin Page under the specific plugin page's installation or user guide tab as highlighted in the screenshot below.

Install the Siteimprove Content Assistant Browser Extension on a Supported Browser

Required for: Optimizely CMP and Email Governance Integrations

• Google Chrome: Install from the Chrome Web Store.
• Mozilla Firefox: Install from the Firefox Add-ons Store.
• Microsoft Edge: Install from the Edge Add-ons Store.

Optimizely CMP Access

Required for: Optimizely CMP Integration

• You will need user access to Optimizely CMP to be able to set up the Optimizely CMP Integration.

User Access to one of the Email Platforms supported by the Email Governance Integration

Required for: Email Governance Integration

Supported email platforms include:

• Adobe Campaign
• Salesforce Pardot
• Marketo
• HubSpot
• Optimizely Campaign

Related Articles

• How to connect to the Siteimprove API