IDOL Category Component 24.4
IDOL Category Component Help

# ClusterMapFromResults

Generates and returns a 2-D map of clusters that have been generated from a `Query` action, or from an earlier ClusterCluster action with DoMapping set to `False`. By default, maps are in JPEG format.

All maps that have been generated are listed in the `cluster/2DMAPS` directory in your IDOL Category Component installation directory.

This action also creates and stores a new set of cluster results that includes the map coordinates of the clusters.

## Example

    http://12.3.4.56:9020/action=ClusterMapFromResults&TargetJobName=MapCluster1&ImportXML=%3C%3Fxml%3E%0D%0A%3Cautn%3Aclusters%3E%0D%0A%20%20%20%20%3Cautn%3Anumclusters%3E1%3C%2Fautn%3Anumclusters%3E%0D%0A%20%20%20%20%3Caut
    n%3Acluster %3E%0D%0A%20%20%20%20%20%20%20%20%3Cautn%3Atitle%3E
    MyClusterTitle%3C%2Fautn%3Atitle%3E%...

This action returns a 2-D Map of the XML cluster data (percent-encoded) specified in the ImportXML parameter. (XML data has been truncated in this example.) A cluster job named `MapCluster1` is also created.

## Required Parameters

The following action parameters are required.

Parameter | Description
--- | ---
TargetJobName | The cluster job to create from this mapping.

You must set one of the following parameters.

Parameter | Description
--- | ---
ImportXML | The XML data to use as input to this mapping.
SourceJobName | The cluster job to use as input to this mapping.

## Optional Parameters

This action accepts the following optional parameters.

Parameter | Description
--- | ---
Fields | The names of additional fields to include in the cluster file.
Username | The name of the user performing 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 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: ClusterMapFromResults