Predefined case search by using external payload in the Case Search view

To create a custom search payload

1. Define a variable (for example, searchPayload) of type CaseSearchPayload. CaseSearchPayload is a properly defined business object which represents the structure of a search payload. If you do not want to use a well-defined business object as type for searchPayload, define the type to be ANY.
2. You can populate this variable in one of two ways:
   • Enable the "Has default" checkbox and provide the following script inline.
   • Use a client-side script to populate the variable
   The following example demonstrates how to populate the variable. Some lines are intentionally commented to indicate that these options in the business object are optional.

   var autoObject = {}; 
   autoObject.conditions = []; 
   autoObject.conditions[0] = { field: "CmAcmCaseState", operator: "EQUAL", value: "2" }; 
   autoObject.fieldDetails = []; 
   autoObject.fieldDetails[0] = { field: "CmAcmCaseState", dataType: "xs:integer", cardinality: "single" }; 
   autoObject.caseTypeList = [{ name: "TSP_CT1" }]; 
   // Uncomment and configure optional parameters as needed:
   // autoObject.sortArray = [{ field: "CmAcmCaseIdentifier", order: "asc" }];
   // autoObject.pagesize = 200; 
   // autoObject.andSearch = true; 

3. The searchPayload variable is used in an event within a coach (for example, the onclick event of a button view). So, you need to add a Data view (from the UI Toolkit) to the layout and bind the searchPayload variable to it. You can then access the searchPayload within the event by using:

   var searchPayload = ${Data1}.getData();

4. Add a button view to the layout. For in instance, name it as Search using custom payload. Write the following code to the onclick event of the button:

   /** 
    * @instance 
    * @memberof CaseSearch 
    * @method searchUsingExternalPayload 
    * @param {searchPayload} (required) searchPayload The search payload. 
    * @param {caseListControlID} (optional) The control ID of the Case List view to render results. 
    */ 
   
   // Data1 is the control id of the Data view
   var searchPayload = ${Data1}.getData(); 
   
   // Case_Search2 is the control id of the Case Search view
   var caseSearchView = ${Case_Search2}; 
   
   // use the Case Search view's public method getSearchFilterView() to get the search filter view within Case Search
   var caseSearchFilterView = caseSearchView.getSearchFilterView(); 
   
   // List Cases2 is the control id of the Case List view. It is optional.
   // searchUsingExternalPayload is a public method on Case Search view, which can be used to search cases
   // using the custom search payload 'searchPayload'.
   // When the second parameter in the searchUsingExternalPayload is not set, the search results would be displayed
   // on all instances of Case List views that might have been added to the coach.
   // When the second parameter in the searchUsingExternalPayload is set, the search results would be displayed
   // on the Case List view, whose control id is set as the second parameter.
   caseSearchFilterView.searchUsingExternalPayload(searchPayload, "List_Cases2");

5. Click the button to run the custom search, and to populate the search results in the Case list view.

var fields =["FolderName","CmAcmHealthIndicator","LastModifier","DateLastModified","CmAcmCaseTypeFolder",
"CmAcmCaseState","CmAcmCaseIdentifier","DateCreated","Creator","Id","CmAcmStageStatus"];

var fieldDetails = []; 
fieldDetails[0] = { field: "CmAcmCaseState", dataType: "xs:integer", cardinality: "single" };

var conditions = []; 
var conditions[0] = { field: "CmAcmCaseState", operator: "EQUAL", value: "2" }; 

var sortArray = []; sortArray[0] = { field: "CmAcmCaseIdentifier", order: "asc"};