The insight module provides services that are used by processes within the process client to store and retrieve data within Insight. It also provides services to manage the selection of dimensions.
The services are implemented as components. The services are named as action data, e.g. "search documents". Components for the UI have UI in their name and are named as description of the UI, e.g. "Document Search UI".
The services send and receive data structures. The data structures for worker, document and event are described first.
The available services are:
| Put document | Pass a document to Insight. |
| Put event | Pass an event to Insight. |
| Get search configuration | Retrieve a search configuration which indicates what features are available in a search. |
| Get dimension values | Get values for a dimension, such as process type, based on characters typed by the user. |
| Search documents | Search for documents. |
| Search events | Search for events. |
| Get document | Get details of one document. |
| Get worker | Get details of one worker, including all its events and all its documents. |
| Get file | Get details of a file so that it can be retrieved. |
| Get results file | Return the results of a query as a file. |