Installing the plugin
You can conveniently install the C-Tools (CDF, CDA, CDE …) from the Pentaho User Console (which is the web-interface of the Pentaho BA Server) using the Marketplace.
If you are more a friend of running scripts, you can download the c-tools-installer from Pedro Alve’s Github account.
Folder strucutre of plugin
pentaho-solutions/system/pentaho-cdf directory you find following interesting files and folders:
|folder or file||description|
|css||includes CSS files for blueprint and bootstrap|
|lib||contains the java binary files.|
|resources||contains various other resources like images.|
|template-dashboard.html and template-dashboard-*.html||The first one is the default outer/document template which gets applied to your dashboard content. Other templates have to be named following this pattern:
If you want to have a deeper understand of which external frameworks a special component is using, this folder is the right place to start your search.
pentaho-solutions/system/pentaho-cdf-dd folder is part of the Community Dashboard Designer (CDE).
Files that make up your dashboard
If you are a purist and don’t want to use the Community Dashboard Editor, you could as well code everything. You can create a folder inside the
pentaho-solutions folder and include in the most basic form following files:
|*.xcdf||This is an XML file discribing the dashboard as well as defining the basic settings: The
|*.html||This is a partial
Here some examples (code taken from the Pentaho BI Server examples): xcdf file:
<?xml version="1.0" encoding="UTF-8"?> <cdf> <title>Pentaho Home Dashboard</title> <author>Webdetails</author> <description>Pentaho Home Dashboard</description> <icon></icon> <template>template.html</template> <style>mantle</style> </cdf>
content template template.html (shortened for brefity):
If this scared you off now, don’t you worry, there is a the Community Dashboard Editor available, which allows you to create a Dashboard via an easy to use GUI.
Where to store your own files
You can put your resources directly under the
Creating your own document template
Take a look at any of the template files in
pentaho-solutions/system/pentaho-cdf/template-dashboard*.html. It should be fairly easy to understand how to create your own templates based on this.
Outer/document templates are used to define common artifacts that are used across dashboards. A typical example of this is a navigation, images, styles etc.
You basically prepare a skeleton of an HTML document and use placeholders for the CDF entities, in example:
The outer template can be referenced within the
.xcdf file using the
Style tag. Make sure you only use the costum name of your template: If your template is named
template-dashboard-dwh.html, then reference
dwh for the
The outer template is complemented by the content (inner) template. An example was shown further up in the article.
What you read here is these days mostly relevant as background info. Use the Community Dashboard Editor to design your dashboards in an effective manner.