The Order Summary panel, which is available to the agent when using the Commerce tab, displays order status information. It also presents links based on the state of the order and where the agent is in the order process. The Order Summary display is triggered when the agent performs a specific action or navigates to a specific page.
Note: Page navigation changes take precedence over action changes.
The following actions trigger an update of the Order Summary display:
Select an order, which also changes the active order in the Global Context Area
Add a product to the shopping cart
Cancel an exchange from within the exchange process
Cancel a refund from within the refund process
The following processes trigger an update of the Order Summary display:
Modification of an order on the Shopping Cart, Shipping Address, Shipping Method, Billing, Review Order and Confirmation pages
Scheduling a new or updating an existing schedule using the Schedule page
A Return using Return Items, Return Type or the Return Confirmation pages
Exchanges
To customize the Order Summary panel, override the Nucleus configuration files located in the config/atg/commerce/custsvc/ordersummary directory. Then copy and modify the JSP files in DCS-CSR.war/panels/ordersummary.
Adding a New Order Summary Step
If the new step fits into one of the pre-existing paths, such as modify order or returns, add a new properties file to the configuration. If necessary, create a new JSP file. Pre-existing paths are indicated by the use of a task-based name, such as
exchange,modify,return,template,completeandsubmitted.The properties files have the following entries:
page=indicates the JSP file to display when the agent is in the step. If necessary, add a new JSP file and add it to thepageentry.content=indicates the web-app that contains your JSP files. If you do not indicate the web-app, then the app server will try to find your new JSP in the DCS-CSR web application. Placing your JSP in the DCS-CSR web app for testing is appropriate, but JSPs should be moved into your own web app for production. Additionally, this will prevent your JSPs from being overwritten during any subsequent patch upgrades.visibleWhenInSteps=is a comma separated list of the steps where the JSP should be displayed. The panel stack’s ID is used to identify the step. Use this for paths where steps appear immediately after the step on which the agent is working. Leave the list blank if the step should always remain visible.completeWhenInSteps=is a comma separated list of the steps where the step should be in thecompletestate. Completion is indicated when the step shifts from showing edit links to display the text “complete”. These steps are performed after the step in which the agent is working. Leave the list empty if the step is always complete.
Edit the properties files of the other steps in the path to provide information on the new step. For example, add the ID of the new step to the
visibleWhenInSteps=list of the stepsbeforethis new step in the path when the agent is in the new step.Ensure that one of the panels in the new panel stack calls the JavaScript function
atg.progress.update('someIdStringHere'), passing the ID of the panel stack. This lets the progress bar know it needs to update itself, and indicates where the agent is in the process.To add the JSP into your web applications, modify the Nucleus configuration properties files to identify which web-app contains the JSP file. For example:
path=/panels/ordersummary/specialOffers.jsp
context=/my-web-app
Editing an Existing Order Summary Step
Copy an existing JSP file and rename the file.
Modify the JSP. For example, to modify the template
billingstep so that it is visually different than the modifiable orderbillingstep, copy the existingbillingJSP file and make the changes as needed.
