# PUC

{% hint style="warning" %}

#### Workshop - Pentaho User Console

Your gateway to the Pentaho Business Analytics platform begins with the User Console, the web-based hub where all report viewing, content management, and platform administration converge. 

In this hands-on workshop, you'll learn to navigate the different perspectives within the User Console, understanding how each view serves specific roles in your analytics workflow. You'll discover how to organize your workspace efficiently by creating custom folder structures and curating frequently-used content through the Favorites feature. You'll also explore the administrative capabilities available to platform administrators and learn how to access the comprehensive help resources that will support your ongoing work with Pentaho.

**What You'll Accomplish:**

* Successfully log in to the Pentaho User Console
* Navigate and describe the purpose of different User Console perspectives (Home, Browse Files, Opened, Favorites, Recents, Schedules, Administration)
* Create and organize new repository folders for content management
* Build a personalized Favorites list to streamline access to critical reports and content
* Explore scheduling capabilities and administrative functions (for users with appropriate permissions)
* Locate and access online help resources and documentation within the platform

By the end of this workshop, you'll have established a solid understanding of the User Console environment and developed the organizational practices that will keep your analytics content accessible and well-managed. You'll know where to find reports, how to organize content efficiently, and where to turn for help as you continue your journey with the Pentaho Business Analytics platform.

**Prerequisites:** Pentaho Business Analytics Server installed with valid user credentials\
**Estimated Time:** 20 minutes
{% endhint %}

1. Start the Pentaho Server (Linux) - this has been started as a service.

```bash
cd
cd /opt/pentaho/server/pentaho-server/
sudo ./start-pentaho.sh
```

Select the Pentaho User Console version:

{% tabs %}
{% tab title="Modern Design" %}
{% hint style="info" %}

#### Pentaho User Console 11

The Modern design of the Pentaho User Console (PUC) offers an improved user experience that is intuitive, responsive, and secure. 
{% endhint %}

<figure><img src="https://3159385628-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FiyGCAvfJ7v68TnXf8icC%2Fuploads%2F2nVrWNAt7sk2VhDi0xK9%2Fimage.png?alt=media&#x26;token=06f1c6d0-1785-4cc4-8850-15485b63fef2" alt=""><figcaption><p>PUC - Modern Design</p></figcaption></figure>

1. Log into the Modern Design Pentaho Server Console.

{% embed url="<https://localhost:8080/pentaho/content/login/web/index.html>" %}

| Role          | Username | Password |
| ------------- | -------- | -------- |
| Administrator | Admin    | password |
| Business User | Suzy     | password |

Select a menu option:

{% tabs %}
{% tab title="Home" %}
{% hint style="info" %}

#### Home

The Home page functions as your central access point for Pentaho tools and features within the Modern Design of the Pentaho User Console (PUC). Its Quick Access section provides direct links to essential tools:

* [Browse Files](#browse-files)
* [Plugin Manager](#plugin-manager)
* [Scheduler](#scheduler)
* [Data Connection](#data-connection)
* [Settings](#settings)
* [Semantic Model Editor](#semantic-model-editor)
* Pipeline Designer

Additionally, the Home page displays your recently opened and favorited files - such as transformations and jobs - enabling you to launch or manage them directly without navigating elsewhere.
{% endhint %}

<figure><img src="https://3159385628-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FiyGCAvfJ7v68TnXf8icC%2Fuploads%2F79VuAMObA4ILyHLCKpmm%2Fimage.png?alt=media&#x26;token=79813678-360b-4baf-bf8a-a1617c430c84" alt=""><figcaption><p>Pentaho User Console - Modern Design</p></figcaption></figure>
{% endtab %}

{% tab title="Browse Files" %}
{% hint style="info" %}

#### Browse Files

The Browse Files page enables you to organize your files and folders for efficient retrieval and use. The folders, files, and actions visible within this page are determined by your assigned role and permissions.
{% endhint %}

<figure><img src="https://3159385628-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FiyGCAvfJ7v68TnXf8icC%2Fuploads%2FpGECeoZWGC9tY3vAwoDq%2Fimage.png?alt=media&#x26;token=64fd30dd-35bd-45a0-8c65-fb8b7a2803f1" alt=""><figcaption><p>Browse Files</p></figcaption></figure>

| Menu option     | Description                                                                                                                                                                                                                      |
| --------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Browse Files    | Makes the **Folders** menu navigable so that you can search for or browse to a folder that contains one or more files that you want to view. When you select a folder, the main pane displays the files contained in the folder. |
| Recently opened | Displays a list of recently opened files in the main pane.                                                                                                                                                                       |
| Favorites       | Displays a list of files that you have specified as a favorite in the main pane.                                                                                                                                                 |
| Trash           | Displays a list of files that you moved to the trash.                                                                                                                                                                            |
| {% endtab %}    |                                                                                                                                                                                                                                  |

{% tab title="Plugin Manager" %}
{% hint style="info" %}

#### Plugin Manager

You can extend the **Pentaho User Console (PUC)** by installing plugins that add new capabilities, such as new visualizations, dashboards, and content access extensions. The recommended method for installing, updating, and managing plugins is through the Plugin Manager.

You can use the Plugin Manager to:

* [Install plugins](https://academy.pentaho.com/pentaho-business-analytics/business-analytics/user-console/broken-reference)

  Extend platform functionality by installing new platform plugins and plugins to add new visualizations, dashboards, and content access extensions.
* [Update plugins](https://academy.pentaho.com/pentaho-business-analytics/business-analytics/user-console/broken-reference)

  Update existing plugins to the latest versions.
* [Uninstall plugins](https://academy.pentaho.com/pentaho-business-analytics/business-analytics/user-console/broken-reference)

  Uninstall plugins that are no longer needed.
  {% endhint %}

<figure><img src="https://3159385628-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FiyGCAvfJ7v68TnXf8icC%2Fuploads%2FAH66LVOcjZv4hCknSNom%2Fimage.png?alt=media&#x26;token=0fe1e93d-e805-442c-a74a-81f67d9c4711" alt=""><figcaption><p>Plugin Manager</p></figcaption></figure>

For further details:

{% embed url="<https://academy.pentaho.com/pentaho-11-installation/installation/archive-installation/install-pentaho-server/server-plugins>" %}

{% embed url="<https://academy.pentaho.com/pentaho-11-installation/installation/archive-installation/install-client-tools/ee-plugins>" %}
{% endtab %}

{% tab title="Scheduler" %}
{% hint style="info" %}

#### Scheduler

{% endhint %}

x

<figure><img src="https://3159385628-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FiyGCAvfJ7v68TnXf8icC%2Fuploads%2FnYGNS21ESjVeNPFkGsaC%2Fimage.png?alt=media&#x26;token=25941c02-83e8-4a8c-9df5-d1131f800d76" alt=""><figcaption><p>Sheduler</p></figcaption></figure>

x
{% endtab %}

{% tab title="Data Connection" %}

{% endtab %}

{% tab title="Settings" %}

{% endtab %}

{% tab title="Semantic Model Editor" %}

{% endtab %}
{% endtabs %}
{% endtab %}

{% tab title="PUC" %}
{% hint style="info" %}

#### Pentaho User Console

{% endhint %}

x

2. Click on the link below:

{% embed url="<http://localhost:8080/pentaho/Home>" %}

Enter the following details:

#### Perspectives

{% tabs %}
{% tab title="1. Home" %}
{% hint style="info" %}
The Home Perspective provides quick access to common actions, recently viewed content, and your favourite content. The Getting Started section at the top of the Home Perspective is a great place for new users to browse samples of Pentaho reports, analysis views, and dashboards, or to learn how to create your own content against your data through a series of short 3-5-minute video tutorials.
{% endhint %}

<figure><img src="https://content.gitbook.com/content/iyGCAvfJ7v68TnXf8icC/blobs/db80uAGKgCWsWxsZJ7E2/image.png" alt=""><figcaption><p>Pentaho User Console - PUC</p></figcaption></figure>

<table><thead><tr><th width="82">Item</th><th width="180">Name</th><th>Function</th></tr></thead><tbody><tr><td>1</td><td>Home indicator</td><td>Indicates the current User Console perspective that you are using. The Home menu lets you flip easily from page to page, or return to your Home page.</td></tr><tr><td>2</td><td>Getting Started</td><td>Displays some resources to help you get familiar with the User Console. The Welcome tab shows an introductory video about Pentaho products. The Samples tab holds a variety of small sample reports and dashboards that you can use to get familiar with the software. The Tutorials tab contains a number of tutorial videos that give you a visual guide to the software.</td></tr><tr><td>3</td><td>Current User</td><td>Shows the name of the person currently logged in to the User Console. Clicking the arrow next to the name lets you log out of the User Console.</td></tr><tr><td>4</td><td>Browse Files</td><td>Brings you to the Browse Files window, where you can locate your files using the Browsing and Files panes, and manage them using the Actions pane.</td></tr><tr><td>5</td><td>Create New</td><td>Gives you the option to create a new report in <a href="https://docs.hitachivantara.com/r/IWGVG8qV~XMn3ekqEIpjTw/DMmWA4vfu43ddn~aj9PJUA">Pentaho Interactive Reports</a>, <a href="https://docs.hitachivantara.com/r/IWGVG8qV~XMn3ekqEIpjTw/peN6X2OgzB_40iLFljBFeA">Pentaho Analyzer</a>, or <a href="https://docs.hitachivantara.com/r/IWGVG8qV~XMn3ekqEIpjTw/z1sO8VcaROLgS_EgylsScA">Pentaho Dashboard Designer</a>. If you have permissions to work with data sources, this button also gives you the option to create a new data source.</td></tr><tr><td>6</td><td>Manage Data Sources</td><td></td></tr><tr><td>7</td><td>Documentation</td><td>Documentation for Pentaho products.</td></tr><tr><td>8</td><td>Recents</td><td>Shows a list of your most recently opened files. Clicking on the star icon next to a recently opened file adds it to your Favorites list.</td></tr><tr><td>9</td><td>Favorites</td><td>Shows a list of your favorite files for quick access.</td></tr></tbody></table>
{% endtab %}

{% tab title="2. Browse Files" %}
{% hint style="info" %}
**Browse Files** is where you access and manage all the content that you create or have access to in Pentaho.&#x20;
{% endhint %}

1. From the Perspectives drop-down list, select Browse Files.

<figure><img src="https://content.gitbook.com/content/iyGCAvfJ7v68TnXf8icC/blobs/o3UBN6ZVzVRNuGcsVeSa/image.png" alt=""><figcaption><p>Browse Files</p></figcaption></figure>

{% hint style="info" %}
The left panel displays the directory of files, including your personal home location, as well as the default public space where you can share content with other users and groups. Selecting a folder will display the files in that folder in the middle section of the Browse Perspective.&#x20;

Finally, the Actions list at the right provides fast access to actions available for the selected folder or file, such as opening content, scheduling a report to be run, or adding an item to your Favorites list.
{% endhint %}

<figure><img src="https://content.gitbook.com/content/iyGCAvfJ7v68TnXf8icC/blobs/JIPRDPL2OJf802wUgmXv/image.png" alt=""><figcaption><p>Browse Files</p></figcaption></figure>

***

**Create a Training Folder**

{% hint style="info" %}
Create a folder named Training, in which you will save your content.
{% endhint %}

1. To add a new folder, from the Folders pane, click Public, and then from the Folder Actions pane, click New Folder.

![](https://content.gitbook.com/content/iyGCAvfJ7v68TnXf8icC/blobs/OvzNf2GJdniG3dw7eIaj/8.png)

2. In the Name field, type Training, and then click OK.

![](https://content.gitbook.com/content/iyGCAvfJ7v68TnXf8icC/blobs/vEYEHqCtEUnQwl2zsf1P/9.png)

3. From the Perspectives drop-down list, select Home.
   {% endtab %}

{% tab title="3. Schedules " %}
{% hint style="info" %}
The Schedules Perspective is where you can view and manage all scheduled activities.&#x20;

The Manage Schedules table provides information about what is being scheduled when, where the content generated by the schedule will be placed, the last time a schedule was run, and the next planned schedule trigger.&#x20;

Clicking on the output link for a schedule will take you to the Browse Perspective so you can open any documents generated by the schedule.
{% endhint %}

<figure><img src="https://content.gitbook.com/content/iyGCAvfJ7v68TnXf8icC/blobs/bIyNBkRw0raArmwIZzoD/image.png" alt=""><figcaption><p>Schedules</p></figcaption></figure>

1. In the ‘Browse’ perspective, Select: **Steel Wheels > Vendor Sales Report (interactive report).**

{% hint style="info" %}
There are several reporting options:

&#x20; • Append a timestamp

&#x20; • Save the scheduled report in another location (with overwrite)

&#x20; • Change the report Owner
{% endhint %}

<figure><img src="https://content.gitbook.com/content/iyGCAvfJ7v68TnXf8icC/blobs/Qq7kvrWYIW8SjiJqGfLl/image.png" alt=""><figcaption><p>Schedule options</p></figcaption></figure>

2. Click 'Next'.

<figure><img src="https://content.gitbook.com/content/iyGCAvfJ7v68TnXf8icC/blobs/H2dSU1zJrXDNuDQk1AX4/image.png" alt=""><figcaption></figcaption></figure>

{% hint style="info" %}
There are several scheduling options:

&#x20; • When & How often to schedule

&#x20; • Performance metrics & Logging level
{% endhint %}

3. Click 'Next'.

<figure><img src="https://content.gitbook.com/content/iyGCAvfJ7v68TnXf8icC/blobs/yD1A3ekO2KTDZNgCYVBW/image.png" alt=""><figcaption><p>Set Parameter - Classic Cars</p></figcaption></figure>

{% hint style="info" %}
The report settings only allow you to select 1 parameter.
{% endhint %}

4. Click 'Finish. The schedule has now been created and can be viewed in the Schedule Perspective.

<figure><img src="https://content.gitbook.com/content/iyGCAvfJ7v68TnXf8icC/blobs/naXydN2briFxG0PYR3X5/image.png" alt=""><figcaption><p>Schedule Perspective</p></figcaption></figure>
{% endtab %}

{% tab title="4. Administration" %}
{% hint style="info" %}
The Administration Perspective is where the system administrator manages and configures your Pentaho Business Analytics Server:

including managing user role security - LDAP or Active Directory,&#x20;

set up your mail server settings&#x20;

manage your Pentaho enterprise license keys,&#x20;

manage clean-up routines for manually or scheduled clean-up of content generated by the scheduling system.
{% endhint %}

<figure><img src="https://content.gitbook.com/content/iyGCAvfJ7v68TnXf8icC/blobs/Tl33cx7T0enkSTTrL0zg/image.png" alt=""><figcaption></figcaption></figure>

{% tabs %}
{% tab title="Users & Roles" %}
{% hint style="info" %}
The Users & Roles page in the Pentaho User Console (PUC) is a point-and-click interface for managing system access and permissions. Only administrators or users with Administer Security permission can manage these settings. The system comes with default user and role assignments that can serve as templates.

Before making any security changes, it's crucial to back up the system. For wizard installations, this means backing up the Pentaho Business Analytics and Server directories. For manual or archive installations, additional backup of WAR files and solutions is required.

The interface allows administrators to add, edit, and delete users and roles, as well as customize file and folder permissions through the Browse Files perspective. For organizations with multiple tenants, there's an option to hide individual users' Home folders for enhanced security. More detailed information is available in the Administer Pentaho Data Integration and Analytics documentation.
{% endhint %}

<figure><img src="https://content.gitbook.com/content/iyGCAvfJ7v68TnXf8icC/blobs/G7FYCtH0uELqsO5pCCeZ/image.png" alt=""><figcaption><p>Users &#x26; Roles</p></figcaption></figure>

1. Click Home -> Administration.
2. Highlight a user in the Users list to display which roles are available for that user, as well as which roles are currently defined for that user.&#x20;

You can use the following sample users as templates for adding your own users:

<table><thead><tr><th width="147">Sample User</th><th width="196">Default Role</th><th>Default Operation Permissions</th></tr></thead><tbody><tr><td>admin</td><td>Administrator</td><td><ul><li>Administer Security</li><li>Schedule Content</li><li>Read Content</li><li>Execute Schedules</li><li>Publish Content</li><li>Create Content</li><li>Execute</li><li>Manage Data Sources</li></ul></td></tr><tr><td>bob</td><td>Schedule Power user</td><td><ul><li>Read Content</li><li>Execute Schedules</li></ul></td></tr><tr><td>pat</td><td>Business Analyst</td><td><ul><li>Publish Content</li></ul></td></tr><tr><td>suzy</td><td>Power User</td><td><ul><li>Schedule Content</li><li>Read Content</li><li>Publish Content</li><li>Create Content</li><li>Execute</li></ul></td></tr><tr><td>tiffany</td><td>Report Author</td><td><ul><li>Schedule Content</li><li>Publish Content</li></ul></td></tr></tbody></table>

3. Select the Manage Roles tab to display the Operation Permissions for the user's role.

{% hint style="info" %}
You can alter or remove these roles. Roles can be based on need. Each default role and sample user come with a standard set of permissions, which define a specific set of capabilities when using Pentaho tools and the Pentaho Server.
{% endhint %}

<figure><img src="https://content.gitbook.com/content/iyGCAvfJ7v68TnXf8icC/blobs/zT2uX7W3PRhtrRt0u94U/image.png" alt=""><figcaption><p>Manage Roles</p></figcaption></figure>

<table><thead><tr><th width="213">Operation Permission</th><th>Definition</th></tr></thead><tbody><tr><td>Administer Security</td><td><p>The default Administrator role automatically conveys full operation permissions to users assigned to that role, even if the check box next to it is cleared. These permissions include the Read Content and Create Content permissions, which are required for accessing the Administration perspective.</p><p>This permission has the following capabilities:</p><ul><li>Access to the Administration perspective of PUC.</li><li>Access and manage all content in the Browse perspective.</li><li>View and work with all user schedules in the Schedules perspective.</li><li>Create server block out times in the Schedules perspective.</li></ul></td></tr><tr><td>Schedule Content</td><td><ul><li>Schedule reports and content.</li><li>View, edit, or delete their own schedules using the Schedules perspective.</li></ul></td></tr><tr><td>Read Content</td><td><ul><li>View content in the Browse perspective.</li><li>View content through the File > Open dialog box.</li></ul></td></tr><tr><td>Execute Schedules</td><td><ul><li>View all scheduled reports from all users.</li><li>Pause and resume all scheduled reports</li><li>Run scheduled reports and content if that user has access to data source material used for the reports.</li></ul></td></tr><tr><td>Publish Content</td><td><p>This permission includes the following capabilities for tools such as Report Designer, Schema Workbench, and Metadata Editor.</p><ul><li>Allows client tools to store reports or data models in the Pentaho Repository.</li><li>When held in conjunction with Write permission on the target folder, upload supported content types. See the <em>Administer Pentaho Data Integration and Analytics</em> document for details.</li></ul></td></tr><tr><td>Create Content</td><td><ul><li>Create, import, delete, and save reports to the repository.</li><li>See a list of data sources which are used to create reports or dashboards.</li></ul></td></tr><tr><td>Execute</td><td>Read and execute transformations and jobs.</td></tr><tr><td>Manage Data Sources</td><td><ul><li>Create, edit, or delete new data sources.</li><li>See a list of data sources that are used to create reports or dashboards.</li><li><p>Also includes the following capabilities while working with Analysis Reports:</p><ul><li>Make inline model editing changes including modifying existing (base) measures.</li><li>Add and edit calculated measures to the data model.</li><li>Hide and show fields.</li></ul></li></ul><p>Note: This operation permission does not include Metadata Editor data sources. </p></td></tr></tbody></table>

x

x

x
{% endtab %}

{% tab title="Authentication" %}
{% hint style="info" %}

{% endhint %}

x

x

x

{% endtab %}

{% tab title="Second Tab" %}
x
{% endtab %}
{% endtabs %}
{% endtab %}
{% endtabs %}
{% endtab %}
{% endtabs %}