Versions Compared

Old Version 30

changes.mady.by.user Documenter

Saved on

compared with

New Version Current

changes.mady.by.user Documenter

Saved on

Key

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


sites in their network
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

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.

Expand
titleWhat is a deployment instance?
Tip

Think of the deployment process as completing one or more copying sessions.

  • In a deployment instance, data type(s) and items are selected to be copied over to one destination site.
  • A successful Image Removeddeployment instance is when all selected item data were 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.
  • A failed Image Removeddeployment instance is when no selected item data were deployed to a destination site.
    • If you selected multiple destination sites, you are initiating multiple deployment instances.

    *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


    What category data can be deployed?

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

    A

    Category Data

    Category Maintenance Mode


    Info
    titleCheck Category Maintenance 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 at a time; cannot deploy multiple categories
    • cannot deploy 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 Added


    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.

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

    In the CMS, go to Settings → Settings → Feature Management →
    • category image, deletion of category image
    • category banner, including image
    • category tree structure (excluding products) - Online mode on both deploying and destination sites
    • category product hierarchy 
    • category products
    • category details
    • category SEO details
    • category custom fields       
    Info
    titleCheck Category Maintenance mode

    When the deploying site is in Integrated mode:

    • only one category's data can be deployed at a time 
    • 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 will fail. The Content Deployment Log will display this error message:
      Image Removed

    Step-by-step guide

    1. Enable Category Deploy

    •  
    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 dataThis 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:

    Multiexcerpt
    MultiExcerptNameB2B/B2C/Both

    Both

    Third Party Costs
    Multiexcerpt
    MultiExcerptNameThird Party Costs
    n/a
    Related help
    1. Go to E-commerceEcommerce → Products & Categories → Category Maintenance.

    2.  Do you want to deploy data from  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.
      1. Online mode: Multiple categories - on the top right of the page, select Deploy the button. Single category - find the category, hover over its Options, then select Deploy.

      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.

    3. In the Deploy modal popup, toggle ONto select the data type(s) to deploy. If your the source site is in Integrated Maintenance mode, category hierarchy data cannot be selected.


    4. Toggle ON the category to deploy. If you're deploying multiple categories, toggle ON each required category. to select each category.  


    5. Click Next.

    6. Toggle ON to select one or more valid destination target sites.


    7. Click Next.

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

    9. In the next screen, check whether deployment was successful or failed,
      10. Single destination site
    10. 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
      11. Failed deployment: the progress bar remains at step 3 'Summary' and the failed message is displayed.
      Image Removed
      Review data and site details for this deployment instance for issues before trying again. Check the Content Deployment Log for errors.
    11. Multiple destination sites: 
      1. Successful to all destination sites - the progress bar reaches step 4 'Results' and has a 'Successful' message. You can also click the link (2) to see the deployment details.   

    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

    1. In the 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 = "category" and title ~ "'CMS Category Maintenance'"