Versions Compared

Old Version 26

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.
Deployable


Info
titleWant this feature?

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

Quick Guide

Lockable content type: yes.

Deployable content type: yes.

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

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.   

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. The In the source site CMS, the campaign is created on the HQ source site, locked, and then deployed to all franchisee sites. 

Panel

On this page:

Table of Contents

Tip
titleRelated Content

Remember that apart from the campaign itself, other content objects need to be in place on a destination site for the campaign to display properly. 

Supporting content objects for a campaign required include:

  • the page that displays the campaign
  • on that page, a campaign slider widget to render the campaign (locked)
    Image Removed
  • products promoted in the campaign.

These may need to be created, configured and/or deployed.

See: Campaigns

What is Deployable? 

You can only deploy a whole campaign. The campaign can be new or already on the destination site. If the campaign already exists, any campaign data changes will be copied over.   

A campaign must initially be locked to be selectable for deployment. After the first deployment instance, a campaign can be locked or unlocked.    

Campaign Data

To deploy campaign data, the campaign must be locked. No data is deployed when the campaign is unlocked.


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


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:

title
    • campaign details (description, start/end dates)
    • campaign page SEO details
    • products for the campaign
    • change in campaign products and sorting order
    • locked/unlocked status of the campaign  
Info
    • status  

Campaign Products

When a campaign was created, included

Campaign products from the

deploying

source site

's global

catalogue were added

. These are the promoted products in a campaign  Image Removed

when the campaign was created.   

Image Added

Unavailable Products 

If a product

is unavailable on the destination

code does not exist on a target site, deployment

will

still

be flagged 'successful'

completes.  

  • If a product code exists
on the destination site
  • but is 'inactive' on the target site, the product is added to the campaign
. Just like any inactive product,
  • but the campaign will not display that product to customers.
  • If a product code
does not
  • doesn't exist on the
destination
  • target site,
the deployment log entry will add a note that one or more products could not
  • it will not be added to the
copied over
  • campaign on the target site.
 
  • Image Modified 
Campaign
  • 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

To change the status
  • First deployment of a campaign
from locked to unlocked on a destination site, unlock the campaign on the deploying site, then deploy the campaign. The
  • : 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.
NOTE - When an unlocked campaign is deployed, no campaign data are copied over.To relock a campaign on the destination site, lock the campaign on the deploying site, then deploy. The
  •  
  • UNLOCKED → LOCKED: relock campaign on source site, then deploy. This will deploy the locked status and any data changes
are copied over.

Lock/Unlock a Campaign  

When Content Lock is enabled in CMS Feature Settings. a lock toggle displays on a campaign or at the top of an Edit Campaign page. Just toggle ON/OFF to lock and unlock a campaign.

Unlocked campaign

Image Removed

Locked campaign

Image Removed

Locked campaigns on destination sites 

In the CMS on a destination site
  • 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 unlock it for editing or deletingedit or delete it.

Enable Deploy Campaigns


To enable

Deploy

Campaigns:Go to Settings → Settings → Feature Management → Deploy Content.
  • Click Configure.
    Image Removed
    • Enable Campaign Lock. 
    Image Removed
  • Click Save.

    • Deploy a Campaign

    In a deployment event, you You can deploy a single campaign to a single one or multiple sites or multiple campaigns to a single or multiple sites. Success/failure of deployment to each destination site is recorded as a separate instance, and 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
    must be enabled on the deploying and destination sites.
  • A campaign must be locked initially to be deployable.
    • Deploying an unlocked campaign
    • 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
    data changes
    • , relock the campaign
    must be locked.
    • , then deploy.
      •  Campaign product deletions are not deployed.
    A deployed campaign cannot be deleted using the deployment process.
    •  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
    on the destination site,
      • 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 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 E-Commerce 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. 
       

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

    4. Click Next.

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

    7. Review the deployment details, then click Deploy.

    8. On the next screenIn Step 4, check whether the whole deployment to a destination site was successful, partially successful or failed.
      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, such as the non-existence of products selected for the campaign.
      A completely successful deployment:
      Image Removed
      Unavailability of products on destination site message:
      Image Removed
      Failed: If deployment failed for all destination sites, an error message is displayed. Close the Deploy modal. Go to the Content Deployment Log to check for errors. 
      Image Removed

    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

    B2B

    Third Party Costs
    Multiexcerpt
    MultiExcerptNameThird Party Costs
    n/a

    Related help

    1.  

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