request a demo
PRODUCTS
FEATURES
SOLUTIONS
CASE STUDIES
DOCUMENTATION
BLOG
Editorial Guide
Introduction
What is Brightspot
Advantages
Get Started
Brightspot Demo Installation
Using Docker Platform
1. Download and Install the Docker Platform
2. Install Brightspot
3. Start an Instance of Brightspot
4. Using Brightspot
Using Docker Toolbox
1. Download and Install the Docker Toolbox
Dashboard
Common Content
Work Streams Widget
Bulk Upload
Recent Activity
Scheduled Events
Drafts
Sitemap
Resources
Adding the Resources Widget to the Dashboard
Adding Bookmarks to the Resources Widget
Selections
Custom Dashboards
Dashboard Scoping
Setting a Dashboard
Shared Dashboards
One-off Dashboards
Publishing Concepts
Page Structure
Header
Footer
Main
Content Hierarchy
Overview of the Brightspot Hierarchy
Implementing Content Hierarchy
Publishing Process
Overview
Publishing Workflows
Creating Content
Reviewing Content
Publishing Content
Archiving Content
Creating Content
Content States and Actions
Content Actions and States
Content States
Working with Drafts
Creating Drafts
Viewing a Draft
Merging Drafts
Deleting Drafts
Using Workflows
Previewing Content
Rich Text Editor
Text Formatting
HTML Markup
Lists
Text Alignment
Copy Editing
Tables
Keyboard Shortcuts
Adding External Content
Content Templates
Types of Content Templates
Understanding the Hierarchy of Content Templates
Content Templates at the Site Level
Content Templates at the Role Level
Content Templates at the User Level
Deleting Content Templates
Maps, Locations, and Regions
Locations
Regions
Inline Editing
Search Engine Optimization
<title> and <meta> Tags
Open Graph Properties
How Brightspot Populates SEO Text
URL Management
Types of URLs
Permalinks
Multi-Site and URLs
Manually Adding URLs
Redirect URLs
Wildcard URLs
Deleting URLs
Publishing to a Live Site
Working with Schedules
Scheduling a Single Item
Publishing a Scheduled Item Immediately
Bulk Scheduling of Multiple Items
Editing or Deleting Bulk Schedules
Deleting or Archiving Content
Revisions
Understanding the Revisions Widget
Retrieving Previous Revisions
Modifying Previous Revisions
Naming or Renaming a Revision
Comparing Revisions
Images
Adding an Image to Brightspot
Viewing an Image’s Information
Preparing an Image for Publication
Editing an Image
Setting a Focus Point
Cropping an Image
Resetting a Crop
Annotating an Image
Themes
Overview of Themes
Page Layout
Styling
Behavior
Using Themes
Uploading a New Theme
Upgrading a Theme to New Release
Changing to a Different Theme
Changing a Site’s Theme
Testing Development Versions of a Theme
Overriding Themes at the User Level
Components
Overview
Ads
Error Modules
Freeform
Creating a Freeform Module
Freeform Theming Tutorial
Galleries
Lists
Basic Lists
Advanced Lists
Downloads
Dynamic Lists
Dynamic Social Feed
Playlist Videos
Personalized Content
Promos
Creating a Promo Module
Promo Theming Tutorial
Rich Text
Search
Shared
Stock Tickers
Tabs
Recipes
Common Components
Ingredients
Creating a New Site
Adding a Header and Footer
Adding an Action Bar
Adding a Favicon
Elements in Page Structure
Blogs
YouTube Clone
Search
Full-Text Search
Filtering Search Results
Advanced Query Search
Search Display Options
Sorting Retrieved Items
Adding Fields to Listing
Setting Items Per Page
Paging Through Search Results
Setting Display Mode
Filtering for Watched Items
Full screen
Saving Searches and Using Recent Searches
Saving Searches
Using a Saved Search
Using a Recent Search
Search Carousel
Working with Search Results
Exporting Search Results
Actions Available from Search Results
Collaboration
Work Streams
Creating a Work Stream
Modifying a Work Stream
Filtering Work Streams
Viewing a Work Stream’s Progress
Editing an Item in a Work Stream
Deleting a Work Stream
Workflows
Creating Workflows
Modifying Workflows
Deleting Workflows
Transitioning an Item Through a Workflow
Introducing Published Content into a Workflow
Limiting Users’ Access to Workflow Transitions
Locking
Content Locking
Field-Level Locking
Viewers
Bulk Actions
Bulk Editing
Bulk Archiving
Collections
Creating a Collection from Search Results
Viewing Assets in a Collection
Adding Assets to Collections
Removing Assets From Collections
Renaming or Deleting Collections
Roles, Users, and Permissions
Understanding Permissions and Controls
Assigning Permissions to Controls
Sites Control
Areas Control
Widgets Control
UI Control
Tabs Control
Types Control
Managing Roles
Creating New Roles
Editing Roles
Custom Content Edit Forms
Creating Custom Content Edit Forms
Modifying Custom Content Edit Forms
Deleting Custom Content Edit Forms
Assigning Custom Content Edit Forms to a Role
Managing Users
Creating Users
Editing Users
User Settings
Viewing and Modifying Your Profile
Enabling Two-Factor Authentication
Notifications
Overview of Notifications
Prerequisites
Delivery Options
Subscriptions and Events
Viewing Recent Notifications
Sites and Site Settings
Understanding Site Hierarchy
Settings for the Global Site
Global Dictionaries
Site URL and Tool URL
Overview
Configuring Tool URL
Configuring Site URL
Date Format
Multi-Site
Creating Site Categories
Creating Sites
Permissions and Multiple Sites
Assigning Permissions to Content on Multiple Sites
Switching Between Sites
Publishing to Multiple Sites
Production Guides
Creating Production Guides
Creating Field-Level Production Guides
Creating Page-Level Production Guides
Creating Site-Level Production Guides
Viewing Production Guides
Viewing Site-Level Production Guides
Viewing Page-Level Production Guides
Viewing Field-Level Production Guides
Two-Factor Authentication
Enabling or Disabling Two-Factor Authentication at the Site Level
Enabling Two-Factor Authentication
Disabling Two-Factor Authentication
Enabling or Disabling Two-Factor Authentication at the Role Level
Enabling or Disabling Two-Factor Authentication at the User Level
Logging in to Brightspot with Two-Factor Authentication
First-Time Logging in with Two-Factor Authentication
Subsequent Logging in with Two-Factor Authentication
If You Lost Your Authentication Device
Looking Glass
Licensing
Brightspot Documentation
Introduction
How Brightspot Works
Get Started
Installation
Quick Installation
Step 1. Download and Install Java Development Kit (JDK)
Step 2. Download
Step 3. Extract
Step 4. Run
Vagrant Installation
Install Vagrant Machine
Boot Vagrant Machine
Vagrant Directory Structure
Map Host Name to IP Address
Stop a Vagrant Machine
Advanced Installation
Prerequisites
MySQL
Tomcat
Solr
Build a Brightspot Project
Start the Application Server
Tutorials
Tutorial Locations
Hello World
Software Requirements
Time Required
What You Should Know
Download and Run the Brightspot Tutorial Project
Project Structure Conventions
Creating an Article Model
Creating a View
Creating an Article ViewModel
Automatically Creating Permalinks
Summary
Hello Styleguide
Software Requirements
Time Required
What You Should Know
Understanding Styleguide
Previewing Layout in the Styleguide
Adding Formatting
Summary
Content Modeling
Introduction
Step 1: Define the Content Types
Step 2: Define the Properties of Each Content Type
Step 3: Define the Data Type of Each Property
Step 4: Define the Interaction Requirements
Step 5: Define the Data Processing Requirements
Creating a Content Type
Field Types
Text Field
Rich Text
Object Field
Date Widget
Boolean Field
Enum Field
List Fields
Set Fields
Storage Item
Location
Region
Markdown Editor
Embedded Types
Query Field
Annotations
@Content.Searchable
@RichTextElement.Exclusive
@RichTextElement.Tag
@RichTextElement.Tags
@Seo.DescriptionFields
@Seo.KeywordsFields
@Seo.OpenGraphType
@Seo.TitleFields
@ToolUi.BulkUpload
@ToolUi.Cluster
@ToolUi.ClusterDisplayOrder
@ToolUi.ClusterDisplayOrders
@ToolUi.CodeType
@ToolUi.CollectionItemProgress
@ToolUi.CollectionItemToggle
@ToolUi.CollectionItemWeight
@ToolUi.CollectionItemWeightColor
@ToolUi.CollectionItemWeightMarker
@ToolUi.ColorPicker
@ToolUi.CompatibleTypes
@ToolUi.CssClass
@ToolUi.DefaultSearchResult
@ToolUi.DefaultSortField
@ToolUi.DisplayAfter
@ToolUi.DisplayBefore
@ToolUi.DisplayFirst
@ToolUi.DisplayGlobalFilters
@ToolUi.DisplayGrid
@ToolUi.DisplayLast
@ToolUi.DropDown
@ToolUi.Expanded
@ToolUi.FieldDisplayOrder
@ToolUi.FieldDisplayType
@ToolUi.FieldSorted
@ToolUi.Filterable
@ToolUi.GlobalFilter
@ToolUi.Heading
@ToolUi.Hidden
@ToolUi.InputProcessorPath
@ToolUi.InputSearcherPath
@ToolUi.LanguageTag
@ToolUi.LayoutField
@ToolUi.LayoutPlaceholder
@ToolUi.LayoutPlaceholders
@ToolUi.Main
@ToolUi.Note
@ToolUi.NoteHtml
@ToolUi.NoteRendererClass
@ToolUi.OnlyPathed
@ToolUi.Placeholder
@ToolUi.Publishable
@ToolUi.PublishButtonText
@ToolUi.ReadOnly
@ToolUi.RichText
@ToolUi.Secret
@ToolUi.Sortable
@ToolUi.StoragePreviewProcessorPath
@ToolUi.StorageSetting
@ToolUi.SuggestedMaximum
@ToolUi.SuggestedMinimum
@ToolUi.Suggestions
@ToolUi.Tab
@ToolUi.TabDisplayOrder
@ToolUi.Unlabeled
Viewing a Model’s Available Annotations
Using Expression Language in Annotations
Creating Custom Fields
Images
Image Setup
Configuring Storage
Choosing an Image Editor
Image Object Model
Cropping Images
Image Galleries
Image Tag
Inheritance
Modifications
Resource Bundles
Creating Properties Files
Renaming Fields
Renaming Tabs
Renaming Content Types
Restricting Fields
Hiding Content Types
Hiding Fields
Changing Field Order
Rich Text
Rich-Text Toolbar
Defining a Toolbar Class
Associating a Toolbar Class with a Rich-Text Field
Rich-Text Elements
Rendering Rich Text
Images
Focus Points
Creating Image Sizes
Using Image Sizes
Image URLs
View System
Traditional
Model
View
ViewModel
Debugging
Headless
Model
ViewModel
ViewModels
Methods
Advanced View Modeling
ViewModel Overlays
Annotations
Type Annotations
Field Annotations
Custom Field Annotations
Search Engine Optimization
Adding Robots.txt to Sites
Adding Open Graph Fields
Error Pages
Modifying Web.xml
Creating a Custom Error Page
Example 1: Using Raw HTML
Example 2: Using MVVM Pattern
Widgets
Dashboard Widgets
Creating Dashboard Widgets
Configuring Dashboard Widgets
Content Edit Widgets
Creating
Creating Updating Content Edit Widgets
Position
Placement
Hiding
Additional Configuration
Profile Tabs
Localization
Localizing Brightspot
Widgets
Content Edit Forms
Localizing Published Web Sites
Installing Custom Dictionaries
Date Formats
Search
Customizing Search Panel Settings
Understanding the Search Panel Loop
Customizing the Search Panel Loop
Customizing Search Results
SearchResultField
SearchResultView
SearchResultAction
SearchResultSelectionGeneratable
SearchResultSuggester
SearchCarouselPreviewable
Searching Non-Content Objects
Visibility Labels
Default Visibility Labels
Custom Visibility Labels
Permalinks
URL Paths
Auto-Generate Permalink
Sites
Global-Only Settings
Site Settings
Multi-Site Considerations
Querying with Site Restrictions
Configuration
Brightspot Editorial URL
Security
User Creation
File Upload Restrictions
Session Timeout
Authentication Policy
FAQ
How do I reset two-factor authentication?
Licensing
Plugins
Introduction
Access
Deploying Access
Overview
Create UI Form for Assigning Access Control
Checking for Access to Requested Content
Configuring Access
Configuring Content Substitutions
Applying Access Control
AMP
Overview
Configuring AMP
Building AMP Templates
Analytics
Brightspot Analytics
Configuring Brightspot Analytics
Brightspot Reports
Configuring Brightspot Reports
Google Analytics
Configuring Google Analytics
Accessing Reports
Collections
Creating Collections
Viewing Assets in a Collection
Adding Assets to Collections
Removing Assets From Collections
Copying, Renaming, or Deleting Collections
Sharing Collections
Conversation
Configuring Conversation
Conversation Subscriptions
Using Conversation
Digital Asset Management
Deploying DAM
Step 1: Installing Third-Party Converters
Step 2: Installing Converters into DAM
Step 3: Implementing Download Capability for Data Model
Configuring DAM and Converter Programs
Downloading Assets
Downloading Individual Assets
Reviewing Download Activity
Asset Requests and Asset Expirations
Publishing Asset Requests
InDesign
Implementing InDesign
Before You Begin
Implementation
Using InDesign
Installing Adobe Plugin
Logging into Brightspot
Choosing a Template
Changes From Source Content
Changes From InDesign
Images
Personalization
Configuring Personalization
Adding Targets
Working with Audiences
Creating Audiences
Modifying Audiences
Deleting Audiences
Personalizing Content
Slack
Social
Overview
Social Publishing
Facebook
Creating a Facebook App
Connecting Brightspot to a Facebook App
Adding Callback URIs to a Facebook App
Authorizing Posts to Facebook
Twitter
Creating a Twitter App
Connecting Brightspot to a Twitter App
Authorizing Posts to a Twitter Account
Time Series
Introduction
Using Time Series
Twilio
Step 1: Acquire SMS API Credentials
Step 2: Provision From Numbers
Step 3: Configure Dari for Text Messaging
Step 4: Configure Text Message Delivery
Watch
Configuring Watch
Working with Watches
Adding Watchers to an Item
Removing Watchers from an Item
Searching for Watched Content
Implementing Auto-Watch
Media Desk Training
Introduction
Training Manuals
Training Videos
Glossary
Dari Documentation
Overview
Support
Databases
SQL Databases
Creating a SQL Database
Indexing
Tables
Solr Database
Aggregate Database
Forwarding Database
Transactions
Async Database
AsyncDatabaseReader
AsyncDatabaseWriter
Data Modeling
Modeling
Creating a Model
Object Type Definitions
Object State
Model Constructors
Methods
Creating Objects
Updating Objects
Deleting Objects
Field Types
String
Number
Boolean
Date
StorageItem
Locale
Record
Location
Region
Collections (
List
or
Set
)
Relationships
Object References
Embedded Objects
Many-to-Many Relationships
Indexes
Indexed Methods
Visibility-Indexed Fields
Reindexing Existing Objects
Persistence APIs
Save
Delete
Object Labels
Annotations
@LazyLoad
@Modification.Classes
@ObjectField.AnnotationProcessorClass
@ObjectType.AnnotationProcessorClass
@Recordable.Abstract
@Recordable.BeanProperty
@Recordable.BootstrapPackages
@Recordable.BootstrapFollowReferences
@Recordable.CollectionMaximum
@Recordable.CollectionMinimum
@Recordable.Denormalized
@Recordable.DisplayName
@Recordable.Embedded
@Recordable.FieldInternalNamePrefix
@Recordable.Ignored
@Recordable.Indexed
@Recordable.InternalName
@Recordable.JunctionField
@Recordable.JunctionPositionField
@Recordable.LabelFields
@Recordable.Maximum
@Recordable.MimeTypes
@Recordable.Minimum
@Recordable.PreviewField
@Recordable.Recalculate
@Recordable.Regex
@Recordable.Required
@Recordable.SourceDatabaseClass
@Recordable.SourceDatabaseName
@Recordable.Step
@Recordable.TypeId
@Recordable.TypePostProcessorClasses
@Recordable.Types
@Recordable.TypesExclude
@Recordable.Values
@Recordable.Where
@RoutingFilter.Path
@UpdateTrackable.Names
Modifications
Modifying a Class without the Source
Modifying a Group of Classes
Accessing Modification Fields
Best Practices
Augmentations
Substitutions
File Storage
Creating StorageItems
Upload Handling
StorageItem Lifecycle
Before Save
After Save
Customizing Storage Path Generation
Configuring StorageItem
Setting the Default Storage Item Configuration
Configuring StorageItem for Local Storage
Configuring StorageItem for Amazon Simple Storage Service
Configuring StorageItem for Cloud Storage
Querying
Query Tool
FROM
from Method
fromType Method
fromGroup Method
fromAll Method
fromQuery Method
Predicates
Chaining Methods
Advanced Predicates
Paginated Results
QueryFilter
Bind Variables
Querying Relationships
GROUP BY
Sort Methods
Spatial Queries
Query Reference Options
referenceOnly
resolveToReferenceOnly
Reloader
Tasks
Creating a Background Task
Schedule Tasks
Repeating Task
Recalculation Task
Queue Processing
Queue Pipeline Example
Debugging
Contextual Debugging
URL Query Parameters
Cache
Output Format
Task Status
Build Information
Configuring Build Information
Viewing Commit Information
Code Playground
Database Bootstrap
Exporting from a Database
Importing to a Database
Database Bulk Operations
Reindexing
Copy Solr / SQL
Database Query
Database SQL Query
Database Solr Query
Database Schema Viewer
Database Storage Item Bulk Operations
Application Settings
Performance Stats
Web Database
Build the Query
Run the Query
Configuration
Database Configuration
General
SQL Database
Aggregate Database
Solr Database
Export/Import
Debug Tools
Storage Item Configuration
Image Editor Configuration
General
DIMS Image Editor
Miscellaneous Configuration
Signed Cookies
Caching Filter
Mail Provider
Styleguide Documentation
Getting Started
Stack
Project Structure
Installation
System Requirements
Creating a Styleguide Project
User Interface
Preview
Raw JSON Data
Processed JSON Data
BEM
Template Listing
Tutorial
Step 1: Create Project
Step 2: Create Template
Step 3: Create Data File
Step 4: Create Styling
Step 5: Project Integration
Summary
Templating
Introduction
Handlebars
BEM
BEM
Nested Nature of Class Names
Nested Class Names in Less
Template Hierarchy
Multi-Level Template Inheritance
Example
Helpers
{{block}}
{{blockBody}}
{{blockName}}
{{cdn}}
{{element}}
{{elementName}}
{{format}}
{{include}}
{{partition}}
{{render}}
Partitioning
Understanding Partitioning
Setting the Number of Columns in a Partition
Applying Conditional Formatting for Columns and Rows
Templates Supplied with Brightspot
Article
Author
Blog
Blog Post
Gallery
Global and Navigational
Modules List
Page
Press Release
Search Results
Section
Tag
Video
Mocking Data
Creating Mock JSON Data
Keys
File Paths
Value Helpers
date
hexColor
image
name
number
paragraphs
sentences
var
words
Special Keys
_dataUrl
_delegate
_image
_include
_key
_random
_repeat
_template
_wrapper
fields
imageSizeContexts
imageSizes
javaPackage
pom
styles
vars
JavaScript
Structure of JavaScript Extensions
Adding Dependencies
Build Configuration
View Generator
How the View Generator Creates View Classes
Images
Overview
Define Image Sizes
Naming Convention for Image Sizes
Fixed Image Size
Maintaining Aspect Ratio
srcSetDescriptors
Image Format
Grouping Aspect Ratios in the Image Editor
Image Size Display Names
Runtime Image Quality and Compression
Define Image Size Context
Types of Image Size Context
Determining an Image’s Context
Lookup Logic for Image Size - Single Image
Setting Different Image Sizes in a List of Items
Applying Image Size at Runtime
Resource Bundles
Evaluating Plurals
Localization
Conditional Output and Theme Inheritance
Date Format
Priority of Date Formats
Configuring Date Format with a Resource Bundle
Style Selection
Default Style
Restricting Available Styles
Themes
Overview
Creating a Theme
Strategies for Creating a Theme
Example
Running a Theme’s Styleguide
Updating Themes
Resolving Path References
Default Path References
Extended Path References
Configuration
Location of Configuration Files
Adding a Filter to Styleguide
Data Modeling
Overview
Adding Booleans
Adding Strings
Adding Storage Items
Adding Numbers
Adding Dates
Adding Colors
Adding Records
Adding Regions
Adding Locations
Field Options
Placing Fields in Specified Tabs
Displaying Theme-Specific Fields in Views
Reusing Fields
Hiding Style Variations
Style Variations
Defining Style Variations
Combining Configurations with File Globbing
Advanced
Contextual Rendering
Implementing Contextual Rendering
Deployment of Contextual Rendering
Template Hierarchy in a Brightspot Theme
Page.hbs
ContentPage.hbs
CreativeWorkPage.hbs
ArticlePage.hbs
Summary
Releases
Release Notes
v3.3.29
v3.3.28
v3.3.27
v3.3.26
v3.3.25.1
v3.3.25
v3.3.24
v3.3.23
v3.3.22
v3.3.21
v3.3.20
v3.3.19
v3.3.18
v3.3.17
v3.3.16
v3.3.15
v3.3.14
v3.3.13
v3.3.12
v3.3.11
v3.3.10
v3.3.9
v3.3.8
v3.3.7
v3.3.6
v3.3.5
v3.3.4
v3.3.3
v3.3.2
v3.3.1
v3.3.0
Previous Major Releases
Release Notes 3.2
Release Notes 3.1
Release Notes 3.0
Release Notes 2.4
Versioning
Find Your Version
Version Numbering
3.2.x Releases
3.3.x Releases
Upgrading Brightspot Version
Plugins
Plugins
Introduction
Access
Deploying Access
Overview
Create UI Form for Assigning Access Control
Checking for Access to Requested Content
Configuring Access
Configuring Content Substitutions
Applying Access Control
AMP
Overview
Configuring AMP
Building AMP Templates
Analytics
Brightspot Analytics
Configuring Brightspot Analytics
Google Analytics Page View Supplier
Configuring Page View Supplier
Brightspot Reports
Configuring Brightspot Reports
Google Analytics
Configuring Google Analytics
Creating a Google Analytics Account
Creating a Google API Service Account
Configuring a Brightspot Site
Accessing Reports
Collections
Creating Collections
Viewing Assets in a Collection
Adding Assets to Collections
Removing Assets From Collections
Copying, Renaming, or Deleting Collections
Sharing Collections
Conversation
Configuring Conversation
Conversation Subscriptions
Using Conversation
Digital Asset Management
Deploying DAM
Step 1: Installing Third-Party Converters
Step 2: Installing Converters into DAM
Step 3: Implementing Download Capability for Data Model
Configuring DAM and Converter Programs
Downloading Assets
Downloading Individual Assets
Reviewing Download Activity
Asset Requests and Asset Expirations
Publishing Asset Requests
InDesign
Implementing InDesign
Before You Begin
Implementation
Using InDesign
Installing Adobe Plugin
Logging into Brightspot
Choosing a Template
Changes From Source Content
Changes From InDesign
Images
Personalization
Configuring Personalization
Adding Targets
Working with Audiences
Creating Audiences
Modifying Audiences
Deleting Audiences
Personalizing Content
Slack
Social
Overview
Social Publishing
Facebook
Creating a Facebook App
Connecting Brightspot to a Facebook App
Adding Callback URIs to a Facebook App
Authorizing Posts to Facebook
Authorizing Posts to a Facebook Profile
Authorizing Posts to a Facebook Page
Twitter
Creating a Twitter App
Connecting Brightspot to a Twitter App
Authorizing Posts to a Twitter Account
Time Series
Introduction
Using Time Series
Twilio
Step 1: Acquire SMS API Credentials
Step 2: Provision From Numbers
Step 3: Configure Dari for Text Messaging
Step 4: Configure Text Message Delivery
Watch
Configuring Watch
Working with Watches
Adding Watchers to an Item
Removing Watchers from an Item
Searching for Watched Content
Implementing Auto-Watch
