Upload and Download from the BA Repository
Overview
Uploading and downloading from the BA Repository is done with the User Console 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 BA Repository is done with the User Console 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 BA Repository. | These are the file types that are hidden by default in the BA Repository. |
|
|
Upload Folders and Files
The User Console can be used to upload files and folders to the BA Repository. A quick word about manifests: when a user downloads content out of the repository, a manifest file is created within the zip file which contains the permission and ownership information about the file.
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.
- From the User Console Home, click Browse Files. The Browse Files page appears.
- From the Browse pane on the left, click to choose the destination folder for the upload.
- With the destination folder highlighted, click Upload in the Folder Actions pane on the right. The Upload dialog box appears.
- Browse to the file or folder to be uploaded by clicking Browse.
- Click OK to begin upload using the default settings.
- Choose preferences for the upload by clicking to expand the Advanced Options menu.
- Choose Replace the Existing File or Do Not Upload from the first menu.
- Choose File Permissions from the second menu. The choices are Do Not Change Permissions or Retain Permissions on the Uploaded File.
- 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.
- Choose None, Short, or Verbose from the Logging menu.
- Click OK.
Upload from the Command Line
- Open the command line interface by clicking Start and typing cmd. Press Enter.
- From the command line interface, go to the location where you have a local copy of Biserver-EE installed, such as C:/dev/pentaho/biserver-ee.
- 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
- 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.
| Command | Description | Values | Required |
|---|---|---|---|
| -i,--import | Upload Command | n/a | Yes |
| -a,--url <arg> | URL of the repository (for example, http://localhost:8080/pentaho). | URL | Yes |
| -c,--charset <arg> | Charset to use for the repository. Characters from external systems are converted to this charset | UTF-8 (default) | No |
| -f,--path <arg> | Repository path to which the uploaded files are added (for example, /public) | File path | Yes |
| -h,--help | Prints this message | n/a | No |
| -p,--password <arg> | Repository password | Alphanumeric | Yes |
| -u,--username <arg> | Repository username | Alphanumeric | Yes |
| -x,--source <arg> | External system type | legacy-db or file-system (default) | Yes |
| -o , --overwrite <arg> | Overwrites file(s) on upload. Default value is True. | Boolean | No |
| -m, --permission <arg> | Applies ACL using manifest file. Default value is True. | Boolean | No |
| -r, --retainOwnership | Replaces the file ownership upon upload with the ownership of the original download. Default value is True. | Boolean | No |
| -l, --logfile <arg> | Path to local file system with name of file to write | File path | No |
| -t, --type <arg> | The type of content being uploaded - files (default), metadata. | File type | No |
| -a_ds,--analysis-datasource <arg> | Analysis datasource type. | Alphanumeric | No |
| -a_param,--analysis-parameters <arg> | Analysis datasource parameters. Alphanumeric No | Alphanumeric | No |
| -a_xmla,--xmla-enabled <arg> | Analysis XMLA enabled flag. | Boolean | No |
| -cat,--catalog <arg> | Catalog description. | Alphanumeric | No |
| -ds,--datasource-type <arg> | Datasource type. | Alphanumeric | No |
| -m_id,--metadata-domain-id <arg> | Metadata domain ID. | Alphanumeric | No |
| -params,--params <arg> | Parameters to pass to REST service call. | Alphanumeric | No |
| -res,--resource-type <arg> | Import/Export resource type. | Alphanumeric | No |
| -rest,--rest | Use the REST (default) version (not local to the BA Server). | Alphanumeric | No |
| -s,--legacy <arg> | If True - use the legacy Import/Export on local BA server. | Boolean | No |
| -v,--service <arg> | This is the REST Service call, for example: ACL, children, properties. | URL | No |
Download Folders and Files
Download a Folder
- From the User Console Home, click Browse Files. The Browse Files page appears.
- From the Browse pane on the left, browse to the location of the folder to be downloaded.
- With the folder highlighted, click Download in the Folder Actions pane on the right.
- Choose Save File in the window that appears, and click OK.
Download a File
- From the User Console Home, click Browse Files. The Browse Files page appears.
- 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.
- Click to select the file in the Files pane and choose Download in the Folder Actions pane on the right.
- Choose Save File in the window that appears, and click OK.
Download from the Command Line
- Open the command line interface by clicking Start and typing cmd. Press Enter.
- From the command line interface, go to the location where you have a local copy of Biserver-EE installed, such as C:/dev/pentaho/biserver-ee.
- 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
- Press Enter after the arguments are typed.
| Command | Description | Values | Required |
|---|---|---|---|
| -e, --export | Download command | n/a | Yes |
| -a,--url <arg> | URL of repository (for example, http://localhost:8080/pentaho) | URL | Yes |
| -c,--charset <arg> | Charset to use for the repository. Characters from external systems are converted to this charset. | UTF-8 (default) | No |
| -h,--help | Prints this message. | n/a | No |
| -f,--path <arg> | Repository path to which the uploaded files are added (for example, /public) | File path | Yes |
| -p,--password <arg> | Repository password | Alphanumeric | Yes |
| -fp,--filepath <arg> | Location that the zip file is downloaded to | File path | Yes |
| -u,--username <arg> | Repository username | Alphanumeric | Yes |
| -l, --logfile <arg> | Path to local file system with name of file to write | File path | No |
| -w, --withManifest <arg> | If true, includes Manifest.xml inside zip. If false, download excludes this file. | Boolean | No |
| -a_ds,--analysis-datasource <arg> | Analysis datasource type. | Alphanumeric | No |
| -a_param,--analysis-parameters <arg> | Analysis datasource parameters. | Alphanumeric | No |
| -a_xmla,--xmla-enabled <arg> | Analysis XMLA enabled flag. | Boolean | No |
| -cat,--catalog <arg> | Catalog description. | Alphanumeric | No |
| -ds,--datasource-type <arg> | Datasource type. | Alphanumeric | No |
| -m_id,--metadata-domain-id <arg> | Metadata domain ID. | Alphanumeric | No |
| -params,--params <arg> | Parameters to pass to REST service call. | Alphanumeric | No |
| -res,--resource-type <arg> | Import/Export resource type. | Alphanumeric | No |
| -rest,--rest | Use the REST (default) version (not local to the BA Server). | Alphanumeric | No |
| -s,--legacy <arg> | If True - use the legacy Import/Export on local BA server. | Boolean | No |
| -v,--service <arg> | This is the REST Service call, for example: ACL, children, properties. | URL | No |