IDOL Category Component 24.3

# ClusterSGPicServe

Allows you to generate a spectrograph image from spectrograph data sets that you produced by using the ClusterSGDataGen action. The `ClusterSGPicServe` action uses the spectrograph data sets in the timespan defined by one or more of the StartDate, EndDate, and Interval parameters.

The image that is generated is stored in GIF format in the `idol/cluster/SGPICCACHE` directory in your IDOL Category Component installation directory.

NOTE: The spectrograph uses lines to represent the size (number of documents in a cluster) and quality of a cluster. The brighter a spectrograph line is, the more documents the cluster includes, and the thicker the line is, the higher the cluster quality.

## Example

    http://12.3.4.56:9020/action=ClusterSGPicServe&SourceJobName=DataSet1&StartDate=1000290000&EndDate=1000300000

This action generates an image from spectrograph `DataSet1`. The image is generated from the spectrograph data sets that were generated between `September 12 2001`, `11:20:00` and `14:06:40`.

## Required Parameters

The following action parameters are required.

Parameter | Description
--- | ---
SourceJobName | The spectrograph data set to generate an image from.

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 to return spectrograph data.
Interval | The time span for which to return spectrograph data.
StartDate | The time span for which to return spectrograph data.

## Optional Parameters

This action accepts the following optional parameters.

Parameter | Description
--- | ---
ForceRefresh | Whether to generate a new spectrograph image every time the action runs.
SGHeight | The height of the spectrograph image to generate.
SGWidth | The width of the spectrograph image to generate.
SourceJobName | The spectrograph data set to generate an image from.
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.3 | Last updated June 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.3

Topic Title: ClusterSGPicServe