Versions Compared

Old Version 42

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 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 remote management and source control of specific content on one or more sites in your organisation. The Administrator and Content Administrator roles can select destinations ('target sites') and copy over' content while in the CMS of their own site ('source site'). 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 saved data objects ('items') 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 via by way of the CMS navigation menu. HereBelow, they are highlighted in yellow. (NOTE - Not all submenu items are deployable.)

Lockable

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 that a source site 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

These content types contain lockable items. when Content Lock is enabled AND the item is in locked status.

Pages and templates

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. 

NOTE - If a locked item is deployed on a Content Lock feature disabled target site, it will not be locked and can be edited or deleted by target site users (if their role usually allows it for the content type).   

Non-lockable Items

A lockable item can only be deployed when in locked status.

For more on content locking, see: Content Lock.

Non-lockable Items

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

These are the non-lockable content types.  


Tip

For more on content locking, see: Content Lock.

Expand
Click here for specific deployment conditions of a content object type
titletitleLooking 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 details on both sites match
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 item, the 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 or on the

object

item's Options menu.

In general, the  Deploy button at the top allows multiple data types and items to be selected for a deployment. Clicking

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
is usually limited
  • to
deployment of
  • 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 allows

you to select more than one category

all valid categories can be selected for a deployment

instance

.
Image Added

(2)

Clicking Deploy on a

Selecting Deploy from the 'Shirts' category's Options menu

(2), e.g., 'Sports & Outdoors', will only deploy that category's data.  
Panel

On this page:

Table of Contents

Deployment Rules

Deployment rules are there to maintain content integrity on target sites. 

  1. Deployment will be cancelled if a content item is not found.
  2. Deployment will fail if the item is in draft mode (if Page Preview is on).
Deployment Process

allows only this category to be selected.

Image Added  


Deployment Steps

Regardless of content type, the deployment process is completed using the Deploy popup. This opens on selecting the Deploy button or the Deploy menu itemsteps are the same. Clicking Deploy opens the Deploy popup. NOTE - The popup will not open if you attempt to deploy an 'unlocked' lockable itemcampaign.  

Deployment Steps 


Click Configure.
Toggle ON/OFF Destination Sites.
When enabled, Deploy buttons or links will display for deployable item. (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 Target Sites

Sites that share an organisation Id are treated as being in the same network. You may not always want all networked sites to be selectable for the Deploy Content feature. Target sites can be enabled and disabled in Feature Settings.

To enable a site to be selectable as a target site:

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

    • Deploying Lockable Items

    A lockable item must be in locked status to be deployable. If the source site has the Page Preview feature enabled and an item is deployed in draft mode, deployment will fail. 

    Go to the locked item. 
    Click the Deploy button. NOTE - If there is no Deploy button, no data item is ready to deploy. If there is a Deploy button but does not work, there is no locked deployable item.
    Image Removed
    In the Deploy popup, select individual items to deploy or toggle Select All.
    Image Removed
    Click the Next button.
    Select one or more available target 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 - If deploying to multiple target sites, check the Content Deployment Log for individual site results. 
    Image Removed
    To check deployment results, click the link. For a guide to a deployment record, see: View Content Deployment Log.
    Image Removed

    Deploying Non-lockable Items

    To deploy a non-lockable item:

    In the CMS, go to  Settings → Settings → Content → Deploy Content.
    Click Configure.
    In Linked Sites Feature Settings, toggle ON the content type(s) you want to deploy. NOTE - Non-lockable content types do not have the word 'locks'.  
    Image Removed
  • Click Save.

    • Deploying Role Settings

    Role settings changes

    The deployment steps are complete when all four steps are done.

    Image Removed

    Click the link to view deployment results for errors and other messages.

    1

    - Select the data type

    . Select Data Item(s)

    and 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.)

    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 target 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 data items and target 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

    Tip

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

    Image Removed

                         

    Administrator Functions

    Enable/disable Deploy Content

  • In the CMS, go to Settings → Settings → Content → Deploy Content.
    Image Removed


    • 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 failed for at least one target 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 settings:

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

    2. Click Configure.

    3. In Deploy Sites Feature Settings, toggle ON Role.  
    4. Click Save.

    5. To open the Deploy modalpopup, 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'"