IDOL Category Component 24.4
IDOL Category Component Help

# ClusterServe2DMap

Allows you to return a 2-D map (in GIF format) of clusters that have been generated by using the ClusterCluster action with DoMapping set to `True`. All maps that have been generated are listed in the `cluster/2DMAPS` directory in your IDOL Category Component installation directory.

## Example

    http://12.3.4.56:9020/action=ClusterServe2DMap&SourceJobName=Cluster1&StartDate=1000290039

This action returns a 2-D Map for a cluster called `Cluster1`. The 2-D Map is returned for a cluster that was generated on `September 12 2001` at `11:20:39`.

## Required Parameters

The following action parameters are required.

Parameter | Description
--- | ---
SourceJobName | The cluster to return the 2-D map for.

You must define a time span, which you can set by using one or more of the following parameters.

Parameter | Description
--- | ---
EndDate | The time span for which the 2-D map of clusters data returns.
Interval | The time span for which the 2-D map of clusters data returns.
StartDate | The time span for which the 2-D map of clusters data returns.

## Optional Parameters

This action accepts the following optional parameters.

Parameter | Description
--- | ---
Retries | The number of times to retry a failed action.
RetryInterval | The number of seconds to wait before retrying a failed action.
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: ClusterServe2DMap