Table Load

The Table Load activity creates a table on the TIBCO Patterns server using the information in a file. The file contains table meta-data (for example, field names) or rows to load into the table.

General

The General tab has the following fields:

Table Load Configuration Fields

Field

Module Property?

Description

Name

No

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

Patterns Connection

Yes

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

Description

Provide a short description for the Table Load activity.

Input

The Input tab has the following fields:

Table Create Input Fields

Input Item

Description

Name

The table name.

Type

The table type. This can be Standard, Parent, or Child.

Description

An optional note to attach to the table.

ParentTableName

The parent table name. This is required if the table type is Child.

Prefilter

The kind of prefilter used to index the table. This can be GIP, SORT, or PSI.

GpuIndexing

Set to true() to enable GPU harnessing on the table.

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 ibi Patterns - Search 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

Currently supported encodings are LATIN1 and UTF-8. This is optional.

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. Optional.

KeyFieldIndex

Index of the file field that contains record keys. Optional.

At most one of 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. Optional.

ParentKeyFieldIndex

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

For child tables, exactly 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.

FieldDefinitionOverride

Overrides the table meta-data present in the file. The number of overrides must match the number of fields in the file (excluding key fields, if any). This is optional.

FieldDefinitionOverride/ Name

Define the field names for the table. The complete list of field names must be given. It is not supported to override some names and not others. This is optional. Do not provide if HasFieldNames is true() and FileReadBy is PatternsServer.

FieldDefinitionOverride/ Type

Define the field types for the table. The complete list of field types must be given. It is not supported to override some field types and not others. This is optional. The default is SearchableText. Do not provide if HasFieldTypes is true() and FileReadBy is PatternsServer.

FieldDefinitionOverride/ CharacterMapName

Name of the character map that applies to the field. This is optional. The default is =STD=. It is ignored for fields types other than SearchableText or Attributes.

Output

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