Uploading Data from CSV Files - Console Mode

Parameter Name

Description

File Name (file_name)

The CSV file location to be uploaded.

Database Name (database_name)

The name of the database in Virtutem Analytics into which the CSV file is to be uploaded.

Note : Ensure that the database is already available in  Virtutem Analytics  account. If it does not exist contact Virtutem to create the database before executing this upload to avoid failure. 

Table Name (table_name)

The table name into which the CSV file is to be uploaded. 

Ensure that the specified table with similar column structure is already created in the Virtutem Analytics Reporting Database.

In case the table does not exist, then you can set the Upload Tool to create the table and then upload the data into this table using the ZOHO_CREATE_TABLE parameter available in common_params.conf file. Refer to the  Configure Import Settings  section to know more about the ZOHO_CREATE_TABLE parameter.

Import Type

Set one of the following as  Import Type .

·   APPEND  - appends the CSV data to the end of the table.

·   UPDATEADD  - updates existing data and appends new data. For this you need to configure  ZOHO_MATCHING_COLUMNS  in  common_params.conf  in the conf  directory.

·   TRUNCATEADD  - Deletes the existing data and adds new data.

User Name (zohoreports_username)

Your Virtutem Analytics account login name

Note:  If you have registered in Virtutem Analytics using other login such as Google Apps, Gmail, Facebook & Yahoo, then you cannot use these credentials to upload data using Upload Tool. In this case you need to generate a Virtutem Username and Password to upload data. 

Password (zohoreports_password)

Password for accessing your Virtutem Analytics account.

Parameter

Possible Values

Description

ZOHO_CREATE_TABLE

·   True

·   False

Optional
This parameter specifies whether to create the table or throw error, if the specified table does not exist in the database.

·   True  - New table will be created in the specified database with the said name and then the data will be imported. If the table already exists in the database, then the data will be imported into it.

·   False  - The data will be imported into the specified table. If the table does not exist in the specified database then it throws an error.

Default value is  false .

LINES_TO_SEND

Optional 
Upload Tool splits the CSV file into batches for uploading. This parameter specifies the nu

er of row for each batch.
Default value is  5000 .

ZOHO_FIRST_ROW_HEADER

·   True

·   False

Optional 
This parameter specifies whether the first row of the CSV file is the column header or not.

·   True  - First row contains the column header names.

·   False  - First row does not contain the column headers. In this case it is mandatory to specify the column header names for the parameter ZOHO_COLUMN_HEADER_NAMES (described next).

Default is  true.

ZOHO_COLUMN_HEADER_NAMES

Column Names with comma separator

This parameter is mandatory when the  ZOHO_FIRST_ROW_HEADER  is set to  false
Specify the column headers/names in the same order as the data exists in the CSV file. The column names provided here will be considered as the header of the CSV file.

ZOHO_DATE_FORMAT

Format of the date.
E.g.,
ZOHO_DATE_FORMAT = dd-MMM-yyyy

Note : The above example indicates a date in the format 10-Nov-2013. Ensure you provide the appropriate notation to match your date format. 

Optional 
In case you are using a custom date format other than the default date format in Virtutem Analytics , then you can use this parameter to specify the date format. Refer to the following link: How to construct date format string.

ZOHO_MATCHING_COLUMNS** 

List the column names separated by comma.
E.g.,: ZOHO_MATCHING_COLUMNS = Name, Department 

This parameter is mandatory when the  ZOHO_IMPORT_TYPE  is set to  UPDATEADD . Set this parameter to column names based on which the existing records in the table need to be matched. If the record already exists in the table then it will be replaced with the new values in the uploaded CSV file. Remaining rows will be added at the end of the table. 

ZOHO_AUTO_IDENTIFY

·   True default

·   False

This parameter specifies whether the tool should automatically identify the delimiter or not.

·   True  -The tool will automatically identify the delimiter (ZOHO_DELIMITER parameter) and text qualifier (ZOHO_QUOTED parameter) in the CSV file that is being imported. By default this will be set to  true .  

·   False  - You need to specify the delimiter and text qualifier explicitly. The following table lists the parameters to specify the delimiter and text qualifier. 

In case this parameter is set to false, then you need to specify the delimiter and text qualifier usin the parameters in the   table below.

ZOHO_SKIPTOP

Optional
This parameter specifies the number of top rows that are to be skipped in the CSV file being imported.

ZOHO_THOUSAND_SEPARATOR

·   0

·   1

·   2

·   3

Optional
This parameter specifies the thousand separator for the numeric data.
The following is the list of parameter values and the corresponding thousand separator.

·   0 - COMMA

·   1 - DOT

·   2 - SPACE

·   3 - SINGLE QUOTE

Default is 0.

ZOHO_DECIMAL_SEPARATOR

·   0

·   1

Optional 
This parameter specifies the decimal separator for the numeric data.

The following is the list of parameter values and the corresponding decimal separator.

·   0 - DOT

·   1 - COMMA

Default value is  0.

ZOHO_FILE_ENCODING

·   UTF-8

·   UTF-16

·   GB18030

·   Shift_JIS

Optional 
This parameter specifies the File Encoding Format of the input file.

Default value is  UTF-8 .

ZOHO_REMOVE_BOM

·   True

·   False

Optional
If you are uploading a CSV file contains which contains Byte Order Mark (BOM), then you can use this parameter to identify and remove BOM Characters. 

Set this to  true , the tool will identify the BOM and remove the BOM from the file. You can also specify the BOM type (UTF-16LE,UTF-16BE), if you know the type.

ZOHO_CANOVERRIDE

·   True

·   False

Optional 
In case another import is triggered for the same table when this import is in process, then you can use this parameter to specify whether the new import can override this import. 

·   True  - The tool will stop the current import process and overwrite the table with new import.

·   False  - The tool will not disturb the current import process and will cancel the new import request.

Default value is  false.

ZOHO_ON_IMPORT_ERROR

·   ABORT

·   SKIPROW

·   SETCOLUMNEMPTY

This parameter controls the action to be taken in case there is an error during import.

·   ABORT  - In case of any error, the import will be aborted.

·   SKIPROW  - In case of any error, the specific row(s) in which error occurred will be skipped and then continue importing the rest of the data.

·   SETCOLUMNEMPTY -   In case of any error, the value of the specific cell(s) in which error occurred will be set to empty and then continue importing the rest of the data. 

Default value is  SETCOLUMNEMPTY

Parameter

Possible Values

Description

ZOHO_COMMENTCHAR

Comment Character.

The CSV row will be skipped, If the comment character is found at the beginning of the row.
Example: ZOHO_COMMENTCHAR="$

The above will skip the rows starting with $ character while importing. 

ZOHO_DELIMITER

·   0

·   1

·   2

·   3

Specifies the delimiter which separates the values in the file. The following is the list of parameter values and the corresponding delimiter:

·   0 - COMMA

·   1 - TAB

·   2 - SEMICOLON

·   3 - SPACE

ZOHO_QUOTED

·   0

·   1

·   2

Specifies the Text Qualifier which surrounds string values in the CSV file, if available. The following is the list of parameter values and the corresponding text qualifier:

·   0 - None

·   1 - SINGLE QUOTE

·   2 - DOUBLE QUOTE