Open topic with navigation

# ClusterSGDataGen

Allows you to generate spectrograph data from snapshots that you have taken by using the ClusterSnapshot action. The `ClusterSGDataGen` action uses the snapshots in the time span defined by one or more of the StartDate, EndDate, and Interval parameters.

Note: This is an administrative action that can be sent only from AdminClients (which are set in the `[Server]` section of the configuration file).

When it is sent, the `ClusterSGDataGen` action is queued. After it finishes, the spectrograph data sets it has generated are stored in the `idol/cluster/SGDATA` directory in your IDOL Category Component installation directory. You can retrieve the spectrograph image, data, or documents by using the ClusterSGPicServe, ClusterSGDataServe, and ClusterSGDocsServe actions.

## Example

    http://12.3.4.56:9000/action=ClusterSGDataGen&SourceJobName=Job1&TargetJobName=Job1a&StartDate=1000290039&EndDate=1000290650

This action uses port `9000` to generate spectrograph data from all snapshots called `Job1` that were generated between `September 12 2001` at `11:20:39` and `September 12 2001` at `11:30:50` (if no snapshot is available for these dates, IDOL Category Component uses the snapshots that were generated before these dates). The snapshots are stored on a machine with the IP address `12.3.4.56`. The spectrograph data set that is generated is called `Job1a`.

## Parameters

Parameter | Description | Required
--- | --- | ---
BindLevel | The conceptual similarity of clusters. |
ComparisonTolerance | The maximum amount of time between snapshots to compare. |
Cycles | The number of times to run the action. |
Dependencies | A list of classification schedules that must be complete before the `ClusterSGDataGen` action can run. |
EndDate | The time span for which to generate spectrograph data. | See Comments
FillGaps | Whether to create additional snapshots for the spectrograph generation if none exist in the timespan. |
FillGapsFrequency | The interval at which IDOL Category Component checks if snapshots exist in the timespan for which it is generating a spectrograph. |
Interval | The time span for which to generate spectrograph data. | See Comments
ProfileSourceJobName | A profile snapshot to compare to the SourceJobName. |
RankSections | The relevance that documents must have to a cluster. |
Repeat | The time to elapse between runs of the action. |
Retries | The number of times to retry a failed action. |
RetryInterval | The number of seconds to wait before retrying a failed action. |
SourceJobName | The snapshot to generate spectrograph data from. | Yes
SourceJobName2 | The name of the snapshot to compare to the SourceJobName snapshot. |
StartDate | The time span for which to generate spectrograph data. | See Comments
StartTime | The time to run the first action. |
TargetJobName | The name of the spectrograph data to generate. | Yes
Username | The name of the user performing the action. |
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.
EncryptResponse | Encrypt the output.
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 define a timespan, which you can set with one or more of the following parameters:

- EndDate

- Interval

- StartDate

© 2016 Hewlett Packard Enterprise Development LP | Send documentation feedback to HPE Close We welcome your comments! To open the configured email client on this computer, open an email window. Otherwise, copy the information below to a web mail client, and send this email to AutonomyTPFeedback@hpe.com. Product: Topic Title: Help Topic: Feedback:

_HP_HTML5_bannerTitle.htm