| meta.Title | description |
|---|---|
Creating a Custom Dashboard |
A guide to creating a custom dashboard in Umbraco |
This guide takes you through the steps to setup a Custom Dashboard in Umbraco.
A Dashboard is a tab on the right-hand side of a section eg. the Getting Started dashboard in the Content section:
.jpg)
It is generally considered good practice to provide a custom dashboard to welcome your editors to the backoffice of your site. You can provide information about the site and/or provide a helpful gateway to common functionality the editors will use. This guide will show the basics of creating a custom 'Welcome Message' dashboard. The guide will also show how you can go a little further to provide interaction using AngularJS.
The finished dashboard will give the editors an overview of which pages and media files they've worked on most recently.
Here's an overview of the steps that will be covered:
- Setting up the dashboard plugin
- Writing a basic Welcome Message view
- Configure the Custom Welcome Dashboard to be displayed
- Adding translations
- Adding styles
- Adding an AngularJS controller
- Display the current user's name in our welcome message
- Display the current user's recent updates
- Create a shortcut button to add a new blog post
- You can do anything...
This tutorial uses AngularJS with Umbraco, so it does not cover AngularJS itself, there are tons of resources on that already here:
There are a lot of parallels with Creating a Property Editor. The tutorial Creating a Property Editor Tutorial is worth a read through too.
At the end of this guide, we should have a friendly welcoming dashboard displaying a list of the editor's recent site updates.
The first thing we must do is create a new folder inside our site's '/App_Plugins' folder. We will call it 'CustomWelcomeDashboard'
Next, we will create an HTML file inside this folder called WelcomeDashboard.html. The HTML file will contain a fragment of a HTML document and does not need <html><head><body> entities.
Add the following HTML to the WelcomeDashboard.html.
{% code title="WelcomeDashboard.html" lineNumbers="true" %}
<div class="welcome-dashboard">
<h1>Welcome to Umbraco</h1>
<p>We hope you find the experience of editing your content with Umbraco enjoyable and delightful. If you discover any problems with the site please report them to the support team at <a href="mailto:">[email protected]</a></p>
<p>You can put anything here...</p>
</div>{% endcode %}
Similar to a property editor you will now register the dashboard in a package.manifest file. Add a new file inside the ~/App_Plugins/CustomWelcomeDashboard folder called package.manifest:
{% code title="package.manifest" lineNumbers="true" %}
{
"dashboards": [
{
"alias": "welcomeDashboard",
"view": "/App_Plugins/CustomWelcomeDashboard/WelcomeDashboard.html",
"sections": [ "content" ],
"weight": -10,
"access": [
{ "deny": "translator" },
{ "grant": "admin" }
]
}
]
}{% endcode %}
The above configuration is effectively saying:
"Add a tab called 'WelcomeDashboard' to the 'Content' section of the Umbraco site, use the WelcomeDashboard.html as the content (view) of the dashboard and don't allow 'translators', but do allow 'admins' to see it!"
{% hint style="info" %} The order in which the tab will appear in the Umbraco Backoffice depends on its weight. To make our Custom Welcome message the first Tab the editors see, make sure the weight is less than the default dashboards. Read more about the default weights.
You can specify multiple controls to appear on a particular tab, and multiple tabs in a particular section. {% endhint %}
After registering your dashboard, it will appear in the backoffice - however it will have it's dashboard alias [WelcomeDashboard] wrapped in square brackets. This is because it is missing a language key. The language key allows people to provide a translation of the dashboard name in multilingual environments. To remove the square brackets - add a language key:
You will need to create a Lang folder in your custom dashboard folder and create a package specific language file: ~/App_Plugins/CustomWelcomeDashboard/Lang/en-US.xml
{% hint style="info" %}
The App_Plugins version of the Lang directory is case sensitive on Linux systems, so make sure that it start with a capital L.
{% endhint %}
{% code title="en-US.xml" lineNumbers="true" %}
<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<language>
<area alias="dashboardTabs">
<key alias="welcomeDashboard">Welcome</key>
</area>
</language>{% endcode %}
Read more about language files
Welcome Dashboard
We can apply the same workflow to elements inside the dashboard, not only the name/alias. Extend the translation file xml like so:
{% code title="en-US.xml" lineNumbers="true" %}
<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<language>
<area alias="dashboardTabs">
<key alias="welcomeDashboard">Welcome</key>
</area>
<area alias="welcomeDashboard">
<key alias="heading">Welcome!</key>
<key alias="bodytext">This is the Backoffice. From here, you can modify the content, media, and settings of your website.<key>
<key alias="copyright">© Sample Company 20XX</key>
</area>
</language>{% endcode %}
We are adding another area tag with a few keys. Let us adjust the dashboard HTML accordingly:
{% code title="en-US.xml" lineNumbers="true" %}
<div class="welcome-dashboard">
<h1><localize key="welcomeDashboard_heading">Default heading</localize></h1>
<p><localize key="welcomeDashboard_bodytext">Default bodytext</localize></p>
<p><localize key="welcomeDashboard_copyright">Default copyright</localize></p>
</div>{% endcode %}
The localize tag will be replaced with the translated keywords. We have some default text inside the tags above, which can be removed. It would usually not be visible after the translation is applied.
As for the localize tag syntax in HTML, the area alias is combined with the key alias - so if you want to translate:
<localize key="welcomeDashboard_heading">Default heading</localize>The xml for that specific key will look like this:
<area alias="welcomeDashboard">
<key alias="heading">Welcome!</key>
</area>The area and key aliases are combined and an underscore is added inbetween.
{% hint style="info" %} If you don't see the brackets disappearing - you may need to restart the website. {% endhint %}
With the above steps completed, your dashboard is all set up to be translated across different backoffice languages. To test it out, you could, for example, add another language XML file, like da.xml for the Danish language.
<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<language>
<area alias="dashboardTabs">
<key alias="welcomeDashboard">Velkommen</key>
</area>
<area alias="welcomeDashboard">
<key alias="heading">Velkommen!</key>
<key alias="bodytext">Dette er Backoffice. Herfra kan du ændre indholdet, medierne og indstillingerne på din hjemmeside.</key>
<key alias="copyright">© Sample Selskab 20XX</key>
</area>
</language>The backoffice language can be changed in the Users section, if you wish to test out the translations.
Congratulations! Job well done, however, this is only the starting point. Dashboards can be styled with CSS, but there are a couple more steps to follow to be able to apply a custom stylesheet:
Inside this package manifest we add a bit of JSON to describe the dashboard's required JavaScript and stylesheet resources:
{
"dashboards": [
{
"alias": "welcomeDashboard",
"view": "/App_Plugins/CustomWelcomeDashboard/WelcomeDashboard.html",
"sections": [ "content" ],
"weight": -10,
"access": [
{ "deny": "translator" },
{ "grant": "admin" }
]
}
],
"javascript": [
/*javascript files listed here*/
],
"css": [
"~/App_Plugins/CustomWelcomeDashboard/customwelcomedashboard.css"
]
}Now create a stylesheet in our CustomWelcomeDashboard folder called 'customwelcomedashboard.css', and add some styles, I don't know perhaps a bit of purple:
.welcome-dashboard h1 {
font-size:4em;
color:purple;
}This stylesheet will now be loaded and applied to your dashboard. Add images and HTML markup as required.
.png)
{% hint style="info" %} One caveat is that the package.manifest file is loaded into memory when Umbraco starts up. If you are adding a new stylesheet or JavaScript file you will need to start and stop your application for it to be loaded. {% endhint %}
If the title doesn't change color, Smidge may be caching the CSS and JavaScript. To clear the cache and get it to load in the new JavaScript and CSS, you can configure the Runtime minification settings in the appsettings.json file. When you reload the page, you'll see the colorful title.
For information on creating bundles of your site's CSS or JavaScript files in your code, see the Bundling & Minification for JavaScript and CSS section.
Hopefully, now you can see the potential of what you can provide to an editor as a basic welcome dashboard.
We can add functionality to the dashboard by associating an AngularJS controller with the HTML view.
Let's add a new file to the CustomWelcomeDashboard folder called customwelcomedashboard.controller.js where our controller code will live.
We register this AngularJS controller to the Umbraco Angular module:
angular.module("umbraco").controller("CustomWelcomeDashboardController", function ($scope) {
var vm = this;
alert("hello world");
});In our HTML view, we update the outer div to wire up the controller to the view:
<div class="welcome-dashboard" ng-controller="CustomWelcomeDashboardController as vm">{% hint style="info" %} The use of vm (short for view model) is to enable communication between the view and the controller. {% endhint %}
Finally, we need to update the package.manifest file to load the additional controller JavaScript file when the dashboard is displayed:
{
"dashboards": [
{
"alias": "welcomeDashboard",
"view": "/App_Plugins/CustomWelcomeDashboard/WelcomeDashboard.html",
"sections": [ "content" ],
"weight": -10,
"access": [
{ "deny": "translator" },
{ "grant": "admin" }
]
}
],
"javascript": [
"~/App_Plugins/CustomWelcomeDashboard/customwelcomedashboard.controller.js"
],
"css": [
"~/App_Plugins/CustomWelcomeDashboard/customwelcomedashboard.css"
]
}If all is setup fine we should now receive the 'Hello world' alert every time the dashboard is reloaded in the content section of Umbraco.
Umbraco has a fine selection of angular directives, resources, and services that you can use in your custom property editors and dashboards. The details are here: Backoffice UI. For this example, it would be nice to welcome the editor by name. To achieve this we can use the userService to customize our dashboard welcome message and increase friendliness:
We inject the userService into our AngularJS controller like so:
angular.module("umbraco").controller("CustomWelcomeDashboardController", function ($scope,userService) {and then we can use the userService's promise based getCurrentUser() method to get the details of the current logged in user:
angular.module("umbraco").controller("CustomWelcomeDashboardController", function ($scope, userService) {
var vm = this;
vm.UserName = "guest";
var user = userService.getCurrentUser().then(function(user) {
console.log(user);
vm.UserName = user.name;
});
});{% hint style="info" %}
Notice you can use console.log() to write out to the browser console window what is being returned by the promise. This helps to debug, but also understand what properties are available to use.
{% endhint %}
Finally we can now update our view to incorporate the current user's name in our Welcome Message:
<h1><localize key="welcomeDashboard_heading">Default heading</localize> {{vm.UserName}}</h1>
An editor may find it useful to see a list of articles they have been editing along with a link to load and continue editing. This could be instead of having to remember and find the item again in the Umbraco Content Tree.
We can make use of Umbraco's Angular resource for retrieving audit log information. Add logResource to the method and use the getPagedUserLog method to return a list of activities the current user has performed recently.
We inject the logResource into our controller:
angular.module("umbraco").controller("CustomWelcomeDashboardController", function ($scope, userService, logResource) {Add a property on our ViewModel to store the log information:
vm.UserLogHistory = []; Add to our WelcomeDashboard.html view some markup using angular's ng-repeat to display a list of these log entries:
<h2>We know what you edited last week...</h2>
<ul>
<li ng-repeat="logEntry in vm.UserLogHistory.items">{{logEntry.nodeId}} - {{logEntry.logType}} - {{logEntry.timestamp | date:'medium'}}</li>
</ul>In our controller we will populate the array of entries using the logResource. The getPagedUserLog method expects to receive a JSON object containing information to filter the log by:
var userLogOptions = {
pageSize: 10,
pageNumber: 1,
orderDirection: "Descending",
sinceDate: new Date(2018, 0, 1)
};These options should retrieve the last ten activities for the current user in descending order since the start of 2018. We pass the options into the getPagedUserLog like so:
logResource.getPagedUserLog(userLogOptions)
.then(function (response) {
console.log(response);
vm.UserLogHistory = response;
});Take a look at the output of console.log of the response in your browser to see the kind of information retrieved from the log:
{pageNumber: 1, pageSize: 10, totalPages: 1, totalItems: 1, items: Array(1)}
items: Array(1)
0:
$$hashKey: "object:1289"
comment: "Published languages: English (United States)"
entityType: "Document"
logType: "PublishVariant"
nodeId: 1055
parameters: "English (United States)"
timestamp: "2019-10-10T14:49:55.223Z"
userAvatars: []
userId: 1
userName: "Jakob N"
pageNumber: 1
pageSize: 10
totalItems: 1
totalPages: 1It's nearly all we need but missing information about the item that was saved and published!
We can use the entityResource, another Umbraco Angular resource to enables us to retrieve more information about an entity given its id.
Inject this into our angular controller:
angular.module("umbraco").controller("CustomWelcomeDashboardController", function ($scope, userService, logResource, entityResource) {We need to loop through the log items from the logResource. Since this includes everything, we need to filter out activities we're not interested in eg, Macro Saves, or DocType Saves. Generally we need the entry in the log to have a nodeId, a 'logType' of 'save' and an entity type of Media or Content.
The entityResource then has a getById method that accepts the ID of the item and the entity 'type' to retrieve useful information about the entity. For example, its Name and Icon.
The getById method is supported on the following entity types: Document (content), Media, Member Type, Member Group, Media Type, Document Type, Member and Data Type. This needs to be defined before we loop through the entries.
Putting this together:
logResource.getPagedUserLog(userLogOptions)
.then(function (response) {
console.log(response);
vm.UserLogHistory = response;
// define the entity types that we care about, in this case only content and media
var supportedEntityTypes = ["Document", "Media"];
// define an empty array "nodes we know about"
var nodesWeKnowAbout = [];
// define an empty array "filtered log entries"
var filteredLogEntries = [];
// loop through the entries in the User Log History
angular.forEach(response.items, function (item) {
// if the item is already in our "nodes we know about" array, skip to the next log entry
if (nodesWeKnowAbout.includes(item.nodeId)) {
return;
}
// if the log entry is not for an entity type that we care about, skip to the next log entry
if (!supportedEntityTypes.includes(item.entityType)) {
return;
}
// if the user did not save or publish, skip to the next log entry
if (item.logType !== "Save" && item.logType !== "Publish") {
return;
}
// if the item does not have a valid nodeId, skip to the next log entry
if (item.nodeId < 0) {
return;
}
// now, push the item's nodeId to our "nodes we know about" array
nodesWeKnowAbout.push(item.nodeId);
// use entityResource to retrieve details of the content/media item
var ent = entityResource.getById(item.nodeId, item.entityType).then(function (ent) {
console.log(ent);
item.Content = ent;
});
// get the edit url
if (item.entityType === "Document") {
item.editUrl = "content/content/edit/" + item.nodeId;
}
if (item.entityType === "Media") {
item.editUrl = "media/media/edit/" + item.nodeId;
}
// push the item to our "filtered log entries" array
filteredLogEntries.push(item);
// end of loop
});
// populate the view with our "filtered log entries" array
vm.UserLogHistory.items = filteredLogEntries;
// end of function
});Finally update our view to use the additional retrieved entity information:
<h2>We know what you edited last week...</h2>
<ul class="unstyled">
<li ng-repeat="logEntry in vm.UserLogHistory.items">
<i class="{{logEntry.Content.icon}}"></i> <a href="/Umbraco/#/{{logEntry.editUrl}}">{{logEntry.Content.name}} <span ng-if="logEntry.comment">- {{logEntry.comment}}</span></a> - <span class="text-muted">(Edited on: {{logEntry.timestamp | date:'medium'}})</span>
</li>
</ul>and we should have a list of recently saved content and media:
.png)
{% hint style="info" %}
The URL /umbraco/#/content/content/edit/1234 is the path to open up a particular entity (with id 1234) ready for editing.
The logResource has a few bugs prior to version 8.1.4. If you are on a lower version this may not give the expected result.
{% endhint %}
One of the key user journeys an editor will make in the backoffice is to create a new thing of some sort. If it is a person's job to create new blog entries, why not create a handy shortcut to help them achieve this common task?
We could add a shortcut to allow the users to add a blogpost.
Add the following to our view:
<div>
<a class="btn btn-primary btn-large" href="/umbraco/#/content/content/edit/1065?doctype=BlogPost&create=true">
<i class="icon-edit"></i>
Create New Blog Post
</a>
</div>1065 is the ID of our blog section and blogPost is the alias of the type of document we want to create.
At this point we are done with the tutorial, your files should contain this:
CustomWelcomeDashboardController:
angular.module("umbraco").controller("CustomWelcomeDashboardController", function ($scope, userService, logResource, entityResource) {
var vm = this;
vm.UserName = "guest";
var user = userService.getCurrentUser().then(function (user) {
console.log(user);
vm.UserLogHistory = [];
vm.UserName = user.name;
});
var userLogOptions = {
pageSize: 10,
pageNumber: 1,
orderDirection: "Descending",
sinceDate: new Date(2018, 0, 1)
};
logResource.getPagedUserLog(userLogOptions)
.then(function (response) {
console.log(response);
vm.UserLogHistory = response;
// define the entity types that we care about, in this case only content and media
var supportedEntityTypes = ["Document", "Media"];
// define an empty array "nodes we know about"
var nodesWeKnowAbout = [];
// define an empty array "filtered log entries"
var filteredLogEntries = [];
// loop through the entries in the User Log History
angular.forEach(response.items, function (item) {
// if the item is already in our "nodes we know about" array, skip to the next log entry
if (nodesWeKnowAbout.includes(item.nodeId)) {
return;
}
// if the log entry is not for an entity type that we care about, skip to the next log entry
if (!supportedEntityTypes.includes(item.entityType)) {
return;
}
// if the user did not save or publish, skip to the next log entry
if (item.logType !== "Save" && item.logType !== "Publish") {
return;
}
// if the item does not have a valid nodeId, skip to the next log entry
if (item.nodeId < 0) {
return;
}
// now, push the item's nodeId to our "nodes we know about" array
nodesWeKnowAbout.push(item.nodeId);
// use entityResource to retrieve details of the content/media item
var ent = entityResource.getById(item.nodeId, item.entityType).then(function (ent) {
console.log(ent);
item.Content = ent;
});
// get the edit url
if (item.entityType === "Document") {
item.editUrl = "content/content/edit/" + item.nodeId;
}
if (item.entityType === "Media") {
item.editUrl = "media/media/edit/" + item.nodeId;
}
// push the item to our "filtered log entries" array
filteredLogEntries.push(item);
// end of loop
});
// populate the view with our "filtered log entries" array
vm.UserLogHistory.items = filteredLogEntries;
// end of function
});
});WelcomeDashboard.html:
<div class="welcome-dashboard" ng-controller="CustomWelcomeDashboardController as vm">
<h1><localize key="welcomeDashboard_heading">Default heading</localize> {{vm.UserName}}</h1>
<p><localize key="welcomeDashboard_bodytext">Default bodytext</localize></p>
<p><localize key="welcomeDashboard_copyright">Default copyright</localize></p>
<h2>We know what you edited last week...</h2>
<ul class="unstyled">
<li ng-repeat="logEntry in vm.UserLogHistory.items">
<i class="{{logEntry.Content.icon}}"></i> <a href="/Umbraco/#/{{logEntry.editUrl}}">{{logEntry.Content.name}} <span ng-if="logEntry.comment">- {{logEntry.comment}}</span></a> - <span class="text-muted">(Edited on: {{logEntry.timestamp | date:'medium'}})</span>
</li>
</ul>
<div>
<a class="btn btn-primary btn-large" href="/umbraco/#/content/content/edit/1065?doctype=BlogPost&create=true">
<i class="icon-edit"></i>
Create New Blog Post
</a>
</div>
</div>You can create your own custom Angular services/resources to interact with your own serverside data (using UmbracoAuthorizedJsonController).
The property editor tutorial has a step explaining how to do this.
With all of the steps completed, you should have a functional dashboard that will let the logged-in user see the changes they made!
Hopefully this tutorial has given you some ideas on what is possible to do when creating a dashboard. Remember to check out the Angular API docs for more info on all of the resources and services you can find for the backoffice!