> 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/speciality-courses/embedded-analytics.md).

# Embedded Analytics

Coming soon — Put Pentaho reports, Analyzer views and CTools dashboards inside another application: report URLs, embedded views, sign-on from the host, and styling that matches it.

{% hint style="warning" icon="eye" %}
**SANDBOX — draft page.** **🚧 In development — coming soon.** This Speciality is still being written. The outline below comes from the draft course `analyst-embed-specialty` in Pentaho Content Manager: module and lesson names, kinds and estimated times are taken from its lab manifests, and may change before release. The labs have not yet been tested on a lab server. Items marked REPLACE-ME need an owner's confirmation.
{% endhint %}

Put Pentaho reports, Analyzer views and CTools dashboards inside another application: report URLs and parameters, embedded Analyzer and dashboards, sign-on passed from the host application, and styling that matches it.

{% columns %}
{% column %}

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

{% column %}

<p align="center"><i class="fa-flask" style="color:orange;">:flask:</i><br><strong>7 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</strong><br><em>estimated</em></p>
{% endcolumn %}
{% endcolumns %}

{% hint style="success" icon="cloud-arrow-up" %}
Every workshop will be hands-on, on a Windows lab machine with the Lab Guide embedded. REPLACE-ME — confirm the hosted lab for this Speciality.
{% endhint %}

***

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

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

Report Designer and CTools, or equivalent experience publishing reports and building CDE dashboards. Comfort editing a little HTML and JavaScript helps: every workshop embeds into a small host page served on the lab machine.
{% 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, on a Windows lab machine.
{% endhint %}
{% endcolumn %}
{% endcolumns %}

***

{% hint style="info" icon="trophy" %}

#### What you'll build

A host web page that carries Pentaho inside it: a parameterised report in a frame, the same report as PDF, image and download, an Analyzer view, and a CTools dashboard rendered into the page and driven by it — signed on safely and styled to match. The capstone puts it all into a customer portal.
{% endhint %}

***

<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" %}
This is the draft outline. Times are the lab guides' own estimates, and the course is not yet open for enrolment.
{% 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">—</td><td align="right">~30m</td></tr><tr><td>Embedding Reports</td><td align="center">1</td><td align="center">2</td><td align="right">~1h 20m</td></tr><tr><td>Embedding Analyzer and Dashboards</td><td align="center">1</td><td align="center">2</td><td align="right">~1h 35m</td></tr><tr><td>Sign-On and Styling</td><td align="center">1</td><td align="center">2</td><td align="right">~1h 35m</td></tr><tr><td>Capstone Project</td><td align="center">—</td><td align="center">1</td><td align="right">~2h</td></tr><tr><td><strong>Total</strong></td><td align="center"><strong>5</strong></td><td align="center"><strong>7</strong></td><td align="right"><strong>~7h</strong></td></tr></tbody></table>

{% stepper %}
{% step %}

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

`2 readings · ~30m`

How to get the most out of this guide, and the ways Pentaho 11 content can be embedded in another application.

<figure><img src="https://1021209504-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fu2m9COjKaS0E9nT7B9bQ%2Fuploads%2Fg3r1sqUnAw1Use4EKeJX%2Fthree-ways-in.svg?alt=media" alt="The three ways in. From the host page: an iframe gets a Pentaho page in the frame, meeting the framing and cookie rules; a div filled through cde-embed.js and the dash! loader gets a dashboard class from getDashboard, meeting the CORS and cookie rules. From the host&#x27;s server, a server-side call gets a PDF or CSV file, meeting no browser rule. localhost:8000 and localhost:8080 are two origins."><figcaption><p>Three ways in: two through the browser, each meeting its own browser rules, and one from the host's server, with no browser involved</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>~15m</td></tr><tr><td><i class="fa-file-lines" style="color:green;">:file-lines:</i></td><td>Embedding Options in Pentaho 11</td><td>~15m</td></tr></tbody></table>

</details>
{% endstep %}

{% step %}

### <i class="fa-file-code" style="color:blue;">:file-code:</i> Embedding Reports

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

Run published reports by URL, pass their parameters from the host application, and choose the output format.

<figure><img src="https://1021209504-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fu2m9COjKaS0E9nT7B9bQ%2Fuploads%2FBfb56qseJZ6j5gHIA46E%2Freport-url-anatomy.svg?alt=media" alt="The report URL in five parts: the server, http://localhost:8080/pentaho; the API, /api/repos/, which runs files by path; the repository id, the report&#x27;s path with each slash as a colon, URL-encoded; the endpoint, /generatedContent for output only or /viewer for the prompt panel and report; the query string, parameters by Name and output-target for the format."><figcaption><p>The anatomy of a report URL: five parts, in the order they appear, and what each one controls</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 Report URLs and Parameters</td><td>~15m</td></tr><tr><td><i class="fa-flask" style="color:orange;">:flask:</i></td><td>Embed a Report with Parameters</td><td>~35m</td></tr><tr><td><i class="fa-flask" style="color:orange;">:flask:</i></td><td>Output Formats and Rendering</td><td>~30m</td></tr></tbody></table>

</details>
{% endstep %}

{% step %}

### <i class="fa-window-restore" style="color:blue;">:window-restore:</i> Embedding Analyzer and Dashboards

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

Place an Analyzer view and a CTools dashboard inside a host page, and drive them from it.

<figure><img src="https://1021209504-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fu2m9COjKaS0E9nT7B9bQ%2Fuploads%2Fh4K815p0QGmfGSFGtXrf%2Fframe-vs-page.svg?alt=media" alt="Side by side. In a frame: host CSS and JavaScript stop at the frame&#x27;s edge, where contentDocument is null; behind it is a Pentaho page with its own styles, scripts and origin; the server must allow framing. Rendered into the page: the host loads cde-embed.js, require with the dash! loader, getDashboard answers with a class, new SalesDash, render draws it into the div; the server must allow CORS."><figcaption><p>In a frame, the host stops at the frame's edge; rendered into the page, the dashboard is part of the host page</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 Embedded Analyzer and Dashboards</td><td>~15m</td></tr><tr><td><i class="fa-flask" style="color:orange;">:flask:</i></td><td>Embed an Analyzer View</td><td>~35m</td></tr><tr><td><i class="fa-flask" style="color:orange;">:flask:</i></td><td>Embed a CTools Dashboard</td><td>~45m</td></tr></tbody></table>

</details>
{% endstep %}

{% step %}

### <i class="fa-id-badge" style="color:blue;">:id-badge:</i> Sign-On and Styling

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

Sign the user in once, in the host application, and make embedded content look like part of it.

<figure><img src="https://1021209504-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fu2m9COjKaS0E9nT7B9bQ%2Fuploads%2FQsRGLWsmFjxRMADTs51g%2Ftwo-sessions.svg?alt=media" alt="A sequence across the browser, the host on localhost:8000 and the Pentaho Server on localhost:8080. 1, the user signs in to the host, which answers with its own session cookie. 2, the host page arrives with an iframe holding a Pentaho URL. 3, the browser requests it with its localhost:8080 cookies. 4a, with a valid JSESSIONID the content runs as that user; 4b, with none, a login page or prompt."><figcaption><p>Two applications, two sessions: the host's cookie signs the user in to the host only, and the Pentaho request runs as whoever its JSESSIONID names</p></figcaption></figure>

<figure><img src="https://1021209504-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fu2m9COjKaS0E9nT7B9bQ%2Fuploads%2Fm1YONmYQnquWhCbF4RIA%2Fsign-on-approaches.svg?alt=media" alt="The four approaches, from prefer to avoid. 1, single sign-on: one identity provider for both, a redirect with no prompt. 2, a reverse proxy: one site, so Pentaho&#x27;s cookie is first-party; it signs no one in by itself. 3, a trusted host: the host&#x27;s server calls from a TrustedIpAddrs address and names the user. 4, in red, URL parameters: the password lands in the page, logs, history and Referer."><figcaption><p>The sign-on approaches, from the one to prefer to the one to avoid</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 Sign-On for Embedded Content</td><td>~15m</td></tr><tr><td><i class="fa-flask" style="color:orange;">:flask:</i></td><td>Pass Sign-On from the Host Application</td><td>~45m</td></tr><tr><td><i class="fa-flask" style="color:orange;">:flask:</i></td><td>Style Embedded Content to Match</td><td>~35m</td></tr></tbody></table>

</details>
{% endstep %}

{% step %}

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

`1 workshop · ~2h`

Put a report, an Analyzer view and a dashboard inside a customer portal, signed in and styled to match.

<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>Capstone: Analytics Inside a Customer Portal</td><td>~2h</td></tr></tbody></table>

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

***

{% hint style="info" icon="award" %}
**Optional, not part of the path**

Speciality courses are open to any learner who wants to go further. They are not among the five mandatory courses of the Certified Solution Analyst path. The course ends in a capstone project. REPLACE-ME — confirm whether it carries its own exam and course accreditation.
{% endhint %}

***

<p align="center"><a href="https://academy.pentaho.com/solution-analyst-path-sandbox/speciality-courses.md" class="button secondary" data-icon="arrow-left">Back to Speciality Courses</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/speciality-courses/embedded-analytics.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.
