CategorySetSpecialDocs

Allows you to specify individual documents to explicitly exclude from or include in a category, and to assign weighting factors to the documents to include.

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.

Example

http://12.3.4.56:9020/action=CategorySetSpecialDocs&Category=32349987602210557106&Exclusions=excl1,excl2&Inclusions=incl1,incl2&FakeWeights=80,85

This action instructs IDOL Category Component to exclude documents with the references excl1 and excl2, and to include documents with the references incl1 and incl2 (giving them weighting factors 80 and 85, respectively) into the category with the ID 32349987602210557106.

Required Parameters

The following action parameters are required.

Parameter Description
Category The ID of the category to set special documents for.

Optional Parameters

This action accepts the following optional parameters.

Parameter Description
Absolute Whether to append documents to an existing special documents set.
Exclusions References to documents to exclude from the category.
FakeWeights Weighting factors to apply to explicitly included documents (Inclusions).
Inclusions References to documents to include in the category. If you specify one or more documents in Inclusions, you must include an equal number of values in FakeWeights.

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.