This section describes how to download the Upload Tool and setup the common configuration files to use the tool.
SkyDesk Reports Upload Tool can be downloaded from the below URLs. The tool is supported in Windows, Linux and Mac operating systems.
|Download Upload Tool|
|Windows Download||Linux Download||Mac Download (Refer to the below note)|
Mac users need to define the following settings in the setEnv.sh file of the Upload Tool's /bin folder. The upload tool that you download will the same as that of the Linux version, but you need to make the following given changes before using the tool.
Once the above changes are done, you can start using the Upload tool as instructed further in this document.
This section will help the users who are using old version of the Upload tool and now downloading the new version of the Upload tool for an update:
Once downloaded, extract the zip files to a directory of your choice. Open the folder where you have extracted the file. You will notice that it contains sub folders as shown below.
The bin folder contains batch files and shell scripts required to upload data from CSV files (GUI/Console mode) and in-house databases. This is also used to set environmental variables. The following is a brief description of the files available in the /bin directory:
The conf directory contains all the configuration files for the tool. Before you execute the tool you need to specify the appropriate configuration settings. The /conf directory consists of three files. They are:
The lib folder contains the required executable JAR files to run the tool.
Upload Tool runs in your local environment (machine) and contacts SkyDesk Reports service in the cloud for pushing data either from a CSV file or a database. There are some configuration settings which are common to both these methods. You can configure these settings in the common_params.conf file, found under /conf/ directory, as described below.
In the configuration file common_params.conf, there are two parameters called REPORT_SERVER_URL and IAM_SERVER_URL. The tool will connect the REPORT_SERVER_URL (which is the SkyDesk Reports service URL) after being authenticated by the IAM_SERVER_URL (this is the URL of the SkyDesk Authentication server).
Default values are provided for these two parameters, as given below. Do not change the default values provided:
If the upload tool is going to be executed with the user credentials of a Shared User, and not from the user credentials of the SkyDesk Reports Administrator or Workspace owner, then you need to provide the following parameter. This parameter should provide the SkyDesk Reports user name of the Workspace owner or SkyDesk Reports Administrator to whom this Shared user is associated with, as value.
If the Upload tool is going to be connected to the Internet through a proxy server (typically used in an Organization Network), you need to specify your proxy server details in common_params.conf file.
To connect with the internet through a proxy server you need to provide the following CONNECTION PARAMETERS in the /conf/common_params.conf file. You can edit the file using the text editor such as Vi or Vim or Notepad.
The following screen shot displays a typical Proxy configuration.
Other import settings that need to be configured in the common_params.conf file for different upload methods will be discussed under the corresponding sections.
Uploading Data from CSV Files - GUI Mode l Uploading Data from CSV Files - Console Mode l Uploading data from Relational databasesl Uploading Data from NOSQL Database l Uploading Data from Cloud Database