The Case List widget provides incoming events to handle
the data that is received from other widgets.
Clear content event
| Description |
Clear the content in the Case List widget. |
| Event ID |
icm.ClearContent |
| Payload |
null |
Refresh event
| Description |
Rerun the current search query and refresh the
list of cases. |
| Event ID |
icm.RefreshCaseList |
| Payload |
null |
Search cases event
| Description |
Update the case list with the cases that were
returned by a search. |
| Event ID |
icm.SearchCases |
| Payload |
- searchTemplate
- An ecm.model.SearchTemplate object that represents the search
criteria. The Case List widget can run the search directly by using this template. This parameter is
ignored if a value is provided for the ceQuery parameter.
- searchProperties
- An array of properties that are used by the search criteria.
- caseType
- The symbolic name of the case type that is being searched. If
the search is across a solution, the value of this parameter is "".
- caseTypeTitles
- A JSON object that contains the symbolic name of the case title
property for each case type that is being searched. The structure
is:
caseTypeTitles: {
caseType1: caseTitle symbolic name1,
caseType2: caseTitle symbolic name2
}
- detailsViewProperties
- An array of properties that are to be displayed in the details
view of the Case List widget.
- magazineViewProperties
- A JSON object that contains an array of properties for each case
type that is being searched. These properties include the Case Summary
View properties and well-known properties (CmAcmCaseIdentifier, CmAcmCaseState,
CmAcmCaseTypeFolder, LastModifier, DateLastModified).
The structure
is of the JSON object is: magazineViewProperties: {
caseType1: [prop1, prop2, prop3],
caseType2: [prop1, prop2, prop3],
}
These properties are displayed in the second line
for each case in the magazine view.
- ceQuery
- A user-provided Content Platform Engine query statement that is used to
search cases. If a value is specified for this parameter, the searchTemplate
parameter is ignored.
|
Select a row event
| Description |
Select a row by the row number or the case identifier. |
| Event ID |
icm.SelectRow |
| Payload |
The payload can contain one of the following values:
- caseID
- A string that contains the identifier of the case that is to be selected.
- rowNumber
- A string that contains the number of the row that is to be selected.
|
Sort by property event
| Description |
Sort the list of cases by the specified property. |
| Event ID |
icm.SortByProperty |
| Payload |
- symbolicName
- A string that contains the symbolic name of the column that is to be used to sort the case
list.
|