Use the Bulk Import Tool command-line interface to import
large volumes of documents into a Content Platform Engine object store.
The following command-line options are available for Bulk Import
Tool:
Usage:
BulkImport -h [homedir] -q -CE <num>- -v
- Displays the Bulk Import Tool version in the console and the journals
file, and then exits the program.
- -h or -help
- Displays the Bulk Import Tool Help information in the console
and journals file and then exits the program.
- -h <homedir>
- -h specifies the location of the “home
directory”, which contains the CEBI.cfg configuration file. -h is
a required setting.
- -q
- Sets the quiet mode, which suppresses any output to the console
and journals file.
- -CE <num>
- Sets the maximum number of import threads. The default is three,
if another number is not specified.
- -S
- Turns on spy mode. Outputs detailed information in the console
and in the journals file. Spy mode reports more detail than debug
mode. Spy mode can create system overhead and is not recommended unless
you are troubleshooting an issue.
- -D
- Turns on debug mode. Outputs detailed information in the console
and in the journals file. Debug mode can create system overhead and
is not recommended unless you are troubleshooting an issue.
- -T
- Turns on test mode. When test mode is on, batches are validated,
no import occurs.
- -G
- Turns on class mode. Bulk Import Tool retrieves class data from
the object store that is specified in the CEBI.cfg file
and outputs that information into the DocClassAttributes.txt and DocClassAttributes.xml files.
These files are created in the home directory that is specified by -h <homedir>,
and then the program exits.
- -f
- Creates a FolderAttributes.txt file that
contains a list of folders from the object store.
- -r
- If you are in clustered environment, use the -r flag
to ignore any .lck files that are in process
by another instance of Bulk import that shares the working directory.
If there is a batch that fails to complete, run Bulk import without
using the -r flag. Bulk import initially looks
for .lck files in the working directory and reprocesses
the .lck files.
- -P [password]
- Creates password files. After the files are created, the program
exits. Use this option to create encrypted password files for the
object store password. The password that is stored in clear text in
the cebi.cfg file can be commented out, which
causes Bulk Import Tool to look for the encrypted password in the
password files. The password files, named . passwd0 and .passwd1,
are both needed to get the encrypted password. The password files
are placed in the home folder or the location that you specified with
the -h <homedir> option.
Important: Keep
both of these password files protected by using the appropriate file
system protections.
You are prompted for a password if you
use the -P parameter without a password argument,
or you can provide a password with the -P parameter.
You can enable or disable logging without restarting Bulk Import
Tool.
- To enable DEBUG logging, create a file that is named: .CEBI.Debug
in CE_home /tools/CEBI/
- To disable DEBUG logging, delete the file that is named: .CEBI.Debug
from CE_home /tools/CEBI/
- To enable SPY logging, create a file that is named: .CEBI.Spy
in CE_home /tools/CEBI/
- To disable SPY logging, delete the file that is named: .CEBI.Spy
from CE_home /tools/CEBI/
Tip:
The location
to add or delete the .CEBI.Debug and .CEBI.Spy files varies. The location
depends on where the
BulkImport.jar command was
run from to start Bulk Import Tool.