Brightspot CMS User Guide

Global site settings


The Global site has many settings that serve two purposes: configuring Brightspot and providing defaults for lower levels in the site hierarchy.

The settings described in this section apply to most versions of Brightspot. Your version of Brightspot may have different settings.

Global settings–Main tab

Field
Description
Name Name for global site.
URL Global site’s protocol and domain, such as https://global.brightspot.com.
Company Name Company name. If there is no company logo, the company name appears in the header next to the Navigation Menu. If there is no company name and no logo, BRIGHTSPOT appears in the header.
Company Logo Company logo. Appears in the header next to the Navigation Menu. Overrides company name.
Background Image Background image for login page. If set to None, a standard Brightspot image appears.
Environment Name of environment. Appears in black ribbon in the header.
Default Role
Default role when creating a new user. For information about creating roles, see Creating a role; for information about creating users, see Creating a user.
Default Site URL
Default URL for published sites. For information about creating sites, see Creating a site; for an explanation of site URLs, see Site URLs.
Default Preview URL
Default base portion of a URL used to preview content. If not specified, Brightspot uses the Default Site URL.
Default Tool URL
URL Brightspot uses when sending notifications that include links, such as emails or text messages. Also the URL editors use to log in to Brightspot. Do not append /cms to this field.
Allow Global Editing Editors logged in to the Global site can edit content associated with any other site. Overrides access permission set at asset level.
Authenticators Service for authenticating users attempting to log in to Brightspot.
  • Default Tool Authenticator—Editors log in to Brightspot using standard username and password.
  • Google Tool Authenticator—Editors log in to Brightspot using their Google sign-on.
Theme Default theme for all sites. You can override this setting at the site level.

Global settings—Front-End tab

Field
Description
Logos & Icons
Logo Site’s logo. Typically appears in the top left corner of each page.
News Publisher Logo Renders a site logo that complies with width and height restrictions for AMP.
Favicon Site’s favicon appearing in browsers and some mobile apps. Use .png or .jpg files.
Favicon Ico Site’s favicon appearing in browsers and some mobile apps. Use .ico files.
Layout
Hat Site’s hat.
Navigation Site’s navigation.
Footer Site’s hat.
Above Content appearing in the above block on all the site’s page.
Aside Content appearing in the aside block on all the site’s page.
Below Content appearing in the below block on all the site’s page.
Search Page Page that lists results when a visitor searches for content.
Type Specific Overrides
Type Specific Overrides Logos, icons, and layouts applicable to specific content types. Configurations in these fields override settings in the Logos & Icons and Layouts accordions.
Access
Access Substitution

Asset displayed when an unauthorized visitor requests content, such as when a visitor tries to view a page behind a pay wall before logging in.

  • None—Returns a 403 Forbidden message.
  • Content Substitution—Displays a selected asset even if the visitor does not have access to it.
  • External Redirect—Redirects the visitor to a URL.
  • Internal Redirect—Displays a selected asset only if the visitor has access to it.
Subscription Plans Subscriptions available to visitors to view specific content on your site.
Action Bar
Default Action Bar Site’s default action bar. Appears on all of the site’s assets unless overridden for a content type.
Tracking Parameter Name Tracking parameter appended to URLs for assets shared from the action bar.
Type Specific Overrides Action bars applicable to specific content types for this site. Overrides Default Action Bar.
Ads
Disable Ads Parameter Value Value in a query string that blocks an ad feed.
Ad Sizes List of available ad sizes on this site.
CMS Preview Disabled Ad Sizes List of ad sizes that are not populated with ads in the preview pane.
Ad Modules List of Ad Sense or Ad Manager modules available for this site. Requires active accounts with these Google services. For more information, see Configuring an ad feed.
Asset
Watermarks Front-end watermarks associated with binary files (documents, spreadsheets, presentations, or images).
Authentication
Authentication Settings List of standard authentication managers used to authenticate access to your site, such as when a visitor attempts to log in to an account on your site. For more information, see Configuring an authentication manager.
Community
Commentable Types Content types to which visitors can post comments.
Error
Error Handlers List of HTTP error or status codes and associated pages that visitors receive.
Organization Fields for specifying an organization in a JSON-LD object.
Facebook
Instant Article Settings Settings for generating Facebook Instant Articles from Brightspot. For more information, see Configuring Facebook Instant Articles.
Form CAPTCHA
Provider Configuration for adding a reCAPTCHA control on forms. For more information, see Configuring Google reCAPTCHA.
Google Calendar
Max Event Results Maximum number of events Brightspot imports, per user, into an intranet’s calendar.
JSON-LD
Types The JSON-LD content type injected into an asset's published pages. For more information, see Adding JSON-LD to published assets.
Open Graph
Default Open Graph Image Image appearing in social networks when an asset is shared.
OpenAir
(various) Settings for configuring an integration with OpenAir.
Permalinks
Permalink Rule Overrides

Configures how Brightspot generates permalinks for a content type. For each content type, you can configure one of the following rules:

  • Contained Versionable Permalink Rule—Brightspot generates permalinks from a combinations of an asset's version number and slug. Applies to assets of content type Versionable.
  • Default Permalink Rule—Brightspot generates permalinks from an asset's slug.
  • No Permalink Rule—Brightspot does not automatically generate a permalink; editors must manually create permalinks for each asset.
  • Section Prefix Permalink Rule—Brightspot generates permalinks from a combination of the section’s slug and the asset's slug.
  • Type Version Wildcard Permalink Rule—Brightspot generates permalinks from a combination of the item's name and a version number. Applies to assets of content type Type Version.
  • Versionable Container Permalink Rule—Brightspot generates permalinks from a combination of the item's title and a version number. Applies to assets of content type Versionable Container.

For each rule, you can specify how Brightspot resolves duplicate permalinks.

  • Inherit—Use the rule inherited from the global site.
  • Disabled—Do not automatically resolve duplicate permalinks; editors must resolve them individually.
  • Enabled—Brightspot appends a number to duplicate permalinks, incrementing the number for each new duplicate.
Push Notifications
Service Provider Service providing push notifications.
Device Registration Shared Key Not used.
Enable Notification Activates the push service on the Brightspot server.
Default Publishing Targets List of publishing targets, such as AWS SNS topics, to which Brightspot sends notifications.
iOS Registration Target List of publishing targets on the Apple Push Notification Service. These targets provide a native iOS user experience.
Android Registration Target List of publishing targets on Google’s Firebase Cloud Messaging. These targets provide a native Android user experience.
Amazon Registration Target List of publishing targets on Amazon Device Messaging. These targets provide native user experiences on Amazon devices such as Fire tablets.
iOS Payload iOS-specific key-value pairs included with the message sent from the notification service provider.
Android Payload Android-specific key-value pairs included with the message sent from the notification service provider.
Amazon Payload AWS-specific key-value pairs included with the message sent from the notification service provider.
RSS Settings
Disable Feed If toggled on—
  • Brightspot stops populating your site’s RSS feed.
  • Removes the existing feed and its previously included assets.
Copyright Copyright notice appearing in the feed’s copyright tag, which not all RSS readers display.
Default To Atom Auto Detect If toggled on, the feed is a discoverable Atom feed. If toggled off, the feed is a discoverable RSS feed.
Type Specific Feed Overrides

Feed configurations for specific content types. For homepages, pages, sections, and tags, you can configure the following:

  • Disable Feed—Enables or disables the feed.
  • Render Full Content—Delivers the entire asset—not just a summary—to the RSS feed as plain text.
  • Enabled Feed Item Types—Content types associated with these settings, or leave blank to apply the settings to all content types

The settings in this field override Disable Feed.

Search
Disable Search Analytics Not used.
SEO
robots.txt Lines to includes in the site’s robots.txt file. For detailed information about this file, see Robots.txt Specifications.
Sitemap Settings
Site Map Types One of the standard sitemap types.
Site Map Default URL Default URL appearing in the site’s sitemap.
Stock Ticker
Settings Settings for retrieving stock quotes from an online service such as Q4.
Tag Manager
Tag Manager Google Tag Manager applicable to this site. For information about using Google Tag Manager with Brightspot, see Google Tag Manager.
Video
Video Frontend Settings

Settings for rendering a browser’s native video player in a published page.

  • Options—Aspects of the video player’s behavior.

    • Autoplay—Player automatically starts playback as soon as possible. Overrides the preload=none setting below.
    • Muted—Video playback is muted, and visitor must explicitly unmute.
    • Card Overlay—Overlays a promo on the video before playback.
    • Playlist—Not used.
  • Preload—What the player retrieves before the visitor actually starts playing.

    • None—Player does not preload any of the video.
    • Metadata—Player loads the video’s metadata, such as duration.
    • Auto—Player preloads the video.
  • Width—Width of the video’s display area.
  • Height—Height of the video’s display area.
  • Controls—If toggled on, the video player includes controls such as volume, seeking, and pause/resume.
  • Loop—If toggled on, the video replays after completion.
  • Live Video No Content Message—Text to display when a live video is not streaming.
Advanced
Locale Published site’s language and location. The site’s appearance changes to reflect the selected locale.
Time Zone Time zone used to compute the published time as reported in some  tags. For example, your Brightspot server is in New York and you publish an asset at 9:00 AM. In addition, you set this field to Europe/London. In this case, Brightspot renders , indicating the asset was published at 2:00 PM.
Default Date Time Format Pattern that configures the site’s date and time format.
Web App Manifest Web app manifest delivered to clients from this site.
Browser Config The browserconfig file delivered to clients from this site.
Custom Scripts And Styles <link>, <meta>, <script>, and <style> elements included in web pages delivered from this site—beyond what is defined in the site’s theme. You can send different sets of custom tags to specific clients by filtering on HTTP method, URL pattern, and content type.
Custom Response Headers Response headers sent to clients—beyond what is configured for the site’s server. You can send different response headers to specific clients by filtering on HTTP method, URL pattern, and content type. For information about configuring response headers, see Response header.
Default Playlist Sequence of videos that plays if an asset includes a single video. This playlist ensures that every item containing a video has more than one video, thereby increasing a visitor's engagement.
Strip Query String From Directory Redirects A client’s request for a resource may trigger a redirect to a different directory. Toggle on this field if you want to strip the query string from the request before the server performs the redirect.

Global settings—Integrations tab

Field
Description
Integrations List of third-party apps with which the site interacts. Examples include Google’s AdSense and Video Analytics.
Disable Third Party Parameter Value Value in a query string that blocks interacting with the third-party app.
Adobe AEM
Settings Settings for synchronizing between Adobe Experience Manager and Brightspot. For more information, see Configuring AEM synchronization overview.
Adobe Stock
Adobe Stock API Client API client for connecting to Adobe Stock. Each client requires the following:
  • Integration Name—Name for the integration that appears in the Edit Global or Edit Site widget.
  • API Key—API key from the Adobe Stock console. For more information, see Federated Search with Adobe Stock.
Analytics
Automatic Analytics JavaScript Injection If toggled on, Brightspot adds JavaScript to your published assets for accumulating analytics on the Brightspot server. (Does not affect JavaScript for third-party analytics services.)
Search Sources Search engines from which traffic arrives to the asset. If blank, Brightspot tracks incoming traffic referred by Google, Bing, and Yahoo. You can override this setting at the site level.
Social Sources Social networks from which traffic arrives to the asset. If blank, Brightspot tracks incoming traffic referred by Twitter, Facebook, LinkedIn, and YouTube. You can override this setting at the site level.
Associated Press
Associated Press API Client

API client for connecting to Associated Press. Each client requires the following:

  • Integration Name—Name for the integration that appears in the Edit Global or Edit Site widget.
  • API Key—API key from the Associated Press console. For additional information, see Federated search with AP Images.
Atlassian
Disable Personal Data Reporting Task Prevents Brightspot from collecting and reporting Jira data at the individual user level.
AWS Comprehend
Region Region to use when making requests to this AWS service. If blank, Brightspot reads the region from a configuration file.
Language Language of the text that will be sent to AWS Comprehend. Defaults to English.
Minimum Key Phrase Confidence Minimum confidence rating (0.0–1.0) required to accept a key phrase. See the key phrases documentation for information regarding what a key phrase is.
Minimum Entity Confidence Minimum confidence rating (0.0–1.0) required to accept an entity. See the entities documentation for information regarding what an entity is.
AWS Elemental
Video Player Player to use when delivering videos from AWS Elemental. If blank, Brightspot sends the Plyr player.
Region Region to use when making requests to this AWS service. If blank, Brightspot reads the region from a configuration file.
AWS Elemental MediaConvert
Transcoding Settings Transcoding settings for converting videos using MediaConvert.
Enable MediaConvert Service If toggled on, Brightspot sends videos to the MediaConvert service.
MediaConvert Role ARN ARN for the MediaConvert role. This value is taken from your AWS console.
MediaConvert SQS Queue Name MediaConvert SQS queue name. This value is taken from your AWS console.
MediaConvert Sync Button Delay (Minutes) Number of minutes after which Brightspot displays a button in the content edit form to check if a conversion is complete.
AWS Elemental MediaLive
Save Live-to-VOD as draft Saves the live video steam in Brightspot so you can edit or publish it later.
Create Live-to-VOD From The Backup Channel Saves the media stream using the steam’s backup channel.
Enable Media Live Service If toggled on, you can stream live videos through MediaLive.
Media Live Role ARN ARN for the MediaLive role. This value is taken from your AWS console.
AWS Elemental MediaTailor
MediaTailor Configuration for VOD Configuration for video-on-demand.
MediaTailor Configuration for Live (MediaStore) Configuration for live video streams.
Enable MediaTailor Service If toggled on, the MediaTailor service delivers personalized ads to your videos published with Brightspot.
AWS Rekognition
Region Region to use when making requests to this AWS service. If blank, Brightspot reads the region from a configuration file.
AWS Rekognition (Image)
Enable Rekognition Image Service If toggled on, Brightspot sends images to the Rekognition service, and receives corresponding text.
Minimum Label Confidence Confidence level for detecting objects, concepts, and scenes in an image. If blank, defaults to 0.50.
Minimum Text Confidence Confidence level for detecting text in an image. If blank, defaults to 0.50.
Minimum Celebrity Confidence Confidence level for detecting a celebrity in an image. If blank, defaults to 0.50.
Minimum Moderation Label Confidence Confidence level for detecting unsafe content in an image. If blank, defaults to 0.50.
AWS Rekognition (Video)
Enable Rekognition Video Service If toggled on, Brightspot sends videos to the Rekognition service, and receives corresponding text.
Region Region to use when making requests to this AWS service. If blank, Brightspot reads the region from a configuration file.
Time Frame Interval (Seconds) Number of seconds by which Brightspot groups Rekognition’s results. If blank, Brightspot groups the results in 60-second intervals.
SQS Queue Name AWS SQS queue that Brightspot polls to determine when a video’s processing is complete. This value is taken from your AWS console.
Topic ARN ARN of the topic providing this service.
Role ARN ARN of the role with access to this service.
Minimum Label Confidence Confidence level for detecting objects, concepts, and scenes in a video. If blank, defaults to 0.50.
Minimum Moderation Label Confidence Confidence level for detecting unsafe content in a video. If blank, defaults to 0.50.
AWS SES
Enable Bounce and Complaint Notification Service If toggled on, Brightspot accesses the SES service to retrieve bounce and complaints notifications generated by other AWS services.
Bounce Notification SQS Queue Name AWS SQS queue that Brightspot polls to retrieve notifications regarding bounced emails. This value is taken from your AWS console.
Complaint Notification SQS Queue Name AWS SQS queue that Brightspot polls to retrieve complaints regarding outbound emails. This value is taken from your AWS console.
AWS SQS
Region Region to use when making requests to this AWS service. If blank, Brightspot reads the region from a configuration file.
AWS Textract
Enable Textract Service If toggled on, Brightspot sends documents to the Textract service, and receives extracted text.
SQS Queue Name AWS SQS queue that Brightspot polls to determine when an extraction is complete. This value is taken from your AWS console.
Topic ARN ARN of the topic providing this service.
Role ARN ARN of the role with access to this service.
Minimum Block Confidence Confidence level for accurately extracting text. If blank, defaults to 0.50.
AWS Transcribe
Enable Transcribe Service If toggled on, Brightspot sends audio and video files to the Transcribe service, and receives the transcription.
SQS Queue Name SQS queue that Brightspot polls to determine when a transcription is complete. This value is taken from your AWS console.
Region Region to use when making requests to this AWS service. If blank, Brightspot reads the region from a configuration file.
Transcribe Settings Settings indicating the languages in which you submit audio or video files.
AWS Translation
Input Bucket AWS bucket to which Brightspot pushes assets to be translated.
Output Bucket AWS bucket containing translated assets.
Translation Role Arn ARN of the topic providing this service.
Aws Region Region to use when making requests to this AWS service. If blank, Brightspot reads the region from a configuration file.
Disable Translation Update Task If toggled on, Brightspot does not continually monitor the progress of translation jobs.
All Async Processing If toggled on, Brightspot processes the translations in an asynchronous matter. Editors can proceed to other tasks and return to the translated asset to view the results.
Task Host Name or address of the host running the translation background tasks.
Box
Client ID Client ID from your Box console.
Client Secret Client secret from your Box console.
Brightcove
Global Import Frequency
Number of minutes after which Brightspot imports videos added to Brightcove. The default is one minute.
Settings Settings for connecting to and interacting with Brightcove. For detailed information, see Configuring Brightcove for federated search.
Dropbox
Dropbox Application Key Application key from your Dropbox console.
Application Secret Application secret from your Dropbox console.
Facebook
Facebook App Access Token Access token from your Facebook console.
Facebook settings

Settings for connecting to Facebook.

  • App ID—ID for a Facebook app.
  • Disabled—If toggled on, Brightspot does not push content to the app.
Getty
Download Full Images
If toggled on, Brightspot retrieves the largest display size for an image, and may impact charges from Getty.
Getty API Client

API client for connecting to Getty. Each client requires the following:

  • Name—Name for the integration that appears in the Edit Global or Edit Site widget.
  • API Key—API key from your Getty console.
  • API Secret—API secret from your Getty console.
Giphy
API Key API key from your Giphy console.
Use Still Images for Search Preview If toggled on, Brightspot displays a still image in the search panel instead of the animated image.
Google
Google Server API Key API key from your Google console.
Task Host Name or address of the host ingesting output from Google services, such as DFP or Google Analytics.
Drive Client ID Drive client ID from your Google console.
Drive Client Secret Drive client secret from your Google console.
Google Analytics
Metrics To Display Metrics appearing in the content edit page's Analytics widget. If blank, all metrics appear.
Custom Events to Display Events defined in your Google Console that appear in the content edit page's Analytics widget. If blank, all events appear.
Credentials Credential key from your Analytics console.
View ID View ID from your Analytics console.
Import Time Zone Time zone associated with the View ID, from your Analytics console.
Page Report If toggled on, Brightspot imports page-specific analytics. If toggled off, Brightspot analytics for the site as a whole.
Site Reports

One or more of the following:

  • Demographics—Demographic information provided by Google, such as geography.
  • Device Categories—Visits by device category, such as laptop or tablet.
  • Referrals—Indications of how visitor arrived at your site, such as email campaign or social media link.
  • Visits—Number of visits.
Custom Event Filter Strategy Filter with which Brightspot imports analytics for custom events.
  • None—No filter, Brightspot imports analytics for all custom events.
  • All Except—Multiple custom event filters. A custom event must match all of the filters to be excluded.
  • Only—Multiple custom event filters. A custom event must match at least one of the filters to be included.
Import Schedule
  • Cron Expression—Cron expression specifying how often Brightspot imports from Google Analytics. For example, 0 0 0/1 1/1 * ? * imports every hour on every day. For information about building cron expressions, see Cron Maker.
  • Schedule Builder—Series of widgets for configuring an import schedule. For detailed information, see Configuring Analytics ingestion intervals with the schedule builder.
Historical Days To Import Number of days’ analytics to import into Brightspot.
Google DFP
DFP Tag Import Document header script. You can generate the script using Ad Manager Tag Generator & Tester.
Window Sizes List of window sizes to which DFP sends ads.
Image Recognition
Provider List of image recognition providers and confidence intervals for various image categories.
Lingotek
Client ID Client ID from your Lingotek console.
Community ID Community ID from your Lingotek console.
Mail Publishing
S3region Region to use when making requests to this AWS service. If blank, Brightspot reads the region from a configuration file.
Queue Name AWS SQS queue that Brightspot polls for bounce and complaint notifications. This value is taken from your AWS console.
Marketo
Enable Import If toggled on, Brightspot imports forms from Marketo.
Fetch Size Number of forms to import in a retrieval.
Accounts Configures Marketo accounts from which Brightspot imports forms.
SEMrush
API Key API key from the SEMrush console.
Content Types Content types for which SEMrush retrievals are available. A widget containing SEMrush retrievals appears in the content edit page for these content types.
Excluded Keywords Keywords not submitted to SEMrush.
Number of Results Maximal number of keywords in a retrieval.
Shutterstock
Shutterstock API Client

API client for connecting to Shutterstock. Each client requires the following:

  • Name—Name for the integration that appears in the Edit Global or Edit Site widget.
  • Consumer Key—Consumer key from your Shutterstock console.
  • Consumer Secret—Consumer secret from your Shutterstock console.
  • Linked Enterprise Accounts—Shutterstock enterprise accounts from which Brightspot can perform federated search. Click the link and enter your credentials on the Shutterstock login page.
Slack
Workspaces List of workspaces in which Brightspot can perform federated search. For information about configuring a Slack workspace, see Configuring Slack federated search.
Tealium
Visitor ID Provider Not used.
Webhook Settings

Settings to connect to Tealium through a webhook.

  • Username—Username added to the webhook request.
  • Password—Password added to the webhook request.
  • Audience Size Grace Period—Number of months during which Brightspot does the following:

    • Uses the estimated Tealium audience size configured in Brightspot.
    • Accumulates visitor counts to determine the actual audience size.

    After the grace period, Brightspot uses the actual audience size.

Vimeo
Client ID
Client ID from the Vimeo console.
Client Secret
Client secret from the Vimeo console.
Number of Videos to Load Each Request Number of videos to retrieve in each federated search. For example, if you select 25, then Brightspot retrieves the first 25 matching videos, then the next 25, and so on. If blank, Brightspot retrieves 50 videos each batch.
YouTube
YouTube API Client

API client for connecting to YouTube. Each client requires the following:

  • Name—Name for the integration that appears in the Edit Global or Edit Site widget.
  • API Key—API key from the YouTube console.
  • Channel ID—Channel from which Brightspot performs federated search.

Global settings—CMS tab

Field
Description
Analytics
Task Host Host on which the task monitoring analytics accumulated by Brightspot runs.
Page Views Supplier

Source provider of page view data.

  • None—Page view data is collected by Brightspot Analytics, but not displayed on the Search results page.
  • Brightspot Analytics—Source of page views is the Brightspot server.
  • Google Analytics—Source of page views is Google Analytics.
Disable Analytics HTML Tag Writer If on, disables the JavaScript that collects page view data. Data remains uncollected until the script is re-enabled.
Video Analytics Supplier

Source provider of video view data.

  • None—Video view data is accumulated by Brightspot Analytics, but not displayed anywhere within Brightspot.
  • Brightspot Analytics—Source of video views is the Brightspot server.
Assignment Desk
Content Types Content types available for use with Assignment Desk.
Default Assignment Type Initial assignment type to use when creating a new assignment. (You can select a different assignment type when you actually create an assignment.)
Broadcast
Global Only If on, editors see the broadcast message only when working in the global site.
Broadcast Message
Message appearing on top of the header.
Broadcast Expiration Date and time when broadcast message expires. If blank, broadcast message has no expiration.
Content Templates
Global Defaults Globally available templates populated with default values. For details, see Content templates.
Global Extras Globally available templates populated with default values and labeled as a different content type. For details, see Content templates.
Site Specific Defaults Templates populated with default values for a specific site. For details, see Creating a site-level content template.
Site Specific Extras Templates populated with default levels and labeled as a different content type for a specific site. For details, see Creating a site-level content template.
DAM Asset Expiration Settings
(various) Configures emails notifying subscribers of assets about to expire. For detailed information, see Configuring asset expiration emails.
DAM Asset Request Approval Settings
(various) Configures emails notifying subscribers of approved asset requests. For detailed information, see Configuring asset request emails.
DAM Asset Share Settings
(various) Configures emails subscribers use to share an asset. For detailed information, see Configuring asset sharing emails.
DAM Asset Update Notification Settings
(various) Configures emails notifying subscribers that an asset has changed. For detailed information, see Configuring asset update notifications.
DAM Document Data Extraction Settings
Extractor Services Service for extracting content from a binary file, such as text from a PDF.
Dashboard
Default Dashboard Default dashboard for all roles and users. Users, roles, and sites with a default dashboard of None inherit this dashboard. For detailed information, see Dashboards.
Resources Default list of resources for the Resources widget. For detailed information, see Configuring the Resources widget.
Quick Start Settings List of content types and assets appearing in the Quick Start widget. For detailed information, see Adding, removing, or "favoriting" items in your Quick Start widget.
Bulk Upload Settings Sets the default file type in the Upload Files widget.
Email to CMS
Mail Content Mappings Settings for converting an incoming email into an asset. For detailed information, see Mail publishing.
Publish Immediately If toggled on, assets submitted to Brightspot over email are published immediately.
Mail Publisher Configuration for submitting content to Brightspot over email.
FTP
Configurations

Configurations for automatically ingesting files on an FTP server.

  • Name—Name for this configuration.
  • Server Address—Server’s host name.
  • Port—Port on which the FTP server is running.
  • Protocol—FTP or FTPS. Requires supplying a username and password.
  • Directory Paths—Directory on the server that Brightspot polls for files to ingest.
  • Delete Files After Import—If toggled on, Brightspot deletes files on the server after importing them.
  • Fetch Interval—Interval between Brightspot checks for new files on the server. If blank, Brightspot does not import files from the server.
Hunspell
Dictionaries List of dictionaries containing correctly spelled words. For detailed information, see Creating an auxiliary dictionary.
Natural Language Entities
Enable Natural Language Entities Activates a natural language process that scores the salience of terms relative to your content.
Minimum Value Minimum salience value to report. Lower numbers generally require longer processing times.
Notifications
System Notifications Notifications that Brightspot sends to a listserv email, Slack group, or SMS address. Editors subscribing to those services can listen for the notifications. For example, you can configure Brightspot to send a notification to the Slack channel #publications every time an editor clicks Publish. All editors subscribed to that slack channel see the notification.
Automatic User Subscriptions Notifications to which users are automatically subscribed. Users can opt out of these subscriptions.
Email Settings

Settings for sending emails from Brightspot.

  • Default From Email—From address appearing in emails sent from Brightspot, such as no-reply@brightspot.com.
  • Mail Provider Setting Key—Identifier of an email provider configured on the Brightspot server.
  • Additional Notification Emails—Additional email addresses to which Brightspot sends notifications; applicable only in development environments.
SMS Settings

Settings for sending text messages from Brightspot.

  • Default From Phone Number—Phone number from which Brightspot sends text message notifications. Must be a number registered with an SMS service for sending text messages. If blank, Brightspot uses the value configured for Dari.
  • Sms Provider Setting Key—Identifier of an SMS provider configured on the Brightspot server.
Preview
Preview To Edit If toggled on, editors can edit assets inside the preview pane.
Closed by Default For mobile devices, preview pane is closed by default. Enable this option for the preview pane to be closed by default for other devices.
Preview Types Previews generated by external applications, such as a GraphQL server.
Default Preview Type Default preview type from available preview types.
Preview Devices List of devices available in the preview pane. If blank, all devices are available.
RTE
Default Text Overlay CSS Default CSS statements for text overlaid on graphics. For example, color: white; sets the overlaid text in white.
Legacy HTML Provides backward compatibility for those projects using the old style of storing HTML from rich-text editors.
Enable Annotations Deprecated.
Enable Collaborative Editing If toggled on, editors can modify text simultaneously in the rich-text editor (similar to Google Docs).
Security
Two-Factor Authentication Required Default setting for requiring two-factor authentication when logging in.
Site Copier
Disallow Site Copy If toggled on, administrators cannot copy sites. For additional information, see Copying a site.
Copy Threshold Maximal number of assets Brightspot copies from the original site to the new site.
Social Publishing
Content Types List of content types for which social publishing is enabled.
Style Groups
Curated Style Groups Groups of module styles that editors can apply to multiple assets. For details, see Applying a module style.
Suggestions
Number of Suggestions Number of suggestions appearing in a drop-down list.
Show Suggested Owner Content Only If toggled on, the suggestions are taken from content associated with the current asset’s site.
Suggestion Provider One of the available providers that returns suggestions.
Translation
Available Locales Locales to which your content is translated.
Locale Groups Groups of locales. If you translate your content to multiple locales, it may be easier to manage them as a group.
Default Service Settings Settings for the default translation service. You can override these settings for individual translation jobs.
Type Settings

Translation settings for individual content types.

  • Types—Content types to which these settings apply.
  • Completion Action—Action Brightspot applies to a completed translation.
  • Service Settings—Settings for the translation service applicable to the selected content types.
UI
Common Times Static times for general usage, such as setting a daily column deadline to 3:30 PM. You can have these times appear in Brightspot.
Inline Editing

Items users can edit using the Inline Editor.

  • All Contents—Users can edit the asset and subsidiary assets. For example, if an article contains an author, the user can modify both the article and the author.
  • Only Main Content—Users can edit the asset but not its subsidiary assets.
  • Disabled—Inline editor is not available.

Users can override this setting at the user level; for details, see Creating a user.

Disable Viewers Disables the viewer mechanism.
Content Locking Applies various levels of content locking.
Inactivity Lock Timeout Number of minutes after which the locking editor navigated away from the browser tab that Brightspot removes the lock. For example, if Juan opened an article, and started working in a different browser tab, Brightspot removes the lock on the article after the specified number of minutes. The timer resets when Juan returns to the browser tab. Set to zero for no timeout.
Network Lock Timeout Number of minutes after which locking editor’s network connection ends (such as putting a laptop to sleep) that Brightspot removes the lock. Set to zero for no timeout.
Hard Lock Timeout
Number of hours after which Brightspot unconditionally removes a lock. Set to zero for no timeout.
Recent Revisions Banner Expiration Number of hours after which an unpublished revision no longer appears in the Recent Revisions Banner.
Allow Disable Unlocking

Allows editors in a role with the Disable Content Unlocking permission to prevent other editors without the permission Disable Content Unlocking from unlocking an asset they opened. Editors disable content unlocking by clicking a link in the message area.

Example:

  • Juan and Julie have the permission Disable Content Unlocking.
  • John does not have the permission Disable Content Unlocking.
  • Juan opened an article, and clicked the link to disable content unlocking.

In this scenario—

  • Julie can unlock the asset because she has the Disable Content Unlocking permission.
  • John cannot unlock the asset because he does not have the Disable Content Unlocking permission.

(This setting does not override the effect of Inactivity Lock TimeoutNetwork Lock Timeout, and Hard Lock Timeout.)

Disable Search Term Highlighting In search results, the search term is not highlighted in yellow.
Enable Calendar Search Result View Changes the view for the editorial calendar widget.
Enable Padded Crop Deprecated.
Disable Video Editor UI Disables video editing functionality.
Display Tabs as Tabs By Default If toggled on, tab labels are always visible; if toggled off, tab labels are visible as a menu.
List Gallery Default View Changes default view in a gallery from grid view to list view.
Localization Bundles Customized labels for Brightspot’s widgets.
Enable Sticky Search Filters Retains values for common search filters when searching for a different content type. For example, if you first search for articles with status Draft, and then search for images, the setting for status remains Draft.
Enable Pre Publish Actions If toggled on, Brightspot provides cues for updating an asset's fields (such as promo overrides) before actually publishing the asset. For more information, see Pre-publishing actions.
Enable Post Publish Actions If toggled on, Brightspot provides suggestions for placing assets after they are published. For more information, see Post-publishing actions.
Open Post Publish Actions Automatically If toggled on, Brightspot displays the widget for post-publish actions after the asset is first published. If toggled off, editors can still access post-publish actions by clicking more_horiz > Post Publish Actions. For more information, see Post-publishing actions.
Conversation Types List of content types for which the conversation widget is available in the content edit page. If blank, conversation is available for all content types. For more information, see Sending and viewing messages through Conversation.
Watching Search Result Filter Enabled If toggled on, the legacy Watching filter is available in the search panel’s results; editors can filter search results for only the assets they are watching.
Watching Search Filter Disabled If toggled off, the Watching filter appears in the search panel’s Misc Filters widget; editors can filter search results for only the assets they are watching.
Advanced
Default Task Host Default host on which various background tasks run. Brightspot assumes all background tasks are running on this host unless you specify a different one for a particular task.
Disabled Plugins List of installed plugins that are disabled.
Single Generated Permalink Forces a newly generated permalink to replace any existing permalinks.
Extra CSS Additional lines of CSS code that impact the Brightspot GUI. For example, the statement label {text-decoration: underline;} underlines all field labels in the Brightspot GUI.
Extra Java Script Lines of JavaScript code that run every time you load a page in Brightspot. For example, the statement alert('Good morning!'); displays an alert message every time you load the Dashboard, content edit form, or any other page.
Use Non Minified CSS Displays linked CSS files in pretty print. Applies to viewing page sources within Brightspot. For example, if you load the Dashboard, view source, and view the linked CSS files, those files appear in pretty print. This setting has no effect on the built file All.min.css, which is always uglified.
Use Non Minified Java Script Displays linked JavaScript files in pretty print. Applies to viewing page sources within Brightspot. For example, if you load the Dashboard, view source, and view the linked JavaScript files, those files appear in pretty print. This setting has no effect on the built file All.min.js, which is always uglified.
Disable Automatically Saving Drafts Deprecated.
Enable Ajax Saves Deprecated. Use instead Disable Work in Progress.
Disable Types Not Associated with Java Classes Prevents models not associated with a class from appearing in the Brightspot GUI. For example, if you renamed a class Cookies to Cake, Cookies does not appear in the Brightspot GUI.
Disable Configurable Search Filters If toggled off, editors can move the search panel’s common filters to a collapsible list.
Trailing Slash Configuration

Configures the conditions for appending or removing a trailing slash from a URL.

  • Do Not Change—Incoming URLs not changed.
  • Remove—Removes trailing slashes from incoming URLs unless an asset already exists at the modified URL.
  • Normalize—Changes the incoming URL to an existing one (if possible).
Disable Tool Checks Deprecated.
Allow Insecure Authentication Cookie Deprecated.
Display Site in Search Result Adds a Site column to the search panel. This column indicates to which site a found asset belongs.
Always Generate Permalinks Always generates new permalinks and retains previous ones. For example, Brightspot often creates permalinks from the headline field. If an asset’s first draft has a headline cookies, the first permalink is /cookies. If the asset’s second draft has a headline cakes, the asset now has two permalinks: /cookies and /cakes.
Disable Edit Field Update Cache Deprecated. Replaced by Disable Rtc.
Dari Settings List of key-value pairs for interacting with Dari.
Enable Cross Domain Inline Editing Inline Editor appears for all elements on a page, even those belonging to a different domain. Useful when you log in to Brightspot at one domain (such as bsp.example.com) but publish to a different domain (such as www.example.com).
Disable Rtc Disables the real-time communication (RTC) platform between the browser and the server. Several features rely on this platform, such as Viewers, so disabling RTC disables these features. Useful for debugging as RTC frequently changes the state of several system elements and thereby masks the sources of bugs.
Disable Invisible Content Preview Disables the display of invisible content, such as archived assets, in the Preview Pane. For example, an author is associated with an article, and the author’s record is subsequently archived. The author is still visible in the preview pane—but not in the published version. Marking this option prevents the archived author from appearing in the preview pane.
Disable Work in Progress As users type in the content edit form, Brightspot saves the incremental changes even before they click one of the save buttons in the Publish widget. Marking this option disables those interim saves.
Use Old History Index
Provides backward compatibility for those projects using the old indexing of History objects.
Use Old Taxonomy Children Detection Provides backward compatibility for those projects using the old indexing of objects implementing the Taxon interface.
Use Old Directory Paths Predicate

When querying for objects with a path:

  • If on, appends legacy predicate paths != missing.
  • If off, appends current predicate hasPath = true.
Use Legacy Settings Site Switching Deprecated.
Use Legacy Search With Content If toggled on, Brightspot appends query parameters to links in the search panel. Deprecated.
Auto Increment Permalinks Brightspot automatically appends an incremental number to a permalink if necessary to prevent a duplicate URL.

Global settings—Social tab

Field
Description
Social Links
(various) Usernames for various social networks. These usernames typically appear in the footer.
Previous Topic
Customizing Brightspot's labels
Next Topic
Customizing Brightspot's appearance
Was this topic helpful?
Thanks for your feedback.