Running the SubStringIndexTool

The SubStringIndexTool is used to create the schema objects associated with a substring index, and populate them with data from the source attribute. If the source attribute exists in a class that has subclasses, then the substring index contains information for all subclasses. The tool is run from a Windchill shell, using the following syntax:

• <class name> and <attribute name> identify the object attribute for a substring index specified in the configuration file. If <class name> and <attribute name> are not specified, then the <operation> is applied to all substring index entries configured in the configuration file. The <class name> and <attribute name> arguments are optional.

Operation

Description

create

Performs all operations necessary to make the substring index usable by the system, in the following order: config, table, build, and index.

create is the only operation needed to create a substring index, and should be used in most cases. The other operations may be used individually if greater control is needed over managing the substring index.

config

Reloads configuration information in the method server.

build

Populates the substring index schema objects with data from the source attribute.

table

Creates the table schema object for the substring index.

index

Creates the index schema objects for the substring index.

sync

Manually synchronizes the substring index data with the associated source attribute values.

drop

Drops all schema objects for the substring index.