Remove From Cache step

The Remove From Cache step is used to remove documents from a document cache so that they are no longer available for use in the currently executing process or subprocess. The Remove From Cache step references a Document Cache component, which describes how the cache is defined.

note

• Remove From Cache step is part of the Advanced Workflow and is available only in the Professional, Professional Plus, Enterprise, and Enterprise Plus Editions of Integration. Contact your Boomi account representative for more information.

• 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.

Removing documents from a document cache

Use a Remove From Cache step to remove documents from a document cache so that they are no longer available for use in the currently executing process or subprocess.

Procedure

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

   The Remove From Cache step dialog opens.

2. Enter a display name for the step.

3. Select or create a Document Cache component.

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

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

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

   note

   Removing documents by index name 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, all documents will be removed from the document cache.

   • Select the **Empty Cache Behavior option 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. If you remove 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.