To make customizations, you can modify the page fragments and override the component or page fragment properties. Payment group information is displayed on a number of pages, including the billing, order view, e-mail and refund method pages. Payment group information is displayed using the PaymengGroupTypeConfiguration.displayPageFragment and PaymentGroupTypeConfiguration.displayRefundMethodPageFragment property values.

The following table provides display information on Credit Card type payment groups:

Value

Title

Content

Example

Value1

Type

[credit card type] – [last four digits of card]

Visa – 2112

Value2

Expiration Date

[card expiration year] / [card expiration year]

11/12

Value3

Billing Address

[first] [last]
[address 1]
[address 2]
[city], [state] [zip code] [country]
[phone number]

Bob Smith
119 Grand Street
Apt. 1509
Brooklyn, NY 10023
USA
212-555-4321

Status

Status

[payment group status]

Authorization succeeded

The following table provides display information on Store Credit type payment groups:

Value

Title

Content

Example

Value1

Type

Store Credit – Store Credit Number

Store Credit – 1c1123

Value2

Amt. Remaining

[store credit remaining]

15.32

Value3

Blank

[blank]

blank

Status

Status

[payment group status]

Debited

The following table provides display information on Gift Certificate type payment groups:

Value

Title

Content

Example

Value1

Type

Gift Certificate – Gift Certificate Number

Gift Certificate – 1g4332

Value2

Amt. Remaining

[amount remaining]

15.32

Value3

Blank

[blank]

blank

Status

Status

[payment group status]

Debited

The following table provides display information on Pay In-store type payment groups:

Value

Title

Content

Example

Value1

Type

Pay In Store

Pay In Store

Value2

Blank

[blank]

blank

Value3

Blank

[blank]

blank

Status

Blank

[blank]

blank

The following table provides display information on Cash type payment groups:

Value

Title

Content

Example

Value1

Type

Cash

Cash

Value2

Blank

[blank]

blank

Value3

Blank

[blank]

blank

Status

Blank

[blank]

blank

The display values are used in the following locations:

Display Pages

Value1

Value2

Value3

Status

Billing
Order Review
Refund Type
Confirmation Emails

X

X

X

Order View
Scheduled Orders
Refund Review

X

X

X

X

The /atg/commerce/custsvc/ui/CreditCardConfiguration.properties, StoreCreditConfiguration.properties and GiftCertificateConfiguration.properties files in the /DCS-CSR-UI directory hold all of the properties of the page fragments. The configuration file contains the page fragment location.

The following examples use the Credit Card payment group; however, all three payment group types have corresponding files.

The following is an example of the CreditCardConfiguration.properties file:

$class=atg.commerce.csr.order.PaymentGroupTypeConfiguration
addPageFragment=/atg/commerce/custsvc/ui/fragments/order/AddCreditCard
editPageFragment=/atg/commerce/custsvc/ui/fragments/order/EditCreditCard
displayPageFragment=/atg/commerce/custsvc/ui/fragments/order/
  DisplayCreditCard

type=creditCard
addPageFragmentTitleKey=addCreditCardTitle
editPageFragmentTitleKey=editCreditCardTitle
resourceBundle=atg.commerce.csr.order.WebAppResources

editRefundMethodPageFragment=/atg/commerce/custsvc/ui/fragments/order/
  EditCreditCardRefundMethod
displayRefundMethodPageFragment=/atg/commerce/custsvc/ui/fragments/order/
  DisplayCreditCardRefundMethod
editRefundMethodPageFragmentTitleKey=editCreditCardRefundMethodTitle

The CreditCardConfiguration.properties file identifies the location of the page fragment, which in turn, defines your page fragment JSP file and the servletContext. For example:

$class=atg.web.PageFragment

URL=/include/order/displayCreditCard.jsp
servletContext=DCS-CSR

The displayCreditCard.jsp file contains the values for the display details, including the title and the content. You must modify the default value1, value2, value3 and status properties with your custom information. The combination of these parameters defines one display value, such as value1:

Example: Payment Group Display Page Fragment Components

The following is a portion of the default configuration of the displayCreditCard.jsp file. In this example, the displayHeading parameter, which defines the display value1 title, is set to use the Billing Summary header. The displayValue parameter, which defines the display value1 content, is set to display the credit card information:

<c: if test="${propertyName == 'value1'}">
  <c: if test="${displayHeading == true}">
    <fmt: message key='billingSummary.commerceItem.header.type'/>
  </c: if>
  <c: if test="${displayValue == true}">
    <csr: displayCreditCardType creditCard="${paymentGroup}"/>
  </c: if>
</c: if>

To display your customized payment group title and content, modify the displayHeading and displayValues accordingly. For example, in the GiftCertificate.jsp file, the value1 title has been modified to use the same displayHeading but the displayValue has been modified to use the newOrderBilling gift certificate value:

<c: if test="${propertyName == 'value1'}">
  <c: if test="${displayHeading == true}">
    <fmt: message key='billingSummary.commerceItem.header.type'/>
  </c: if>
  <c: if test="${displayValue == true}">
    <fmt: message
     key="newOrderBilling.displayPaymentMethods.giftCertificate"/>
    <c: if test="${!empty paymentGroup && !empty
      paymentGroup.giftCertificateNumber }">
      <fmt: message key="common.hyphen"/>
      &nbsp;
      <c: out value="${paymentGroup.giftCertificateNumber}"/>
    </c: if>
  </c: if>
</c: if>

As noted above, the title and content for value1 is shown on the Billing, Order Review, Refund Type, Order View, Scheduled Orders, and Refund Review pages as well as on confirmation e-mails. You may also modify the value2 and value3 property as needed. Note that Store Credit and Gift Certificate payment groups do not use the value3 property by default, so it is left blank. You may add the displayHeading and displayvalues to the property as required.

Other properties that can be customized within the display page fragment include the status property. This property is used to identify the status of the group object and is displayed only on the Order View, Scheduled Orders and Refund Review pages. The default title for all payment groups is Status. Modify the display value to point to your customized information as needed. The following is an example of the displayCreditCard.jsp status:

<c: if test="${propertyName == 'status'}">
  <c: if test="${displayHeading == true}">
    <fmt: message key='billingSummary.commerceItem.header.state/>
  </c: if>
  <c: if test="${displayValue == true}">
  <dsp: droplet name="PaymentGroupStateDescriptions">
    <dsp: param name="state" value="${paymentGroup.stateAsString}"/>
    <dsp: param name="elementName" value="stateDescription"/>
    <dsp: oparam name="output">
      <dsp: droplet name="IsHighlightedState">
        <dsp: param name="obj" value="${paymentGroup}"/>
        <dsp: oparam name="true">
            <span class="atg_commerce_csr_dataHighlight"><dsp: valueof
              param="stateDescription"></dsp: valueof></span>
        </dsp: oparam>
        <dsp: oparam name="false">
          <dsp: valueof param="stateDescription"></dsp: valueof>
        </dsp: oparam>
      </dsp: droplet>
    </dsp: oparam>
  </dsp: droplet>
  </c: if>
</c: if>

Note that there are DSP tag files that, once copied into your customization library, can be used to extend default JSP files. For example, the displayCreditCardType.tag file displays the credit card name and renders the last four digits of the credit card number. For information on working with DSP tag files, refer to the ATG Page Developer's Guide.


Copyright © 1997, 2013 Oracle and/or its affiliates. All rights reserved. Legal Notices