Storage type scopes

The DOCUMENT scope is used for attaching pairs (metas) to Exalead CloudView documents. Pairs stored on documents can optionally be indexed and pushed back into the index.

The DOCUMENT scope saves the doc ID, the build group and the source of the document, to link the data to the document. This is how it works:

• When a document X is pushed in the storage, a pair A is added to the storage and linked to document X.

• A repushFromCache request is triggered on document X.

• The document travels through the analysis pipeline, the StorageServiceDocumentProcessor queries the storage to retrieve all the pairs linked to document X.

• Each document pair is added as a meta within document X. For example, the processor attaches meta A to document X (if a meta A already exists it is replaced, otherwise it is created). Multi-valued pairs are pushed as multi-valued metas.

The USER scope allows a user to store private data. If user X stores the key A in his/her user scope, it is not accessible to any other user. This is good for keeping per-user state in applications (shopping carts, preferences, etc.).

The USER scope data is not meant to be indexed by Exalead CloudView as it contains private user data.

The SHARED scope is a general-purpose scope which is shared across Mashup UI applications. It allows you to store data that you do not want to link to a document (see DOCUMENT scope).

The SHARED scope data is not meant to be indexed by Exalead CloudView.