IBM FileNet P8, Version 5.2.1            

Configuring Bulk Import tool

To configure Bulk Import tool, modify the parameters in the configuration file.

About this task

You must modify the CEBI_cfg.sample configuration file, which provides Bulk Import tool with the information required to complete the batch import process. You can find a sample configuration file in the following default directory:

Copy the CEBI_cfg.sample file from the installation directory to create a Bulk Import tool configuration file, CEBI.cfg, that is specific to your system. Enter the appropriate values in the CEBI.cfg file. When you modify the configuration file, a line that begins with a semicolon (;) is a comment line and is ignored by the program. Blank lines are also ignored.

Procedure

  1. Open the CEBI.cfg file and enter the following login information in the LogonAttribute section:
    UserName
    The user name for logging in to Content Platform Engine.
    PassWord
    The password for logging in to Content Platform Engine.
    CeUri
    The Content Platform Engine URI. Example: http://cm-vmwtcl4a:8080/wsi/FNCEWS40MTOM.
    ObjStore
    The name of the object store that contains the document classes and documents. Example: bkmOS8nomove

    To specify multiple object stores, create a CEBI.cfg file for each object store. Start Bulk Import tool with the -h<file list of home directories> flag. Each home directory that you specify requires a CEBI.cfg that uses a specific object store.

  2. Start of changeEnter the document class and index information in the DocClassAttribute section. You can enter multiple DocClassAttributes sections. Each DocClassAttributes section must describe only one document class.End of change
    Start of changeTo generate files that contain your document class information for the specified object store, enter the following command:
    java -cpclasspath;BulkImport.jar bulkImport.BI_Start -h /home path -G
    Enter your class path information and the Bulk Import tool directory for home path. The files DocClassAttributes.txt and DocClassAttributes.xml are created in the home directory that you specified in the command. Use the information in either of these files to update your CEBI.cfg file to specify the following parameters:End of change
    ClassName
    The symbolic name of the class in the object store where you want to import your documents.
    ClassCode
    Start of changeThe class code. The class code can be a number 1 - 999. This number is generated by the -G option in the Bulk Import Tool. It does not come from the Content Platform Engine server. You can manually set this code to any valid number that is unique in the class codes that are listed in the CEBI.cfg file.End of change
    Start of changeIndexNameEnd of change
    Start of changeThe symbolic name of the Content Platform Engine class property that is associated with that Content Platform Engine class. You can add as many IndexName parameter entries as you need. However, you must include the properties that are set as required on Content Platform Engine. These required properties must have a valid entry in the transact.dat file for the batch to process correctly.
    Property fields that are of the type Date must provide a valid date mask that follows the property name. The date mask must follow this format:
    • CEBI.cfg format example: IndexName=CEBIMVdatetime:"MM/dd/yyy'T'HH:mm:ss.SSS'z"
    • transact.dat format example that uses the same date/time formatting for multi-valued properties with two values:02;{03/07/2012T13:28:49.123z|09/17/2011T02:01:00:888z},CEBIMVDateTimeFile;;test.txt
    Restriction: If milliseconds are specified, they are rounded to the nearest second when the document is imported to Content Platform Engine.

    You can modify the date format, for example yyyy/MM/dd or dd/MM/yyyy. But your format must match the date format that is used in the .dat file. 'T' must be uppercase and 'z' can be either case if it matches the format in the .dat file.

    The order of the IndexName entries is the expected order of the values that are found in the transact.dat file.

    You cannot use multiple valued properties and choice lists.

    End of change
  3. Enter the following batch information:
    MaxSubBatchSize
    The maximum size of a sub-batch in 1 K units. The MaxSubBatchSize setting controls the size of network packets. The default is 1024 bytes.
    MaxDocPerSubBatch
    The maximum number of documents of a sub-batch. The default is 999.
    WorkingDirectory
    The working directory where Bulk Import tool searches for the batches of documents that you want to import. The directory can be on a local drive or a shared network drive. This setting is required.
    JournalDirectory
    The directory where the Bulk Import tool log files are written. If not specified, the journals directory is created in the WorkingDirectory.
    FieldDelimiter
    Start of change Sets the major delimiter in the transact.dat file. The default is colon. Special characters can be used: ASCII 0x01 to 0xFF, except for 0x20 (space). To be able to use the extended ASCII codes from 0x80 to 0xFF, the CEBI.cfg and transact.dat files must be created with ANSI encoding.End of change
    ItemDelimiter
    Start of changeSets the minor delimiter in the transact.dat file. The default is comma. Special characters can be used: ASCII 0x01 to 0xFF, except for 0x20 (space). To use the extended ASCII code from 0x80 to 0xFF, you must create the CEBI.cfg and transact.dat file files with ANSI encoding. End of change
    SleepInterval
    The total number of seconds that Bulk Import tool waits from the initial search for available batchname.eob files to the next search for available batchname.eob files. This interval is not affected by how long it takes Bulk Import tool to process its current work unless the current work exceeds the sleep interval time setting. If the work exceeds the sleep interval, then another sleep interval is appended to the end of the last sleep interval before Bulk Import tool does another search for an available batchname.eob file. The default and suggested setting is 60 seconds. The maximum setting is 3600 seconds, 1 hour.
    DelayProcess
    Creates a delay in processing between the physical time stamp on a batchname.eob and when Bulk Import tool recognizes the batchname.eob file for processing. Setting this keyword to 300 causes a 5-minute delay between the time that the batchname.eob file is created and when Bulk Import tool reads the file for processing. This setting is often referred to as the "batchname.eob age". Set this parameter to zero seconds. The maximum setting is 3600 seconds, 1 hour. The default is 30 seconds.
    OSNice
    Sets Bulk Import tool to “sleep” mode between batch processing. Using this setting slows down Bulk Import tool and allows other processes to get processing time. This parameter is useful when you run Bulk Import tool in normal production time. The default is zero seconds and the maximum is 21600 seconds, 6 hours.
    Timing
    Log output that is used in performance analysis. The default value is FALSE. A setting of TRUE provides extra logging details. You can use the timer.awk program with the added log information for performance analysis.
    UNIX systems and Windows systems with UNIX tools for DOS loaded: Some newer UNIX systems might require the use of nawk instead of awk. Example:
    • awk –f timer.awk journals/imp20020328
    • nawk –f timer.awk journals/imp20040129
    Solaris 5.8 requires the use of nawk, as awk gives poor results. You can also use the nawk program instead of awk on other UNIX operating systems when the programs are present.
    ExternalPassDirectory
    The directory where a copy of the batchname.pass file is written. This directory is usually an externally mounted directory that is visible to third-party programs.
    ExternalErrorDirectory
    The directory where a copy of the batchname.err file is written. This directory is usually an externally mounted directory that is visible to third-party programs.
    ExternalRptDirectory
    The directory where a copy of the batchname.rpt file is written. This directory is usually an externally mounted directory that is visible to third-party programs.
    PassCopyDirectory
    The directory where a copy of the batchname.pass file is written is usually a local directory.


Last updated: October 2015
p8pit010.htm

© Copyright IBM Corporation 2015.