Customize related tasks forSterling Order Management System
Sterling Order Management System enables users to efficiently set up and maintain the catalog for their organization, and define the peripheral components of items such as assets and classifications after their organization has downloaded detail for all of the items into the database.
You do this by performing tasks and related tasks using the Sterling Order Management System task-based user interface.
The Related Tasks panel contains related task categories and related tasks under a given category that pertains to a screen.
- Removing a related task or a related task category
- Adding a related task or a related task category
- Redirecting a related task to a new screen in the corresponding Related Task metadata file
All the customizations pertaining to the related tasks must be performed by defining the corresponding Related Task metadata file located at the <install_dir>/extensions/sbc/webpages/sbc/metadata/relatedtasks folder.
The related task metadata filenames for the screens are listed in the following table:
|
Screen Name |
Related Task Metadata File Name |
|---|---|
Customer Entitlement |
buyingentitledetailscreen.xml |
Seller Entitlement |
sellingentitledetailscreen.xml |
Customer Entitlement Search |
buyingentitlementsearch.xml |
Seller Entitlement Search |
sellingentitlementsearch.xml |
Delivery Service Associations |
sbcItemDetailsManageServices.xml |
Return Pickup Service Associations |
sbcItemDetailsManageServices.xml |
Coupon Search |
couponSearch.xml |
Manual Pricing Rule Search |
manualPricingRuleSearch.xml |
Price List Search |
seapricelistsearch.xml |
Pricing Rule Search |
pricingRuleSearch.xml |
|
For all other screens |
<sciId>.xml ...where sciId is the unique identifier of the screen. For example, itemSearch is the sciId property of the Item Search screen and the Related Task metadata file for this screen is itemSearch.xml. |
Components of a related task metadata file
- Category: You can add, delete, or modify a related task category
by defining the Action attribute in the Category element in the Related
Task metadata file.You can perform the following tasks pertaining to a related task category in the corresponding Related Task metadata file:
- Add a new related task category in the corresponding Related Task metadata file: The new related task category is added at the end of the list in the corresponding Related Tasks panel.
- Delete a related task category from the corresponding Related Tasks XML: All the related tasks under a given category are deleted from the corresponding Related Tasks panel.
- Modify a related task category in the Related Task metadata file corresponding to a related task category: You can add a new related task, remove an existing related task, and modify an existing related task. Modifying a related task includes modifying only the action that occurs when a user clicks a related task under a given category.
- IncludeCategory: If a Related Task metadata file contains this element, it indicates that this XML consists of multiple Related Task metadata files corresponding to various categories. The path to these Related Task metadata files are defined in the corresponding File attribute of the IncludeCategory element. You can add or delete the IncludeCategory element, which in turn adds or deletes a category if it is present in the File attribute. However, you cannot set the value of the Action attribute to MODIFY in the IncludeCategory element.
- Task: You can add, delete, or modify a related task by defining
the Action attribute in the Task element. However, you need to first
set the Action attribute to Modify in the corresponding Category element.Note: You cannot customize the Dynamic Tasks.