Versions Compared

Old Version 33

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.


Info
titleWant this feature?

Deploy Content is a CV ecommerce multisite content management feature. It can also be used with Content Lock to remotely send restricted from editing locked content to target sites. Implementation requires consultation with Commerce Vision. Source and target sites must be on the same version (min. 2022.3).

CV: 105298

Overview

The Deploy Content feature allows the CMS remote management and source control of specific content on one or more sites in your organisation. The Administrator and Content Administrator roles to 'can select destinations ('target sites') and copy over' content from one CV website while in the CMS of their own site ('source site')to . NOTE - For successful deployment, source and target sites must be on the same version. 




About Deployable Content

When you deploy content, you're copying over one or more

destination CV websites

saved data objects ('

target sites

items')

in their organisation's network. These administrator roles can enable/disable the feature for specific content types as needed. For a target site to be selectable, it must be on the same version as the source site. 

What content types and data items can be deployed?

Lockable content items in locked status (available only for items that can be used with Content Lock)Pages and templates

from the site you're on to another site. A deployable content type is just a content data group that you can use with this feature. Of course, not all content can be deployed. We've identified those content data groups that multisite organisations often want to reuse on their different sites. In general, all deployable content types contain propriety data - created by, for or are otherwise meaningful to your organisation in some way.    



Deployable content types are almost always structured and accessed by way of the CMS navigation menu. Below, they are highlighted in yellow. (NOTE - Not all submenu items are deployable.)

Image Added

Deployment & Content Locking 

A content type also has another feature variable. Its data items can either be lockable or non-lockable. Lockable Items are deployed in locked status so that they cannot be edited or deleted on a target site - by any CMS user. Lockable content types typically contain data a business or head-office wants to maintain control of. Other content types are non-lockable. This means the source site can deploy content that CMS users on target sites can edit and/or delete.    

Lockable Items

When deployable? only when both the Deploy Content and Content Lock features are enabled on the source site. NOTE - If a locked item is deployed to a target site with Content Lock disabled target sie, it will be unlocked. This means it can be edited or deleted by users there (if their roles allow it).   


These are the lockable content types. 

A lockable

content items

item can only be deployed when in locked status.

For more on content locking, see: Content Lock.

Non-lockable

content itemsProduct content

Items

When deployable? when the Deploy Content feature is enabled on the source site.

These are the non-lockable content types.  

For more on locking, see: Content Lock.


Click here for specific deployment conditions of a content object type
Expand
title
Tip
titleLooking for a content type specific guide?

For a guide on how Content Lock & Deploy Content works with a specific content type, click on the content type. 


Content Type Deployment Rules

General Rules

Deployment rules are there to maintain integrity of deployed data on a target site. 

  1. Deployment to a target site will be cancelled if a data item is not found.
  2. The deployment process will fail if an item is in draft mode (when Page Preview is on).

Content Type Rules

Each content type also has specific conditions of deployment.  

Expand
titleHere is a quick guide...


TypeWhat is deployable?Conditions
Pages & Templates
  • whole page or specific objects in existing pages
  • whole page or specific objects in new pages
  • whole page or specific objects in draft pages (if Page Preview on)

Note - when a whole page is deployed, any deleted objects will also be deleted on destination sites. 

  • saved
  • locked 
Widgets
  • changes to existing widgets
  • new widgets added to a zone
  • draft widgets (if Page Preview on) 
  • saved
  • locked
Zones
  • all content and objects in a zone
  • locked
Layouts
  • changes to existing layouts including custom layouts   
  • saved
  • locked
Campaigns
  • new campaigns
  • updates to existing campaigns
  • saved
  • locked
Banner Types
  • changes to existing banner types
  • new banner types
  • locked
Article Types
  • changes to existing article types
  • new articles types
  • saved
  • locked
  • SEO information for details on both sites the samematch
Articles
  • changes to existing articles
  • new articles
  • saved
  • locked
Section Menus
  • changes to section menu items
  • new section menus
  • non-lockable
Roles
  • changes to role settings
  • new roles
  • non-lockable
  • saved
Menus
  • changes to menu settings and items
  • new menus
  • non-lockable
  • by Role
  • saved
Category
  • online-maintained details and settings only
    • changes to existing category information
    • new and existing sub-categories (only if top category exists on destination site)
    • category structure (only if top category exists on destination site)
    • category products (only if top category exists on destination site)
  • non-lockable
Product Details
  • Online-maintained product details
  • non-lockable
Product Features
  • Any new or existing features
  • non-lockable

What Can Be Deployed?

When Deploy Content is available for a page or content object, a Deploy button displays





Panel

On this page:

Table of Contents


Start Deployment


When an item or page of items is of a deployable content type, you will see a Deploy button on the top right of the page

and/

or

Deploy

on the

object

item's Options menu.

In general, the top Deploy button allows multiple data types and items to be selected for a deployment instance. Deploy from an object's menu is usually limited to deployment of that object or item.

The general rule is:

  • use the Deploy button to select from all multiple valid items on the page.
  • use Deploy on an item's menu to deploy only that item.


Info
titleNo Deploy button?

Deployment function is disabled (no Deploy buttons or menu items) when no target sites have been set for the source site.  


Example: deploying in Category Maintenance

Image Removed

(1) Deploy button, (2) Deploy menu item

Image Added    

(1) Clicking the Deploy button

(1) allows you to select more than one category

allows all valid categories can be selected for a deployment

instance

.

Clicking

Image Added

(2) Selecting Deploy from

a

the 'Shirts' category's Options menu

(2), e.g., 'Sports & Outdoors' will only allow deployment of that category's deployable data.  
Panel

On this page:

Table of Contents

Deploy Rules

Deploy rules are there to maintain content integrity on linked sites. 

  1. Deployment is cancelled if edited object is not found.
  2. Deployment will fail if an object is in draft mode (if Page Preview is on).

The Deployment Process

No matter the content data type, the deployment process is completed through the Deploy modal. This popup opens when you click the Deploy button or the Deploy menu item. The process has four steps:

1 - Select the data type(s) and/or item(s) to deploy.
Step-by-step

Image Removed

1. Toggle ON each data type you want to deploy.

2. Toggle ON each item to deploy. (Not all content types have the item level.)

allows only this category to be selected.

Image Added  


Deployment Steps

Regardless of content type, the deployment steps are the same. Clicking Deploy opens the Deploy popup. NOTE - The popup will not open if you attempt to deploy an 'unlocked' campaign.  


When deployment is successful, all four steps are completed.

Image Removed

Successful: Click the link to go to the Deployment Log. TIP: Even though the deployment instance is successful, the system may have detected other issues.
:

When deployment fails, step 4 is not completed.

Image Removed

(1)

Image Removed

(2)

Image Removed

(3)

Image Removed

(4)

Image Removed

(5)

Image Removed

1. Select Data Item(s)

Valid data items are displayed for selection. NOTE - If the popup has no no data items, it means there are no deployable items. 

1. Toggle to select data item(s). 

2. If applicable, toggle to select data type(s). NOTE - Some content items have selectable data types, e.g., products, categories. This allows you to specify only those data types you want to deploy.

3. Click Next.

2 - Select destination site


Step 1 Deploy

Image Added

2. Select Target Site(s)

.

Step-by-step

Image Removed

1

4. Toggle ON to select one or more destination target site(s) to deploy to.

25. Click Next.

3 - Check selected data and destination site(s) are correct.

Step-by-step

Image Removed

1. Review the data and destination site summary.

2. To proceed with deploytment, click Deploy. 

4 - Check deployment results.

Step-by-step

1. Go to Content → Advanced Content → Content Deployment Log.

2. Find the deployment instance. 

3. Click Edit for the failed deployment instance.

4. Scroll down, then click More Information. 

4. View error messages for the deployment.

                     

Deploy Rules and Result Messages

Result Messages

Successful

  • single linked site - all changes to selected data type(s) and items have been deployed on the destination site.
  • multiple linked sites - all changes to selected data type(s) and items have been deployed on all destination sites.

Failed

  • single linked site - at least one change to selected data type(s) and items cannot be deployed and the whole deployment instance was cancelled. Nothing was deployed to the selected linked site.
  • multiple linked sites - at least one change to selected data type(s) and items cannot be deployed on all sites and all deployment instances were cancelled. Nothing was deployed to all selected linked sites.

Partially successful 

multiple linked sites -all changes to data types of selected data type(s) and


Info
titleIncompatible Target Sites

You can view target sites on different versions to the source site but they cannot be selected.

Image Added


Step 2 Deploy

Image Added

3. Check Data Item & Target Site Selections

6. In Deployment Name, name this deployment. If left blank, the system adds the content type + date as the name.

7. Review data and target site selections. Go back to Steps 1-2 to reselect, if needed.

8. To start deployment, click Deploy. 


Step 3 Deploy

Image Added

4. Check Deployment Results

9. Check the Successfully Deployed? column,

  • Successful - when the whole deployment was successful. NOTE - A whole deployment is successful only when all data items were successfully deployed to all target sites.
  • Partially Successful - when all data items were successfully deployed to at least one target site but
also
  • failed for at least one target site.
   

Administrator Functions

Enable/disable Deploy Content

  • In the CMS, go to Settings → Settings → Content → Deploy Content.
    Image Removed
    • Click Configure.
  • Toggle ON/OFF Destination Sites.
    • When enabled, Deploy buttons or links will display for deployable objects. (NOTE - For Role and menu deployment, see: Deploy Role and menus.) 
    Deploy disabled                                                                   Deploy enabled
    Image Removed   Image RemovedThe Content Deployment Log will also be available on the Advanced Content menu. See: View Deployment Log.
    Image Removed

    Add linked sites

    Sites that share an organisation Id are treated as in a network. You may not always want to deploy a set of changes to all available sites. What sites a deployment instance can select from is set in Feature Settings.

    To add sites that content can be deployed to:

    Go to Settings → Settings → Content → Linked Sites.
    Click Configure.
  • Scroll down to the Sites section.
    Image Removed
    • Toggle on one or more sites from the available sites.
  • Click Save.

    • Deploying lockable objects

    The contents of a lockable object must be in locked status to be deployable. if unlocked, only the unlock status is deployed. This is used to allow users on linked sites to edit content. You'll know when an object is deployable by the displayed Deploy button or link under Options. If your site uses Page Preview and an object is deployed before Publishing, it will be deployed in the Draft mode.

    Go to the locked object. 
    Locate the Deploy button and click it.
    Image Removed
    In the Deploy modal, select individual objects to deploy or toggle Select All.
    Image Removed
    Click the Next button.
    Select one or more available deployment sites.
    Image Removed
    Click Next.
  • Check the summary of items to be deployed.
    Image Removed
    • To confirm deployment, click Deploy.
    Check the deployment results. NOTE - The result for each individual site is displayed separately. 
    Image Removed
    You can check the deployment details for more information. On the Results modal, click the link.
    Image Removed
  • Check the deployment details. You can enter notes about the deployment. 
    Image Removed

    •   

    Deploying non-lockable objects

    Non-lockable objects need additional setting to be enabled for deployment.

    To deploy a non-lockable object:

    In the CMS, go to  Settings → Settings → Content → Linked Sites.
    Click Configure.
    In Linked Sites Feature Settings, toggle ON the feature type(s) you want to deploy.  
    Image Removed
  • Click Save.

    • Deploying Role Settings

    Role settings changes are deployed from the Deployment section of the Linked Site
    • Failed -  when there were no target sites with all items successfully deployed.
    • Blank - deployment of at least one product or category item was cancelled because the product/category code did not exist on a target site. CHECK the deployment record for more information.       

    10. Click the link to view the deployment's results, e.g., for errors and other messages.


    Tip

    You can always view a deployment's results in the Content Deployment Log.

    Image Added


    Step 4 Deploy 
    Image Added


                         

    Deploying Role Settings

    Unlike all other content types, Role settings are deployed from the Deploy Content Feature Settings page.


    To deploy Role changessettings:

    1. In the CMS, go to  Settings → Settings → Content → Linked SitesDeploy Content.

    2. Click Configure.

    3. In Linked Deploy Sites Feature Settings, toggle ON Enable Role Deployment.  
      Image RemovedImage Added
    4. Click the Deploy button displayed Save.
      Image Removed 
    5. In To open the Deploy modal, select one or more Roles to deploy.
      Click Next. 
    6. Select the linked sites for deployment. 
    7. popup, click the Deploy button next to Role.
       

    Anchor
    deployment-log
    deployment-log
    Viewing Deployment History & Results

    To check deployment results:

    In the CMS, go to Content → Advanced Content → Content Deployment Log.
    Image Removed
    Use the Search tool to find the deployment instance. 
    Image Removed
  • Click Edit for the deployment instance you want to view.
    Image Removed

    • Additional Information

    Multiexcerpt
    hiddentrue
    MultiExcerptNameFeature Title

    --

    Minimum Version Requirements

    Multiexcerpt
    MultiExcerptNameMinimum Version Requirements

    4.38

    Prerequisites
    Multiexcerpt
    MultiExcerptNamePre reqs

    Implementation by Commerce Vision

    Self Configurable
    Multiexcerpt
    MultiExcerptNameSelf Configurable

    No

    Business Function
    Multiexcerpt
    MultiExcerptNameBusiness Function

    Content

    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

    view any deployment your site was involved in (as source or target site), view the Content Deployment Log. You can also rename a deployment and add notes about it while in the record. 


    Related Resources

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

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