Download and Setup
This section describes how to download the Upload Tool and setup the common configuration files to use the tool.
Zoho Reports Upload Tool can be downloaded from the below URLs. The tool is supported in Windows, Linux and Mac operating systems.
Note Mac users:
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.
- After you unzip the Upload Tool files, open a terminal/command-line and change the directory to/bin.
- Type the following command at the command prompt.
- Copy the java location returned by your system.
- Open the setEnv.sh file and remove the line #2 (export JAVA_HOME=$TOOL_HOME/jre)
- Modify the path in #3 ie.. JAVABIN=input_the_path
- Save the setEnv.sh file.
Once the above changes are done, you can start using the Upload tool as instructed further in this document.
Migrating to the latest version of the Upload tool
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:
- Download the new Upload Tool ZIP file
- Unzip the ZIP file in a new directory (say, LatestUploadTool)
- Go to the home directory (ZohoReports/UploadTool) of the old Upload tool
- Copy conf directory
- Paste the conf/ directory in the Latest Upload Tool Home (LatestUploadTool/ZohoReports/UploadTool)
- Use the latest Upload tool to upload your data into Zoho Reports
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:
- CSVUploadGUI.bat / CSVUploadGUI.sh - This file contains the script that is required to invoke the Upload Tool in GUI mode.
- CSVUploadConsole.bat / CSVUploadConsole.sh - This file contains the script that is required to invoke the Upload Tool in Console mode.
- UploadFromDB.bat / UploadFromDB.sh - This file contains the script that is required to upload data from in-house database.
- setEnv.bat/ setEnv.sh - This file is used to set the required environmental variables.
- Use the .bat files for Windows machine and the .sh files for Linux & Mac machine.
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:
- common_params.conf: This configuration file contains parameters that has to be specified for pushing data either from a CSV file or an in-house database. This file contains Connection Parameters for configuring proxy server details, if you are going to connect to the Internet through a proxy server. It also contains Import Parameters which has to be configured while uploading data from a CSV file.
- database_connection_params.conf: This configuration file has to be setup if you are going to use the tool to connect to your local database to fetch data and upload the same into Zoho Reports. This file also contains the local database connection parameters like database type, name, local host name/machine name, port, user name, password etc.
- database_sql_queries.xml: This configuration is another file to setup if you are going to use the tool to connect to your local database to fetch data and upload the same into Zoho Reports. You need to specify the SQL SELECT Queries to be executed in the local database to fetch the required data to be uploaded into Zoho Reports. In this file you will also be configuring where the uploaded data has to be stored in Zoho Reports i.e., Zoho Reports database name and table name.
The lib folder contains the required executable JAR files to run the tool.
Upload Tool runs in your local environment (machine) and contacts Zoho 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 Zoho Reports service URL) after being authenticated by the IAM_SERVER_URL (this is the URL of the Zoho Authentication server).
Default values are provided for these two parameters, as given below. Do not change the default values provided:
- IAM_SERVER_URL= https://accounts.zoho.com
- REPORT_SERVER_URL= https://reportsapi.zoho.com
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 Zoho Reports Administrator or Database owner, then you need to provide the following parameter. This parameter should provide the Zoho Reports user name of the Database owner or Zoho Reports Administrator to whom this Shared user is associated with, as value.
- DBOWNERNAME = database_owner_username
Proxy Server Settings
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.
- If you are using a Direct Internet connection, then this setting can be ignored.
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.
- USEPROXY - Set this to true, if you are connected through a Proxy server. Set this to false, if you are connected to the Internet directly. By default this value is set to false.
- PROXYHOST - Specify the machine name or IP address where the proxy server is running in your network.
- PROXYPORT - Specify the port in which the proxy server is running.
- PROXYUSERNAME - Specify your proxy server user name to access the proxy server.
- PROXYPASSWORD - Specify your proxy password to access the proxy server.
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.