Skip to main content
Pentaho Documentation

Upload and Download from the Pentaho Repository

Overview

You can upload and download from the Pentaho Repository through the Pentaho User Console (PUC) or the command line interface. The ability to upload and download assumes that you have already created a data source, that data content exists to be pushed, and defines permissions for the repository.

Uploading and downloading from the Pentaho Repository is done using the Pentaho User Console (PUC) or the command line interface. The ability to upload and download assumes that you have already created a data source, that data content exists to be pushed, and defines permissions for the repository.

For uploading, any starting location can be selected. Permission settings are inherited through the folder structure if the destination location has existing permission settings. It is advisable to keep existing security settings as defaults for the upload. Uploading more than one file or folder requires the files to be zipped before beginning the upload.

For downloading, you are able to select the destination location for the downloaded file or folder. The download process always creates a ZIP file that includes a manifest file along with the downloaded content. The manifest file contains the collection of permissions settings for the downloaded files and folders and is found in the root directory of the ZIP file.

Supported File Types Hidden File Types

These are the supported file types and artifacts for uploading and downloading from the Pentaho Repository.

These are the file types that are hidden by default in the Pentaho Repository.

  • Reporting (.prpt, .prpti, .xml)
  • Analyzer (.xanalyzer)
  • Dashboards (.xdash)
  • Solution Files (.xaction, .locale)
  • Web (.html, .htm)
  • Reporting (.xml)
  • Solution Files (.properties)
  • Graphics (.png, .jpg, .gif, .svg)

Upload Folders and Files

The User Console can be used to upload files and folders to the Pentaho Repository. To upload files, a user must hold Publish Content operation permission and Write permission for the target folder (Browse Files > Properties > Share > Users and Roles > Permissions), where permissions can be held through a user name or a role that the user holds (Power User for example).

For Retain permission on upload file, the file permission contained in the uploaded zip (exportManifest.xml) will be the permission applied the repository. If the file doesn't have an entry in the exportManifest.xml for the permission, then it will use the default permission, which is inherit. This is equivalent to the command line switch, --permission=true.

For Set Owner based on uploaded file, the owner found in the uploaded zip (exportManifest.xml) will be the owner of the file in the repository. If the file doesn't have an entry in the exportManifest.xml for the Owner, then it will set the Owner to the user who is uploading the zip. This equivalent to the command line switch, --retainOwnership=true.

These steps walk you through uploading to the repository with the User Console.

  1. From the User Console Home, click Browse Files. The Browse Files page appears.
  2. From the Browse pane on the left, click to choose the destination folder for the upload.
  3. With the destination folder highlighted, click Upload in the Folder Actions pane on the right. The Upload dialog box appears.
  4. Browse to the file or folder to be uploaded by clicking Browse.
  5. Click OK to begin upload using the default settings.
  6. Choose preferences for the upload by clicking to expand the Advanced Options menu.
    1. Choose Replace the Existing File or Do Not Upload from the first menu.
    2. Choose File Permissions from the second menu. The choices are Do Not Change Permissions or Retain Permissions on the Uploaded File.
    3. If you selected Retain Permissions on the Uploaded File, choose File Ownership by selecting Do Not Change Owner or Set Owner Based on Uploaded File from the third menu.
    4. Choose None, Short, or Verbose from the Logging menu.
  7. Click OK.

The upload runs and the files or folders are uploaded to the repository. If the upload fails, an error log window opens with specific information.

Upload from the Command Line

  1. Open the command line interface by clicking Start and typing cmd. Press Enter.
  2. From the command line interface, go to the location where you have a local copy of the Pentaho Server installed, such as C:/dev/pentaho/pentaho-server.
  3. Enter a space, then type the arguments for upload into the command line interface. A completed upload argument would look something like this:
    import-export.bat --import --url=http://localhost:8080/pentaho --username=dvader --password=password --charset=UTF-8 --path=/public --file-path=C:/Users/dvader/Downloads/pentaho-solutions.zip --overwrite=true --permission=true --retainOwnership=true
  1. Press Enter after the arguments are typed.

The upload process runs and the results are displayed in the command interface. If an argument is required for successful upload and has not been provided, the missing requirement is displayed in the command interface. The Command Line Arguments Reference has a list of available command line arguments for uploading.

Download Folders and Files

Downloading folders and files can be done through the User Console or through the command line interface. The download process always creates a ZIP file that includes a manifest file along with the downloaded content. The manifest file is a collection of the permissions settings for the downloaded files and folders and is found in the root directory of the ZIP file.

Download Action Permissions

Only the Administrator role has downloading permissions, by default. The roles that have download action permissions are defined in the in the pentaho.xml configuration file. To add downloading permissions for a user, add that user to a role that has download permissions as shown below:

Providing the download action permissions to non-admin users can expose sensitive data.

  1. Stop the Pentaho Server.
  2. Navigate to the pentaho.xml file, located at /server/pentaho-server/pentaho-solutions/system/pentaho.xml 
  3. Open the file with any text editor and locate the download-roles node in the file.
  4. Add additional roles as needed, Power User for example: 

   <download-roles>Administrator,Power User</download-roles>

Use no spaces between roles, just a comma. 

  1. Save and close the pentaho.xml file.
  2. Restart the Pentaho Server
  3. Restart the User Console. Log on as a user with that role. You will now see the Download option in the File Actions pane in the Browse Files perspective of the User Console.

Download a Folder

  1. From the User Console Home, click Browse Files. The Browse Files page appears.
  2. From the Browse pane on the left, browse to the location of the folder to be downloaded.
  3. With the folder highlighted, click Download in the Folder Actions pane on the right.
  4. Choose Save File in the window that appears, and click OK.

The folder is saved as a ZIP file with the manifest located in the top level of the file.

Download a File

  1. From the User Console Home, click Browse Files. The Browse Files page appears.
  2. Browse to the location of the file by clicking through the folders in the Browse pane on the left. The Files pane in the center populates with a list of reports.
  3. Click to select the file in the Files pane and choose Download in the Folder Actions pane on the right.
  4. Choose Save File in the window that appears, and click OK.

The file is saved as a ZIP file with the manifest located in the top level of the file.

Download from the Command Line

  1. Open the command line interface by clicking Start and typing cmd. Press Enter.
  2. From the command line interface, go to the location where you have a local copy of the Pentaho Server installed, such as C:/dev/pentaho/pentaho-server.
  3. Enter a space, then type the arguments for download into the command line interface. A completed download argument would look something like this:
    import-export.bat --export --url=http://localhost:8080/pentaho --username=dvader --password=password --charset=UTF-8 --path=/public --file-path=C:/Users/dvader/Downloads/pentaho-solutions.zip --overwrite=true --permission=true --retainOwnership=true
  1. Press Enter after the arguments are typed.

The download process runs and the results are displayed in the command interface. The file is saved as a ZIP file with the download manifest located in the top level of the file. If an argument is required for successful download and has not been provided, the missing requirement is displayed in the command interface. The Command Line Arguments Reference has a list of available command line arguments for downloading.

Response Code Definitions

Here is a list of response codes for the import-export.bat script.

Response Code Definition
1 Publish to server failed.
2 General publish error.
3 Publish successful.
5 Authentication to the publish server failed. Username or password is incorrect.
6 Datasource publish failed.
7 XMLA catalog already exists.
8 Schema already exists.
9 Content about to be published already exists.
10 Error publishing to the server due to prohibited symbols in the name of the content.