Retrieve From Cache step

The Retrieve From Cache step is used to retrieve documents from a document cache so that they can be used in the currently executing process or subprocess. The Retrieve From Cache step references a Document Cache component, which describes how the cache is defined.

note

When documents are retrieved from a document cache for use in a process, they replace the current document data and its document properties with those from the cache.

Retrieving documents from a document cache

Use a Retrieve From Cache step to retrieve documents from a document cache so that they can be used in the currently executing process or subprocess.

Procedure

1. Drag the Retrieve From Cache step onto the process canvas.

   The Retrieve From Cache step dialog opens.

2. Enter a display name for the step in the Display Name field.

3. Select or create a Document Cache component from which the documents will be retrieved.

4. Indicate which documents should be retrieved from the specified document cache:

   • All Documents — Retrieves all documents from the document cache.

   • indexName — Retrieves documents that are associated with the selected index.

   note

   • Retrieving all documents from the document cache is available only if the Enforce one index entry per document option is in effect for the specified Document Cache component. If that option is not in effect, documents can be retrieved only by index name.

   • When retrieving All Documents, Empty Cache Behavior option allows you to define how the Retrieve From Cache step behaves in the event it receives an empty document cache:

     • Stop document execution (recommended) (Default) - Ends document processing without returning errors in Test Mode, Process Reporting, event logs, etc. This option is recommended because an empty document cache is typically not considered a process failure. The 'Fail documents with errors' option is offered for backward compatibility.

     • Fail document with errors - Fails the document and returns an error in Test Mode, Process Reporting, event logs, etc.

   • When retrieving documents by index name, the keys within the selected index are displayed. Each key corresponds to an element in the source profile. Documents that contain these elements and that have parameter values will be retrieved from the document cache.

5. Optional: If you retrieve documents by index name, specify a parameter value for each key within the selected index. For more information, refer to the Parameter values topic.

6. Click OK.