This is archived CyberStore v2024.1 documentation. For current guidance, see the latest documentation.

Control Library

The Control Library provides the CyberStore controls used to compose storefront and checkout experiences. Each page documents the control’s source-supported purpose, configurable behavior, and direct CyberStore base relationship.

Control bases

• CyberStoreBaseControl provides shared visibility and access conditions for CyberStore controls.
• ItemControl adds item-type visibility conditions for controls that operate on one catalog item.
• ListingControl provides listing scope and item-type behavior for catalog listings.
• PricingControl provides shared pricing display and add-to-cart behavior.
• HotSpoting is a legacy control base with no documented public properties.

Catalog and item detail

• CatalogItemDetailControl provides the primary product-detail display and its default subcontrol composition.
• FilterControl provides catalog characteristic filtering for supported listing controls.
• CharacteristicValueDisplayControl displays a configured characteristic value as a link, image, or button.
• CatalogHotbuyVerticleListingControl lists random Hot Buys from the current category hierarchy.
• CatalogItemCharacteristicBooleanButton is a legacy characteristic button control.
• CatalogItemCharacteristicDisplayControl displays characteristics from a selected family.
• CatalogItemCharacteristicTabsDisplayControl groups item characteristics into tabs.
• CatalogItemCharacteristicURLButton is a legacy characteristic URL button control.
• CatalogItemCharacteristicURLDropDown displays a characteristic URL drop-down.
• CatalogItemListCreateListControl lets shoppers create an item list.
• CatalogItemListingByCategoryControl lists items by category.
• CatalogCategoryZoomControl is a legacy category zoom control.
• CatalogContactUsControl displays a custom contact form and sends submissions by email.
• CatalogDataViewControl is a catalog data-view control.
• CatalogFeaturedItemControl displays a randomly selected featured item.
• CatalogFilterControl filters item searches by price range.
• CatalogHotbuyControl displays randomly selected Hot Buys in two columns.
• CatalogItemDiagramListing displays Hot Spot diagrams.
• CatalogItemImageControl displays featured and zoomable item images.
• CatalogItemQuickOrderEntry lets shoppers add stock codes directly to the cart.
• CatalogItemZoomControl displays zoomable item images and thumbnails.
• CatalogPricingControl displays item pricing as a secondary control.
• CatalogRelatedItemsControl displays items related to the current item.
• CatalogRequestQuoteControl gathers quote requirements from shoppers.
• CatalogSearchControl provides catalog keyword and category search.
• CS2_CatalogHotbuyControl is a deprecated Hot Buy control.
• CatalogAvailableToPromiseReportControl lists item availability by category.
• CatalogCategoryBreadcrumbControl displays the current category hierarchy.
• CatalogCategoryCharacteristicHeaderControl adds characteristic detail to category headers.
• CatalogCategoryQuickViewControl is a legacy category quick-view control.
• CatalogAccessorySelectionGrid edits accessorized cart items within the cart display.
• CatalogCategoryDiagramListing displays available category Hot Spot diagrams.
• CatalogContentDisplayControl displays configured catalog content.
• CatalogHotSpotDisplayControl is an obsolete Hot Spot display control.
• CatalogHotSpotListingControl lists an item’s Hot Spots.
• CatalogItemListButtonControl lets shoppers add an item to a personal list.
• CatalogItemSKUListingControl lists shopper-selectable SKUs.
• CatalogItemTextLinkListControl lists sibling item-detail links.
• CatalogItemTileListingControl is a legacy tiled item listing control.
• CatalogCategoryNavigationControl displays approved category navigation.
• CatalogCategorySearchDisplayControl displays sibling category search results.
• CatalogCategorySearchListControl lists sibling categories and their item counts.
• CatalogCharacteristicFilterControl is an unfinished legacy characteristic filter control.
• CatalogItem2xListingControl lists filtered items in two columns.
• CatalogItemImageZoomControl provides thumbnail navigation and optional zoom for item-detail photos.
• CatalogItemSelectionControl is an item-detail subcontrol for SKU selection.
• CatalogSimplePricingControl provides streamlined pricing and add-to-cart behavior.
• CatalogItemListingGroupByCategoryControl is a category-grouped item listing control.
• CatalogItemQuantityDiscountDetailControl displays item quantity-discount details.
• CatalogItemQuantityDiscountDisplay displays item quantity-discount breaks.
• CatalogItemVerticleListingControl displays a paged vertical item listing.
• CatalogOnHandQuantityDisplayControl displays item availability and lead-time messages.
• CatalogAccessorySelection lets shoppers select accessories for a base item.
• CatalogAccessorySelection2 is a legacy accessory selection control.
• CatalogAddtoCartButton is an obsolete add-to-cart control.
• CatalogBannerControl displays novo CMS banners and tracks views and clicks.
• CatalogBulkOrderControl displays a link to a designated page.
• CatalogCategoryInformation displays a category heading and subheading.
• CatalogCategoryListControl displays sibling categories and item counts.
• CatalogCategoryMenuControl displays catalog category navigation.
• CS2_ItemDisplayControl is a deprecated Create Struct 2 item display control.

Cart and checkout

• ShoppingCartDisplayControl displays cart items and lets shoppers adjust quantities or remove items.
• ShoppingCartDisplaySavedCartControl displays a saved cart.
• ShoppingCartDisplayItemCount displays the number of items in a shopper’s cart.
• ShoppingCartQuickEntryControl lets shoppers add items directly to the cart.
• GiftCertificate lets shoppers apply a promotion code during checkout payment selection.
• CheckOutAddress provides the address step of checkout.
• CheckOutShippingOptions lets shoppers select shipping and provide instructions.
• CheckOutPaymentMethods lets shoppers select an eligible payment method.
• CheckOutConfirmOrder displays an order for confirmation or cancellation.
• CheckOutItemList displays the items in a checkout order.
• CheckOutDisplayOrderTotals displays order totals and labels.
• CheckOutOrderDisplayControl displays a consolidated order summary.
• CheckOutDisplayOrderReceipt displays an order receipt after confirmation.
• CheckOutPrintOrderConfirmation displays a printable order confirmation.
• CheckOutRePrintOrderConfirmation displays the submitted-order confirmation for reprinting.

Common controls

• CommonStateDropDownControl displays available states in a drop-down.
• CommonValidEmailControl requests and validates a shopper email address.
• CommonRequiredPasswordControl collects and validates a password confirmation.

Distributor controls

• DistributorSearchControl lets shoppers find distributors and their listings.
• DistributorUploadControl is a legacy distributor upload control.
• DistributorUploadLinkControl is a legacy distributor upload-link control.

Personalization controls

• PersonalizationControl opens item-personalization views.
• PersonalizationDisplayControl shows a shopper’s saved item personalizations.
• PersonalizationReviewControl collects shopper approval for personalized cart items during checkout.
• PersonalizationListingTemplate is a legacy personalization listing template.

Other storefront controls

• DataDisplayControl displays SYSPRO data through a configured template.
• ItemReportControl displays an item report.
• LoadWidgetControl loads a widget file into a storefront page.
• NovoLiteratureRackControl displays literature managed in novo CMS.
• NovoMenuControl displays a novo menu.
• NovoSearchControl provides novo content search.

Customer controls

• CustomerAccount2Control collects on-file customer verification during registration.
• CustomerAccount3Control collects the final registration address details.
• CustomerAccountControl displays and collects shopper account information.
• CustomerAccountMFAControl lets shoppers opt in to SMS multi-factor authentication.
• CustomerAddress collects shopper addresses.
• CustomerFileUploadControl accepts shopper file uploads.
• CustomerForgotPWControl provides password recovery.
• CustomerLoginControl renders shopper sign-in actions.
• CustomerLogoutControl ends a shopper session.
• CustomerOrderDisplay displays an existing order for its owner.
• CustomerOrderStatus lets shoppers search their order status.
• CustomerSmartLoginControl provides returning-shopper actions.
• CustomerAccountCharacteristicEditControl edits account characteristics.
• CustomerChangeRequestShipDateControl manages requested ship dates.
• CustomerOrderDisplayValuesControl is a legacy control marked as not used.
• CustomerChangePasswordControl manages verified password changes.
• CustomerDispatchDisplayControl is a legacy dispatch display control.
• CustomerHideShowPriceControl toggles price visibility.
• CustomerLoginCompleteControl provides post-login actions.
• CustomerMasterAccountControl switches an administrator’s associated customer.
• CustomerRegistrationComplete is a legacy control marked as not used.
• CustomerAccountAdminControl is a legacy customer account administration control.

Shared guidance

• Using Controls explains the shared configuration and inheritance boundaries for the pilot controls.