Versions Compared

Key

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

...

  • Ensure that the Linked Products Plugin is installed by going to Admin > Configuration > Local Plugins and search for “Linked Products”. Check that it is installed and, if not, install it. This plugin is required for linked products.

    image-20240729-152747.png

  • Create the' IsRenewal' Specification Attribute if it doesn’t already exist.

    • Go to Catalog > Attributes > Specification attributes and click Add New to create a new attribute if it doesn’t already exist.

      • Name it ‘IsRenewal’

      • Add a new option and input 'True' as the name.

    • Save it

  • Product Shells for renewal product(s) should be created according to the configuration guide.

...

  • Confirm that the following product classification(s) are created.

    1. The ‘Is Renewal Product’ Product Classification must be added as a classification if not already set up as a product classification.

      1. To set the ‘Is Renewal Product’ Product Classification up as a new classification go to Aspenware Commerce>Product Classifications and select Add Classification and define the following fields as follows

        1. Name: Is Renewal Product

        2. Description: Assign this classification to renewal products.

        3. Select the checkbox for Is Renewal

      2. Click Add.

    2. The ‘Renewal Lock’ Product Classification must be added as a classification if not already set up as a product classification.

      1. To set the ‘Renewal Lock’ Product Classification up as a new classification go to Aspenware Commerce>Product Classifications and select Add Classification and define the following fields as follows

        1. Name: Renewal Lock

        2. Description: Assign this classification to renewal products.

        3. Select the checkbox for Renewal Lock

      2. Click Add.

Language Strings

  1. Go to Configuration > Languages > English > String Resources to set specific language strings that apply to the renewal page. Use the following language strings to edit what customers see in the following scenarios.

    1. If a customer does not have any eligible products, they will see configurable messaging on the renewals or linked product page. 

    2. If they are not logged in, they will not see any products and will be shown configurable messaging on the page. 

...

  • An HTML widget can be enabled that displays below the category bar and shows configurable messaging that links to the renewal or linked products page for logged in customers and to the login page for users who are not signed in. From Nop Templates > Plugins > HTML Widgets > Manage HTML Widgets, select to edit, or create a new widget for, ‘Renewal Homepage Banner’ widget. From Tools > source code, you can paste in or edit the HTML. The HTML that is configurable is in blue below.

...

This task assumes that the prerequisite task of configuring the product shell for the renewal products has been configured according to this Configuration Guide.

  • Go to Catalog > Products and choose to Edit the product.

  • Assign the product to a category that has been set up to be hidden. (Instructions on hiding a category here)

    1. These products are set up as very simple products, so define the SKU and Price in the Product info section, unless they are going to be leveraging Aspenware Payment Plan functionality. 

Info

NOTE: IF a product is a renewal product and is going to leverage Aspenware Payment Plan functionality, the following setup is recommended because these products cannot have the product defined on the product info tab and must have the SKU and price defined in the attribute combination table.  

  • Start by creating a new product attribute called Payment Plan from Catalog > Attributes > Product Attributes

  • Define a single default value called ‘Payment Plan’

  • Go to all settings and add ‘Payment Plan’ to the comma-separated list for the value of this setting: 'catalogsettings.hiddenattributes'

  • Then go Catalog > Products to edit the desired Renewal payment plan product

  • Go to the Attributes section and click Add a new attribute.

    1. From the Attribute drop-down, select ‘Payment Plan’

    2. Enter ‘[Hidden]’ in Text Prompt field

    3. Check Is Required

    4. Set Control Type to 'Radio Button List'

  • Click Save and Continue Edit

  • In the Values section, click Add a new value.

    1. Set Attribute value type to ‘Simple’

    2. Name it 'Payment Plan'

    3. Check Is preselected

    4. Do not set the other options.

  • Save it.

  • Go back to product details and click on the Attribute combinations tab to set up only one attribute combination row in the combination table with the SKU and deposit price.

    1. Select Generate several combinations button.

    2. From the modal only check ‘Payment Plan’ and click Generate.

    3. Then add the product header code in the SKU field and deposit price in the Price field.

  • Click Save.

  • Go to the Attributes section and click Add a new attribute to add the AssignedTo attribute. This will lock down the assigned customer so that guests cannot change these options.

    1. From the Attribute drop-down, select ‘AssignedTo’.

    2. Enter ‘{ "lock": true } [Assigned To]’ in Text Prompt field.

    3. Set Control Type to 'Text'.

  • Click Save and Continue Edit

  • From here, add desired add-on products to the product. A renewal product cannot have a core attribute added to it but can have add on attributes. Follow the configuration guide for simple add-on products to add standard add-ons to the renewal product.

    • Attributes used to associate add-on products to renewal products must use the Control type of ‘CHECKBOXES’. Using the CHECKBOXES control type enables the add-on to be selected or deselected on the PDP during the purchase flow.

      Image RemovedImage Added
Note

IMPORTANT: For renewal products, something needs to be typed in the Text prompt field for EVERY attribute, though this will not show for customers.

  • Next, open the Specification attributes section and select Add attribute to add the ‘IsRenewal’ specification attribute. This will ensure that if someone does somehow locate the standard PDP for this renewal product they will not able to add it to the cart, and this product can only be added to the cart through the gated renewal page.

    • Choose ‘Custom text’ from the Attribute type drop-down.

    • Select the ‘IsRenewal’ attribute.

    • Type ‘Yes’ in the Value field.

    • Check Show on product details page.

    • Save it.

  • Save the overall renewals product.

2. Add Product Classifications to Renewal Product. 

  • Go to Aspenware Commerce > Product Classifications > Add Assignment, and select the hidden Category where the renewal product lives, and the renewal Product requiring assignment.

  • In the Classification table, click the Assign checkbox next to the following classifications

    • 'Requires Assignment''

    • ‘Is Renewal Product’

    • 'Renewal lock'

  • Click Add.

HINT: Products flagged with the renewal classifications will only be available on the (store URL)/renewal or (store URL)/linked products pages if the logged-in customer has previously purchased an RTP|One product component that links to this current product via product component link configuration.

...