Versions Compared

Key

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

...

1. Infrastructure Tasks

  • Obtain Client ID and Secret IDs from Alterra (there are different for test and prod.)

    Status
    colourRed
    titleRequired

  • Send the following information to Alterra for testing and implementation:

    1. Resort name

    2. Test email addresses (that can receive emails)

    3. Resort callback URLs (your PDP URL, test, and production)

Status
colourYellow
titlePrerequisite

2. Commerce Tasks

  • Work with your Aspenware Representative to install and enable the IKON Friends & Family Plugin.

    Status
    colourRed
    titleRequired

Status
colourYellow
titlePrerequisite

  • Set up products in Aspenware Commerce.

    Status
    colourRed
    titleRequired

    1. Set up the product as you would normally.

    2. Note the product ID in the URL on the Product Configuration page. Consider that this may be different between your live and test environment if not performing copy live to tests frequently.

    3. Copy the product ID and add it to the Product ID field in Aspenware Commerce > Configuration > Local Plugins > IKON Friends & Family. Consider that this may be different between your live and test environment if not performing copy live to tests frequently.

  • Configure Ikon Friends & Family Plugin

    Status
    colourRed
    titlerequired

    1. On General tab (first tab) enter:

      1. The two-letter abbreviation for your resort

      2. Leave Logo Image URL as is, this image is hard-coded.

      3. Select Save.

  • On the Language tab (second tab).

    1. Enter the language you would like to appear in the bottom “toast” message when the responses noted above each text box are returned.

  • Go to the Ikon Login Configuration (third tab) and enter:

    1. Enter the appropriate URL or endpoint as follows:

      1. Login Domain:

        1. IF test: https://account.uat.ikonpass.com

        2. IF production: https://account.ikonpass.com

      2. Login Endpoint: /login

      3. Redirect URI: [resort-pdp-url]/login-callback (this will be different between test and prod and will need to be updated when copy live to tests occur.)

  • Go to the Ikon Entitlement API Configuration (fourth tab) and enter values obtained from your Ikon representative, while blackout dates will change according to year and pass type.

    1. Entitlements API domain:

      1. IF test: https://api.uat.ikonpass.com

      2. IF prod: https://api.ikonpass.com

    2. Entitlements Client ID: Value provided by Ikon Pass

      1. (Note that these values are different for test and production and from the redemption API.)

    3. Entitlements Client Secret: Value provided by Ikon Pass

      1. (Note that these values are different for test and production and from the redemption API.)

    4. Entitlements Token Endpoint: /token

    5. Entitlements Vouchers Endpoint: /v2/available-vouchers

      1. Note that this value may change as Alterra makes updates to their code. Aspenware will work closely with Alterra to stay informed of Endpoint changes.

    6. Ikon Pass Entitlement Type ID: This number is provided by Ikon Pass.

      1. For the 2021/2022 season, these values are in sync between test and production.

    7. Ikon Pass Blackout Dates: This number is provided by Ikon Pass.

    8. Ikon Base Plus Pass Entitlement Type ID: This number is provided by Ikon Pass.

    9. Ikon Base Plus Pass Blackout Dates: This number is provided by Ikon Pass.

    10. Ikon Base Pass Entitlement Type ID: This number is provided by Ikon Pass.

    11. Ikon Base Pass Blackout Dates: This number is provided by Ikon Pass.

    12. Ikon Local Pass Entitlement Type ID: This number is provided by Ikon Pass.Leave blank if you are not an IKON Local Resort.

    13. Ikon Local Pass Blackout Dates: Enter your local resort’s blackout dates. Leave blank if you are not an IKON Local Resort.

  • Go to the Ikon Redemption API Configuration tab (fifth tab) and enter the following:

    1. Redemption Api Domain:

      1. IF test: https://api-central-entitlements-uat.azurewebsites.net

      2. IF prod: https://api-central-entitlements.azurewebsites.net

  • Redemption Token Api Domain:

    1. IF test: https://api-identityserver4-uat.azurewebsites.net

    2. IF prod: https://api-identityserver4.azurewebsites.net

  • Redemption Client Id: Value provided by Ikon Pass and is unique per resort.

    1. Note that these values are different for test and production and from the redemption API.

  • Redemption Client Secret: provided by Ikon Pass (Unique per resort)

    1. Note that these values are different for test and production and from the redemption API.

  • Redemption Token Endpoint: /connect/token

  • Redemption Single Voucher Endpoint: /v1/redemptions/manual

    • Note this value should be stable for the 2021-22 season, but may change in the future as Alterra makes updates to their code. Aspenware will work closely with Alterra to stay informed of Endpoint changes.

  • Redemption Grant Type: client_credentials

  • Redemption Scope: write_entitlements

  • Redemption Type Id: 6

Status
colourGreen
titleDetailed Setup

...

Note

IMPORTANT: Enabling this feature does require an annual feature subscription fee. Talk to your Aspenware representative about adding this feature to your Aspenware Commerce subscription.

...

  • Go to Aspenware Commerce > Configuration > Local Plugins

    1. Locate “IKON Friends & Family” under the Aspenware Group and select Install.

  • Once installed Enable the plugin by selecting Edit next to the listed plugin and ensure the Is enabled checkbox is selected.

Detailed Setup Guide

Note: For resorts using a multistore Nop environment, the Friends and Family component must be set up separately via the url for the specific resort. Do this by inputting product IDs and each configuration tab (including styles) separately per resort.

1. Set up Products

  • Set up the product(s) that will be used for the Ikon Friends & Family component. To do this:

    1. Set up the product as you would normally. (See Configuring Products for basic product setup.)

    2. Note the product ID in the URL on the Product Configuration page. Consider that this may be different between your live and test environment if not performing copy live to tests frequently.

    3. Copy the product ID and add it to the Product ID field in Aspenware Commerce > Configuration > Local Plugins > IKON Friends & Family. Consider that this may be different between your live and test environment if not performing copy live to tests frequently.

2. Configure IKON Friends and Family Plugin

  • Go back to the plugin (Aspenware Commerce > Configuration > Local Plugins > IKON Friends & Family) and select Configure.

    1. Under the General tab enter the two-letter abbreviation for your resort (if you do not know this abbreviation contact your Ikon pass representative).

    2. Under the General tab, you will see the Logo Image URL, leave as is

      1. Note that currently, this image is hard-coded.

    3. Select Save.

  • Go to the Language tab (second tab).

    1. Enter the language you would like to appear in the bottom “toast” message when the responses noted above each text box are returned. See the example below.

    2. Select Save.

...

  • Go to the Ikon Login Configuration (third configuration tab).

    1. Enter the appropriate URL or endpoint as follows:

      1. Login Domain:

        1. IF test: https://account.uat.ikonpass.com

        2. IF production: https://account.ikonpass.com

      2. Login Endpoint: /login

      3. Redirect URI: [resort-pdp-url]/login-callback (see note below on how to configure)

        1. Note this will be different between test and prod and will need to be updated when copy live to tests occur.

    2. Select Save.

...

Note

IMPORTANT: For the redirect URI, enter the URL from your resort’s PDP followed by “/login-callback” and remove the subdirectory pointing to the category. This will return the logged-in Ikon Pass guest to the appropriate page.

  • Go to the Ikon Entitlement API Configuration (fourth configuration tab). Most of the values will need to be obtained from your Ikon representative, while blackout dates will change according to year and pass type. See the image below for an example.

    1. Entitlements API domain:

      1. IF test: https://api.uat.ikonpass.com

      2. IF prod: https://api.ikonpass.com

    2. Entitlements Client ID: Value provided by Ikon Pass

      1. (Note that these values are different for test and production and from the redemption API.)

    3. Entitlements Client Secret: Value provided by Ikon Pass

      1. (Note that these values are different for test and production and from the redemption API.)

    4. Entitlements Token Endpoint: /token

    5. Entitlements Vouchers Endpoint: /v2/available-vouchers

      1. Note that this value may change as Alterra makes updates to their code. Aspenware will work closely with Alterra to stay informed of Endpoint changes.

    6. Ikon Pass Entitlement Type ID: This number is provided by Ikon Pass.

      1. For the 2021/2022 season, these values are in sync between test and production.

    7. Ikon Pass Blackout Dates: This number is provided by Ikon Pass.

    8. Ikon Base Plus Pass Entitlement Type ID: This number is provided by Ikon Pass.

    9. Ikon Base Plus Pass Blackout Dates: This number is provided by Ikon Pass.

    10. Ikon Base Pass Entitlement Type ID: This number is provided by Ikon Pass.

    11. Ikon Base Pass Blackout Dates: This number is provided by Ikon Pass.

    12. Ikon Local Pass Entitlement Type ID: This number is provided by Ikon Pass.Leave blank if you are not an IKON Local Resort.

    13. Ikon Local Pass Blackout Dates: Enter your local resort’s blackout dates. Leave blank if you are not an IKON Local Resort.

...

  • As you can see above, the component is broken down into 4 modules. Resorts may replace any portion with a transparent background png that roughly follows the guidelines above. Images outside of these guidelines will autosize and, therefore, may be stretched.

  • To upload any of the images go to Catalog > Your Product > Email Description > Open the “Image Tab”

    • Select Browse, select image from desktop and upload

    Note the image below is the proper size, has a transparent background, and is 255.8KB

    Once uploaded find the image in the RoxyFile list
    Select image and select “Preview”

  • Example image to be uploaded:

  • Copy the url in your browser window

  • Image Added

  • Go to configuration tab and paste the proper url in the appropriate Styling tab input field

  • Sarah Holst There is a new and final Styling configuration tab that was added due to new requirements from IKON that came in last week and Aaron and Leigh accommodated for. Leigh Bush will have the details on this, essentially, our recommendation is to upload the images required to the AW Commerce Admin Image hosting service - Go to Content management>message templates> edit any template> Select Insert>Insert Image >click the file icon>Add file>Choose file. Then find the files for each image on your computer (AW can get from IKON to use as part of your implementation - must use IKON approved styling/wording/fonts/images, etc). Once uploaded, you can click on an image title and select preview to get the links, and these URLS can be plugged into the admin tab below.

Sarah Holst Another step that is only relevant to resorts that have multiple storefronts is that this is supported so that you can have unique values for this plugin for each storefront. I can’t figure out how that works, so Leigh Bush will need to provide steps/show you how.

...

Insert excerpt
AE:Like this Page Excerpt
AE:Like this Page Excerpt
nopaneltrue

...