IDOL Category Component 24.4
IDOL Category Component Help

# ClusterResults

Allows you to return cluster data in XML format from a cluster that you have generated by using the ClusterCluster action. The cluster data that returns is restricted to data within the time span defined by one or more of the StartDate, EndDate, and Interval parameters.

## Example

    http://12.3.4.56:9020/action=ClusterResults&SourceJobName=Cluster1&NumClusters=1&NumResults=1

This action returns XML data for the `Cluster1` cluster. IDOL Category Component can return at most one document for one cluster.

## Required Parameters

The following action parameters are required.

Parameter | Description
--- | ---
SourceJobName | The name of the cluster to return in XML format.

## Optional Parameters

This action accepts the following optional parameters.

Parameter | Description
--- | ---
EndDate | The timespan for which to return cluster data.
Interval | The timespan for which to return cluster data.
MaxTerms | The maximum number of terms to return.
NumClusters | The maximum number of clusters to return.
NumResults | The maximum number of documents to list for each cluster.
Retries | The number of times to retry a failed action.
RetryInterval | The number of seconds to wait before retrying a failed action.
StartDate | The timespan for which to return cluster data.
Username | The name of the user performing the action.
XMLEncoding | Overrides the default XML encoding.
XMLMeta | Returns the cluster results date, database, and language.

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 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: ClusterResults