Example UI eXtension

This eXtension shows how the SDL Tridion dashboard can be extended in both the CME and Experience Manager, using DeckPages, OptionPanels and ExtendedAreas. It is designed as an example to show what is possible and comes complete with all source code so you can see how it is all done. Feel free to take it apart completely or reuse as a basis for your own UI extensions. A description of the techniques used can be found on www.tridiondeveloper.com/dashboard-extension.

Example UI - Dashboard

Installation

This eXtension comes with full source as a Microsoft Visual Studio solution which you can directly compile and deploy (you can use the free Microsoft Visual Studio Express edition). The package also contains a pre build extension which you can install using the following instructions:

  1. a) Copy the files under Extension\Example to a directory on your SDL Tridion CMS server, this will be your extension location
    b) Copy the file Extension\Example.Editor.dll to the ..Tridion\web\WebUI\WebRoot\bin directory

  2. Set up the extension location as a virtual directory in IIS 
     a)  In the IIS console, browse to the SDL Tridion 2011 website
     b)  Under the WebUI\Editors directory add a new Virtual Directory (named "Example"), pointing to your extension location on disk (see step 1a)

    Example UI - IIS setup 

  3. Configure extension in the GUI. To do this, find the system.config file under ..\Tridion\web\WebUI\WebRoot\Configuration
     a)  Make a backup of the file first so you can always revert to the way it was with no extensions configured
     b)  Locate the <editors> element and add a new editor like so:

 <editor name="Example">
    <installpath>C:\Program Files (x86)\Tridion\web\WebUI\Editors\Example\</installpath>
    <configuration>Configuration\ExampleEditor.config</configuration>
    <vdir>Example</vdir>
 </editor>

 The editor element has 3 important elements: 
 I)  installpath - The exact location of where you copied the extension (see step 1a)
 II)  configuration - The relative location of the extension configuration file
 III)  vdir - The name of the virtual directory as it's set up in IIS

Thats it, after a refresh of your browser you will find additional button in the Tridion Dashboard above the Control Room. The source can be downloaded below.


Developer
:    Bart Koopman
Company
License agreement
Download package
Tags
:    Example,  2011,  UI,  extension
Version
:   1.0
Source
:   Yes

About the Author
Bart Koopman
Community Development Consultant

As a Community Development Consultant, Bart is the evangelist of all SDL Tridion products. Bart used to be a consultant and trainer at SDL Tridion, supporting both partners and customers with their implementations.

SDL CMT division