For more efficient processing of a task list, it is possible to define serial processing sessions. During these sessions, the user will move on to the next task without going back to the search that initiated the session.
The start of these processing sessions is configured using the JS API:
JSAPI.get().batchSession().registerBuilder(function(session, callback){
callback.enable(session);
});
The context at the start of the processing session (search request) is retained during the processing session. However, the JS API allows you to modify the session by exposing the following methods:
Function | Description |
---|---|
getRequest() | Retrieves the query executed during the processing session |
setRequest(request) | Modifies the query executed during the processing session |
getPlace() | Retrieves the current place |
getSourcePlace() | Retrieves the place at the origin of the processing session |
getComponentSource() | Retrieves the component at the origin of the processing session |
getLast() | Retrieves the identifier of the last component opened during the processing session |
setEnabled(enabled) | Disables the treatment session |
isEnabled() | Determines whether the processing session is active or inactive |