IDOL Server 24.1

# ClusterSGDocsServe

Allows you to return documents from a cluster in a spectrograph data set that you produced by using the ClusterSGDataGen action. The `ClusterSGDocsServe` action uses the spectrograph data sets in the time span defined by one or more of the StartDate, EndDate, and Interval parameters.

## Example

    http://12.3.4.56:9000/action=ClusterSGDocsServe&SourceJobName=MyJob&Cluster=1&StartDate=1000288183

This action requests the documents in the `MyJob` spectrograph data set that were generated on `September 12 2001` at `10:49:43`. Documents can return only for cluster `1` of the clusters in the `MyJob` spectrograph data set.

## Required Parameters

The following action parameters are required.

Parameter | Description
--- | ---
Cluster | The cluster for which to return documents.
SourceJobName | The spectrograph data set to return.

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
--- | ---
NumResults | The maximum number of documents to return 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.
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.
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 2023 Open Text
Version 24.1 | Last updated December 2023

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 Server 24.1

Topic Title: ClusterSGDocsServe