Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents

Setup Checklist

Insert excerpt
AE:Set-up ChecklistAE:
Set-up Checklist
nopaneltrue

1. POS

TASKS

Tasks

POS Task 1

  • Complete POS accounting tasks for products sold online needs to be completed

    Status
    colourRed
    title

Required
Expand
titleExample of POS Task

Products that need age ranges assigned are created in POS and have age ranges added to POS

  • REQUIRED

Status
colour

Yellow

Green
title

Prerequisite

detailed setup

2.

INFRASTRUCTURE TASKSInfrastructure Task 2 -

Payment Provider Tasks

  • Determine if ApplePay, GooglePay or PayPal will be used.

    Status
    colourRed
    title

Required Expand
titleExample of Infrastructure Task
​Confirm that the Azure function app is setup and configured to the desired frequency. -
  • required

  • Configure GooglePay in Braintree

    Status
    colour

Red
  • Blue
    title

Required
  • optional

  • Configure ApplePay in Braintree

    Status
    colour

Yellow
  • Blue
    title

Prerequisite

3. COMMERCE TASKS

Commerce Task 3 -
  • optional

Status
colour

Red

Inventory is mapped to product or product variant in the Inventory Pool plugin

Status
colourRed
titleRequired

Code is entered

Green
title

Required
Expand
titleExample of Commerce Task

Confirm that the Aspenware Commerce products that will have inventory assigned to them are fully configured with the correct attributes -

Status
colourRed
titleRequired

Status
colourYellow
titlePrerequisite

Language String, Setting, HTML widget, etc. Task 4 -

Status
colourBlue
titleoptional

Expand
titleExample of Setting Task

​Ensure the setting ‘ecommercesettings.productinventory.cachetime’ is set to your desired cache time -

Status
colourBlue
titleoptional

Status
colourYellow
titlePrerequisite

Configuration Task 5 -

Status
colourRed
titleRequired

Expand
titleExample of Configuration Task

detailed setup

3. Infrastructure Tasks

  • If on a version earlier than 2.27, work with your Aspenware Representative to ensure the following settings in the Azure appsettings.json file are set:

    • AllowStorageOfCC = TRUE

    • AllowTransferOfCC = TRUE

3. Commerce Tasks

  1. Update Settings

    Status
    colourRed
    titleREQUIRED

    1. For version 2.27 or later, in Configuration > Settings > All Settings, configure the following:

      1. ecommercesettings.allowstorageofcc = TRUE

      2. ecommercesettings.allowtransferofcc = FALSE

  2. Set up GL Report.

    Status
    colourRed
    title

Required

If using location in RTP, location code is entered

Status
colourRed
titleRequired

If multi day product, number of days is defined
  1. required

  2. Configure Aspenware Commerce Payment Gateway

    Status
    colourRed
    titleRequired

If using non default lock time of 900 seconds, the desired lock time is configured.

Status
colour

Blue

Green
title

optional

Status
colourGreen
titleDetailed Setup

...

detailed setup

Detailed Setup Guide

Insert excerpt
AE:Prerequisites Tasks ExcerptAE:Prerequisites Tasks Detailed Setup Guide Excerpt
Detailed Setup Guide Excerpt
nopaneltrue

POS Tasks

...

...

If using Braintree

...

Decide on supported payment methods

  • CC/Paypal/Apple Pay/Google Pay

If using Google Pay within Braintree

...

Note

IMPORTANT: Syncing Braintreetokens to the POS to use for refunds or resort charge is not possible. This is due to POS technical limitations with storing Braintree tokens that would require the POS to engage in development activities to support.

  • Complete POS accounting tasks for products sold online.

Payment Provider Tasks

Determine which additional payment methods will be supported for your resort. Possibilities include:

  • PayPal

  • Apple Pay

  • Google Pay

1. Configure Google Pay in Braintree (optional)

  • Use debug merchant ID for test: 01234567890123456789

  • In

    prod braintree

    production Braintree go to Settings > Processing > Google Pay and enable Google Pay

  • In production, you

    You'll also need to submit a support request with Google to register your domain and receive a merchant

    id

    ID. - fill out this form

    : https://services.google

    .

    com/fb/forms/googlepaymentAPI/

  • Send Aspenware test site and

    prod

    production site to Google

  • Google approves submissions for APIs

    . They will need to ensure it adheres to their Acceptable Use Policy

  • Once approved, you’ll send Google an email address to be used for production access.

  • Once they approve you, you can sign up for a developer account

    payments.developers.google.com/signup 

    HERE.

  • Send Aspenware your merchant ID.

    If using

2. Configure Apple Pay

...

in Braintree (optional)

  • Set up an Apple Developer Account and Merchant and Certificate and upload your Certificate in Braintree.

  • Download the Certificate Signing Request

    https://www.braintreegateway

    .

    com/merchants/xgw9z8r4t7g55n5g/processing/apple_pay/csr 

  • Sign in to your Developer Center in Safari. (You may need an Apple Developer Account to do this.)

  • Create an Apple Pay Merchant ID - You'll first need a developer center account to do this

    I believe

    . They recommend using separate Apple Pay Merchant IDs for sandbox and production to ensure that your sandbox app cannot create production transactions.

  • Generate a new Apple Pay Certificate in Apple's developer portal - again you'll do this within your developer center.

  • in Braintree production, Select Apple Pay Certificate and click Continue.

  • In the

    dropdown

    drop-down, choose the appropriate Apple Merchant ID for your Braintree environment (Sandbox or Production) and click Continue.

  • Under Payment Processing Certificate, click Create Certificate.

  • Upload the CSR that you downloaded from Braintree in the first step

    1

    above.

    : Note:

    You must use the CSR we provide. Do not create a CSR file yourself.

  • Download the new Apple Pay Certificate and upload it when setting up Apple

    Pay  in braintree

    Pay in Braintree go to Settings > Processing > Apple Pay

  • Then host the domain association file from Apple on the shop.

Infrastructure Tasks

  • If

    using Square
    • You will need a Square Merchant account. If you don't already have one, you can sign up here: https://squareup.com/signup/

      • Important: Your merchant account must have at least one location with enabled credit card processing. Please refer to the Square customer support if you have any questions about how to set this up.

    • Sign in to your Square Developer Portal at https://connect.squareup.com/apps; use the same sign in credentials as your merchant account.

    • Click on '+New Application' and fill in the Application Name. This name is for you to recognize the application in the developer portal and is not used by the extension. Click 'Create Application' at the bottom of the page.

    • In the Square Developer admin go to 'Credentials' tab. Copy the Application ID and paste it into Application ID below.

    • In the Square Developer admin go to 'OAuth' tab. Click 'Show Secret'. Copy the Application Secret and paste it into Application Secret below. Click 'Save' on this page.

    • Copy this URL: https://shop.YOURRESORT.com/Plugins/PaymentSquare/AccessToken. Go to the Square Developer admin, go to 'OAuth' tab, and paste this URL into Redirect URL. Click 'Save'.

    • On this page click 'Obtain access token' below; the Access token field should populate. Click 'Save' below.

    • Choose the business location. Location is a required parameter for payment requests.

    • Fill in the remaining fields and save to complete the configuration.

    • Notes: For Nop 3.9, you need to set the API to earlier than 3/13 version. You will also need to be added as an admin on the square account to be able to complete setup. 

Infrastructure Tasks

  • Infrastructure Task that must be completed first. Remove section if not required

Commerce Tasks

  • AW Commerce task that must be completed first

Settings, Language Strings and/or HTML Widgets for this Feature

...

Settings

  • AW Commerce Settings that must first be completed

Language Strings

  • AW Commerce Language Strings that must first be completed

HTML Widgets

  • AW Commerce HTML Widgets that must first be completed

Detailed Setup Guide

  1. Step 1 Header

  2. Step 2 Header

1. Step 1 Header

  • First bullet should provide navigation instructions i.e. Catalog >Attributes >Product attributes

    1. Sub-bullet for step 1. Every step and click should be detailed so that someone could follow with little prior experience.

      1. Sub-bullet for step a. Include screenshots of the step and use skitch to mark up screenshots. It can be downloaded here: https://www.techspot.com/downloads/5705-skitch.html

Expand
titleExample of content within a section
  • From the Aspenware Commerce Plugins>Age Range page in Admin, click View Add Range Types in the upper right corner.

  • Click Add Age Range Type.

  • Enter a name and description for the age range type.

  • To set the date used to compare the customer’s age to the required age range, select:

    1. Calculate from Trip Start (this age range type is likely already configured), or 

    2. Calculate from Today’s Date (age range based on purchase date), or

    3. Specify the Calculation Start Date; the customer’s age on this date will be used to determine if they are eligible for the product based on the age ranges

  • Click Add.

  • Age Range Types can be edited and inactivated, but they cannot be hard deleted without contacting Aspenware. 

  • Age Range types that are set to Calculate from Trip Start or Today’s Date will never need to be edited, unless you would like to edit the name. Age Range Types that are calculated from a fixed date however, will need to be edited each year to adjust for the current year.

Image Removed

 

Hint: Age Range Types should also be adjusted year over year. If age ranges are calculated based on Trip Start, then they will not need to be updated.

Once completed for all required age range types move on to create Age Range.

Info

Note: When possible use notes, warnings, and hints within info panel macros. See https://aspenware.atlassian.net/wiki/pages/resumedraft.action?draftId=781156460 for more details on these.

2. Step 2 Header

  • First bullet should provide navigation instructions i.e. Catalog >Attributes >Product attributes

    1. Sub-bullet for step 1

      1. Sub-bullet for step a

...

DELETE CONTENT AFTER THIS LINE

go to the Glossary page and add the key terms Excerpt Include that you added for your configuration guide.

To add the feature terms to the Glossary, navigate to the glossary and add a header for your feature using an H2. Select the + and then select …view more. Search for Excerpt Include and in the Page Containing the Excerpt search for “Configuration: [FEATURE]” select to hide panel, preview and add.

How-to Guide of this page can be found here: [Internal] Configuration page Setup Guide

...

  • on a version earlier than 2.27, work with your Aspenware Representative to ensure the following settings in the Azure appsettings.json file are set:

    • AllowStorageOfCC = TRUE

    • AllowTransferOfCC = TRUE

Note

IMPORTANT: AllowStorageofCC must be set to TRUE for the GL Export function to work.

Aspenware Commerce Tasks

  1. Update Settings

  2. Set up GL Report.

  3. Configure Aspenware Commerce Payment Gateway

1. Update Settings

NOTE: You will need to determine if you will be using Aspenware Payment Plans with your Braintree implementation before updating the following settings.

  • Go to Configuration > Settings > All settings (advanced)

    1. Search for ecommercesettings.allowtransferofcc

      Image Added

       

      1. Click Edit.

        Image Added

         

      2. Set the Value to FALSE and click Update.

        Image Added

    2. Search for ecommercesettings.allowstorageofcc

      Image Added

       

      1. Click Edit.

        Image Added

         

      2. Set the Value as follows:

        1. If Using Aspenware Payment Plans, set to FALSE

        2. If NOT using Aspenware Payment plans, set to TRUE

          Image Added
      3. Click Update.

Note

IMPORTANT: AllowStorageofCC must be set to TRUE for the GL Export function to work.

2. Set up GL Report

  • Work with your Aspenware Representative to set up the GL Report so you can reconcile GL reporting in the POS and payment gateway.

3. Configure Aspenware Commerce Payment Gateway

  • Go to Configuration > Payment Methods in Admin.

  • Click Edit on the Braintree payment gateway.

  • Check Is active the for Braintree and Save.  Ensure that only Braintree is set to Is active.

  • Select Configure on the Braintree payment method. 

  • To change or set up payment account, fill in the following fields:

    • Use Sandbox: Should be checked for test and unchecked for prod

    • Merchant ID: Obtain from Braintree

    • Private Key:  Obtain from Braintree

    • Public Key: Obtain from Braintree

    • Additional Fee: Set to 0.00

    • Additional fee. Use percentage: Unchecked

    • Requires Billing Address: Unchecked

    • Requires Phone Number: Unchecked

      Image Added
  • Click Save.

  • Test a live credit card for each type of accepted credit card (Visa, Amex, Discover, Mastercard) to ensure the gateway is processing payments properly once setup is completed. 

Common Troubleshooting

Q: What functionality is and isn’t available to me because of having Braintree as a Payment Provider?

A: Good news is that using Braintree allows you to enable a number of advanced features, most notably Payment Plans, Saving a credit card to use on future e-commerce transactions, Apple Pay, Google Pay and Pay Pal. Some limitations with using Braintree are that in order to store a token for being charged at a later date, a minimum $1 transaction must be completed to store the card, so any product that enrolls you in a Payment Plan must have a minimum $1 deposit. Unfortunately, because some functionality is made possible by having a token stored in the POS, and neither RTP|One nor Siriusware support storing Braintree tokens, resort charge, direct to lift, and capturing tokens for refunds in the POS is not supported.

Q: When I look at an order status in Aspenware Commerce Order Details, the status is set to pending rather than complete? What’s wrong with this order?

A:  The true indicator of whether a product made it to RTP|One successfully is the order queue. If you see orders showing as ‘Pending’ in the Sales > Orders area, check if any products in these orders have Shipping checked on the product editor.

...

This won't cause problems per se but is really only used for retail products that are shipped, so it shouldn't be checked.  Because nopCommerce is often used as a retail platform, what processing means in Nop is similar to what Open means in RTP|One. The order is paid for, but the order has not been fulfilled, aka shipped. For ski, we send the order to RTP|One for fulfillment and don't do any fulfillment in NOP - we use the delivery plugin for shipping ski media and ignore nopCommerce shipping, so it's not a problem, but my guess is that if you uncheck shipping on these products and save it, you will start seeing these orders show as completed.

...