Read-only. The documents in a database that the current agent considers to be "unprocessed." The type of agent determines which documents are considered unprocessed.

Defined in

AgentContext

Data type

DocumentCollection

Syntax

public DocumentCollection getUnprocessedDocuments()
   throws NotesException

Usage

This method is valid only for agents.

What documents are returned?

The following table describes the documents that are returned by getUnprocessedDocuments. Document selection occurs once, before the agent runs.

Agent runs on:	UnprocessedDocuments returns documents that meet all of these requirements:
All documents in database	Meet the search criteria specified in Agent Properties box
All new & modified documents	Not processed by this agent with updateProcessedDoc Created or modified since the agent last ran Meet the search criteria specified in Agent Properties box
All unread documents in view	Are unread and in the view Meet the search criteria specified in Agent Properties box
All documents in view	Are in the view Meet the search criteria specified in Agent Properties box
All selected documents	Are selected in the view Meet the search criteria specified in Agent Properties box
None	Is the current document only
Before New Mail Arrives	None (does not return any documents; use DocumentContext in AgentContext instead)
After New Mail Arrives	Mailed to the database since the agent last ran Meet the search criteria specified in Agent Properties box
Newly modified documents	Modified since the agent last ran Meet the search criteria specified in Agent Properties box
Pasted documents	Pasted into the database since the agent last ran Meet the search criteria specified in Agent Properties box

Using UpdateProcessedDoc

For agents that run on new and modified documents, you must use updateProcessedDoc in Session to mark each document as "processed," which ensures that a document gets processed by the agent only once (unless it's modified again). If you do not call this method for each document, the agent processes the same documents the next time it runs.

The updateProcessedDoc method marks a document as processed only for the particular agent from which it is called. Using updateProcessedDoc in one agent has no effect on the documents that another agent processes.

Language cross-reference

UnprocessedDocuments property in LotusScript NotesDatabase class

@All function in formula language

Example
See Also

Accessing agents
Collecting all documents and all unprocessed documents
DocumentContext property

Glossary