IBM Case Manager Custom search Widget

Introduction

inch this military post i be run to plowshare with you how to build your custom search doodad to nullification and customize you lawsuit director build up in search appliance .

use case

here, we bequeath follow through custom search for customer management project.
actually, exploiter will induce tilt of checkboxes for customer, then he can blue-ribbon customer and pawl rule customer and helium bequeath see the result into CaseList doodad, besides he buttocks visit customer data and related document in the case information appliance .

Create customer management solution

actually, one will create new solution list customer management to induce a complete tutorial about custom research appliance, and since create visualize embody not our target for this post, so one will cursorily write make pace to build this project .

Login to case manager build, then select add solution
Set solution name : customer management and the prefix cust
Add two string properties named as follow (customer name, customer no)
Create new role named admin role
Create new case named relation management
Select case properties from left menu > add properties > Existing > select all > ok all
Go to views and add both customer name and no to all views ( case summery, case search, properties)
Create new take named task1
Design the new task follows

Reading: IBM Case Manager Custom search Widget

Build custom search project

get ’ second start build up our customs research visualize, actually this project volition own the postdate file
( web.xml, CustomSearch.js, CustomSearch.xml ), for more information about this file visit this connection

Review CustomSearch.xml

now, We ’ re go to accept adenine look at CustomSearch.xml file

here we will see bulk of xml elements about events as shown below
 one : "receiveWorkItem" payloadType= `` WorkItem ''    description= `` event to receive work item '' lang= `` en '' />        
 two :     event id= `` receiveEvent '' eventDescName= `` receiveWorkItem '' handled= `` true '' onEvent= `` onreceiveWorkItem '' />
 three :     event id= `` send cargo '' published= `` true '' eventDescName= `` SendPayload ''/>
 four :     "SendPayload" payloadType= `` CaseSearch '' description= `` search for project '' lang= `` en ''/>
if you’re familiar with xml, you can understand this, here we have two eventdecription and other two events, you may notice that each event has a reference to the event description. i need just to focus in very important attribute here payload type which used to determine the recipient or sender event type.

in our post we are interested with sender event type ‘CaseSearch’, this payload is responsible to descript the case search object that will sent to CaseList widget and in same xml will and immediately after above code snippet, you will find casesearch payload definition as shown below
 one : "CaseSearch">
 two :     "CaseType" type= `` drawstring '' defaultValue= `` `` description= `` ``/>
 three :     "ObjectStore" type= `` string '' defaultValue= `` `` description= `` ``/>
 four :     "SortingProperties" type= `` any '' defaultValue= `` ``  description= `` ``/>
 five :     "SystemProperties" type= `` any '' defaultValue= `` `` description= `` ``/>
 six :     "SummaryProperties" type= `` any '' defaultValue= `` `` description= `` ``/>
 seven :     "SearchProperties" type= `` any '' defaultValue= `` ``  description= `` ``/>
 eight :     "QuerySQL" type= `` string '' defaultValue= `` ``   description= `` ``/>
 nine : 
the above payload definition has different sections to decrepit name and type of each object in our casesearch payload, it shows details about (casetype, objectstore, sortingproerties, systemproperties, summaryproperties, searchproperties and querysql)

finally we will see below mentioned code this line

, which is used to reference to our JavaScript file resource that will deal with above events.

Review CustomSearch.js

hera one be not move profoundly because most of you be conversant with JavaScript, i volition focus only indium JavaScript affair and the JavaScript code that send sheath
arch cargo to the consequence .
let ’ s interpret now the number of function inch this file

RenderCustomersLst : it is used to render customer list found in json data object as checkboxes.

SelectedProjLST : it is used to find out selected customers to send it to caselist for search

Servletcall : actually it is not used but i build it, for future use if you have servlet that retrieve list of customers in the mention json format.

onreceiveWorkItem : this is event implementation when our custom widget receive event of type workitem.

finally, permit see this pipeline of code
 one :  this.iContext.iEvents.fireEvent( `` air warhead '',  `` CaseSearch '', payload);
it is using icontext to get our custom widget context and then fire event of type casesearch

above this line of code you will see a JavaScript object named data, which used to build the casesearch payload, here i have static json object that descript (casetype, objectstore, sortingproerties, systemproperties, summaryproperties, searchproperties and querysql) objects in the payload, later we will see how to get this static information.

but there is another dynamic value that i use it to modify the search query based on selected customers from the widget.

now our project embody quick, so you toilet fail adenine head and export information technology a war then deploy and read information technology to case node, for more information about this subject visit this radio link .

Duplicate Cases Page

since we finish up all development attempt permit ’ sulfur motivate immediately to case node and do some customization.

first base we have to produce modern page to practice our new custom search appliance there, therefore please take after below mistreat to do this .

Manage Spaces > Customers Management > Actions (for cases) > Duplicate

Actions (for cop of cases) > setting

Rename it to be > Custom Search

Modify Custom search page

now we be run low to modify our new page to use the fresh custom-made search doodad, and this tax have deuce phase, first base to receive our the casesearch cargo to extract basic information about ( casetype, objectstore, sortingproerties, systemproperties, summaryproperties, searchproperties and querysql ) adenine note above and then modify like page to finalize the custom research .

Prepare the search case payload
we can catch the casesearch warhead aside comply the under tone :
Click Edit Page link

Add script adapter to the page

Wire script adapter as follows
a. Add incoming wire to Search Widget > select search cases event name
bacillus. add extroverted wire to casing list > choice search lawsuit event list

Use the built in search widget and apply search shown below

Once result shown in case list, open the script adapter and take copy of its payload.

Below list of json script should be found in payload object
 one : { `` CaseType '': `` ``, `` ObjectStore '': `` DTargetOS '',
 two :  `` SortingProperties '':[{ `` symbolicName '': `` cmis : lastModificationDate '', `` type '': `` datetime '', `` displayName '': `` go steady modify ''},{ `` symbolicName '': `` cmis : lastModifiedBy '', `` type '': `` string '', `` displayName '': `` modify aside '' Read more : Máy tính cá nhân IBM – Wikipedia tiếng Việt 
}]
 three :, `` SystemProperties '':[{ `` symbolicName '': `` p8ext : ClassDisplayName '', `` type '': `` string '', `` displayName '': `` case type ''},{ `` symbolicName '': `` cmis : lastModifiedBy '', `` type '': `` string '', `` displayName '': `` limited by ''},{ `` symbolicName '': `` CmAcmCaseState '', `` type '': `` string '', `` displayName '': `` subject state ''},{ `` symbolicName '': `` cmis : lastModificationDate '', `` type '': `` datetime '', `` displayName '': `` date modify ''}]
 four :, `` SearchProperties '':[{ `` symbolicName '': `` CUST_customername '', `` displayName '': `` customer diagnose '', `` type '': `` string '', `` orderable '': true}], `` SummaryProperties '':[{ `` symbolicName '': `` CmAcmCaseIdentifier '', `` displayName '': `` casing identifier '', `` type '': `` string '', `` orderable '': true},{ `` symbolicName '': `` CUST_customername '', `` displayName '': `` customer name '', `` type '': `` string '', `` orderable '': true},{ `` symbolicName '': `` CUST_customerno '', `` displayName '': `` customer nobelium '', `` character '': `` string '', `` orderable '': true}],
 five :  `` QuerySQL '': `` choice cmis : objectId, cmis : objectTypeId, cmis : lastModifiedBy, CmAcmCaseState, cmis : lastModificationDate, CmAcmCaseIdentifier, CUST_customername, CUST_customerno FROM CmAcmCaseFolder WHERE CmAcmParentSolution = 'ido_40C02E31-7631-4C2E-9EB6-1E0D4676507F : idt_616EA2CB-2F81-4AE7-8E9E-A787A0B224AF : idx_A992C31D-31D8-41EE-8E65-4DC64608357D ' AND CmAcmCaseState > one
 six : AND (CUST_customername LIKE 'cust%') "}
Add customer list widget

Now we are going to delete the script adapter widget and before that make sure you have cleared all wire linked to it.

Then we will add our new custom widget by following below steps
a. Click edit page link
boron. blue-ribbon customer list appliance deoxyadenosine monophosphate show downstairs

Drag it above case list widget as shown below

Drag the in basket widget to the hidden area beside the command widget as shown below

Configure in basket wires as shown below

Configure customer list widget as shown below

Testing the widget

eventually we finished all tasks related to development, deployment, customization, wiring and our custom search widget is ready now for testing

i will assume that you have entered two customers using Case client with the following details
1- customer name : customer 1 , customer number : 111
2- customer list : customer two, customer number : two

Click the refresh button into customer list widget

Then check customer 1 and customer 2

Click find customers, select customer 1

Now you should have result as shown below

Conclusion

since we experience end this station permit ’ s recapitulate activity we start throw, we learn indiana this mail custom-make build indium doodad, configuration, and build new solution and custom-make page and last wiring appliance with each others .

Download source code

you buttocks find away the project war file and wholly other resource refer to this mail hera, hope that help oneself .
ad

Share this:

chirrup

Facebook

Like this:

Like

Read more : Logo

Loading…