Record Bulk Load

The Record Bulk Load activity populates records into a TIBCO Patterns table from a CSV file.

General

The General tab has the following fields:

Record Bulk Load Configuration Fields

Field

Module Property?

Description

Name

No

The name of the activity within the process. The default value is bulk_load.

Patterns Connection

Yes

The path to the shared configuration resource which contains the Patterns Connection information. See Activities Connection.

Description

Provide a short description for the Record Bulk Load activity.

Input

The Input tab has the following fields:

Record Bulk Load Input Fields

Input Item

Description

TableName

The name of the table to load records into.

Operation

The record operation to perform. The following are the possible operations:

Insert: Records are inserted. Records keys that already exist in the table cause a fault.
Update: Records are updated. Records keys that do not exist in the table cause a fault.
Upsert: New records are inserted and existing records are updated.

FileName

Name of the file that contains the table data. This should be the full path name in the correct format for the system it is on.

FileReadBy

The file system that contains the file. The following are the possible systems:

PatternsServer - if the file is on the TIBCO Patterns server system. The file must be inside the server's loadable-data-directory. For more information, see Loading Data Files.
BWClient - if the file is on the TIBCO BusinessWorks system. The file must be readable by the plug-in at run time. If BWCE is targeted, the file must be available to the container.

FileEncoding

Supported encodings are LATIN1 and UTF-8. This is optional. The default is LATIN1 (same as the default for the TIBCO Patterns server or TIBCO Patterns Java API).

HasFieldNames

Set to true() if the data file has a header line with the table’s field names.

HasFieldTypes

Set to true() if the data file has a header line with the table’s field types.

KeyFieldName

Name of the file field that contains record keys. This is optional.

KeyFieldIndex

Index of the file field that contains record keys. This is optional.

At most, either KeyFieldName and KeyFieldIndex can be specified. If neither is specified, records are assigned ascending numerical keys, but this is strongly discouraged.

ParentKeyFieldName

Name of the file field that contains parent-record keys. This is optional.

ParentKeyFieldIndex

Index of the file field that contains parent-record keys. This is optional.

For child tables, one of these two must be specified.

InitialKey

If neither KeyFieldName or KeyFieldIndex are specified, this can be used to set the starting point of the ascending generated keys. This is optional.

DoMaxWork

Set to true() if invalid records in the data file should be ignored.

Output

The output contains the information on the table after the activity completes. See Table Create Output Fields for details.