Creating an Empty Parametric Index

The following procedure uses the Parametric Index wizard to create an empty parametric index.

1. From the Business Console screen, select File | New | Parametric Index. The Parametric Index wizard displays.



2. Click Create a new parametric index from scratch. Click Next.



3. Enter a name and a description for your parametric index. Click Next.



4. Select a data source to use for the parametric index. The following source options are available:

Use the fields of an existing collection

Use an existing XML data file

No data source

Click Next.

Using the Fields of a Collection

1. If you use the fields of an existing collection, choose the collection to use. Click Next.



2. Select a collection from the list of available collections. Click Next.



3. Select collection fields. Move the fields you want to use to the parameters list.

Select the parameter properties for each parameter, including name, collection field, default value, delimiter, and one of the following data types:

Attribute—A string that specifies a name-value pair.

Date—A string in the date export format.

Float—A real number in IEEE floating-point representation.

Signed—A 4-byte signed number in the range of -2,147,483,648 to +2,147,483,647, inclusive.

String—A null-terminated character string. String is the default data type.

Taxonomy—A special data type based on taxonomies in the Taxonomy module.

Tree—A string that associates the value with a category in a hierarchical organization of categories.

Unsigned—A 4-byte unsigned number in the range of 0 to 232-1.

See the Verity K2 Parametric Developer Guide for additional information about these data types. See Using the Taxonomy Module for information about the taxonomies used.

Click Generate to test the configuration of the parameters you have created. Sample data is generated using the number of documents specified in the text field. Defining the number of documents to use while generating sample data allows you to avoid potentially long computations. A higher number of sample records yields a more complete picture of the data in your system.

Click Finish to create the parametric index.

4. Confirm the settings for the new parametric index. Click Create Parametric Index to create the new parametric index. You can also

Click Edit to edit the outline file before creating the parametric index.

 

   
  Note   Parameters with a type of taxonomy do not appear in the outline file.
   

 

Click Exit to leave the wizard without creating a new parametric index.

5. Click Open New Parametric Index after the creation process is complete. The new parametric index opens in Business Console.

Using an XML Data File



1. If you use an existing XML data file for your source, you must choose the XML file. Browse to the file, select the file, and click Next.



2. Configure your XML mappings by selecting the following:

Unique ID—A string that identifies a document. This field tells the parametric index where to look to find the Unique ID within the XML record.

XML record—A string that specifies the XML element that defines the record.

VDK field—A string that specifies the name of the VDK field. Use _docid when you do not have an explicit field to which to map. If you use _docid, the unique ID must be numeric.

See the Verity K2 Parametric Developer Guide for information about XML and parametric index mapping.

Click Next.



3. Select an XML element and the parameters to use. Move the elements you want to use to the parameters list.

Select the parameter properties for each parameter, including name, XML element, default value, delimiter, and one of the following data types:

Attribute—A string that specifies a name-value pair.

Date—A string in the date export format.

Float—A real number in IEEE floating-point representation.

Signed—A 4-byte signed number in the range of -2,147,483,648 to +2,147,483,647, inclusive.

String—A null-terminated character string. String is the default data type.

Taxonomy—A special data type based on taxonomies in the Taxonomy module.

Tree—A string that associates the value with a category in a hierarchical organization of categories.

Unsigned—A 4-byte unsigned number in the range of 0 to 232-1.

See the Verity K2 Parametric Developer Guide for additional information about these data types. See Using the Taxonomy Module for information about the taxonomies used.

Click Generate to test the configuration of the parameters you have created. Sample data is generated using the number of documents specified in the text field. Defining the number of documents to use while generating sample data allows you to avoid potentially long computations. A higher number of sample records yields a more complete picture of the data in your system.

Click Finish to create the parametric index.



4. Confirm the settings for the new parametric index. Click Create Parametric Index to create the new parametric index. You can also

Click Edit to edit the outline file before creating the parametric index.

Click Exit to leave the wizard without creating a new parametric index.

5. Click Open New Parametric Index after the creation process is complete. The new parametric index opens in Business Console.

Using No Data Source

1. If you are creating a parametric index without using a data source, you need to create parameters. Create parameters and add them to the Parameters list.



Select the parameter properties for each parameter, including name, XML element, collection field, and one of the following types:

Attribute—A string that specifies a name-value pair.

Date—A string in the date export format.

Float—A real number in IEEE floating-point representation.

Signed—A 4-byte signed number in the range of -2,147,483,648 to +2,147,483,647, inclusive.

String—A null-terminated character string. String is the default data type.

Taxonomy—A special data type based on taxonomies in the Taxonomy module.

Tree—A string that associates the value with a category in a hierarchical organization of categories.

Unsigned—A 4-byte unsigned number in the range of 0 to 232-1.

See the Verity K2 Parametric Developer Guide for additional information about these data types. See Using the Taxonomy Module for information about the taxonomies used.

Click Generate to test the fields you have selected by generating sample data on a selected number of the sample documents.

Click Finish to create the parametric index.

2. Confirm the settings for the new parametric index. Click Create Parametric Index to create the new parametric index. You can also

Click Edit to edit the outline file before creating the parametric index.

Click Exit to leave the wizard without creating a new parametric index.

3. Click Open New Parametric Index after the creation process is complete. The new parametric index opens in Business Console.