IDOL Server 24.1

# CategoryExportToXML

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.

NOTE: 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`.

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=CategoryExportToXML

This action exports all descendants of the root category into XML format and return the XML on screen.

## Required Parameters

The following action parameters are required.

Parameter | Description
--- | ---
Category | The ID of the category to export.

## Optional Parameters

This action accepts the following optional parameters.

Parameter | Description
--- | ---
Above | Whether to export the category ancestors.
Below | Whether to export the category descendants.
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.
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.

Copyright 2023 Open Text
Version 24.1 | Last updated December 2023

Send documentation feedback

Close

Send documentation feedback

To send feedback using your default email client, open an email window.

Otherwise, send your feedback and the information below to MFI-swpdl.idoldocsfeedback@opentext.com.

We appreciate your feedback!

Product: IDOL Server 24.1

Topic Title: CategoryExportToXML