Get started with the embedded samples

To deploy embedded samples to your Pentaho Server, you must download and run a script, and then move files that are created by the script to the appropriate directories.

1. Download the pentaho-sdk- 9.3.0.zip file from the Support Portal.

   1. On the Support Portal home page, sign in using the Pentaho support username and password provided in your Pentaho Welcome Packet.

   2. In the Pentaho card, click Download.

      The Downloads page opens.

   3. In the 9.x list, click See all <number> articles to see the full list of 9.x downloads.

   4. On the 9.x page, click Pentaho 9.3 GA Release.

   5. Scroll to the bottom of the Pentaho 9.3 GA Release page.

   6. In the file component section, navigate to the SDK folder.

   7. Download the pentaho-sdk- 9.3.0 <build number>-dist.zip file.

      The readme file that is in the ZIP file contains deployment information.

2. Unpack the pentaho-sdk- 9.3.0 <build number>-dist.zip file to a temporary directory.

   The pentaho-sdk- 9.3.0 <build number>-dist directory is created in the temporary directory.

3. Stop the Pentaho Server.

   Note: See the Install Pentaho Data Integration and Analytics document for instructions on stopping and starting the Pentaho Server.

4. Navigate to the pentaho-sdk- 9.3.0 <build number>-dist directory.

5. Run one of the following scripts that is appropriate for the OS.

   • installer.jar

   • install.bat

   • install.sh The following two directories are unpacked to the directory that you specified while running the script: integration-examples and platform-plugins.

6. Copy the integration-examples directory to the pentaho-server/tomcat/webapps directory.

7. Navigate to the platform-plugins directory and copy the example-visualization and oem-tools directories.

8. Paste the example-visualization and oem-tools directories into the pentaho-server/pentaho-solutions/system directory.

9. Start the Pentaho Server.

The samples are deployed and can be accessed by opening a web browser and navigating to http://localhost:8080/integration-examples. To access the OEM tools, browse to http://localhost:8080/pentaho/content/oem-tools/resources/web/index.html. To access the example-visualization, look under the Charts menu in Analyzer. The example-visualization is listed as Example KPI.

To deliver content and expose various services, we use a REST web interface. These sections comment on the various samples and how they use the REST URLs. For the full reference of the Pentaho REST API, see http://javadoc.pentaho.com.

Note: The REST APIs often allow interaction with repository files. The REST API expects references to repository files to be specified using the : character as file separator.