Previous Topic: Install the Bulk Load ClientNext Topic: Before Using the Bulk Load Client


Command Line Options

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

-b, --batchSize <number>

Specifies the maximum number of user data records to be sent to the server in each request. This option is used to avoid overloading the server.We recommend you to use a batchSize of 100.

-c, --configFile <file>

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

-e, --endpointInfoFile

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

-f, --format (CSV | XML)

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, 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 is submitted to the Bulk Loader task directly without transformation.

-h, --help

Displays the command syntax.

-i, --inputFile <file>

Determines the user data records to be sent to the server. It can be in XML or CSV format.

-o, --outputFile <file>

Writes the result 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 the endpointInfoFile option.

-u, --user <username>

Specifies the user name for CA IdentityMinder authentication.

Note: The user must be authorized to use the CA IdentityMinder Bulk Loader task.

-v, --verbose

Specifies the output as much of the message as available.

-V, --version

Displays the version information of the program.

-T, --transformOnly

Specifies to 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.