Category Component 25.3
Category Component Help

# CategoryImportFromXML

Import category information contained in an XML file to a specified category. The imported category information is stored as new descendants of the category to which it is imported. If the import XML includes the category IDs, `CategoryImportFromXML` creates categories with those IDs, rather than generating new ones.

You specify the XML file to use by setting either ImportFileName or ImportXML.

The XML file from which you import the category information must be in Knowledge Discovery category XML format. For more information about this format, refer to the Knowledge Discovery Administration Guide.

You can use this information to import normal, SimpleCat, and Relevance categories.

NOTE: If you exported the category XML from a Category component where the MultipleParentsAllowed configuration parameter was set to `True` in the `[Category]` section of the configuration file, `CategoryImportFromXML` cannot import a category that has the same ID as an existing category, or that has the same name and parent as an existing category. In this case, the action rejects these categories.

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=CategoryImportFromXML&ImportFileName=MyCategory.xml

This action imports the category information contained in the `MyCategory.xml` file to the root category.

## Required Parameters

You must set one of the following parameters.

Parameter | Description
--- | ---
ImportFileName | The file that contains the data to import.
ImportXML | XML data to import. NOTE: You can use a POST request if you use this parameter.

## Optional Parameters

This action accepts the following optional parameters.

Parameter | Description
--- | ---
BuildNow | Whether to build the category immediately.
Flat | Whether to use a flat XML format.
OnConflict | How to handle duplicate categories.
Parent | The parent of the new categories.
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 2025 Open Text
Version 25.3 | Last updated July 2025

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: Knowledge Discovery Category Component 25.3

Topic Title: CategoryImportFromXML