Allows you to export a category (including its descendants, training documents, and terms and weights) to XML format. You can write the XML output to the screen or to a file.
You can use this action to export normal, SimpleCat, and Relevance categories.
If you have set the MultipleParentsAllowed configuration parameter to True
in the [Category]
section of the configuration file, CategoryExportToXML
exports categories in a flat XML structure, even if you set Flat to False
.
This is an administrative action that can be sent only from AdminClients (which are set in the [Server]
section of the configuration file).
http://12.3.4.56:9000/action=CategoryExportToXML
This action uses port 9000
to instruct HPE IDOL Server, which is located on a machine with the IP address 12.3.4.56
, to export all descendants of the root category into XML format and return the XML on screen.
Parameter | Description | Required |
---|---|---|
Above | Whether to export the category ancestors. | |
Below | Whether to export the category descendants. | |
Category | The ID of the category to export. | Yes |
ExportFileName | The XML file to export the category to. | |
Flat | Whether to use a flat XML format. | |
IncludeCatID | Whether to export category IDs. | |
IncludeContents | Whether to include the training data in the XML. | |
IncludeTopLevel | Whether to export the specified category. | |
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. |
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. |
|