IDOL Server 24.2

# CategorySetDetails

Allows you to set details for a category. You can also use `CategorySetDetails` to create new fields in a category.

NOTE: This is an administrative action that can be sent only by users that belong to an authorization role that allows the `Admin` standard role, or which enables the action explicitly. See Authorization Roles Configuration Parameters.

You must specify one of the following parameter combinations for `CategorySetDetails`:

- Name

- Fields and Values

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

NOTE: A category cannot have the same name as another category with the same immediate parent category.

## Examples

    http://12.3.4.56:9000/action=CategorySetDetails&Category=324987602&Fields=AUTHOR,WORK&Values=Austen,Emma

This action sets the value of the `AUTHOR` field for the category with the ID `324987602` to `Austen`, and the value of the `WORK` field to `Emma`. If the `AUTHOR` and `WORK` fields do not exist in the category, they are added to it with the specified values.

    http://12.3.4.56:9000/action=CategorySetDetails&Category=324987602&Fields=MaxTerms,MinTermWeight&Values=200,3

This action uses the special fields MaxTerms and MinTermWeight to set the maximum number of terms for the category with the ID `324987602` to `200`, and to set the minimum weight that any term included in the category must have to `3`.

## Require dParameters

The following action parameters are required.

Parameter | Description
--- | ---
Category | The ID of the category to set fields for.

You must set at least one of the following parameters.

Parameter | Description
--- | ---
Fields | The fields to set for the category.
Name | A new name for the category.
Values | Values for the specified Fields.

## Optional Parameters

This action accepts the following optional parameters.

Parameter | Description
--- | ---
BuildNow | Whether to build the category immediately.
Databases | Restricts results to specific databases.
FieldText | A field restriction to apply to the category results.
NormalMinDocOccs | The minimum number of documents that a term must occur in for it to be given a weight.
NumResults | The maximum number of results to return.
Recurse | Apply these changes to all descendants.
RelevantCat | The child category to use as the relevant category.
SimpleCatDefaultCat | The child category to use as the default category for CategorySimpleCategorize.
SimpleCatParam | A weighting factor to use in CategorySimpleCategorize.
TaxonomyRoot | Whether this category is the root of a taxonomy.
Threshold | The relevance threshold of results.
UserName | The name of the user that sends the action.

This action accepts the following standard ACI action parameters.

Parameter | Description
--- | ---
ActionID | A string to use to identify an ACI action.
FileName | The file to write output to.
ForceTemplateRefresh | Forces the server to load the template from disk.
Output | Writes output to a file.
ResponseFormat | The format of the action output.
Template | The template to use for the action output.
TemplateParamCSVs | A list of variables to use for the specified template.

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 Server 24.2

Topic Title: CategorySetDetails