The Order Approval gear relies upon existing ATG Portal and Oracle ATG Web Commerce functionality. The subsections that follow describe various aspects of its implementation.

Gear Modes and Display Modes

The following table lists the gear modes used in the Order Approval gear, as well as their corresponding display modes, device outputs, and JSP fragments.

Gear Mode

Display Mode

Device Output

Page Fragment

content

Shared

HTML

OrderApprovalShared.jsp

Full

HTML

OrderApprovalFull.jsp

installConfig

Full

HTML

installConfig.jsp

instanceConfig

Full

HTML

instanceConfig.jsp

userConfig

Full

HTML

userConfig.jsp

Note that OrderApprovalFull.jsp includes several other page fragments provided with the Order Approval gear, for example, orderDetail.jsp and approveOrder.jsp. You can find these JSPs in <ATG10dir>/CommerceGears/orderapproval/src/orderapproval.war/web/html/
content/
.

For general information about gear modes, display modes, and device outputs, see the Designing a Gear chapter in the ATG Portal Development Guide. For general information about creating gear content and configuration pages, see the Creating Gear Page Fragments chapter in the same guide.

Components

The Order Approval gear makes use of the following major components:

Component

Description

/atg/portal/gear/
GearConfigFormHandler

Class atg.portal.framework.GearConfigFormHandler.

GearConfigFormHandler is provided with the PAF. It is used in the Order Approval gear configuration pages to create the forms with which to set the gear’s instance and user parameters.

For more information on GearConfigFormHandler, see the Gears and the Portal Application Framework and Creating Gear Page Fragments chapters in the ATG Portal Development Guide.

/atg/userdirectory/
droplet/HasFunction

Class atg.userdirectory.droplet.HasFunction.

The HasFunction servlet bean is used in OrderApprovalShared.jsp and OrderApprovalFull.jsp first to check whether the user who has logged in is an approver and then to render the page content accordingly. If the user is an approver, the gear content is displayed. If the user is not an approver, a message indicating that the user is not authorized to view the gear is displayed.

/atg/commerce/approval/
ApprovalRequiredDroplet

Class atg.commerce.approval.ApprovalRequiredDroplet.

The ApprovalRequiredDroplet servlet bean is used to retrieve and display the orders that require approval by the current user. It is used in both the gear’s Shared and Full Page content pages.

By default, the ApprovalRequiredDroplet.sortAscending property is set to true; this displays the most recent orders that require the approver’s attention first. To display the oldest orders first, simply set this property to false.

For more information about ApprovalRequiredDroplet, see the Implementing an Order Approval Process chapter.

/atg/commerce/approval/
ApprovalFormHandler

Class atg.commerce.approval.ApprovalFormHandler.

ApprovalFormHandler is used in the gear’s Full Page content pages to create and manage the forms with which the approver can approve and reject orders.

For more information about ApprovalFormHandler, see the Implementing an Order Approval Process chapter.

/atg/commerce/gears
/orderapproval/ApprovalResolvedDroplet

Class atg.commerce.approval.ApprovalRequiredDroplet.

The ApprovalResolvedDroplet servlet bean is used to retrieve and display the orders that have been approved and/or rejected by the current user. It is used in the Full Page content page that displays the approver’s “resolved approval requests.”

For more information about the ApprovalRequiredDroplet class from which this Order Approval gear component is instantiated, see the Implementing an Order Approval Process chapter.

/atg/commerce/order/
OrderLookup

Class atg.commerce.order.OrderLookup.

The OrderLookup servlet bean is used in the gear’s Full Page content pages to retrieve and display a given order.

For more information on OrderLookup, see the Implementing Order Retrieval chapter.

/atg/commerce/catalog/
ProductLookup

Class atg.commerce.catalog.custom.CatalogItemLookupDroplet.

The ProductLookup servlet bean is used to retrieve and display product information for the approver’s orders. It is used in the Order List gear content page.

For more information on ProductLookup, see the CatalogItemLookupDroplet reference entry in Appendix: ATG Commerce Servlet Beans.

Tag Libraries

The Order Approval gear uses the following standard tag libraries:

For information on the DSP tag libraries, see the ATG Page Developer's Guide. For information on the PAF tag library and Jakarta’s i18n tag library, see the ATG Portal Development Guide.

No custom tag libraries were written for this gear.