> For the complete documentation index, see [llms.txt](https://academy.pentaho.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://academy.pentaho.com/solution-analyst-path-sandbox/solution-analyst/ctools.md).

# CTools

The fifth course of the Solution Analyst path: CTools. 16 lessons across 6 modules: CDA data sources, CDF and CDE dashboards with CCC charts, and CGG, ending in a Retail Sales analysis dashboard.

{% hint style="warning" icon="eye" %}
**SANDBOX — draft page.** Built from `bi-developer-ct-associate` 0.1.8 in Pentaho Content Manager. Module and lesson names, the reading-or-workshop kinds and the times come straight from each lab's manifest. Items marked REPLACE-ME need an owner's confirmation.
{% endhint %}

The fifth and last of the five courses on the Solution Analyst path. Go beyond the dashboards Dashboard Designer can build: the Pentaho Community Tools stack in the User Console — Community Data Access (CDA) for the data, the Community Dashboard Framework (CDF) and the Community Dashboard Editor (CDE) with CCC charts for the dashboards, and the Community Graphics Generator (CGG) for server-side charts. It ends with a complete Retail Sales analysis dashboard.

{% columns %}
{% column %}

<p align="center"><i class="fa-file-lines" style="color:green;">:file-lines:</i><br><strong>16 lessons</strong><br><em>across 6 modules</em></p>
{% endcolumn %}

{% column %}

<p align="center"><i class="fa-flask" style="color:orange;">:flask:</i><br><strong>9 workshops</strong><br><em>hands-on labs</em></p>
{% endcolumn %}

{% column %}

<p align="center"><i class="fa-clock" style="color:cyan;">:clock:</i><br><strong>~7h 55m</strong><br><em>a long day, or a few evenings</em></p>
{% endcolumn %}
{% endcolumns %}

{% hint style="success" icon="cloud-arrow-up" %}
Every workshop is hands-on and runs on Pentaho's hosting platform. The Lab Guide is embedded in each lab and loads automatically when you open it — nothing to install.
{% endhint %}

***

<h3 align="center">Before you start</h3>

{% columns %}
{% column %}
{% hint style="success" icon="circle-check" %}
**What you'll need**

Business Analyst, or experience building dashboards in the User Console. CTools goes furthest from the point-and-click tools: it helps to have seen a little HTML, CSS and JavaScript, and SQL for the CDA data sources.
{% endhint %}
{% endcolumn %}

{% column %}
{% hint style="info" icon="tag" %}
**Built against**

Pentaho Enterprise Edition **11.0.0.0-232**, the build every course on the Academy runs, with the CTools plugins in the User Console. The hosted labs run this exact release, so every screen, menu and dialog matches the guide step for step.
{% endhint %}
{% endcolumn %}
{% endcolumns %}

***

{% hint style="info" icon="chart-pie" %}

#### What you'll build

Your first CTools dashboard, then CDA data sources that feed dashboard components, CDF dashboards assembled in code, and the Carrier Dashboard built in CDE with responsive Bootstrap layouts, CCC charts, parameters and selectors — with its charts rendered server-side by CGG. The closing use case is a complete Retail Sales analysis dashboard that combines CDA data sources, CDE layout and components, and CCC charts.
{% endhint %}

***

<h3 align="center">Skills you'll gain</h3>

<table data-view="cards"><thead><tr><th></th><th></th></tr></thead><tbody><tr><td><i class="fa-rocket" style="color:blue;">:rocket:</i> <strong>The CTools stack</strong></td><td>CDA, CDF, CDE, CCC and CGG on the Pentaho Server · enabling the plugins · a first dashboard</td></tr><tr><td><i class="fa-database" style="color:blue;">:database:</i> <strong>Community Data Access</strong></td><td>One abstraction over many sources · parameter-driven queries · joins and unions · preview and export</td></tr><tr><td><i class="fa-cubes" style="color:blue;">:cubes:</i> <strong>Community Dashboard Framework</strong></td><td>Code-first dashboards in HTML, CSS and JavaScript · component and dashboard lifecycles</td></tr><tr><td><i class="fa-pen-ruler" style="color:blue;">:pen-ruler:</i> <strong>Community Dashboard Editor</strong></td><td>Layout, Components and Data Sources · Bootstrap layouts · CCC charts · parameters and selectors</td></tr><tr><td><i class="fa-chart-pie" style="color:blue;">:chart-pie:</i> <strong>Community Graphics Generator</strong></td><td>CCC charts rendered server-side as images · for reports and by URL</td></tr><tr><td><i class="fa-trophy" style="color:blue;">:trophy:</i> <strong>Use case — Sales Analysis Dashboard</strong></td><td>A complete Retail Sales dashboard · CDA, CDE and CCC together</td></tr></tbody></table>

***

<h3 align="center">Course outline</h3>

<p align="center"><i class="fa-file-lines" style="color:green;">:file-lines:</i> reading · <i class="fa-flask" style="color:orange;">:flask:</i> hands-on workshop</p>

{% hint style="info" icon="circle-info" %}
Full lessons unlock once you're enrolled — this is the outline only. Times are the lab guides' own estimates.
{% endhint %}

<table data-search="false"><thead><tr><th width="382">Module</th><th width="115" align="center">Reading</th><th width="132" align="center">Workshops</th><th width="100" align="right">Time</th></tr></thead><tbody><tr><td>Getting Started</td><td align="center">2</td><td align="center">2</td><td align="right">~1h 50m</td></tr><tr><td>Community Data Access</td><td align="center">1</td><td align="center">2</td><td align="right">~1h 25m</td></tr><tr><td>Community Dashboard Framework</td><td align="center">1</td><td align="center">2</td><td align="right">~1h 20m</td></tr><tr><td>Community Dashboard Editor</td><td align="center">2</td><td align="center">1</td><td align="right">~2h 5m</td></tr><tr><td>Community Graphics Generator</td><td align="center">1</td><td align="center">1</td><td align="right">~30m</td></tr><tr><td>Use Cases</td><td align="center">—</td><td align="center">1</td><td align="right">~45m</td></tr><tr><td><strong>Total</strong></td><td align="center"><strong>7</strong></td><td align="center"><strong>9</strong></td><td align="right"><strong>~7h 55m</strong></td></tr></tbody></table>

{% stepper %}
{% step %}

### <i class="fa-rocket" style="color:blue;">:rocket:</i> Getting Started

`2 readings · 2 workshops · ~1h 50m`

Meet the CTools stack — CDA, CDF, CDE, CCC, and CGG — installed on top of the Pentaho Server. Enable the CDE/CDA plugins, then build your first dashboard to see how the pieces fit together.

<figure><img src="https://1021209504-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fu2m9COjKaS0E9nT7B9bQ%2Fuploads%2Fw79IymooSJuTXOAp0BTG%2Fct-lab-setup.svg?alt=media" alt="Your machine needs only a browser: the User Console opens the CDE editor and the CTools dashboards run in it, each component calling doQuery on the CTools plugins (CDE, CDF, CDA, CCC, CGG) inside the Pentaho Server at localhost:8080; the plugins reach the HSQLDB sampledata database on port 9001 through the SampleData connection, and start-pentaho.bat brings it all up together"><figcaption><p>Your browser, the Pentaho Server with the CTools plugins, and the sample data</p></figcaption></figure>

<figure><img src="https://1021209504-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fu2m9COjKaS0E9nT7B9bQ%2Fuploads%2FXRym8pAODxbayYwOU5RG%2Fctools-stack.svg?alt=media" alt="The five CTools: in the browser, CDE builds a CDF dashboard whose charts CCC draws; on the Pentaho Server, Save writes the .wcdf, .cdfde and .cda files to the repository, every dashboard component fetches data from CDA with doQuery, CGG draws the same CCC chart on the server as PNG, JPG or SVG and reads its data through CDA, and CDA queries SQL, MDX, metadata, Kettle, scripting and XPath sources"><figcaption><p>The CTools stack: what runs in the browser and what runs on the Pentaho Server</p></figcaption></figure>

<figure><img src="https://1021209504-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fu2m9COjKaS0E9nT7B9bQ%2Fuploads%2FsBq1c8JnevI2PHAT442w%2Fcde-wiring.svg?alt=media" alt="CDE&#x27;s three perspectives joined by name: the Total_SalesChart component&#x27;s HtmlObject is Panel_3, the Name of a layout column drawn as a div, and its Datasource is Total_SalesQuery, an mdx over mondrianJndi data source whose Jndi names the SampleData connection; a wrong name means no chart, no data or no database; Save writes the .wcdf, the .cdfde and the .cda to the repository"><figcaption><p>One chart's wiring: three names that must match, and the three files Save writes</p></figcaption></figure>

<details>

<summary>See the full breakdown</summary>

<table data-search="false"><thead><tr><th width="79"></th><th>Lesson</th><th width="90">Time</th></tr></thead><tbody><tr><td><i class="fa-file-lines" style="color:green;">:file-lines:</i></td><td>Before You Start</td><td>~25m</td></tr><tr><td><i class="fa-file-lines" style="color:green;">:file-lines:</i></td><td>Getting Started</td><td>~25m</td></tr><tr><td><i class="fa-flask" style="color:orange;">:flask:</i></td><td>First Steps</td><td>~30m</td></tr><tr><td><i class="fa-flask" style="color:orange;">:flask:</i></td><td>My First Dashboard</td><td>~30m</td></tr></tbody></table>

</details>
{% endstep %}

{% step %}

### <i class="fa-database" style="color:blue;">:database:</i> Community Data Access

`1 reading · 2 workshops · ~1h 25m`

CDA is the data layer for CTools dashboards: a single abstraction over many sources with parameter-driven queries, joins/unions, preview, and exports. Create CDA data sources and feed them to dashboard components.

<figure><img src="https://1021209504-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fu2m9COjKaS0E9nT7B9bQ%2Fuploads%2Fb8GKfsIFPVQ08HgWlc0N%2Fcda-request.svg?alt=media" alt="A dashboard component or an external app calls doQuery with path, dataAccessId and values; CDA checks the cache key, built from the connection, query, parameter values and, for MDX, the Mondrian role; a hit returns the rows; a miss runs the DataAccess over its Connection, then Column, CalculatedColumn and Output reshape the rows, then they are cached and returned as json, xml, csv, xls or html"><figcaption><p>One doQuery request through CDA: the cache check, then the query and the reshaping on a miss</p></figcaption></figure>

<details>

<summary>See the full breakdown</summary>

<table data-search="false"><thead><tr><th width="79"></th><th>Lesson</th><th width="90">Time</th></tr></thead><tbody><tr><td><i class="fa-file-lines" style="color:green;">:file-lines:</i></td><td>Overview of Community Data Access</td><td>~15m</td></tr><tr><td><i class="fa-flask" style="color:orange;">:flask:</i></td><td>Creating a CDA</td><td>~45m</td></tr><tr><td><i class="fa-flask" style="color:orange;">:flask:</i></td><td>CDA Data Sources</td><td>~25m</td></tr></tbody></table>

</details>
{% endstep %}

{% step %}

### <i class="fa-cubes" style="color:blue;">:cubes:</i> Community Dashboard Framework

`1 reading · 2 workshops · ~1h 20m`

CDF is the code-first dashboard framework — HTML/CSS/JavaScript with managed component and dashboard lifecycles. Understand the framework that CDE is built on by assembling CDF dashboards directly.

<details>

<summary>See the full breakdown</summary>

<table data-search="false"><thead><tr><th width="79"></th><th>Lesson</th><th width="90">Time</th></tr></thead><tbody><tr><td><i class="fa-file-lines" style="color:green;">:file-lines:</i></td><td>Overview of Community Dashboard Framework</td><td>~20m</td></tr><tr><td><i class="fa-flask" style="color:orange;">:flask:</i></td><td>CDF Dashboard</td><td>~30m</td></tr><tr><td><i class="fa-flask" style="color:orange;">:flask:</i></td><td>CDF Dashboards</td><td>~30m</td></tr></tbody></table>

</details>
{% endstep %}

{% step %}

### <i class="fa-pen-ruler" style="color:blue;">:pen-ruler:</i> Community Dashboard Editor

`2 readings · 1 workshop · ~2h 5m`

CDE is the graphical dashboard editor: a Layout / Components / Data Sources workflow over the CDF framework. Build the Carrier Dashboard with responsive Bootstrap layouts, CCC charts, parameters, and selectors — no hand-coding required.

<figure><img src="https://1021209504-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fu2m9COjKaS0E9nT7B9bQ%2Fuploads%2FTUGpNo0BNeBhvvivkGS3%2Fdashboard-lifecycle.svg?alt=media" alt="Sequence of Browser, CDE renderer and CDA: the browser opens the dashboard; CDE writes each layout row and column as a div named after it; init creates every component, and Execute at Start ones run by Priority unless preExecution returns false; each calls CDA doQuery, runs postFetch and renders into its HtmlObject; on every parameter change, the listeners query and render again"><figcaption><p>The lifecycle of a CDE dashboard, from the page request to the interaction loop</p></figcaption></figure>

<figure><img src="https://1021209504-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fu2m9COjKaS0E9nT7B9bQ%2Fuploads%2FEBD4LDzKxXZFXpca79Hf%2Fparameters-listeners.svg?alt=media" alt="A selector stores the choice in its parameter and a pie-slice click calls dashboard.fireChange; the parameter changes and every enabled component listening to it updates; lineChart, with the parameter in Listeners and Parameters, sends paramplanTypeParameter to CDA doQuery and redraws; a component with Listeners only updates with old data, and one with Parameters only never updates"><figcaption><p>Listeners make a component run again; Parameters carry the new value to its query</p></figcaption></figure>

<details>

<summary>See the full breakdown</summary>

<table data-search="false"><thead><tr><th width="79"></th><th>Lesson</th><th width="90">Time</th></tr></thead><tbody><tr><td><i class="fa-file-lines" style="color:green;">:file-lines:</i></td><td>Overview of Community Dashboard Editor</td><td>~10m</td></tr><tr><td><i class="fa-file-lines" style="color:green;">:file-lines:</i></td><td>UI Overview</td><td>~25m</td></tr><tr><td><i class="fa-flask" style="color:orange;">:flask:</i></td><td>Carrier Dashboard</td><td>~1h 30m</td></tr></tbody></table>

</details>
{% endstep %}

{% step %}

### <i class="fa-chart-pie" style="color:blue;">:chart-pie:</i> Community Graphics Generator

`1 reading · 1 workshop · ~30m`

CGG renders CCC charts server-side as images — for reports, for browsers with limited SVG support, and via URL. Generate the Carrier Dashboard's charts with CGG.

<figure><img src="https://1021209504-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fu2m9COjKaS0E9nT7B9bQ%2Fuploads%2F5CXYk1KlYZvY6j9mBY2Q%2Fcgg-export.svg?alt=media" alt="One lineChart definition, two render paths: in the browser, Post Fetch finds typeof cgg undefined, the dashboard block runs and CCC draws the SVG; Export PNG calls the CGG draw service on the server with each parameter as param name, Rhino runs Layout_lineChart.js, which CDE wrote at save, the export block runs, CCC draws the SVG and Batik converts it to the PNG the popup downloads"><figcaption><p>One component definition, rendered by CCC on the dashboard and by CGG for the export</p></figcaption></figure>

<details>

<summary>See the full breakdown</summary>

<table data-search="false"><thead><tr><th width="79"></th><th>Lesson</th><th width="90">Time</th></tr></thead><tbody><tr><td><i class="fa-file-lines" style="color:green;">:file-lines:</i></td><td>Overview of Community Graphics Generator</td><td>~10m</td></tr><tr><td><i class="fa-flask" style="color:orange;">:flask:</i></td><td>Carrier Dashboard Charts</td><td>~20m</td></tr></tbody></table>

</details>
{% endstep %}

{% step %}

### <i class="fa-trophy" style="color:blue;">:trophy:</i> Use Cases

`1 workshop · ~45m`

Put it together end-to-end: build a complete Retail Sales analysis dashboard that combines CDA data sources, CDE layout and components, and CCC charts.

<details>

<summary>See the full breakdown</summary>

<table data-search="false"><thead><tr><th width="79"></th><th>Lesson</th><th width="90">Time</th></tr></thead><tbody><tr><td><i class="fa-flask" style="color:orange;">:flask:</i></td><td>Sales Analysis Dashboard</td><td>~45m</td></tr></tbody></table>

</details>
{% endstep %}
{% endstepper %}

***

<h3 align="center">Exam &#x26; accreditation</h3>

{% columns %}
{% column %}
{% hint style="info" icon="clipboard-check" %}
**The course exam**

40 questions drawn at random from a pool of 50, covering the taught modules. The pass mark is 80%. It's open-book: browse any module or ask the AI assistant while you work.
{% endhint %}
{% endcolumn %}

{% column %}
{% hint style="warning" icon="file-certificate" %}
**Course accreditation**

Finish the lessons and workshops and pass the exam, and you'll automatically be able to download your course accreditation. It states your name, the course and the Pentaho version you studied against, and is valid for two years. The exam is self-paced and not proctored. REPLACE-ME — the course has no accreditation settings yet (its name and topics); confirm them.

This course is the fifth and last step on the Certified Solution Analyst learning path: Business Analyst, then Schema Workbench, Metadata Editor, Report Designer and CTools, leading to the Certified Solution Analyst credential — which closes with a proctored exam delivered through Kryterion's Webassessor.
{% endhint %}
{% endcolumn %}
{% endcolumns %}

***

<p align="center"><a href="https://academy.pentaho.com/solution-analyst-path-sandbox/solution-analyst.md" class="button secondary" data-icon="arrow-left">Back to the Solution Analyst path</a></p>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://academy.pentaho.com/solution-analyst-path-sandbox/solution-analyst/ctools.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
