Previous Topic: How the Bulk Load Client Works

Next Topic: Supported Use Cases

Command Line Options

The following options are used to run the Bulk Load Client:

Command

Description

-b, --batchSize <number>

This option specifies the maximum number of user data records to be sent to the server in each request. This option can be used to break up the large number of records into smaller chunks in order to avoid overloading the server.

-c, --configFile <file>

This option specifies a properties file that contains the configuration options for invoking the Bulk Loader task. The default is "imbulkloadclient.properties".

-e, --endpointInfoFile

This option is used together with the (-s, --storeEndpointInfo) option. This option specifies a properties file that contains the key/value pairs for "user", "password", and "serverUrl".

-f, --format (CSV | XML)

This option specifies the format of the input file (-i, --inputFile) that contains the data records to be sent to the server. The default is XML. When the input file format is XML, you must use the -t, --transformFile <file> option to specify the XSLT template for carrying out the transformation. If the input file format is CSV, the file will be submitted to the Bulk Loader task directly without transformation.

-h, --help

Displays the help and exit.

-i, --inputFile <file>

The input file that contains the user data records to be sent to the server. It can be in XML or CVS format.

-o, --outputFile <file>

If this is option is specified, the result will also be written to this file when the input file is transformed.

-p, --password <pass>

Specifies the password used for server authentication.

-s, --serverUrl <url>

Specifies the URL of the TEWS interface.

-S, --storeEndpointInfo

Stores the specified server URL and the Admin user name and password in the configuration file (-c, --configFile). The password is obfuscated before it is stored. The information that is going to be stored can be provided through (-e, --endpointInfoFile).

-u, --user <username>

Specifies the user name for server authentication.

-v, --verbose

Specifies to output as much of the message as available.

-V, --version

Displays the version information of the program.

 

-T, --transformOnly

Specifies to only carry out the XSLT transformation of the input XML file into CSV format without submitting to the server. If a valid file name is also specified by -o, --outputFile <file>, the CSV result will be written to that file.

-t, --transformFile <file>

Specifies the file that contains the XSLT template for XSLT transformation of the input file, if the file format is in XML.