Umbraco CMS
CloudHeartcoreDXPMarketplace
13.latest (LTS)
13.latest (LTS)
  • Umbraco CMS Documentation
  • Legacy Documentation
    • Umbraco 11 Documentation
    • Umbraco 8 Documentation
    • Umbraco 7 Documentation
  • Release Notes
  • Contribute
  • Sustainability Best Practices
  • Fundamentals
    • Get to know Umbraco
    • Setup
      • Requirements
      • Installation
        • Install using .NET CLI
        • Install using Visual Studio
        • Local IIS With Umbraco
        • Install using Visual Studio Code
        • Installing Nightly Builds
        • Running Umbraco on Linux/macOS
        • Unattended Installs
      • Upgrade your project
        • Version Specific Upgrades
          • Upgrade from Umbraco 8 to the latest version
          • Migrate content to Umbraco 8
          • Minor upgrades for Umbraco 8
          • Upgrade to Umbraco 7
          • Minor upgrades for Umbraco 7
      • Server setup
        • Running Umbraco On Azure Web Apps
        • Hosting Umbraco in IIS
        • File And Folder Permissions
        • Runtime Modes
        • Running Umbraco in Docker
        • Umbraco in Load Balanced Environments
          • Load Balancing Azure Web Apps
          • Standalone File System
          • Advanced Techniques With Flexible Load Balancing
          • Logging With Load Balancing
    • Backoffice
      • Sections
      • Property Editors
        • Built-in Property Editors
          • Checkbox List
          • Color Picker
          • Content Picker
          • DateTime
          • Date
          • Decimal
          • Email Address
          • Eye Dropper Color Picker
          • File Upload
          • Image Cropper
          • Label
          • List View
          • Markdown Editor
          • Media Picker
          • Media Picker (Legacy)
          • Member Group Picker
          • Member Picker
          • Multi Url Picker
          • Multinode Treepicker
          • Repeatable Textstrings
          • Numeric
          • Radiobutton List
          • Slider
          • Tags
          • Textarea
          • Textbox
          • Toggle
          • User Picker
          • Block Editors
            • Block Grid
            • Block List
            • Build a Custom View for a Block
            • Configuring Block Editor Label Properties
          • Dropdown
          • Grid Layout (Legacy)
            • What Are Grid Layouts?
            • Configuring The Grid Layout
            • Settings And Styling
            • Grid Editors
            • Build Your Own Editor
            • Rendering Grid In a Template
            • Grid Layout Best Practices
            • Add Values Programmatically
          • Rich Text Editor
            • Rich Text Editor Configuration
            • Rich Text Editor Styles
            • Rich Text Editor Plugins
            • Blocks in Rich Text Editor
      • Login
      • Content Templates
      • Infinite Editing
      • Log Viewer
      • Language Variants
      • Settings Dashboards
    • Data
      • Defining Content
        • Default Document Types
        • Document Type Localization
      • Creating Media
        • Default Data/Media Types
      • Members
      • Data Types
        • Default Data Types
      • Scheduled Publishing
      • Using Tabs
      • Users
      • Relations
      • Dictionary Items
      • Content Version Cleanup
    • Design
      • Templates
        • Basic Razor Syntax
        • Named Sections
        • Razor Cheatsheet
      • Rendering Content
      • Rendering Media
      • Partial Views
      • Partial View Macro Files
      • Stylesheets And JavaScript
    • Code
      • Service APIs
      • Subscribing To Notifications
      • Creating Forms
      • Debugging
        • Logging
      • Source Control
  • Implementation
    • Learn how Umbraco works
    • Routing
      • Controller & Action Selection
      • Execute Request
      • Request Pipeline
    • Custom Routing
      • Adding a hub with SignalR and Umbraco
    • Controllers
    • Data Persistence (CRUD)
    • Composing
    • Integration Testing
    • Nullable Reference Types
    • Services and Helpers
      • Circular Dependencies
    • Unit Testing
  • Extending
    • Customize the editing experience
    • Dashboards
    • Sections & Trees
      • Sections
      • Trees
        • Tree Actions
      • Searchable Trees (ISearchableTree)
    • Property Editors
      • Property Value Converters
      • Property Actions
      • Tracking References
      • Declaring your property editor
      • Content Picker Value Converter Example
    • Package Manifest
    • Macro Parameter Editors
    • Health Check
      • Health Check Guides
        • Click-Jacking Protection
        • Content/MIME Sniffing Protection
        • Cross-site scripting Protection (X-XSS-Protection header)
        • Debug Compilation Mode
        • Excessive Headers
        • Fixed Application Url
        • Folder & File Permissions
        • HTTPS Configuration
        • Macro Errors
        • Notification Email Settings
        • SMTP
        • Strict-Transport-Security Header
    • Language Files & Localization
    • Backoffice Search
    • Backoffice Tours
    • Backoffice UI API Documentation
    • Content Apps
    • Creating a Custom Database Table
    • Embedded Media Providers
    • Custom File Systems (IFileSystem)
      • Using Azure Blob Storage for Media and ImageSharp Cache
    • Configuring Azure Key Vault
    • Packages
      • Creating a Package
      • Language file for packages
      • Listing a Package on the Umbraco Marketplace
      • Good practice and defaults
      • Packages on Umbraco Cloud
      • Installing and Uninstalling Packages
      • Maintaining packages
      • Create accessible Umbraco packages
      • Example Package Repository
    • UI Library
  • Reference
    • Dive into the code
    • Configuration
      • Basic Authentication Settings
      • Connection strings settings
      • Content Dashboard Settings
      • Content Settings
      • Data Types Settings
      • Debug settings
      • Examine settings
      • Exception filter settings
      • FileSystemProviders Configuration
      • Global Settings
      • Health checks
      • Hosting settings
      • Imaging settings
      • Indexing settings
      • Install Default Data Settings
      • Keep alive settings
      • Logging settings
      • Maximum Upload Size Settings
      • Models builder settings
      • NuCache Settings
      • Package Migration
      • Plugins settings
      • Request handler settings
      • Rich text editor settings
      • Runtime minification settings
      • Runtime settings
      • Security Settings
      • Serilog settings
      • Tours settings
      • Type finder settings
      • Unattended
      • Web routing
    • Templating
      • Macros
        • Managing macros
        • Partial View Macros
      • Models Builder
        • Introduction
        • Configuration
        • Builder Modes
        • Understand and Extend
        • Using Interfaces
        • Tips and Tricks
      • Working with MVC
        • Working with MVC Views in Umbraco
        • View/Razor Examples
        • Using MVC Partial Views in Umbraco
        • Using View Components in Umbraco
        • Querying & Traversal
        • Creating Forms
    • Querying & Models
      • IMemberManager
      • IPublishedContentQuery
      • ITagQuery
      • UDI Identifiers
      • UmbracoContext helper
      • UmbracoHelper
      • IPublishedContent
        • IPublishedContent Collections
        • IPublishedContent IsHelpers
        • IPublishedContent Property Access & Extension Methods
    • Routing & Controllers
      • Routing requirements for backoffice authentication
      • Custom MVC controllers (Umbraco Route Hijacking)
      • Custom MVC Routes
      • Custom Middleware
      • URL Rewrites in Umbraco
      • Special Property Type aliases for routing
      • URL Redirect Management
      • Routing in Umbraco
        • FindPublishedContentAndTemplate()
        • IContentFinder
        • Inbound request pipeline
        • Outbound request pipeline
        • Published Content Request Preparation
      • Surface controllers
        • Surface controller actions
      • Umbraco API Controllers
        • Umbraco Api - Authorization
        • Umbraco Api - Routing & Urls
    • Content Delivery API
      • Custom property editors support
      • Extension API for querying
      • Media Delivery API
      • Protected content in the Delivery API
      • Output caching
      • Property expansion and limiting
      • Additional preview environments support
    • Webhooks
      • Expanding Webhook Events
    • API versioning and OpenAPI
    • Searching
      • Examine
        • Examine Management
        • Examine Manager
        • Custom indexing
        • PDF indexes and multisearchers
        • Quick-start
    • Using Notifications
      • Notification Handler
      • CacheRefresher Notifications Example
      • ContentService Notifications Example
      • Creating And Publishing Notifications
      • Determining if an entity is new
      • MediaService Notifications Example
      • MemberService Notifications Example
      • Sending Allowed Children Notification
      • Umbraco Application Lifetime Notifications
      • EditorModel Notifications
        • Customizing the "Links" box
      • Hot vs. cold restarts
    • Inversion of Control / Dependency injection
    • Management
      • Models Reference
        • Content
        • ContentType
        • DataType
        • DictionaryItem
        • Language
        • Media
        • MediaType
        • Relation
        • RelationType
        • ServerRegistration
        • Template
      • Services Reference
        • AuditService
        • ConsentService
        • DataTypeService
        • DomainService
        • EntityService
        • ExternalLoginService
        • FileService
        • MacroService
        • MediaService
        • MemberGroupService
        • MemberService
        • MemberTypeService
        • NotificationService
        • PackagingService
        • PublicAccessService
        • RedirectUrlService
        • RelationService
        • ServerRegistrationService
        • TagService
        • TextService
        • ContentService
          • Create content programmatically
          • Publish content programmatically
        • ContentTypeService
          • Retrieving content types
          • Retrieving content types
        • LocalizationService
          • Retrieving languages
        • UserService
          • Creating a user
    • Plugins
      • Creating Resolvers
      • Finding types
    • Cache & Distributed Cache
      • Accessing the cache
      • ICacheRefresher
      • IServerMessenger
      • Getting/Adding/Updating/Inserting Into Cache
      • Examples
        • Working with caching
    • Response Caching
    • Security
      • API rate limiting
      • BackOfficeUserManager and Events
      • Cookies
      • Replacing the basic username/password check
      • External login providers
      • Locking of Users and password reset
      • Reset admin password
      • Umbraco Security Hardening
      • Umbraco Security Settings
      • Sensitive data
      • Sanitizing the Rich Text Editor
      • Setup Umbraco for a FIPS Compliant Server
      • HTTPS
      • Two-factor Authentication
      • Server-side file validation
    • Scheduling
    • Common Pitfalls & Anti-Patterns
    • API Documentation
    • Debugging with SourceLink
    • Language Variation
    • UmbracoMapper
    • Distributed Locks
    • AngularJS
      • Directives
        • umbLayoutSelector
        • umbLoadIndicator
        • umbProperty
      • Services
        • Editor Service
        • Events Service
          • changeTitle
  • Tutorials
    • Overview
    • Creating a Basic Website
      • Getting Started
      • Document Types
      • Creating Your First Template
      • CSS and Images
      • Displaying the Document Type Properties
      • Creating a Master Template
      • Creating Pages and Using the Master Template
      • Setting the Navigation Menu
      • Articles and Article Items
      • Adding Language Variants
      • Conclusions
    • Creating a Custom Dashboard
      • Extending the Dashboard using the Umbraco UI library
    • Creating a Property Editor
      • Adding configuration to a property editor
      • Integrating services with a property editor
      • Adding server-side data to a property editor
    • Creating a Multilingual Site
    • Add Google Authentication (Users)
    • Add Microsoft Entra ID authentication (Members)
    • Creating a Backoffice Tour
    • Creating Custom Database Tables with Entity Framework
    • The Starter Kit
      • Lessons
        • Customize the Starter Kit
        • Add a Blog Post Publication Date
          • Add a Blog Post Publication Date
          • Add a Blog Post Publication Date
        • Add Open Graph
          • Add Open Graph - Step 1
          • Add Open Graph - Step 2
          • Add Open Graph - Step 3
          • Add Open Graph - Step 4
          • Add Open Graph - Summary
        • Ask For Help and Join the Community
    • Editor's Manual
      • Getting Started
        • Logging In and Out
        • Umbraco Interface
        • Creating, Saving and Publishing Content Options
        • Finding Content
        • Editing Existing Content
        • Sorting Pages
        • Moving a Page
        • Copying a Page
        • Deleting and Restoring Pages
      • Working with Rich Text Editor
      • Version Management
        • Comparing Versions
        • Rollback to a Previous Version
      • Media Management
        • Working with Folders
        • Working with Media Types
        • Cropping Images
      • Tips & Tricks
        • Refreshing the Tree View
        • Audit Trail
        • Notifications
        • Preview Pane Responsive View
        • Session Timeout
    • Multisite Setup
    • Member Registration and Login
    • Custom Views for Block List
    • Connecting Umbraco Forms and Zapier
    • Creating an XML Sitemap
    • Implementing Custom Error Pages
Powered by GitBook
On this page
  • Introduction
  • Video tutorial
  • Step 1: Create the Backoffice tour files
  • Step 2: Create the Tour Configuration Objects
  • Step 3: Find elements for the Tour Step Object
  • Step 4: Create the Tour Step Object
  • Conclusion
Edit on GitHub
Export as PDF
  1. Tutorials

Creating a Backoffice Tour

In this tutorial, we show how you can create a custom Backoffice Tour in Umbraco CMS.

PreviousAdd Microsoft Entra ID authentication (Members)NextCreating Custom Database Tables with Entity Framework

Last updated 1 year ago

Introduction

In this tutorial we will show how you can create a backoffice tour, helping users get started with working in the Umbraco backoffice.

A use case could be if you have a custom dashboard then a backoffice tour can be used to show how it works.

Before moving on, we recommend reading the Backoffice Tours documentation as it explains how each of the elements works in the tour.

Video tutorial

Step 1: Create the Backoffice tour files

To create the backoffice tour, the first thing we need is to create its associated files.

These files need to be created in the app_plugins folder. If the app_plugins folder does not already exist in your project the folder needs to be created at the root of your project files.

  1. Navigate to the root of the Umbraco project.

  2. Create an app_plugins folder at the root of your project.

  3. Create a folder with the name of your plugin, in the app_plugins folder.

  4. Create another new folder within that, called backoffice.

  5. Create a folder called tours.

  6. Add a new JSON file to the tours folder.

In the JSON file, we will add the Tour Configuration Object and the Tour Step Object in the following step.

Step 2: Create the Tour Configuration Objects

Once we have added the folders and the JSON file, we can go ahead and create the Tour Configuration Object.

In the JSON file, add the following configuration object:

[
  {
    "name": "My Custom Backoffice tour",
    "alias": "myCustomBackofficeTour",
    "group": "Get things done!!!",
    "groupOrder": 1,
    "allowDisable": true,
    "culture": "en-US",
    "contentType": "",
    "requiredSections": [ "content", "media" ],
    "steps": []
  }
]

Once we have added the Configuration Object, it is time to configure it so it fits our backoffice tour.

In this Tour Configuration Object, we are going to change the name, alias, and group:

  1. Change the name to "Settings Section Tour"

  2. Change the alias to "settingsSectionTour"

  3. Change the group to "Learn about the settings section"

  4. Add "settings" to the requiredSection.

The name is what is displayed in the help drawer for our tour.

The alias is unique to our tour. It is used to track the progress the users have made while taking the tour.

The group is used to group related tours in the help drawer under a common subject (for example Getting Started).

The requiredSections is an array of section aliases that a user needs access to, to see the tour. If the user does not have access to all the defined sections, the tour will not be shown in the help drawer.

Once you are done with the steps above, the Tour Configuration should look like this:

[
  {
    "name": "Settings section Tour",
    "alias": "settingsSectionTour",
    "group": "Learn about the settings section",
    "groupOrder": 1,
    "allowDisable": true,
    "culture": "en-US",
    "contentType": "",
    "requiredSections": [ "content", "media", "settings" ],
    "steps": []
  }
]

Step 3: Find elements for the Tour Step Object

Before we get started with creating our Tour Step Objects, we need to find the CSS selector for the elements that we want to highlight in our tour.

In this tutorial, we want to highlight three areas: Settings in the navigation, the side navigation in the Settings section, and then the Settings dashboard.

A lot of elements in the backoffice have the data-element attribute, however, we can also use IDs or classes.

To find the first element, follow the steps below:

  1. Go to the backoffice of your Umbraco project and log in.

  2. Right-click on Settings in the main navigation and inspect the element.

  1. Locate the data-element for the top navigation called section-settings.

  1. Note down the data-element.

Let's find the element for the second step:

  1. Navigate to the Settings section.

  2. Right-click on the left side and inspect the page.

  3. Find the <div> with the id= "navigation".

  1. Note down the id.

And lastly, we need to find the last element for our tour step:

  1. Right-click on the dashboard on the right.

  2. Locate the <section> with the id="contentWrapper".

  1. Note down the id.

Once we have located the elements we can go ahead and create our Tour Step Object.

Step 4: Create the Tour Step Object

We now need to create the Tour Step Object for our tour. The Tour Step JSON Object contains all the data related to tour steps.

In the steps object in the Tour Configuration, add the following code snippet:

"steps": [
      {
        "title": "A meaningful title",
        "content": "<p>Some text explaining the step</p>",
        "type": null,
        "element": "[data-element='global-user']",
        "elementPreventClick": false,
        "backdropOpacity": 0.6,
        "event": "click",
        "view": null,
        "eventElement": "[data-element='global-user'] .umb-avatar",
        "customProperties": null
      }
    ]

We need to configure it so that it fits our tour.

  1. Change the title to "Accessing the settings section"

  2. Change the text in content to: "<p>Clicking on Settings will direct you to the settings section in Umbraco</p>"

  3. Replace the data-element with the first one we found called section-settings

  4. Remove the "[data-element='global-user'] .umb-avatar" from the eventElement.

Once this is done, this is how our tour steps look:

"steps": [
      {
        "title": "Accessing the settings section",
        "content": "<p>Clicking on Settings will direct you to the settings section in Umbraco</p>",
        "type": null,
        "element": "[data-element='section-settings']",
        "elementPreventClick": false,
        "backdropOpacity": 0.6,
        "event": "click",
        "view": null,
        "eventElement": "",
        "customProperties": null
      }
    ]

For this first step, we are not going to change anything else as we want the rest of the settings for this step to be like they are.

Once we start the tour it will highlight the Settings tab in the navigation. It is then possible to click on Settings which will take us to the Settings section.

It's time to create the second step of our tour.

For the sake of this tutorial let's copy the step and insert it below the previous one.

"steps": [
      {
       ...
      },
      {
        "title": "Accessing the settings section",
        "content": "<p>Clicking on Settings will direct you to the settings section in Umbraco</p>",
        "type": null,
        "element": "[data-element='section-settings']",
        "elementPreventClick": false,
        "backdropOpacity": 0.6,
        "event": "click",
        "view": null,
        "eventElement": "",
        "customProperties": null
      }
    ]

In this step, once we click on Settings in the top menu, it will redirect us to the Settings section. It will highlight the side navigation in the Setting section and display our title and content.

Once the steps have been added we can modify the second step in our tour.

  1. Change the title to "This is the Settings Section"

  2. Change the content to "<p>From here you can create document types, and templates, to mention a few</p>"

  3. Replace the data-element with the second one we found called id='navigation'

  4. Change "elementPreventClick" from false to true.

This will ensure that a button saying "next" will show on the step, as we don't want to click on settings.

We are not going to make any changes to the rest of the steps.

So far, this is how our tour looks:

"steps": [
      {
       "title": "Accessing the settings section",
        "content": "<p>Clicking on Settings will direct you to the settings section in Umbraco</p>",
        "type": null,
        "element": "[data-element='section-settings']",
        "elementPreventClick": false,
        "backdropOpacity": 0.6,
        "event": "click",
        "view": null,
        "eventElement": "",
        "customProperties": null
      },
      {
        "title": "This is the Settings Section",
        "content": "<p>In the side navigation, you can create and manage document types, templates, data types just to name a few.</p>",
        "type": null,
        "element": "[id='navigation']",
        "elementPreventClick": true,
        "backdropOpacity": 0.6,
        "event": "click",
        "view": null,
        "eventElement": "",
        "customProperties": null
      }
    ]

This is what the second step looks like in the backoffice when we run the tour:

So far so good. We have created two steps. Let's make a third step for our tour.

Like before, let's copy the previous tour step and add it below like so:

"steps": [
      {
       ...
      },
      {
       ...
      },
      {
        "title": "This is the Settings Section",
        "content": "<p>In the side navigation, you can create and manage document types, templates, data types just to name a few.</p>",
        "type": null,
        "element": "[id='navigation']",
        "elementPreventClick": true,
        "backdropOpacity": 0.6,
        "event": "click",
        "view": null,
        "eventElement": "",
        "customProperties": null
      }
    ]

Now let's modify the step.

We are going to highlight the Settings dashboard in the Settings section.

  1. Change the title to "This is the Settings Dashboard"

  2. Change the content to: <p>In the settings Dashboard, you will be able to work with your document types, templates, data types, etc.</p>

  3. Change the element id to: id='contentwrapper'

We still want to show a "next" button on the step, so we are not going to change the rest of the step.

Once we run the tour, it will highlight the whole Settings dashboard to the right of the side navigation:

We have now created our backoffice tour, which gives a short overview of the Settings section.

Down below you can see how the final tour step Object is configured:

"steps": [
      {
        "title": "Accessing the settings section",
        "content": "<p>Clicking on Settings will direct you to the settings section in Umbraco</p>",
        "type": null,
        "element": "[data-element='section-settings']",
        "elementPreventClick": false,
        "backdropOpacity": 0.6,
        "event": "click",
        "view": null,
        "eventElement": "",
        "customProperties": null
      },
      {
        "title": "This is the Settings Section",
        "content": "In the side navigation, you can create and manage document types, templates, data types just to name a few.</p>",
        "type": null,
        "element": "[id='navigation']",
        "elementPreventClick": true,
        "backdropOpacity": 0.6,
        "event": "",
        "view": null,
        "eventElement": "",
        "customProperties": null
      },
      {
        "title": "This is the Settings Dashboard",
        "content": "<p>In the settings Dashboard, you will be able to work with your document types, templates, data types, etc.</p>",
        "type": null,
        "element": "[id='contentwrapper']",
        "elementPreventClick": true,
        "backdropOpacity": 0.6,
        "event": "",
        "view": null,
        "eventElement": "",
        "customProperties": null
      }
    ]

Now that we have configured the final step of our tour, this is how the code for the tour will look like:

[
  {
    "name": "Settings section Tour",
    "alias": "settingsSectionTour",
    "group": "Learn about the settings section",
    "groupOrder": 1,
    "allowDisable": true,
    "culture": "en-US",
    "contentType": "",
    "requiredSections": [ "content", "media", "settings" ],
    "steps": [
      {
        "title": "Accessing the settings section",
        "content": "<p>Clicking on Settings will direct you to the settings section in Umbraco</p>",
        "type": null,
        "element": "[data-element='section-settings']",
        "elementPreventClick": false,
        "backdropOpacity": 0.6,
        "event": "click",
        "view": null,
        "eventElement": "",
        "customProperties": null
      },
      {
        "title": "This is the Settings Section",
        "content": "In the side navigation, you can create and manage document types, templates, data types just to name a few.</p>",
        "type": null,
        "element": "[id='navigation']",
        "elementPreventClick": true,
        "backdropOpacity": 0.6,
        "event": "",
        "view": null,
        "eventElement": "",
        "customProperties": null
      },
      {
        "title": "This is the Settings Dashboard",
        "content": "<p>In the settings Dashboard, you will be able to work with your document types, templates, data types, etc.</p>",
        "type": null,
        "element": "[id='contentwrapper']",
        "elementPreventClick": true,
        "backdropOpacity": 0.6,
        "event": "",
        "view": null,
        "eventElement": "",
        "customProperties": null
      }
    ]
  }
]

Conclusion

With all the steps completed, we now have a backoffice tour showing the Settings section in the Umbraco backoffice.

You can go ahead and extend the backoffice tour with more steps or create your very own backoffice tours.

Video tutorial on how to create a backoffice tour
Umbraco Backoffice tour folder structure
Inspecting the Settings navigation in the backoffice
Finding the data-element for the first tour step
Finding the id for the second tour step
Finding the id for the third tour step
How the first tour step looks like when running the backoffice tour.
How the second tour step looks like when running the backoffice tour.
How the third tour step looks like when running the backoffice tour.