IDOL Category Component 24.4
IDOL Category Component Help

# TaxonomyGenerate

Allows you to generate a hierarchical taxonomy from a cluster, or from a set of query results.

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.

To generate a taxonomy from a set of query results, you must set DREQuery. To generate a taxonomy from a cluster, you must set Cluster and SourceJobName.

You can use the WriteTaxonomy parameter to specify whether to write the taxonomy to disk or to add the taxonomy to your category hierarchy.

If you write the taxonomy to disk, IDOL Category Component stores it as a folder hierarchy in the `HIERDOCS` subdirectory in the `taxonomy` directory of your IDOL Category Component installation. It stores the taxonomy documents in text format. Otherwise, IDOL Category Component adds the taxonomy to the position in the category hierarchy that you specify with the Parent parameter.

NOTE: Before you create a taxonomy from IDOL Category Component, you must make sure that it does not contain duplicate documents or text that is repeated in multiple documents (for example, document headers). Ensure that these are stripped out at the import stage to gain optimal results.

## Example

    http://12.3.4.56:9020/action=TaxonomyGenerate&Parent=123456789987654321&DREQuery=new+tax+cuts

This action sends the query new tax cuts to IDOL Category Component. IDOL Category Component uses the results of this query to generate a taxonomy, which it adds to the category hierarchy as a child of the category with the ID `123456789987654321`.

## Required Parameters

You must set at least one of the following parameters.

Parameter | Description
--- | ---
Cluster | The number of the clusters to generate the taxonomy from.
DREQuery | A query to use to generate a taxonomy.
SourceJobName | The name of the cluster from which to generate a taxonomy.

## Optional Parameters

This action accepts the following optional parameters.

Parameter | Description
--- | ---
EndDate | A timespan for which to generate a taxonomy from clusters.
Interval | A timespan for which to generate a taxonomy from clusters.
Name | The name of the top level category of the taxonomy to create.
NumResults | The maximum number of documents to store in a taxonomy node.
Parent | The ID of the parent category to use for the taxonomy.
SecurityInfo | Send security details.
StartDate | A timespan for which to generate a taxonomy from clusters.
WriteTaxonomy | Whether to store taxonomy documents.
XMLEncoding | Overrides the default XML encoding.

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.

## Comments

You must set one of the following parameters or parameter combinations:

- DREQuery

- Cluster and SourceJobName

Copyright 2024 Open Text
Version 24.4 | Last updated September 2024

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 IDOL Category Component 24.4

Topic Title: TaxonomyGenerate