Versions Compared

Old Version 10

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.


Image Removed
Info
titleWant this feature?

Locking This is part of Commerce Vision's Franchiser and Multi-site website features. 

Requires 4.38+.

Overview

For multisite control, administrator roles on the deploying site can lock campaigns, or individual objects in a campaign, then deploy these locked statuses to the destination sites. Users on these sites also cannot add, edit or delete a locked object. If a whole campaign is locked, none of its objects can be changed. 

When locking is enabled, locked/unlocked buttons appear against lockable objects. The locked button automatically displays for locked campaigns. Unlocked buttons display only on hover. 

Unlocked campaign

Image Removed

Locked campaign

the CV ecommerce multisite content management feature. Learn more: multisite content management

Overview

You can only deploy a whole campaign. The campaign can be new or already on the target site. For pre-existing campaigns, campaign details will be replaced by deployed data. (This means you can re-deploy the same campaign to make any changes to a previous deployment.)   


Use case: CV Franchise HQ is launching a nationwide sales campaign to promote certain seasonal products for the month of October. Marketing wants consistency in the campaign, from included products to the campaign details. The campaign is to have a banner and slider on the homepage of all franchisee sites from the 1st to 30th of October. In the source site CMS, the campaign is created, locked, and then deployed to all franchisee sites. 


Quick Guide

Source site feature setting: Content Lock AND Deploy Content enabled.

Target site feature setting: For locked deployed campaigns: Content Lock enabled. Otherwise, locked campaigns can be edited or deleted. 

Lockable content type: yes.

Deployable content type: yes.

What can be deployed? locked whole campaigns, unlock status for previously deployed campaigns. 

Campaign data deployed: description, start/end dates, campaign products and sort order

Deployment notes: if the same campaign pre-exists on a target site, campaign details will be replaced by deployed data. SEO URL info for a new deployed campaign must not match any created on a target site. Campaign products with product codes not found on target site will not be deployed.

Other checks: Related content must exist on target site - see tip below. 

How can a deployed campaign be edited or deleted on a target site? Re-deploy campaign on the source site to the target site. This will deploy the unlock status so that target site CMS users can edit or delete it.   




Panel

On this page:

Table of Contents

What can be locked?

A whole campaign

Image Removed 
When a campaign is locked, users who are not Content Administrators/Administrators or are on deployed sites can view a


Campaign Content Locking

Lock/Unlock a Campaign  

With Content Lock enabled on the source (or any site). a lock toggle appears for each campaign on both the Campaigns and Edit Campaign pages. Toggle ON/OFF to lock or unlock a campaign.

Campaign page

Image Added

Edit Campaign page

Image Added


Campaign Data 

Lock or Deploy affects a whole campaign. You cannot lock or deploy only parts of a campaign. Campaign data include:

    • campaign details (description, start/end dates)
    • campaign page SEO details
    • campaign products and sorting order
    • locked/unlocked status  

Campaign Products

Campaign products from the source site catalogue were added when the campaign was created.   

Image Added

Unavailable Products 

If a product code does not exist on a target site, deployment still completes.  

  • If a product code exists but is 'inactive' on the target site, the product is added to the campaign but the campaign will not display that product to customers.
  • If a product code doesn't exist on the target site, it will not be added to the campaign on the target site.
    Image Added 
  • If a campaign product is deleted on the source site and the campaign is re-deployed, the product remains on the target site.

Deploying Locked/Unlocked Status

  • First deployment of a campaign: must be LOCKED. NOTE - The Deploy button will not open the Deploy popup if there are no locked campaigns.
  • LOCKED → UNLOCKED of previously deployed campaign: unlock the campaign, then deploy. Only the unlocked status will be copied over. 
  • UNLOCKED → LOCKED: relock campaign on source site, then deploy. This will deploy the locked status and any data changes since the last deployment.

Locked Campaigns on target sites 

On a target site with Content Locked enabled, users can view a deployed campaign's details but cannot edit or delete it.


Deploy a Campaign

You can deploy a campaign to one or multiple target sites. A deployment's results will record results of: (1) the whole deployment, whether to one or multiple target sites, and (2) for each target site. This can be viewed in the Content Deployment Log.

Info
titleBefore you begin...
  •  On the source site, Content Lock is enabled. For deployed campaigns to be locked on target sites, Content Locked is enabled there.
  •  Campaign to be deployed must initially be LOCKED to be deployable.
  •  Campaign SEO details cannot match those of existing campaigns on a target site or deployment will fail.
  •  Deploying an UNLOCKED status only copies over the unlocked status. No data changes are deployed.
  •  To copy over changes to a deployed campaign, relock the campaign, then deploy.
    •  Campaign product deletions are not deployed.
  •  You cannot delete a deployed campaign.
    •  To prevent a deployed campaign from displaying, re-deploy with a reset past end date/time.
    •  To delete a campaign, deploy the unlocked status, then ask a target site CMS user to delete the campaign. See: Campaigns.  

Tip
titleRelated Content

Remember campaign deployment sends the campaign details only. For deployed campaigns to display properly on a target site, supporting content items need to pre-exist or else be deployed. 

Supporting content objects:

  •  page
, click on the locked campaign to deploy it.
Image Removed
  • Hover over Options and select the Deploy option.

    • Additional Information

    Multiexcerpt
    hiddentrue
    MultiExcerptNameFeature Title

    --

    Minimum Version Requirements
    Multiexcerpt
    MultiExcerptNameMinimum Version Requirements

    4.38

    Prerequisites Multiexcerpt
    MultiExcerptNamePre reqs
    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
    • or template campaign is displayed on, with suitable or same configuration as on source site
    •  products promoted in the campaign

    Learn more: Campaigns



    To deploy a campaign: 

    1. Go to Ecommerce → Campaigns & Promotions → Campaigns.

      Image Added
    2. On the Campaigns page, make sure the campaign(s) to deploy are locked, then click Deploy at the top of the page. 
       Image Added

    3. In the Deploy popup, select one or more campaigns. A campaign's locked/unlocked status is displayed in the icon next to the campaign.
         Image Added

    4. Click Next.

    5. Select target site(s) to deploy the campaign(s) to.
      Image Added
    6. Click Next.

    7. Review the deployment details, then click Deploy.

    8. In Step 4, check whether the whole deployment was successful, partially successful or failed. 

      The popup does not detail results to each target site in multisite deployments. 'Successful' is displayed if all data to all sites was completed.

      Image Added

    Troubleshooting Campaign Deployment

    Non-existent Products

    A deployment will only add a product to a deployed campaign if the product code exists on the target site. If the code is not found, the product is omitted. When this occurs, the deployment will still be flagged as successful. Before deployment, check that products and their codes are available on a target site.  

    Image Added

    SEO URL Naming Conflict

    To ensure SEO URL best practices are kept, deployment will fail if the SEO URL for a deployed campaign matches a pre-existing campaign's on a target site. On the source site, change the SEO URL on the source site, then redeploy.

    Image Added 



    Deploy Campaigns (Admin)

    To enable Deploy Campaigns:

    1. Go to Settings → Settings → Feature Management → Deploy Content.

    2. Click Configure.
      Image Added
    3. In Deployment, toggle ON Campaign Lock. 
      Image Added

    4. Click Save.


    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'"