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 from AdminClients (which are set in the [Server]
section of the configuration file).
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.
http://12.3.4.56:9000/action=CategorySetDetails&Category=324987602&Fields=AUTHOR,WORK&Values=Austen,Emma
This action uses port 9000
to instruct HPE Category Component, which is located on a machine with the IP address 12.3.4.56
, to set 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
.
Parameter | Description | Required |
---|---|---|
BuildNow | Whether to build the category immediately. | |
Category | The ID of the category to set fields for. | Yes |
Databases | Restricts results to specific databases. | |
Fields | The fields to set for the category. | See Comments |
FieldText | A field restriction to apply to the category results. | |
Name | A new name for the category. | See Comments |
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. | |
Values | Values for the specified Fields. | See Comments |
This action accepts the following standard ACI action parameters.
Parameter | Description |
---|---|
ActionID | A string to use to identify an ACI action. |
EncryptResponse | Encrypt the output. |
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. |
You must specify one of the following parameters or parameter combinations for CategorySetDetails
:
|