CDE advanced solutions

1. Log on to the User Console and navigate to the Browse Files perspective.

2. In the Folders pane, click on the Public folder and then, in the Folder Actions pane, click New Folder. Create a solutions folder called demoDashboard.

3. Expand the Public folder and click on the newly created demoDashboard folder. In the Folder Actions pane, click New Folder and create a subfolder titled files which will contain the JavaScript and Cascading Style Sheets (CSS) files used in this dashboard.

4. Open CDE and create a new dashboard titled demoDashboard, and save it in the public demoDashboard folder you just created.

5. From the CDE menu bar, click Settings, and then select the RequireJS Support check box to convert the dashboard to a RequireJS dashboard.

6. Click Ok.

   A message box appears warning you about possible issues with your custom JavaScript code in your dashboard. Click Ok to proceed. The dashboard is now saved as a RequireJS dashboard.

Parent Topic

• Create a dashboard using RequireJS

1. From the Layout Structure menu bar, click the Add Bootstrap Panel button.

2. Configure your bootstrap panel to match the settings in the image below. Be sure to add and rename all displayed rows and columns.

3. In the Properties pane, all columns by default set the Extra Small Devices property to 12 spans. Change the Value for the following columns:

   • Set tableObj and chartObj to 6 spans.

   See CDE dashboard overview for more information on Bootstrap in CDE.

4. Center the title and subtitle in the Properties pane.

   For both titleColumnObj and subTitleColumnObj, locate the Text Align property and click in the Value column. On the keyboard, press the down arrow to display a drop-down menu and select Center.

Parent Topic

• Create a dashboard using RequireJS

1. In the CDE Layout perspective, on the Layout Structure toolbar, click the Add Resource icon.

2. In the Add Resource dialog box, enter the following data:

   • For Resource Type, select Javascript.
   • For Resource Source, select External File. Click Ok.

3. In the Properties pane, click in the Value column to the right of the Name property and enter addins. Press Tab or Enter.

4. Click the caret ('^') button to the right of the Resource file property and navigate to public demoDashboard files. Click Ok.

5. In the Create File dialog box, enter addins and click Ok.

   You have now created the addins.js file, which will contain the JavaScript code to execute within the dashboard components. Note that the name you give to the JS file is how the file itself will be referenced within the dashboard.

6. To enter content in the addins.js file, select the addins resource in the Layout Structure pane. Locate the Resource file property and click the ellipse ('...') button to open the Edit window. Enter the following content for this file:

   define([
     "cdf/AddIn",
     "cdf/Dashboard.Clean",
     "cdf/Logger",
     "cdf/lib/jquery"
   ], function(AddIn, Dashboard, Logger, $) {
     Dashboard.registerGlobalAddIn("Table", "colType", new AddIn({
       name: "customArrow",
       label: "customArrow",
       defaults: {},
       implementation: function(tgt, st, opt) {
         if(typeof st.value !== "number") {
           Logger.warn("customArrow add-in invalid value: " + st.value);
           return;
         }
         var trend = st.value > 0 ? "up" : "down";
         $(tgt).empty()
               .append($('<ul><span class="glyphicon glyphicon-arrow-'
                 + trend +'"></span>&nbsp<span>'+ st.value +'%'+'</span></ul>'));
       }
     }));
   });

   • Lines 2 to 5 specify the dependencies needed for the add-in, which are then registered for use in the function.
   • Line 7 registers the add-in, which is then available to the table component.

7. Press the Save button and then press the Close button.

8. Following steps 2 through 5, add a second JavaScript external resource named title and save a new file named title.js in the public demoDashboard files folder. The dashboard will have a title and a subtitle which are provided by the text components created in Step Five. These components will fetch the displayed value from an object returned by the AMD module defined in the title.js file.

9. To enter content in the title.js file, in the Layout Structure pane select the title resource and then select the Resource file property. Click the ellipse ('...') button to open the Edit window. Enter the following content for this file:

   define(function() {
     return {
       option1: 'CDE Dashboard',
       option2: 'Using a Table with a custom add-in and a CCC Bar Chart',
     };
   });

   In this file, an AMD module is defined which returns an object with two properties. This object will be accessible to the text components, using the same name as the one used for the Name property of the JavaScript external resource, and its properties will be used as the title and subtitle.

10. Press the Save button and then press the Close button.

Parent Topic

• Create a dashboard using RequireJS

Procedure

1. In the Data Source perspective, from the Data Source list, click SCRIPTING Queries, and then click scriptable over scripting twice.

2. In the Datasources panel, in the Name column, enter chartQuery for the first data source, and tableQuery for the second.

3. Add the following script to the Query property for the chartQuery data source:

   import org.pentaho.reporting.engine.classic.core.util.TypedTableModel;
   String[] columnNames = new String[]{
     "Country", "Population growth per City [%]"
   };
   Class[] columnTypes = new Class[]{
     String.class, Float.class
   };
   TypedTableModel model = new TypedTableModel(columnNames, columnTypes);
   model.addRow(new Object[]{
     new String("Tokyo"), new Float("60")
   });
   model.addRow(new Object[]{
     new String("Nice"), new Float("20")
   });
   model.addRow(new Object[]{
     new String("London"), new Float("-10")
   });
   model.addRow(new Object[]{
     new String("Munich"), new Float("30")
   });
   model.addRow(new Object[]{
     new String("Porto"), new Float("10")
   });
   model.addRow(new Object[]{
     new String("Brasilia"), new Float("10")
   });
   
   return model;

4. Add the following script to the Query property for the tableQuery data source:

   import org.pentaho.reporting.engine.classic.core.util.TypedTableModel;
   String[] columnNames = new String[]{
     "Country", "City", "Population growth per City"
   };
   Class[] columnTypes = new Class[]{
     String.class, String.class, Float.class
   };
   TypedTableModel model = new TypedTableModel(columnNames, columnTypes);
   model.addRow(new Object[]{
     new String("Japan"), new String("Tokyo"), new Float("60")
   });
   model.addRow(new Object[]{
     new String("France"), new String("Nice"), new Float("20")
   });
   model.addRow(new Object[]{
     new String("UK"), new String("London"), new Float("-10")
   });
   model.addRow(new Object[]{
     new String("Germany"), new String("Munich"), new Float("30")
   });
   model.addRow(new Object[]{
     new String("Portugal"), new String("Porto"), new Float("10")
   });
   model.addRow(new Object[]{
     new String("Brazil"), new String("Brasilia"), new Float("10")
   });
   
   return model;

Parent Topic

• Create a dashboard using RequireJS

1. Switch to the Components perspective.

2. From the Components list, expand the appropriate Group section, and then add the following components to the dashboard with the specified Name and HtmlObject properties in the table below. (See Customize the Components Perspective for more detailed instruction.)

   Group	Component	Name	HtmlObject
   Others	Text Component	subTitleComponent	subTitleColumnObj
   Others	Text Component	titleComponent	titleColumnObj
   Others	table Component	tableComponent	tableObj
   Charts	CCC Bar Chart	chartComponent	chartObj

3. Set the width and height for the chartComponent bar chart.

   • Click in the Value column for the Height property and type 450. Press Tab or Enter.
   • Click in the Value column for the Width property and type 400. Press Tab or Enter.

4. Set the titleComponent text component by adding the following code to the Expression property:

   function f() {
     return "<strong>" + title.option1 + "</strong>";
   }

   This piece of code is returning the content of option1 defined in the title.js file in Step Three.

5. Set the subTitleComponent text component by adding the following code to the Expression property. Note that this code is similar to the previous step, substituting option2 for option1:

   function f() {
     return title.option2;
   }

6. In the tableComponent component, set the Column Types property as follows:

   Notice that the third line in the table is using the non-standard customArrow add-in. It is now available because it was registered earlier using the addins.js JavaScript external resource file.

7. Set the Datasource property for the tableComponent to use the tableQuery data source created earlier in Step Four.

8. Set the Datasource property for the chartComponent to use the chartQuery data source created earlier in Step Four.

Parent Topic

• Create a dashboard using RequireJS

1. Save your dashboard and click the Preview your Dashboard icon in the top-right corner.

   The Preview window displays.

2. Inspect your dashboard.

   Your finished dashboard should look similar to the image below.

3. When finished, close the Preview window.

Parent Topic

• Create a dashboard using RequireJS

Procedure

1. On your Desktop, create a folder named Embed to hold the three files we will create and upload to the Pentaho Server in this tutorial:

   • main.html
   • includeDashboards.js
   • styles.css

2. Use a text editor to create a new HTML file and save it as main.html in the Embed folder you just created. Copy the following HTML code to the file:

   <!DOCTYPE html>
   <html>
     <head>
       <meta http-equiv="content-type" content="text/html; charset=utf-8"/>
       <title>Embedding CDE Dashboards with RequireJS</title>
       <link rel="stylesheet" type="text/css" href="../../repo/files/:public:Embed:styles.css"/>
      <script type="text/javascript" src="../../../plugin/pentaho-cdf-dd/api/renderer/cde-embed.js"></script>
     </head>
     <body>
       <div class="headerContainer">
         <header class="header">
           <a class="logo" href="http://www.pentaho.com/">
             <img src="http://www.pentaho.com/sites/all/themes/pentaho_resp/_media/logo-pentaho-new.svg" alt="Pentaho Logo">
           </a>
           <div class="titleHTML">
             <strong>Embedding CDE Dashboards with RequireJS</strong>
           </div>
         </header>
       </div>
       <div class="dashboardContainer">
         <div id="content1"></div>
         <div id="content2"></div>
         <script src="../../repo/files/:public:Embed:includeDashboards.js"></script>
       </div>
     </body>
   </html>

   • Line 7 loads the cde-embed.js resource, which contains all the RequireJS configurations to embed CDE dashboards into the HTML page.
   • Line 20 creates a div which contains two other divs, identified as content1 and content2, in which two instances of the required dashboard class will be rendered.
   • Line 23 loads the includeDashboards.js file, which uses RequireJS to load the demoDashboard CDE dashboard as a JavaScript class. This file creates both instances and associates each one to its respective div and executes its render function.

3. Create the includeDashboards.js file and save it in the Embed folder. Copy the following JS code to the file:

   require([
     "dash!/public/demoDashboard/demoDashboard.wcdf"
   ], function(SampleDash) {
     // Create two instances of the same dashboard that use distinct DOM elements
     (new SampleDash("content1")).render();
     (new SampleDash("content2")).render();
   });

   • The CDE dashboard is obtained via the CDE endpoint, /pentaho/plugin/pentaho-cdf-dd/api/renderer/getDashboard. The path field in the query string must contain the path to the CDE dashboard. Below is an example.

     require([
       "/pentaho/plugin/pentaho-cdf-dd/api/renderer/getDashboard?path=/public/demoDashboard/demoDashboard.wcdf"
     ], function(SampleDash) { /* code */ });

   • This endpoint returns a RequireJS module which contains a class for a specific dashboard which is used to create new dashboard instances. You can also embed a dashboard using the simpler dash! RequireJS loader plugin, such as in the includeDashboards.js source code. Below is an example.

     require([
       "dash!/public/demoDashboard/demoDashboard.wcdf"
     ], function(SampleDash) { /* code */ });

4. Create the styles.css file in the Embed folder. Copy the following CSS code to the file:

   body {
     padding: 10px;
   }
   
   img {
     width: 300px;
     padding-bottom: 10px;
   }

5. Zip the Embed folder, and then use PUC to upload the compressed folder to the Pentaho Server’s Public folder.

6. Finally, review your work. From the Public Embed folder, open the main.html​ file. The embedded dashboard should look similar to the image below.

Parent Topic

• Embedding dashboards built with RequireJS

In this walk-through tutorial, you will embed the dashboard created in the Create a dashboard using RequireJS tutorial into an HTML page running on a server that is not the Pentaho Server. This process requires the following steps:

• Save the embed folder.
• Edit the settings XML files.
• Edit the Pentaho XML file.
• Edit the main XML file.
• Access the embedded dashboard.

Parent Topic

• Embedding dashboards built with RequireJS

Child Topics

• Step 1: save the embed folder
• Step 2: edit the settings XML files
• Step 3: edit the Pentaho XML file
• Step 4: edit the main HTML file
• Step 5: access the embedded dashboard

Procedure

1. Open the demoDashboard in CDE.

   1. Log on to Pentaho User Console and navigate to the Browse Files perspective.

   2. In the Folders pane, click to expand the Public folder, and then click to highlight the demoDashboard folder.

   3. In the Files pane, click on demoDashboard and then, in the File Actions pane, click Edit.

      You are now in the Opened perspective with CDE in editing mode. The Editing:demoDashboard tab is now active in CDE.

2. In the Components perspective, press ShiftG. In the Choose what charts to render as CGG popup, click to select the chartComponent check box.

   This popup lists all the components available to CGG, such as the Community Charting Components (CCC) chart components. When you save the dashboard, CGG generates a JavaScript file for each chart selected in the popup and saves it in your solutions directory.

3. Click the Url button to generate a URL link to CGG which will export the target chart image. Copy the export link by selecting the full URL text and pressing CtrlC on your keyboard. When finished, click Close.

4. Before we can use the export URL, we need to save the dashboard so the CGG scripts are generated and saved in the proper repository. To save the dashboard, on the CDE menu bar, click Save.

5. View the generated CGG JavaScript files. In Pentaho User Console, navigate to your demoDashboard folder. Note the following files:

   • The demoDashboard_chartComponent.js contains the chart definitions.
   • The chartComponent.js contains the same content as the above file. This file is saved for backwards compatibility with previous server versions.

6. Open a browser window and paste the export URL (from Step 3) into the browser's navigation bar. Press Enter. The chart image displays in the browser window.

Next steps

http://localhost:8080/pentaho/plugin/cgg/api/services/draw?script=/public/demoDashboard/demoDashboard_chartComponent.js&outputType=svg

Parent Topic

• Exporting charts

Procedure

1. Open the demoDashboard in CDE.

   (For detailed instructions, see Step 1 in Exporting Charts with CGG.)

2. Customize the layout for the export button.

   1. In the Layout perspective, locate the mainContainerColumn column and add a row named exportChartRow.

   2. Select the exportChartRow and add a column named exportChartObj.

   3. Select the exportChartObj column and in the Properties pane, locate the Text Align property and set its value to Center.

3. Add and customize the export button.

   1. In the Components perspective, in the left menu, expand the Others group and click on the Button Component.

   2. In the Components pane, select the Button Component you just added. In the Properties pane, set the following values:

      Property	Value
      Name	exportChart
      Label	Export Chart
      HtmlObject	exportChartObj

4. Copy the following code to the Expression property:

   function f() {
     this.dashboard
         .getComponentByName('render_chartComponent')
         .exportChart('png');
   }

   NoteThis code allows you to retrieve the chartComponent component via the dashboard and execute its exportChart function by passing it the png parameter which defines the export file type as a PNG file.
   When completed, the Properties pane should look similar to the image below.

5. In the Components perspective, press ShiftG to display the Choose what charts to render as CGG popup. Make sure the chartComponent check box is selected, then click Close.

6. After saving the dashboard, return to Pentaho User Console, navigate to the Browse Files perspective and double-click the demoDashboard file. The following chart displays:

7. Press the Export Chart button to download the chart file as a PNG file.

Parent Topic

• Exporting charts