Skip to main content

Coral

Brightspot's Coral integration supports commenting via an embedded Coral forum that replaces the below layout block on a number of content types, such as:

  • Articles
  • Blog posts
  • Listicles
  • Live blogs
  • Pages
Note

In the event that a content type has a sponsor associated with it, editors can hide the embedded Coral forum.

Setting Site permitted domains​

This topic explains how to retrieve the Coral ID necessary for configuring the Coral integration on Brightspot GO.

To set Site permitted domains in Coral:

  1. Log into Coral using your Coral account credentials.
  2. From the dashboard, click Organization.
  3. At the bottom of the page, under Site name, find the site for which you want to retrieve the Coral ID.
  4. Click Details.
  5. In the Site permitted domains field, enter the URLs of the Brightspot environments with which you want to integrate Coral.
Tip

As an example, In the URL https://www.brightspot.com, the domain name is brightspot.

Retrieving the Coral ID code​

This topic explains how to retrieve the Coral ID necessary for configuring the Coral integration on Brightspot.

To retrieve a Coral embed code for configuration:

  1. Log into Coral using your Coral account credentials.
  2. From the dashboard, click Organization.
  3. At the bottom of the page, under Site name, find the site for which you want to retrieve the Coral ID.
  4. Click Details.
  5. In the embed code, search for a URL. The URL's domain name is used in Brightspot as the Coral ID.
Tip

As an example, In the URL https://www.brightspot.com, the domain name is brightspot.

Configuration​

This topic explains how to configure the Coral integration in Brightspot.

To configure the Coral integration:

  1. Click > Admin > Sites & Settings.

  2. In the Sites widget, select the site for which you want to enable this feature, or select Global to enable this feature for all sites.

  3. From the Front-End tab, expand the Commenting cluster.

  4. Under Commenting Services, click .

  5. From the selection field, click Coral Commenting Settings.

  6. Toggle on Enabled to turn on Coral commenting.

  7. Under Exclusion Rules, click Add Sponsored Content Exclusion Rule to exclude commenting on sponsored content. If enabled, the Coral forum will not appear on assets for which you have set a sponsor.

  8. Under Supported Types, click the content types for which you want to support Coral commenting.

    5.0-configure-coral

  9. Under Coral ID, enter the ID associated with your Coral forum.

    Note

    This ID is obtained from Coral. Generally, you can find this ID by navigating to your Coral console and clicking Organization > Site > Details. This is also where you must enter in Site permitted domains. For more information, see Retrieving the Coral ID code for configuration and Setting Site permitted domains.

  10. Toggle on Coral Config Overrides to allow editors to override any fields placed on the content types specified in the Supported Types field.

  11. Click Save.

    Note

    Once these settings are configured, Coral forums will appear on all content types you selected in Step 8; however, if you elected to create an exclusion rule in Step 7, Coral forums will not appear on assets that have a sponsor associated with them.

Configuring forum overrides at the asset level​

Once you have configured Coral in Brightspot, a Coral forum appears on the assets to which you have applied the integration. For details, see step 8 in Configuring the Coral integration.

To apply forum overrides at the asset level:

  1. In the header, click .

  2. Click an asset for which you have applied the Coral integration. A content edit page appears.

    Note

    For more information on how to configure the Coral integration for certain assets, see step 8 in Configuring the Coral integration.

  3. Once an editor begins entering values into the fields in the content edit page, the Coral forum will appear.

  4. To override Coral fields, do the following:

    Note

    All Coral override fields are auto-generated. No changes are necessary unless you elect to make them.

    1. Click > Overrides.

    2. Under Coral, do the following:

      1. Under Coral ID, enter a new Coral ID. This is the ID of a DOM element on the page into which the comment stream will be rendered.
      2. Under Story ID, enter a new story ID. This is an ID used for scraping.
      3. Under Story URL, enter a new story URL. This allows you to more tightly couple Coral with Brightspot, and doing so will allow you to target the Story for later updates via Coral's GraphQL API, such as updating the URL if it changes.
      4. Under Title, enter a new title for the Coral forum.

  5. Complete your site's workflow and publish the asset.