How To
Summary
How to perform a return order search using a customized 'entry type' dropdown in Call Center?
Environment
IBM Sterling Call Center developer toolkit
Steps
The following sample procedure provides details on this customization use case.
Make sure Call Center return customization is set up on the developer toolkit (DTK) before following the procedure below.
(1) In Application Manager, create entry types like (CallCenter, Store, Online)
Reverse logistics > Document specific > Return Order > Order attributes > Order entry types
Reverse logistics > Document specific > Return Order > Order attributes > Order entry types
(2) On DTK environment, create a file (return_override_mashups.xml) at path:
/opt/ssfs/runtime/extensions/icc/webpages/mashupxmls/.
The mashup extensibility example (return_override_mashups.xml) is shared below.
(3) Build the extensions.jar. Rebuild & redploy EAR via update-extn command.
For example:
(3.1) <DTK>/runtime/bin: bash ./sci_ant.sh -f ../devtoolkit/devtoolkit_extensions.xml export
(3.2) /home/admin/devtoolkit_docker/compose: ./om-compose.sh update-extn <DIR of extensions jar>/extensions.jar
(4) In Visual Studio code, create a file (search_fields.json).
<Callcenter customization folder>\callcenter-code\call-center-return\packages\return-root-config\src\assets\custom\search_fields.json
<Callcenter customization folder>\callcenter-code\call-center-return\packages\return-root-config\src\assets\custom\search_fields.json
JSON example (search_fields.json) is shared below.
(5) Run these yarn commands: yarn stop-app, yarn cache clean, yarn start-app.
(6) Log on to the Call Center. The Home page opens.
(7) In the returns panel, click advanced search.
(8) In the advanced return search, select an enterprise.
Make sure return orders are already created using entry types like (CallCenter, Store and Online).
(9) Click on EntryType dropdown. Entry types like (CallCenter, Store, Online) appear.
Return order search can be performed using these various entry types.
Return order search can be performed using these various entry types.
JSON example (search_fields.json)
{
"returns": {
"fields": [
{
"id": "entryType",
"label": "Entry type",
"type": "dropdown",
"internalConfig": {
"id": "entryType",
"title": "Entry type",
"type": "dropdown"
},
"target": "returns",
"request": "EntryType",
"operator": "LIKE",
"insertAfter": "returnNumber",
"fetch": {
"api": "extn_icc.return.getReturnOrderEntryTypeList",
"type": "mashup",
"parameters": {
"CommonCode.CallingOrganizationCode": "{{enterprise}}"
},
"response": {
"listAttribute": "CommonCodeList.CommonCode",
"map": {
"id": "CodeValue",
"label": "CodeShortDescription"
}
}
}
}
]
}
}
{
"returns": {
"fields": [
{
"id": "entryType",
"label": "Entry type",
"type": "dropdown",
"internalConfig": {
"id": "entryType",
"title": "Entry type",
"type": "dropdown"
},
"target": "returns",
"request": "EntryType",
"operator": "LIKE",
"insertAfter": "returnNumber",
"fetch": {
"api": "extn_icc.return.getReturnOrderEntryTypeList",
"type": "mashup",
"parameters": {
"CommonCode.CallingOrganizationCode": "{{enterprise}}"
},
"response": {
"listAttribute": "CommonCodeList.CommonCode",
"map": {
"id": "CodeValue",
"label": "CodeShortDescription"
}
}
}
}
]
}
}
Mashup extensibility example (return_override_mashups.xml)
<mashups>
<mashup
description="Calling common code list to get sales order entry type."
endpoint="EP_CONFIG" id="extn_icc.return.getReturnOrderEntryTypeList"
mashuptype="XAPI" skipDataProvider="true" transactional="true">
<classInformation name="com.ibm.icc.common.mashups.ICCBaseMashup" />
<API Name="getCommonCodeList">
<Input>
<CommonCode CallingOrganizationCode=""
CodeType="ENTRY_TYPE" CodeValue="" DocumentType="0003"
DisplayLocalizedFieldInLocale=""
/>
</Input>
<Template>
<CommonCodeList>
<CommonCode CodeLongDescription="" CodeName=""
CodeShortDescription="" CodeValue="" OrganizationCode=""/>
</CommonCodeList>
</Template>
</API>
</mashup>
</mashups>
<mashup
description="Calling common code list to get sales order entry type."
endpoint="EP_CONFIG" id="extn_icc.return.getReturnOrderEntryTypeList"
mashuptype="XAPI" skipDataProvider="true" transactional="true">
<classInformation name="com.ibm.icc.common.mashups.ICCBaseMashup" />
<API Name="getCommonCodeList">
<Input>
<CommonCode CallingOrganizationCode=""
CodeType="ENTRY_TYPE" CodeValue="" DocumentType="0003"
DisplayLocalizedFieldInLocale=""
/>
</Input>
<Template>
<CommonCodeList>
<CommonCode CodeLongDescription="" CodeName=""
CodeShortDescription="" CodeValue="" OrganizationCode=""/>
</CommonCodeList>
</Template>
</API>
</mashup>
</mashups>
Related Information
Document Location
Worldwide
[{"Type":"MASTER","Line of Business":{"code":"LOB59","label":"Sustainability Software"},"Business Unit":{"code":"BU048","label":"IBM Software"},"Product":{"code":"SS6PEW","label":"IBM Sterling Order Management"},"ARM Category":[{"code":"a8m0z000000cxzVAAQ","label":"Call Center Store and SIM"}],"ARM Case Number":"TS016872649","Platform":[{"code":"PF025","label":"Platform Independent"}],"Version":"All Versions"}]
Was this topic helpful?
Document Information
Modified date:
22 November 2024
UID
ibm17175886