Implementing PaymentWebShop

Introduction    Implementing    Other Uses    Parts

• Set up Model Configuration

• Inherit from PaymentWebShop Pattern

• Specify Payment Gateway Fields

  • Basic Payment Gateway Fields

  • Credit Card Data Fields Send to Payment Gateway

  • Fields Received from Payment Gateway

• Replace Item Entity

• Inherit from RelationalTable

• Relate ItemLineInCart to Product Entity

  • Real Cart Line Price Field

  • Virtual Fields in Cart Line

• Specify Correct Item Fields for Shopping Cart

• Modify Item Functionality

  • Item Category Structure

  • Specify Virtuals for ItemRelation Entity

  • Define ItemRelation.FetchByCategoryActiveSeq View

  • Define ItemRelation.FetchByProduct View

  • Specify fields in WebShop Item List

• Edit GUI function panels

• Calculate Amount Derivation Functions

  • Amount Calculation at Item Line

  • Application-specific Amount Calculation Modifications

• Add Contact Information Fields to GenericUser

• Specify Function Implementation Names

• Generate and Build

  • Specify Implementation Names

    • Tables, Views, and Fields

    • Websydian WebShop Functions

  • Specify INI-files

  • Generate and Build

  • Create Executables

• Modify Document Templates

• Edit Submit Payment Document Template

• Set Up Administration Data

  • Specify Shop

  • Specify Item Category Structure

• Edit Payment Gateway URL fields in Shop table

• Deploy and execute WebShop Application

This implementation page shows how to build an Internet Shop based on the Websydian PaymentWebShop pattern that  that supports online payment through exchange of events with an external payment gateway.

It is assumed that the reader of this implementation guide previously has implemented and deployed a Websydian application, e.g. by following the Websydian Tutorial.

Set up Model Configuration

The first step is to add the WsyShop library to your host group model. The version of WsyBase, WsySess and WsyUtil must be set to version  6.0. The level must be set to highest possible value.

Inherit from PaymentWebShop Pattern

Create your MyShop entity and let it inherit from the PaymentWebShop pattern:

This will create a Payment entity with all the WebShop facilities, with extra payment gateway fields in the Shop entity, with Submit Payment enabled for submission of an external events to a payment gateway, and with event handlers to receive the response from the payment gateway.

Specify Payment Gateway Fields

For the MyShop.Web.Ordering.Submit Payment.Ok event handler the following fields are by default send to the Payment Gateway as Hidden, Signed fields:

These fields are also received as Hidden, Signed fields by the event handlers:

• MyShop.Web.PaymentGateway.LoadOkPage
• MyShop.Web.PaymentGateway.LoadErrorPage

Basic Payment Gateway Fields

The names of the field exchanged with a Payment Gateway is given through the field implementation names. For this reason the implementation names of these fields must be specified. Refer to the specific payment gateway protocol documentation for the names to use.

Credit Card Data Fields Send to Payment Gateway

In order to verify a credit card, the payment gateway needs a number of fields. Again, refer to the protocol documentation for fields to use, field names, and field attributes.

Specify fields sent to Payment Gateway, e.g. by using the fields in the CreditCartTemplate Fetch view:

Specify implementation names for the credit card fields:

Fields Received from Payment Gateway

Optionally, specify additional fields to be received from the Payment Gateway:

Recall that Submit Payment.Ok is a SendToExternalServer event and LoadOkPage and LoadErrorPage are ReceiveFromExternalServer events.

Replace Item Entity

If the entity for Products is labelled MyProduct, the Item entity in MyShop must be replaced as follows:

The pattern entity WebShop.Data.Cart.Item is a placeholder without any attributes. In order to get Selector-functionality to work, the Product entity must inherit from this placeholder:

Inherit from RelationalTable

The tables in MyShop must be relational tables. All WebShop entities inherit from WebShop.Abstract.DataAccess, so simply add the triple:

Edit Submit Payment Document Template

The generated document template of the Ordering.Submit Payment page generator will include both the normal, internal Websydian SessionID field and the external SessionID field, along with the field for the digital sign. 

Open the Ordering.Submit Payment document template with your favorite HTML editor, and remove the Websydian SessionID field and the digital signature fields from the external event form, i.e. delete the lines:

<INPUT TYPE="HIDDEN" NAME="WSYD_SID" VALUE="/(WSYD_SID)">
<INPUT TYPE="HIDDEN" NAME="WSYD_SIGN" VALUE="/(WSYD_SIGN)/(AAmhF)">

Edit Payment Gateway URL fields in Shop table

This step must be made before the Deploy and Execute WebShop Application step of the WebShop implementation guide.

The fields for control of the payment gateway are located in the Shop table. Use the WebShop Administrator program to edit the field for the payment gateway clearing URL:

Maintain Shops for PaymentWebShop

Deploy and Execute WebShop Application

Now the WebShop application is ready to install and execute through a browser. Follow the appropriate installation guide for your platform and Internet Server, refer to the Installation part of the Websydian documentation.