Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Info
titleWant this feature?

Deploy Content is a Commerce Vision multisite feature. Only online-maintained category data can be deployed. 

Requires 2022.3.

Overview

For multisite control, deploying site CMS Administrator and Content Administrator roles can copy over online-maintained category data to valid destination sites in their network. ERP-integrated data cannot be deployed.

This is part of the CV ecommerce multisite content management feature. Learn more: multisite content management

Overview

You can only deploy category re-structure and changes to a top level category down if its category code already pre-exists on the target site.

Image Added 

Use case: CV Franchise HQ has added new product sub-categories to a pre-existing top level category. They want their changes to be distributed to all franchisee sites. Franchisee sites will be able to alter the deployed category details should they want to localise to suit. 


Quick Guide

Source site feature setting: Deploy Content enabled. 

Target site feature setting: none 

Lockable content type: no. Deployed category details can be edited and deleted on target sites.

Deployable content type: yes. 

What can be deployed?* all or part of a category's structure that can be edited online, including subcategories and its products (not product details), SEO URL, meta-data, banner, custom fields. ERP-integrated data cannot be deployed.

*Also dependent on Category Maintenance Mode on source and target sites. See below.

Deployment notes: To deploy all deployable data types, Online Category Maintenance mode must be set on both source and target sites. Top level (parent) category code must pre-exist on a target site. Products with product codes not on a target site will not be deployed.

Other checks: a product must already exist on target site or else, will not be added as a category product in the deployment.   

                     



Panel

On this page:

Table of Contents


only one

Category Data

Category Maintenance Mode


Info
titleCheck Category Maintenance mode

When the deploying site is in Integrated mode:

source site: online mode / target site: online mode

  • deploy category data from a single or multiple categories in one go
  • can deploy all deployable data

source site: Integrated mode / target site: Integrated mode

  • deploy a single category's data
can be deployed
  • at a
time 
  • time; cannot deploy multiple categories
  • cannot deploy category hierarchy (tree structure) data
cannot be selected for deployment.

When a destination site is in Integrated mode (and the deploying site is in Online mode):

deployment of category hierarchy (tree structure) data

Source site: online mode / target site: Integrated mode

  • deployment will fail. The Content Deployment Log will display this error message:
Image Removedcategory
  • Image Added
Tip

Think of the deployment process as completing one or more deployment instances.

  • In a deployment instance, changes in selected data type(s) and items are copied over to one destination site.
  • For a successful deployment instance, all changes must be successfully deployed to a destination site. If one change fails to deploy, the whole deployment instance will fail. No changes will be copied over to this site.
  • If you selected multiple destination sites, you are initiating multiple deployment instances. 

What can be deployed?

NOTE - Category data is non-lockable. This means content managers on destination sites can always rollback your changes or make further edits. 

  • new category

  • Warning

    A top-level category must already exist on the destination site, otherwise category content deployment will fail. New top level categories (Category Codes) cannot be deployed.

    Only online maintained category data types can be deployed. You can select to deploy one or more category data types: 

    • category image, deletion of category image
    • category banner, including image
    • category tree structure (excluding products)
    - Online mode for both deploying and destination sites
    • category product
    hierarchy - category must already exist on destination site
    • hierarchy 
    • category
    product
    • products
    • category details
    • category SEO details
    • category custom fields 
                                 
    Panel

    On this page:

    Table of Contents

    Step-by-step guide

    1. Enable Category Deploy

    In the CMS, go to
    •  
    Settings  Settings  Feature Management → Content
    •  
    •  
    Deploy Content.
    Ensure


    Deploy

    Content is enabled, then click Configure.
    Image Removed
    In Deployment, toggle ON deploy for Category Maintenance.
    Image Removed
  • Click Save or Save & Exit
  • 2. Deploy category data

    This step assumes you have category data ready to deploy. Deployable data for a category must be online-mantained. If your deploying site is in Integrated Category Maintenance mode, some data types cannot be selected. 

    Category Data


    To deploy category data:

    1. Go to E-commerceEcommerce → Products & Categories → Category Maintenance.
      Image Removed
       Do you want to deploy data from Image Added
    2.  Deploy a single category or the same data types from multiple categories? NOTE - The multiple categories category option is only available when your a source site is in Online Mode. 
      Image Removed

      1. Online mode: Multiple categories - on the top right of the page, select Deploy the button. Single category - if your site is in Online mode, find the category, hover over its Options, then select Deploy.
                                   - if your site is in Integrated mode, Image Added
      2. Integrated mode: Single category only - find the category, then click Edit next to it. In the Maintain Category page, hover over the Options button, then select Deploy   

      Follow the steps in the Deploy modal: 

        Toggle ON
      1. .Image Added

    3. In the Deploy popup, toggle to select the data type(s) to deploy. If your the source site is in Integrated Maintenance mode, category hierarchy data cannot be selected.
      Image Modified
      Toggle ON the category to deploy. If you're deploying multiple categories, toggle ON each required category. 

    4. Image RemovedToggle to select each category.  
      Image Added

    5. Click Next.

    6. Toggle ON to select one or more destination target sites.
      Image RemovedImage Added

    7. Click Click Next.

    8. Check the data and site selections are correct, then click Deploy.
      Image RemovedImage Added

    9. In the

      next modal window, check whether deployment was successful or failed,
      Successful deployments - the progress bar reaches step 4 'Results' and has a 'Successful' message. You can also click the link (2) to see the deployment details.   
      Image Removed
      Unsuccessful deployments - the progress bar remains at step 3 'Summary' and the failed message is displayed. Review this deployment's data and details for issues before trying again. 

      Image Removed

    Additional Information

    Multiexcerpt
    hiddentrue
    MultiExcerptNameFeature Title

    --

    Minimum Version Requirements
    Multiexcerpt
    MultiExcerptNameMinimum Version Requirements

    2022.3

    Prerequisites
    Multiexcerpt
    MultiExcerptNamePre reqs

    Multisite Functions enabled

    Self Configurable
    Multiexcerpt
    MultiExcerptNameSelf Configurable

    No

    Business Function
    Multiexcerpt
    MultiExcerptNameBusiness Function

    Catalogue

    BPD Only?
    Multiexcerpt
    MultiExcerptNameBPD Only

    Yes

    B2B/B2C/Both
    Multiexcerpt
    MultiExcerptNameB2B/B2C/Both

    Both

    Third Party Costs
    Multiexcerpt
    MultiExcerptNameThird Party Costs
    n/a

    Related help

    1. final step, click the link to check deployment results,

      Image Added


    2. For deployment to more than one site, scroll down to check deployment for each target site. Click More Information to view error messages logged for the specific target site deployment. 
      Image Added

    Troubleshooting Category Deployment

    Category Not Displaying a Product

    A deployment will only add a product to a deployed category if the product code exists on the target site. If the code is not found, this particular product is omitted. The deployment will still be flagged as successful.

    Solution: Before deployment, check that products and their codes are available on a target site.  

    Category Maintenance Mode Not the Same

    Category Maintenance mode on target site has been set to Integrated mode and cannot receive the data from the source site. Solution: change mode on target site to Online mode. If this cannot be done, Category Deployment cannot be used.

    Image Added 


    Enable Deploy Category (Admin) 

    1. In the CMS, go to Settings  Settings  Feature Management → Content  Deploy Content.

    2. Ensure Deploy Content is enabled, then click Configure.
      Image Added

    3. In Deployment, toggle ON deploy for Category Maintenance.
      Image Added

    4. Click Save or Save & Exit


    Related Resources

    Content by Label
    showLabelsfalse
    showSpacefalse
    excludeCurrenttrue
    cqllabel = "multi-site" and title ~ "'Deploy Content'"

    Content by Label
    showLabelsfalse
    showSpacefalse
    excludeCurrenttrue
    cqllabel = "multi-site"category" and title ~ "'CMS Category Maintenance'"