Custom Tool Groups - Documentation topics on: custom tabs,custom tool groups,roles and tools,tool groups,.

This documentation is a static copy for this version. For current documentation, see: http://dotcms.com/docs/latest

Custom Tool Groups

In addition to the default Tool Groups provided with the dotCMS starter site, you can create your own Tool Groups. This allows you to create Tool Groups with the exact combination of tools needed to give each of your Roles access to just the tools they need, which both simplifies the back-end interface for your users and improves security.

To create a custom Tool Group:

  1. Select System -> Roles & Tools from the navigation side bar.
  2. Select a Role that will receive access to the new custom Tool Group.
  3. Click the Tools tab.
  4. In the Role detail area, click the Create Custom Tool Group button.

Configure Custom Tool Group

The Edit Tool Group popup contains the following properties:

PropertyDescription
Tool GroupThe name of the Tool Group, which will display as a heading on the navigation side bar.
IconThe class name of a Font Awesome icon.
  • You may find a list of icons and their class names on the Font Awesome web site.
  • If you do not supply an icon name, or if the name does not match a valid Font Awesome icon, a default icon will be displayed.
  • dotCMS uses Font Awesome v4.7.0, so only icons existing in this version of Font Awesome are recognized.
OrderAn integer specifying the order the Tool Group will display in the navigation side bar.
  • Tool Groups will display in ascending order based on this number.
ToolsDisplays a list of the tools in the Tool Group, and allows you to add, remove, and re-order the tools within the Tool Group.

Available Tools

The following tools are included by default with dotCMS, and can be assigned to any Tool Group. Note that some of these tools are deprecated legacy tools that are only provided for backward-compatibility for existing dotCMS customers, and it it is strongly recommended that you do not use any deprecated tools when creating new Tool Groups.

ToolFeature(s)Default Location
BrowserSite BrowserSite -> Browser
CalendarEvents CalendarContent -> Calendar
CategoriesCategoriesTypes & Tags -> Categories
ConfigurationConfiguration for your dotCMS instance, including
Branding & Basic Information,
License Management,
Cluster Status, and
Push Publishing server configuration
System -> Configuration
ContainersContainersSite -> Containers
Content TypesContent TypesTypes & Tags -> Content Types
DashboardSite DashboardHome -> Dashboard
ES SearchES SearchDev Tools -> ES Search
FormsForm BuilderMarketing -> Forms
Deprecated
Job SchedulerJob SchedulerNone
LanguagesLanguagesTypes & Tags -> Languages
Link CheckerLink CheckerContent -> Link Checker
LinksMenu LinksSite -> Links
MaintenanceSeveral Administration and maintenance tasksSystem -> Maintenance
PluginsDynamic PluginsDev Tools -> Plugins
Publishing QueuePush PublishingContent -> Publishing Queue
Query ToolQuery ToolDev Tools -> Query Tool
Reports(Legacy) ReportsNone
Deprecated
Roles & ToolsRole permissions and Tool GroupsSystem -> Roles & Tools
RulesRulesMarketing -> Rules
SearchContent SearchContent -> Search
Site SearchSite SearchDev Tools -> Site Search
SitesSitesSystem -> Sites
TagsTag ManagerTypes & Tags -> Tags
TasksUser's assigned Workflow tasksHome -> Tasks
TemplatesTemplatesSite -> Templates
Time MachineTime MachineSite -> Time Machine
UsersUser ManagementSystem -> Users
Vanity URLsVanity URLsMarketing -> Vanity URLs
WorkflowContent Type WorkflowsTypes & Tags -> Workflow

Custom Tools

You may also use plugins to create your own custom tools, which you can then add to any Tool Group. For more information on creating and using plugins, please see the Developing documentation section.