IDOL Category Component 24.2

# Fields

NOTE: This parameter description applies only to the CategorySetDetails action.

The name of one or more fields to set for the specified category. Use Values to set values for these fields.

If the fields that you specify already exist for the category, their values are changed to those you specify in the Values parameter. If the fields that you specify do not exist for the category, IDOL Category Component creates them.

If you specify multiple fields, separate them with commas. There must be no space before or after a comma.

Four special `Fields` are available, which you can use to control the terms to include in a category.

- MaxTerms

- MinTermLength

- MinTermWeight

- WeightingAlgorithm

Actions: | CategorySetDetails
Type: | String
Default: |
Example: | `Fields=AUTHOR,WORK`
See Also: |

## MaxTerms

The maximum number of terms that a built category can have.

Type: | Integer
Default: | 100
Allowed Range: | Minimum: 1 Maximum: 4096
Example: | `Fields=MaxTerms Values=1000`
See Also: |

## MinTermLength

The minimum length that a term can have and be included in category terms.

Type: | Integer
Default: | 0
Allowed Range: | Minimum: 1 Maximum: 4096
Example: | `Fields=MinTermLength Values=3`
See Also: |

## MinTermWeight

The minimum weight that a term can have and be included in category terms.

Type: | Integer
Default: | 0
Allowed Range: | Minimum: 1
Example: | `Fields=MinTermWeight Values=4`
See Also: |

## WeightingAlgorithm

The algorithm used to generate category terms and weights.

NOTE: You can temporarily override the `WeightingAlgorithm` set on a category for a single CategoryBuild action by using the WeightingAlgorithm action parameter of the CategoryBuild action.

You can use one of the following values:

- `0`: default algorithm

- `1`: language categorization

- `2`: bias toward capitalization and proper name terms

- `3`: allow only proper name terms; no single words

Type: | Integer
Default: | 0
Example: | `Fields=WeightingAlgorithm Values=2`
See Also: | WeightingAlgorithm

Copyright 2024 Open Text
Version 24.2 | Last updated March 2024

Send documentation feedback

Close

Send documentation feedback

To send feedback using your default email client, open an email window.

Otherwise, send your feedback and the information below to MFI-swpdl.idoldocsfeedback@opentext.com.

We appreciate your feedback!

Product: IDOL IDOL Category Component 24.2

Topic Title: Fields