eCommerce Configuration

Checklist

Make the appropriate settings changes in the following file:

[Tomcat]\webapps\asset-bank\WEB-INF\classes\ApplicationSettings.properties

eCommerce section:

  • Set the following to true to turn on the ecommerce components:
    ecommerce=true
  • Minimum lifetime of purchases (mins). This is the max time a user can
    spend on the payment page before their details expire on the site:
    purchase-expiry-period=240
  • Show T&Cs step in the checkout
    purchase-show-tcs=false
  • Set to true if user must enter an address before entering psp
    ecommerce-user-address-mandatory=true
  • Whether to show tax region
    ecommerce-show-tax-region=false
  • Purchase description stem (where applicable) - this is followed by a list of asset IDs
    psp-desc-stem=Images:
  • Whether to show an order section in the admin menu
    show-order-section=true
  • Stem for purchase id to use for invoice ids
    ecommerce-purchaseid-stem=
  • How to calculate the shipping costs for print orders:
    1 - Per Print :shipping is calculated per print using the value specfied in the print price band quantity ranges
    2 - Per Order :shipping is calculated per order using the first available price band shipping cost in the order
    shipping-calculation-type=1
  • Use a prefix for the purchase Id
    purchase-id-prefix=AB

PSP section:

  • PSP plugin
    psp-plugin-class=com.bright.assetbank.ecommerce.psp.DemoPSPPlugin
  • Callback Url - in case we pass it to the psp
    psp-callback-url=http://localhost:8080/image-bank/action/callbackPsp
  • PSP secrets for payment security (leave blank if not using)
    psp-secret=
    psp-secret-callback=


Pricing section:

  • Whether to show a pricing section in the admin
    show-pricing-section=true
  • Whether this instance of asset bank has a subscription model available
    Requires users-have-structured-address=true
    subscription=false
  • Set true if tax calculator required
    tax-calculator=false
  • Default tax amount
    vat=-1
  • Default tax name
    vat-name=VAT
  • Whether to have shipping costs i.e. for print price bands
    shipping-costs
    =false

User registration section:

  • Set to true for structured address, or false for a freeform address field.
    A structured address is necessary when using the tax calculator module.
    users-have-structured-address=true
  • Set to true if address should be mandatory
    users-register-strict-address=true
  • Set to true if registering users should enter address/phone details.
    Note: set to true if you are using strict validation above, and are using structured addresses.
    users-register-with-address=true

Lightbox (basket) section:

  • Can users have more than one lightbox? This should be set to false.
    multiple-lightboxes=false

Database update

Open WEB-INF/manager-config/database/refdata_ecommerce_update.sql in a text editor, review it and make changes according to the instructions in the comments, and then run it.

Restart

Restart Asset Bank

Then ensure the following is set for *Public, *Logged-in-users and any other groups your potential asset purchasers will be in:

Admin > Groups > 'Group' > [usage exclusions]
Tick all the boxes on this page.

Now again for each of the groups mentioned above, set the following:

Admin > Groups > 'Group' > [folders] * Note: folders used to be called access levels.

Set downloads to 2 (download after approval - in this case commercial approval by the PSP)

Only tick 2 (download originals) in the advanced download area (DO NOT tick the 'Advanced download' option as this will allow the user to by-pass the usage type they have paid for, allowing them to download all versions of a particular asset).


Was this article helpful?

Yes No

Thanks for your feedback!