Projects:GiftCards/Technical Documentation

Artefacts

This section lists all the technical artefacts that provide the functionality and requirements provided by the functional documentation and UI mock-ups.

Module skeleton

• Forge project creation
• Mercurial repository
• Module metadata

Data model and windows definition

• Table Products modification
  • Field IsGiftCard
  • Field IsVoucher
  • Field Amount (if IsGiftCard)
• Table VoucherSummary. Products tab. (If IsVoucher)
  • Field Product
  • Field Quantity
• Table GiftCardInstance
  • Field GiftCardId (indexed)
  • Field Status (New / Partial / Closed) (indexed)
  • Field Order (Order this gift card was purchased)
  • Field Orderline (Order Line this gift card was purchased)
  • Field DateOrdered (Comes from field Order)
  • Field BusinessPartner (Comes from field Order) (indexed)
  • Field Product (Comes from field OrderLine)
  • Field Amount (if IsGiftCard)
  • Field CurrentAmount (if IsGiftCard)
• Table GiftCardInstanceSummary (if isVoucher: Voucher summary)
  • Field Product
  • Field Quantity
  • Field CurrentQuantity
• Table GiftCardInstanceTransactions (Gift card transactions)
  • Field Date
  • Field Order
  • Field OrderLine (OrderLine that applied this discount)
  • Field ConsumedAmount (if IsGiftCard)
  • Field ConsumedProduct (if IsVoucher)
  • Field ConsumedQuantity (if IsVoucher)

Server side processes

• Create new gift card instance
  • For gift cards
  • For vouchers
  • Hook in order loader process to create gift card instance
• Process gift card transaction
  • For gift cards
  • For vouchers
  • Web service to be used by client
• Cancel gift card transaction
  • For gift cards
  • For vouchers
  • Web service to be used by client
• Get gift card details and transactions by gift card ID
  • Web service to be used by client
• Search/list gift card instances
  • Web service to be used by client

Client side processes and UI

• Dialog to search/List gift card instances
• Dialog to display gift card instances details and transactions.
• Buy a gift card.
  • Display details in receipt view.
  • Add the details needed by the server to create a new gift card instance.
• Use a gift card.
  • From gift card instances details dialog
  • From payments panel using gift card ID
  • Display details in receipt view.
  • Add the details needed by the server to process a new gift card transaction.

Documentation

Code Review

Testing

Module package publication