Configuration: Calendar Templates

Calendar Templates are being leveraged as we roll out new features. Following is a list of which features are currently enabled through Calendar Templates:

  • Inventory Scarcity Indicators on Inline PDP Calendar: As an Aspenware Cloud customer, Calendar Templates admin can be used to configure inventory urgency indicators on the inline calendar that appears on the PDP.

  • Inventory Scarcity Indicators on Full-Page Pricing Calendar: On Commerce 3.0 or later, as an Aspenware Cloud customer, Calendar Templates admin can be used to configure inventory urgency indicators on the full-page pricing calendar.

  • Inventory Scarcity Indicators on the Cloud UI Full-Page Pricing Calendar: As an Aspenware Cloud customer, Calendar Templates admin can be used to configure inventory urgency indicators on the Cloud UI redesigned full-page pricing calendar.

Detailed Setup Guide

  1. Configure Inventory Scarcity Display

  2. Create Global Calendar Templates

  3. Edit Global Calendar Templates

  4. Assign Calendar Template to Desired Product

1. Configure Store-wide Inventory Scarcity Display Settings

Before configuring calendar templates, update the following settings:

Setting

Description

Value

Setting

Description

Value

calendarsettings.enable advanced calendar

Turns on the Advanced Pricing Calendar.

This setting must be TRUE for calendar templates to enable color coding of dates

calendarsettings.useposinventory

If true, the color shading of calendar is based on inventory. This is required for the Cloud UI Calendar if calendarsettings.enabledadvancedcalendar is set to true.

Must be TRUE if calendarsettings.enabledadvancedcalendar is set to true for Cloud UI.

calendarsettings.lowinventorybackgroundcolor

Color used to shade calendar on low inventory dates.

Recommended #F6D241

(yellow)

calendarsettings.soldoutstatustext

Legend text for sold out dates

Text

EX: UNAVAILABLE

 

2. Create Global Calendar Templates

To create the new global calendar template, go to Aspenware Commerce > Aspenware Styling > Calendar Templates > Create New Template.

  • Configure the following settings:

    • Name: Name must be unique and allows for identification of the calendar template when assigning the template to products.

    • Admin Description: The admin description is only visible to admins and displays when assigning the template to products in the product editor. The description cannot exceed 120 characters and will show alongside the name in admin to make assigning products to calendar templates easier.

    • User Description: This description will be displayed above the calendar (see example on Overview Page ) for products assigned to this calendar template. It is optional to add calendar display text. This text cannot contain HTML and cannot exceed 120 characters.

    • Display Inventory Urgency: Setting to define whether or not to display inventory urgency on the product’s calendars. This inventory urgency color coding will appear on the large pricing calendar if configured and also on the calendar on the product detail page if configured. It will not appear on the standard drop-down calendar or the radio button calendar at this point.

    • Threshold: If Display Inventory Urgency is true for a calendar template, an admin can also optionally define a specific threshold number at which to trigger the shading of the date in the calendar based on low inventory. This threshold will be used for all products assigned to this calendar template.

    • Legend Label: Define an under-threshold legend text that is specific to the calendar template before saving a new calendar template not to exceed 20 characters. (See “LIMITED” on Overview page).

  • Click Save.

3. Edit Global Calendar Templates

Calendar templates may be edited but keep in mind that changes to the calendar template will immediately affect all products assigned to that calendar template. If the desire is to make a change that only applies to a single product rather than all assigned products with that template, the best course of action is to create a new template or find an existing template with the desired settings, and update the single product to be assigned to the updated calendar template. If you aren’t sure how changes to the calendar template will cascade to products, each template has a message about the assigned templates in the edit modal.

Go to Aspenware Commerce > Aspenware Styling > Calendar Templates and click the Edit icon next to the template you wish to edit and edit the items you wish to update.

Deleting calendar templates is only possible if no active (published) products are assigned. when deleting a calendar template with assigned products, a message displays to the admin stating, “Cannot delete [Name of calendar template] due to active products being assigned.”

NOTE: Deleting calendar templates is only possible if no active (published) products are assigned. When deleting a calendar template with assigned products, a message displays to the admin stating, “Cannot delete [Name of calendar template] due to active products being assigned.”

4. Assign Calendar Template to Desired Product

A calendar template can be assigned to a product and must be assigned to a product for the inventory availability scarcity functionality to work. A product can have only one calendar template assigned, but a calendar template can have multiple products assigned to it. If a product already has a calendar template assigned, the assigned template can be changed or removed. Calendar templates should only be added to products that have inventory added to them and that are configured to use the Inline Calendar on the PDP and/or the full-page pricing calendar.

To assign or edit the assignment for a product:

  • Go to Catalog > Products > Edit Product > Dynamic Pricing > Calendar Display
    Note that the Calendar Display tab is within the Dynamic Pricing section on the Edit Product page.

  • Select Assign or Manage Calendar Templates

     

Once the template is assigned, it will appear in the Calendar Display section of the Product Editor.

NOTE: Products do not need to be dynamically priced to use Inventory Scaricity Indicators. The Dynamic Pricing plugin will eventually be renamed and expanded to include more date selection display functionality over time and will no longer exclusively be used for dynamically pricing a product.