IDOL Category Component 24.2

# Store and Retrieve the Result State

Whenever you use the `Query`, `Suggest`, or `SuggestOnText` actions, you can save the result state (the `DocID` values of all returned results) in a state token. In subsequent actions, you can use this token to represent the documents from that result set.

A state token is an array of `DocID` values. Its name is of the form `ABCDEFGH–N`, where `ABCDEFGH` is a random alphanumeric string (generated at query time), and `N` is the number of document IDs that the token holds. You can also use document references, rather than document IDs, to create state tokens. In this case, use the `StoredStateField` parameter to specify the name of the field that contains the references.

When you have a state token, supply the token name to specify the entire set of documents (for example, `CWQ4FJ9LZSE5-6`). You can also use a (zero-based) array notation to specify a subset of the documents (for example, `CWQ4FJ9LZSE5-6[3]` to select the fourth document in the array).

Tokens in the array are in the same order as in the returned results.

Content stores tokens persistently, in the directory `installDir/agentstore/storedstate`.

Copyright 2024 Open Text
Version 24.2 | Last updated March 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.2

Topic Title: Store and Retrieve the Result State