The In-baskets widget provides incoming events to handle
the data that is received from other widgets.
Apply filter event
| Description |
Update the work items that are listed in the in-basket based on the specified
filters. |
| Event ID |
icm.ApplyFilter |
| Payload |
The Apply filter event can accept either of the following payloads:
- filters
- An array of icm.model.InbasketFilter objects that represent the filters that
are to be applied to the in-basket. This array uses the following
format:
var filter = icm.model.InbasketFilter.fromJSON(dynamicFilterJSON);
var filters = [];
filters.push(filter);
var payload = {"filters": filters};
The
following example shows the contents of this
payload: var filterJSON = {...};
var filter = icm.model.InbasketFilter.fromJSON(filterJSON);
var filters = [];
filters.push(filter);
var payload = {"filters": filters};
- dynamicFilters
- An array of icm.model.InbasketDynamicFilter objects that represent the
filters that are to be applied to the in-basket. This array uses the following
format:
var payload =
{"dynamicFilters": dynamicFilters,
"cursorLocation": 1,
"cleanDynamicFilterByReset":true};
The
optional cursorLocation parameter specifies the default cursor location. The
optional cleanDynamicFilterByReset parameter specifies whether a dynamic filter is
cleared when the user clicks the Reset button.
The following code
provides an example of this
payload: var payload =
{"dynamicFilters": dynamicFilters,
"cursorLocation": 1,
"cleanDynamicFilterByReset":true};
|
Clear content event
| Description |
Clear the content in the In-baskets widget. |
| Event ID |
icm.ClearContent |
| Payload |
null |
Receive In-basket event
| Description |
Display the tab for the in-basket that is contained in the event
payload. |
| Event ID |
icm.ReceiveInbasket |
| Payload |
- queueName
- The name of the queue in which the work items in the in-basket are stored.
- inbasketName
- The name of the in-basket that is being received.
- cursorLocation
- Optional: The index of the row that is to be selected in the in-basket.
|
Receive Role event
| Description |
Update the In-baskets widget to display the in-baskets that are associated
with the specified role. |
| Event ID |
icm.ReceiveRole |
| Payload |
- role
- A string that contains the symbolic name of the role.
|
Refresh event
| Description |
Refresh the in-basket to update the list of work items.. |
| Event ID |
icm.Refresh |
| Payload |
Any value |
Request open work item event
| Description |
Send the information to open the next work item in the queue. |
| Event ID |
icm.RequestOpenWorkItem |
| Payload |
- queueName
- The name of the queue in which the work item to be opened is stored.
- inbasketName
- The name of the in-basket in which the work item to be opened is located.
- cursorLocation
- Optional: The index of the row in the in-basket that contains the work item to be opened.
|
Request selected work items event
| Description |
Send the information for the in-basket rows that are specified in the event
payload. |
| Event ID |
icm.RequestSelectWorkItems |
| Payload |
Any. The In-basket widget handles the event and sends the specified work items
along with the incoming payload. |