CategoryImportFromDocs

Allows you to import a category hierarchy from path information contained in a particular field in a specified set of documents. The category hierarchy that it creates is empty (untrained), with category names that match the node names in the imported hierarchy data.

You can specify document IDs or references by using DocID or DocRef, or you can define a query to use to identify documents by setting DREQuery. If you do not set any of these parameters, IDOL Server uses all documents.

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:9000/action=CategoryImportFromDocs&PathField=ClothingIndex&Separator=:&DocRef=http://company/catalog/catalog105.xml,http://company/catalog/catalog205.xml

This action imports the category hierarchy contained in the ClothingIndex field in the files catalog105.xml and catalog205.xml files.

Required Parameters

The following action parameters are required.

Parameter Description
PathField The name of the field that contains the category hierarchy data.

Optional Parameters

This action accepts the following optional parameters.

Parameter Description
BuildNow Whether to build the category immediately.
DatabaseMatch Databases to import documents from.
DocID Document IDs for documents that contain category hierarchy data.
DocRef References of documents that contain category hierarchy data.
DREQuery Identifies documents in the data index. IDOL Server imports category hierarchies from the specified fields in these documents.
IgnoreSuffix Determines whether to ignore the final token in any path.
NumResults The maximum number of results to retrieve.
Parent The parent of the new categories. If you set Parent, you cannot also set TaxonomyName.
PathField The name of the field that contains the category hierarchy data.
PathSeparator The separator character to use when typing multiple paths in the field.
PrefixToIgnore Whether to ignore the initial token in any path.
SecurityInfo The security details for the user that sends the action.
Separator The delimiter character used to separate categories in the data to import.
TaxonomyName The taxonomy root to create the new categories in. If you set TaxonomyName, you cannot also set Parent.
TrainNow Automatically assigns documents used to create categories as training documents for those categories.

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.