Brightspot CMS Developer Guide

Global-only settings


Global-only settings are settable only at the system global level, and apply to all admin-defined sites that exist. A setting changed at the global level cascades to all other sites in the site hierarchy. Place settings at the Global level that should not be available for override at the site level. For example, credentials for a third-party integration used by all sites should be global-only settings.

To add custom settings to the global site UI, create a modification class for CmsTool. The following example adds a site setting for a support person to assist editorial users. With this setting, Brightspot can retrieve the phone number of the specified user and display it in the header.

public class SupportSettings extends Modification<CmsTool> { 

    @ToolUi.Tab("Support") 
    @ToolUi.Cluster("Contact")
    private ToolUser user;

    /* Getter and setter */
}
  • Defines the class as a modification of CmsTool.
  • Annotations for the field user. These annotations specify how the site setting appears in the Edit Global widget. Referring to the following example, the setting appears in the Support tab under a Contact heading.

There are several ToolUi annotations that control the display of fields. For more information see Content modeling annotations.

Rendered custom tab, Edit Global widget

Previous Topic
Sites
Next Topic
Site settings
Was this topic helpful?
Thanks for your feedback.
The elements that get you up and running in a matter of days, from pre-built content types, to modules, to landing pages.

Content types
Modules
Landing pages
Everything you need to manage and administer content within Brightspot CMS, including plug-and-play integrations.

Dashboards
Authoring content
Workflows
Admin configurations
A guide for installing, supporting and administering code on the Brightspot platform, including integrations requiring developer support to use.

Field types
Content modeling
Rich-text elements
Images