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, or use a DREQuery.

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 uses port 9000 to instruct HPE Category Component, which is located on a machine with the IP address 12.3.4.56, to import the category hierarchy contained in the ClothingIndex field in the files catalog105.xml and catalog205.xml files.

Parameters

Parameter Description Required
BuildNow Whether to build the category immediately.  
DatabaseMatch Databases to import documents from.  
DocID Document IDs for documents that contain category hierarchy data. See Comments
DocRef References of documents that contain category hierarchy data. See Comments
DREQuery Identifies documents in the DRE. HPE Category Component 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. See Comments
PathField The name of the field that contains the category hierarchy data. Yes
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. See Comments
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.
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.

Comments

If you do not set one of DocID or DocRef, HPE Category Component uses all documents.

You can use one of the following parameters, but not both:


_HP_HTML5_bannerTitle.htm