Topics

Site settings


In This Guide

Setting hierarchy

There are several levels of entities in Brightspot, each with its own level of settings. System administrators can make settings at the top-most level, and then override those settings at the site, role, and user levels.

Site hierarchy

Referring to the previous diagram, there are three groups of settings.

  • Role and user settings—These settings impact how users work with Brightspot. The settings in this group include the dashboard’s appearance, two-factor authentication, and notifications. Many of these settings can be overridden at the role and user level.
  • Site settings—These settings include how a site’s widgets appear within Brightspot, the URLs with which the site is associated, and some security settings. Many of these settings can be overridden at the site level.
  • System-wide settings—These settings include broadcast messages, debugging settings used by developers, integration settings with other web services, and general configuration. These settings cannot be overridden.

Advanced Brightspot deployments have richer hierarchies that define settings at site-role pairs, site-role-content type triplets, and other combinations.


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
NameName for global site.
URLGlobal site’s protocol and domain, such as https://global.brightspot.com.
Company NameCompany 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 LogoCompany logo. Appears in the header next to the Navigation Menu. Overrides company name.
Background ImageBackground image for login page. If set to None, a standard Brightspot image appears.
EnvironmentName 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 Overview of 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 EditingEditors logged in to the Global site can edit content associated with any other site. Overrides access permission set at item level.
AuthenticatorsService for authenticating users attempting to log in to Brightspot.
ThemeDefault theme for all sites. You can override this setting at the site level.

Global settings—Front-End tab

Field
Description
Cascading Settings AlgorithmPriority by which Brightspot applies front-end settings in the content hierarchy.
Logos & Icons
LogoSite’s logo. Typically appears in the top left corner of each page.
News Publisher LogoRenders a site logo that complies with width and height restrictions for AMP.
FaviconSite’s favicon appearing in browsers and some mobile apps. Use .png or .jpg files.
Favicon IcoSite’s favicon appearing in browsers and some mobile apps. Use .ico files.
Layout
HatSite’s hat.
NavigationSite’s navigation.
FooterSite’s hat.
AboveContent appearing in the above block on all the site’s page.
AsideContent appearing in the aside block on all the site’s page.
BelowContent appearing in the below block on all the site’s page.
Search PagePage that lists results when a visitor searches for content.
Type Specific Overrides
Type Specific OverridesLogos, icons, and layouts applicable to specific content types. Configurations in these fields override settings in the Logos & Icons and Layouts accordions.
Access
Access SubstitutionItem 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 item even if the visitor does not have access to it.
  • External Redirect—Redirects the visitor to a URL.
  • Internal Redirect—Displays a selected item only if the visitor has access to it.
Subscription PlansSubscriptions available to visitors to view specific content on your site.
Action Bar
Default Action BarSite’s default action bar. Appears on all of the site’s assets unless overridden for a content type.
Tracking Parameter NameTracking parameter appended to URLs for items shared from the action bar.
Type Specific OverridesAction bars applicable to specific content types for this site. Overrides Default Action Bar.
Ads
Disable Ads Parameter ValueValue in a query string that blocks an ad feed.
Ad SizesList of available ad sizes on this site.
CMS Preview Disabled Ad SizesList of ad sizes that are not populated with ads in the preview pane.
Ad ModulesList of Ad Sense or Ad Manager modules available for this site. Requires active accounts with these Google services.
Authentication
Authentication SettingsList of standard authentication managers used to authenticate access to your site, such as when a visitor attempts to log in to your site.
Community
Commentable TypesContent types to which visitors can post comments.
Email to CMS
Mail Content MappingsSettings for converting an incoming email into an asset.
Publish ImmediatelyIf toggled on, Brightspot immediately publishes an asset converted from an email.
Error
Error HandlersList of HTTP error or status codes and associated pages that visitors receive.
Facebook
Instant Article SettingsSettings for generating Facebook Instant Articles from Brightspot.
Form CAPTCHA
ProviderConfiguration for adding a reCAPTCHA control on forms.
Google Calendar
Max Event ResultsMaximum number of events Brightspot imports, per user, into an intranet’s calendar.
Open Graph
Default Open Graph ImageImage appearing in social networks when an item is shared.
OpenAir
(various)Settings for configuring an integration with OpenAir.
Permalinks
Permalink Rule OverridesConfigures how Brightspot generates permalinks for a site-content type combination. For each content type, you can configure one of the following rules:
  • Default Permalink Rule—Brightspot generates permalinks from an item’s slug.
  • No Permalink Rule—Brightspot does not automatically generate a permalink; editors must manually create permalinks for each item.
  • Section Prefix Permalink Rule—Brightspot generates permalinks from a combination of the section’s slug and the item’s slug.

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 ProviderService providing push notifications.
Device Registration Shared KeyNot used.
Enable NotificationActivates the push service on the Brightspot server.
Default Publishing TargetsList of publishing targets, such as AWS SNS topics, to which Brightspot sends notifications.
iOS Registration TargetList of publishing targets on the Apple Push Notification Service. These targets provide a native iOS user experience.
Android Registration TargetList of publishing targets on Google’s Firebase Cloud Messaging. These targets provide a native Android user experience.
Amazon Registration TargetList of publishing targets on Amazon Device Messaging. These targets provide native user experiences on Amazon devices such as Fire tablets.
iOS PayloadiOS-specific key-value pairs included with the message sent from the notification service provider.
Android PayloadAndroid-specific key-value pairs included with the message sent from the notification service provider.
Amazon PayloadAWS-specific key-value pairs included with the message sent from the notification service provider.
RSS Settings
Disable FeedIf toggled on—
  • Brightspot stops populating your site’s RSS feed.
  • Removes the existing feed and its previously included items.
CopyrightCopyright notice appearing in the feed’s copyright tag, which not all RSS readers display.
Default To Atom Auto DetectIf toggled on, the feed is a discoverable Atom feed. If toggled off, the feed is a discoverable RSS feed.
Type Specific Feed OverridesFeed 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 item—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 AnalyticsNot used.
SEO
robots.txtLines to includes in the site’s robots.txt file. For detailed information about this file, see Robots.txt Specifications.
Sitemap Settings
Site Map TypesOne of the standard sitemap types.
Site Map Default URLDefault URL appearing in the site’s sitemap.
Tag Manager
Tag ManagerGoogle Tag Manager applicable to this site.
Video
Video Frontend SettingsSettings 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
LocalePublished site’s language and location. The site’s appearance changes to reflect the selected locale.
Time ZoneTime 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 item at 9:00 AM. In addition, you set this field to Europe/London. In this case, Brightspot renders , indicating the item was published at 2:00 PM.
Default Date Time FormatPattern that configures the site’s date and time format.
Web App ManifestWeb app manifest delivered to clients from this site.
Browser ConfigThe browserconfig file delivered to clients from this site.

Global settings—Integrations tab

Field
Description
IntegrationsList of third-party apps with which the site interacts. Examples include Google’s AdSense and Video Analytics.
Disable Third Party Parameter ValueValue in a query string that blocks interacting with the third-party app.
Adobe AEM
SettingsSettings for synchronizing between Adobe Experience Manager and Brightspot.
Adobe Stock
Adobe Stock API ClientAPI 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
Search SourcesSearch engines from which traffic arrives to the item. If blank, Brightspot tracks incoming traffic referred by Google, Bing, and Yahoo. You can override this setting at the site level.
Social SourcesSocial networks from which traffic arrives to the item. 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 TaskPrevents Brightspot from collecting and reporting Jira data at the individual user level.
AWS Comprehend
RegionAWS region to use when making requests to the service. If blank, Brightspot reads the region from a configuration file.
LanguageLanguage of the text that will be sent to AWS Comprehend. Defaults to English.
Minimum Key Phrase ConfidenceMinimum 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 ConfidenceMinimum 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 PlayerPlayer to use when delivering videos from AWS Elemental. If blank, Brightspot sends the Plyr player.
RegionAWS region to use when making requests to the service. If blank, Brightspot reads the region from a configuration file.
AWS Elemental MediaConvert
Transcoding SettingsTranscoding settings for converting videos using MediaConvert.
Enable MediaConvert ServiceIf toggled on, Brightspot sends videos to the MediaConvert service.
MediaConvert Role ARNARN for the MediaConvert role. This value is taken from your AWS console.
MediaConvert SQS Queue NameMediaConvert 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 Mediative
Save Live-to-VOD as draftSaves the live video steam in Brightspot so you can edit or publish it later.
Create Live-to-VOD From The Backup ChannelSaves the media stream using the steam’s backup channel.
Enable Media Live ServiceIf toggled on, you can stream live videos through MediaLive.
Media Live Role ARNARN for the MediaLive role. This value is taken from your AWS console.
AWS Elemental MediaTailor
MediaTailor Configuration for VODConfiguration for video-on-demand.
MediaTailor Configuration for Live (MediaStore)Configuration for live video streams.
Enable MediaTailor ServiceIf toggled on, the MediaTailor service delivers personalized ads to your videos published with Brightspot.
AWS Rekognition
RegionAWS region to use when making requests to the service. If blank, Brightspot reads the region from a configuration file.
AWS Rekognition (Image)
Enable Rekognition Image ServiceIf toggled on, Brightspot sends images to the Rekognition service, and receives corresponding text.
Minimum Label ConfidenceConfidence level for detecting objects, concepts, and scenes in an image. If blank, defaults to 0.50.
Minimum Text ConfidenceConfidence level for detecting text in an image. If blank, defaults to 0.50.
Minimum Celebrity ConfidenceConfidence level for detecting a celebrity in an image. If blank, defaults to 0.50.
Minimum Moderation Label ConfidenceConfidence level for detecting unsafe content in an image. If blank, defaults to 0.50.
AWS Rekognition (Video)
Enable Rekognition Video ServiceIf toggled on, Brightspot sends videos to the Rekognition service, and receives corresponding text.
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 NameAWS SQS queue that Brightspot polls to determine when a video’s processing is complete. This value is taken from your AWS console.
Topic ARNARN of the topic providing this service.
Role ARNARN of the role with access to this service.
Minimum Label ConfidenceConfidence level for detecting objects, concepts, and scenes in a video. If blank, defaults to 0.50.
Minimum Moderation Label ConfidenceConfidence level for detecting unsafe content in a video. If blank, defaults to 0.50.
AWS SES
Enable Bounce and Complaint Notification ServiceIf toggled on, Brightspot accesses the SES service to retrieve bounce and complaints notifications generated by other AWS services.
Bounce Notification SQS Queue NameAWS SQS queue that Brightspot polls to retrieve notifications regarding bounced emails. This value is taken from your AWS console.
Complaint Notification SQS Queue NameAWS SQS queue that Brightspot polls to retrieve complaints regarding outbound emails. This value is taken from your AWS console.
AWS SQS
RegionAWS region to use when making requests to the service. If blank, Brightspot reads the region from a configuration file.
AWS Textract
Enable Textract ServiceIf toggled on, Brightspot sends documents to the Textract service, and receives extracted text.
SQS Queue NameAWS SQS queue that Brightspot polls to determine when an extraction is complete. This value is taken from your AWS console.
Topic ARNARN of the topic providing this service.
Role ARNARN of the role with access to this service.
Minimum Block ConfidenceConfidence level for accurately extracting text. If blank, defaults to 0.50.
AWS Transcribe
Enable Transcribe ServiceIf toggled on, Brightspot sends audio and video files to the Transcribe service, and receives the transcription.
SQS Queue NameSQS queue that Brightspot polls to determine when a transcription is complete. This value is taken from your AWS console.
RegionAWS region to use when making requests to the service. If blank, Brightspot reads the region from a configuration file.
Transcribe SettingsSettings indicating the languages in which you submit audio or video files.
AWS Translation
Input BucketAWS bucket to which Brightspot pushes items to be translated.
Output BucketAWS bucket containing translated items.
Translation Role ArnARN of the topic providing this service.
Aws RegionAWS region to use when making requests to the service. If blank, Brightspot reads the region from a configuration file.
Disable Translation Update TaskIf toggled on, Brightspot does not continually monitor the progress of translation jobs.
All Async ProcessingIf toggled on, Brightspot processes the translations in an asynchronous matter. Editors can proceed to other tasks and return to the translated item to view the results.
Task HostBrightspot task that monitors translation progress.
Box
Client IDClient ID from your Box console.
Client SecretClient 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.
SettingsSettings for connecting to and interacting with Brightcove.
Dropbox
Dropbox Application KeyApplication key from your Dropbox console.
Application SecretApplication secret from your Dropbox console.
Facebook
Facebook App Access TokenAccess token from your Facebook console.
Facebook settingsSettings 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 KeyAPI key from your Giphy console.
Use Still Images for Search PreviewIf toggled on, Brightspot displays a still image in the search panel instead of the animated image.
Google
Google Server API KeyAPI key from your Google console.
Task HostTask host that ingests output from Google services, such as DFP or Google Analytics.
Drive Client IDDrive client ID from your Google console.
Drive Client SecretDrive client secret from your Google console.
Google Analytics
Metrics To DisplayMetrics appearing in the Edit Page’s Analytics widget. If blank, all metrics appear.
CredentialsCredential key from your Analytics console.
View IDView ID from your Analytics console.
Page ReportIf toggled on, Brightspot imports page-specific analytics. If toggled off, Brightspot analytics for the site as a whole.
Site ReportsOne 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.
Analytics Import Task ScheduleCron 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.
Historical Days To ImportNumber of days’ analytics to import into Brightspot.
Google DFP
DFP Tag ImportDocument header script. You can generate the script using Ad Manager Tag Generator & Tester.
Window SizesList of window sizes to which DFP sends ads.
Lingotek
Client IDClient ID from your Lingotek console.
Community IDCommunity ID from your Lingotek console.
Mail Publishing
S3regionAWS region to use for mail publishing. If blank, Brightspot reads the region from a configuration file.
Queue NameAWS SQS queue that Brightspot polls for bounce and complaint notifications. This value is taken from your AWS console.
Marketo
Enable ImportIf toggled on, Brightspot imports forms from Marketo.
Fetch SizeNumber of forms to import in a retrieval.
AccountsConfigures Marketo accounts from which to import forms.
Notifications
Slack SettingsList of configured Slack message formatters.
Shutterstock
Shutterstock API ClientAPI 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
WorkspacesList of workspaces in which Brightspot can perform federated search. For information about configuring a Slack workspace, see Configuring Slack federated search.
Tealium
Visitor ID ProviderNot used.
Webhook SettingsSettings to connect through a Tealium 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 RequestNumber 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, the default batch size is 50.
YouTube
YouTube API ClientAPI 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 HostTask host that monitors analytics accumulated by Brightspot.
Page Views SupplierSource 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 ScriptsIf on, disables the JavaScript that collects page view data. Data remains uncollected until the script is re-enabled.
Video Analytics SupplierSource 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 TypesContent types available for use with Assignment Desk.
Default Assignment TypeInitial assignment type to use when creating a new assignment. (You can select a different assignment type when you actually create an assignment.)
Broadcast
Global OnlyIf on, editors see the broadcast message only when working in the global site.
Broadcast Message
Message appearing on top of the header.
Broadcast ExpirationDate and time when broadcast message expires. If blank, broadcast message has no expiration.
Content Templates
Global DefaultsGlobally available templates populated with default values. For details, see Content templates.
Global ExtrasGlobally available templates populated with default values and labeled as a different content type. For details, see Content templates.
Site Specific DefaultsTemplates populated with default values for a specific site. For details, see Setting a site-level content template.
Site Specific ExtrasTemplates populated with default levels and labeled as a different content type for a specific site. For details, see Setting a site-level content template.
DAM Asset Expiration Settings
(various)Configures emails notifying subscribers of assets about to expire.
DAM Asset Request Approval Settings
(various)Configures emails notifying subscribers of approved asset requests.
DAM Asset Share Settings
(various)Configures emails subscribers use to share an asset.
DAM Asset Update Notification Settings
(various)Configures emails notifying subscribers that an asset has changed.
DAM Document Data Extraction Settings
Extractor ServicesService for extracting text from a binary file such as a PDF.
Dashboard
Default DashboardDefault dashboard for all roles and users. Users, roles, and sites with a default dashboard of None inherit this dashboard.
ResourcesDefault list of resources for the Resources widget.
Quick Start SettingsList of content types and items appearing in the Quick Start widget.
Bulk Upload SettingsSets the default file type in the Upload Files widget.
Email to CMS
Mail Content Mappings
Publish ImmediatelyIf toggled on, assets submitted to Brightspot over email are published immediately.
Mail PublisherConfiguration for submitting content to Brightspot over email.
FTP
ConfigurationsConfigurations 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
DictionariesList of dictionaries containing correctly spelled words.
Natural Language Entities
Enable Natural Language EntitiesActivates a natural language process that scores the salience of terms relative to your content.
Minimum ValueMinimum salience value to report. Lower numbers generally require longer processing times.
Notifications
System NotificationsNotifications 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 SubscriptionsNotifications to which users are automatically subscribed. Users can opt out of these subscriptions.
Email SettingsSettings 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 EditIf toggled on, editors can edit items inside the preview pane.
Closed by DefaultFor mobile devices, preview pane is closed by default. Enable this option for the preview pane to be closed by default for other devices.
Preview TypesPreviews generated by external applications, such as InDesign or a GraphQL server.
Default Preview TypeDefault preview type from available preview types.
Preview DevicesList of devices available in the preview pane. If blank, all devices are available.
RTE
Default Text Overlay CSSDefault CSS statements for text overlaid on graphics. For example, color: white; sets the overlaid text in white.
Legacy HTMLProvides backward compatibility for those projects using the old style of storing HTML from rich-text editors.
Enable AnnotationsDeprecated.
Enable Collaborative EditingIf toggled on, editors can modify text simultaneously in the rich-text editor (similar to Google Docs).
Security
Two-Factor Authentication RequiredDefault setting for requiring two-factor authentication when logging in.
Site Copier
Disallow Site CopyIf toggled on, administrators cannot copy sites. For additional information, see Copying a site.
Copy ThresholdMaximal number of items Brightspot copies from the original site to the new site.
Social Publishing
Content TypesList of content types for which social publishing is enabled.
Style Groups
Curated Style GroupsGroups of module styles that editors can apply to multiple assets. For details, see Reusing module styles with style groups.
Suggestions
Number of SuggestionsNumber of suggestions appearing in a drop-down list.
Show Suggested Owner Content OnlyIf toggled on, the suggestions are taken from content associated with the current item’s site.
Suggestion ProviderOne of the available providers that returns suggestions.
Translation
Available LocalesLocales to which your content is translated.
Locale GroupsGroups of locales. If you translate your content to multiple locales, it may be easier to manage them as a group.
Default Service SettingsSettings for the default translation service. You can override these settings for individual translation jobs.
Type SettingsTranslation 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 TimesStatic 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 item and subsidiary items. For example, if an article contains an author item, the user can modify both the article and the author.
  • Only Main Content—Users can edit the item but not its subsidiary items.
  • Disabled—Inline editor is not available.

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

Disable ViewersDisables the viewer mechanism.
Content LockingApplies various levels of content locking.
Inactivity Lock TimeoutNumber 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 TimeoutNumber 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 ExpirationNumber 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 item 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 item because she has the Disable Content Unlocking permission.
  • John cannot unlock the item 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 HighlightingIn search results, the search term is not highlighted in yellow.
Enable Calendar Search Result ViewChanges the view for the editorial calendar widget.
Enable Padded CropDeprecated.
Disable Video Editor UIDisables video editing functionality.
Display Tabs as Tabs By DefaultIf toggled on, tab labels are always visible; if toggled off, tab labels are visible as a menu.
List Gallery Default ViewChanges default view in a gallery from grid view to list view.
Localization BundlesCustomized labels for Brightspot’s widgets.
Enable Sticky Search FiltersRetains 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.
Watching Search Result Filter EnabledIf toggled on, the legacy Watching filter is available in the search panel’s results; editors can filter search results for only the items they are watching.
Watching Search Filter DisabledIf toggled off, the Watching filter appears in the search panel’s Misc Filters widget; editors can filter search results for only the items they are watching.
Advanced
Disabled PluginsList of installed plugins that are disabled.
Single Generated PermalinkForces a newly generated permalink to replace any existing permalinks.
Extra CSSAdditional 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 ScriptLines 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 CSSDisplays 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 ScriptDisplays 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 DraftsDeprecated.
Enable Ajax SavesDeprecated. Use instead Disable Work in Progress.
Disable Types Not Associated with Java ClassesPrevents 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 FiltersIf toggled off, editors can move the search panel’s common filters to a collapsable list.
Trailing Slash ConfigurationConfigures 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 ChecksDeprecated.
Allow Insecure Authentication CookieDeprecated.
Display Site in Search ResultAdds a Site column to the search panel. This column indicates to which site a found item belongs.
Always Generate PermalinksAlways generates new permalinks and retains previous ones. For example, Brightspot often creates permalinks from the headline field. If an item’s first draft has a headline cookies, the first permalink is /cookies. If the item’s second draft has a headline cakes, the item now has two permalinks: /cookies and /cakes.
Disable Edit Field Update CacheDeprecated. Replaced by Disable Rtc.
Dari SettingsList of key-value pairs for interacting with Dari.
Enable Cross Domain Inline EditingInline 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 RtcDisables 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 PreviewDisables the display of invisible content, such as archived items, 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 ProgressAs 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 DetectionProvides backward compatibility for those projects using the old indexing of objects implementing the Taxon interface.
Use Old Directory Paths PredicateWhen querying for objects with a path:
  • If on, appends legacy predicate paths != missing.
  • If off, appends current predicate hasPath = true.
Use Legacy Settings Site SwitchingDeprecated.
Use Legacy Search With ContentIf toggled on, Brightspot appends query parameters to links in the search panel. Deprecated.
Auto Increment PermalinksBrightspot 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.

Spelling, dictionaries, locales

With the introduction of word processors in the 1980s, spelling has become quite a bit easier, particularly with hard-to-spell languages such as English. Today, almost any app in which you type also includes a dictionary with standard words. As you type, the app shows misspelled words with a red underline.

Spelling_1.png

If you work in a technical field with a specialized vocabulary, the chances are that some of the words you use are not in the app’s dictionary, so those words are marked as misspelled.

Spelling_2.png

In the previous example, Musa is a technical term not in the standard English dictionary, but it is not misspelled. You can add technical words such as Musa to an auxiliary dictionary so that they are not marked as misspelled.

In addition, apps provide dictionaries for almost every language. If you are typing an article in Spanish, you can use the app’s Spanish dictionary, and add technical words to that dictionary as well.

Locales

In different parts of the world, there are differences in written communication—even within the same language. A date, number, or spelling may be different in one region compared to another.

Locales_1.png

Apps group customary presentations for spellings, numbers, dates, and currency symbols into locales—a language-country pair. In Brightspot, you can see all the available locales in your profile widget.

Locales_2.png

When you change the locale, Brightspot’s widgets change to match the locale’s settings. In particular, Brightspot uses the locale’s dictionary for text you type.

Dictionary selection

The following diagram illustrates how Brightspot determines which dictionary to use as you type in the content edit form.

Dictionary Selection.png

For example, if your locale is English (United Kingdom), Brightspot assumes that all the words you type are in the UK dictionary. If that dictionary is installed in Brightspot, spelling errors are caught accordingly. If that dictionary is not installed in Brightspot, your browser checks for spelling errors using its own dictionary.

(Dictionaries and spelling in browsers is a very complicated topic. Some browsers have dictionaries installed for several languages. Those browsers automatically detect in which language you are typing, and use the corresponding dictionary for spelling. If the browser cannot detect the language you are using, it may assume you are using a default dictionary and mark every word as misspelled, or it may not perform spell check at all. See your browser’s user guide for information about how it checks spelling.)

Detecting misspelled words

Your version of Brightspot may have several language dictionaries installed as well as auxiliary dictionaries with technical terms for those languages. The following diagram illustrates the logic Brightspot uses to detect misspelled words among all those dictionaries.

Misspelled Words.png

For example, you are working in the English-Australia locale, and you type I saw the movie Breaker Morant.

  1. Brightspot looks in the standard English-Australia dictionary, and does not find the word Morant.
  2. Brightspot then looks in the auxiliary dictionary for English-Australia (if you created one), and again does not find the word Morant.

In this case, Brightspot marks the word Morant as misspelled.


Create an auxiliary dictionary

Brightspot comes with spell-check dictionaries for English and Spanish. (Your Brightspot developer can add additional languages.) These dictionaries contain standard words, and Brightspot checks your text against those dictionaries. Words not in those dictionaries are marked as misspelled.

If you use non-standard terminology, such as technical terms or product names, Brightspot marks those terms as misspelled. If you add such terms to an auxiliary dictionary, Brightspot recognizes them as spelled correctly.

Auxiliary dictionaries are specific to your profile’s locale. If you are creating content in US English, you add terms to that locale’s auxiliary dictionary; if you are creating content in Mexican Spanish, you add terms that locale’s auxiliary directory.

To create an auxiliary dictionary:

  1. Click menu > Admin > Sites & Settings.
  2. In the Sites widget, select Global. The Edit Global widget appears.
  3. Under CMS, expand Hunspell.
  4. Under Dictionaries, click add_circle_outline, and select Create New. A New Hunspell Dictionary content edit page appears.

    Auxiliary Dictionary_1.png

  5. In the Name field, type a name for the dictionary.
  6. From the Locale list, select the language for which the dictionary is applicable.
  7. In the Additional Words list, type a word. Click add to add additional words.
  8. Click Save.
  9. Click Back. You return to the content picker.
  10. In the content picker, select the name of the dictionary you created.
  11. Close the content picker. You return to the Edit Global widget.

    Auxiliary Dictionary_2.png

  12. Click Save.

As you type text in various Brightspot fields, words appearing in the dictionaries are not marked as misspelled.

Auxiliary Dictionary_3.svg


JSON-LD

JavaScript Object Notation-Linked Data (JSON-LD) is a specification for helping search engines understand the content of your assets. After reading the JSON-LD, search engines can display your web page in an enhanced format. The following are examples of presentations that Google applies when reading JSON-LD.

Rich results

Rich results provide a preview of the entire asset directly inside search results.

JSON-LD Rich Result

Product reviews

Google aggregates product reviews from various sources, and summarizes them inside the search results.

JSON-LD product reviews

Knowledge graph cards

Knowledge graph cards appear to the right of search results.

JSON-LD knowledge graph

The following resources provide additional information about JSON-LD.


Embed JSON-LD in your assets

You can embed JSON-LD in your assets to improve presentation in search engines' results.

When you enable the JSON-LD plugin, Brightspot inserts abbreviated JSON-LD markup into all your site's pages. You can configure Brightspot to insert extended JSON-LD markup for specific content types.

To embed extended JSON-LD:

  1. Click menu > Admin > Sites & Settings.
  2. In the Sites widget, click the site for which you want to embed JSON-LD, or click Global to configure JSON-LD for all your sites.
  3. Under Front-End, expand JSON-LD.
  4. From the Types list, select the content types for which you want to embed JSON-LD.
  5. From the Organization list, select Set. A form appears.
  6. In the Name field, enter the name that appears in the rich result.
  7. In the URL field, enter the URL the browser loads when a visitor clicks on the search result.
  8. From the Logo field, select Shared or One-Off, and select an image that appears in the rich search result.
  9. Under Social Links, do the following:
    1. Click add_circle_outline. An External form appears.
    2. In the URL field, enter your publication’s site on social networks.
    3. Repeat to add additional URLs on social networks.
  10. Click Save.