Campaign Templates
Campaign templates allow you to save a configuration of a created promotion tier, discount coupon, or gift voucher campaign and recreate it later. Campaign templates help you manage your campaigns by:
- Quickly setting up new campaigns with a similar configuration,
- Making it easier for your team members to create campaigns,
- Copying them to other projects, e.g., moving a campaign configuration from a test environment to a production environment,
- Creating a library of campaigns to be used in the future.
- Modification of validation rules (required if a new validation rule is to be created),
- Modification of customers (required if a new segment is to be created),
- Modification of products (required if a new product collection, product, or SKU is to be created),
- Modification of location (required if a new location is to be created).
Contents
Overview
To create a campaign template, select an existing campaign from the Campaigns tab in the dashboard. In the upper right corner, click on the star-folder image.
You cannot create a template out of a draft campaign.
You can find templates that have already been created in the Campaigns tab of the Campaign Hub section. The list of templates shows details about the campaign template configuration, e.g. the type of the campaign, description, discount effect.
The Templates tab contains information about the template's name, description, campaign type, and creation time.
Clicking on the three dots reveals additional actions connected with the template:
- Create campaign – create a new campaign from the template. You can either leave the configuration as it is or change it.
- Copy – copy the campaign template to a selected project and change its name and description.
- Edit – edit the campaign template’s name and description within the current project.
- Delete – delete the campaign template.
When you create the campaign out of a template in a different project, the template itself is not copied to the campaign template list in the target project. Additionally, when you create a campaign this way, you are automatically switched to the target project.
For promotion tiers, you can create a template based on an existing promotion tier. The promotion tier is saved as a template of a discount campaign. Before a promotion tier can be converted into a template, the promotion campaign must be first saved as a draft or released.
You can only create templates out of individual promotion tiers. The feature does not support creating a template for the whole promotion campaign.
Once the template is created, you can:
- Create a new promotion tier by using any existing promotion tier or discount campaign template.
- Create a new discount campaign by using any existing promotion tier or discount campaign template.
Campaign template object
A template encloses the following elements of campaign configuration:
- Campaign type
- General campaign settings
- Timeframe settings
- Discount settings
- Validation rules – the validation rules are cloned
- Product details (product collection, product, SKU)
- Dynamic segment details
- Location details
- Metadata configuration (product, customer, order, redemption, campaign, voucher, promotion tier)
- Custom event configuration
The following elements are not saved in the template – you have to edit them in the campaign wizard:
- Campaign name
- Category
- Code count
- Access settings in the Areas and Stores (Enterprise feature)
The following elements are not supported by campaign templates:
- Redeeming API keys
- Redeeming users
- Customer loyalty tier
- Static segments
Configuration resources
When you create a campaign from the template, its resources will be created, cloned, or used again.
Expand the Campaign Resource Summary list to see what happens with each resource.
- Resources will be created because they do not exist in the project:
- A validation rule is added because the template is used in a project which does not have it yet.
- An SKU was permanently deleted and it is restored from a template.
- Resources will be created because they have been changed:
- A validation rule used in the template has been changed in the meantime, so it will be created again.
- A static collection used in the template has been changed in the meantime, so it will be created again.
- Resources will be cloned to prevent other campaigns from being affected: An existing validation rule used in the template is copied, so it can be used separately in a new campaign. This prevents changes from being introduced to other campaigns that use the validation rule saved in the template.
- Resources will be used again:
- A product collection is reused in its current state because it already exists in the project and it has not been changed.
- Matching definition:
- A metadata schema in the template has a matching definition in the project so it will be used.
- Missing definition:
- A metadata schema in the template does not have an existing matching definition in the project. However, the resources will keep their metadata even if the definition is missing. Only users with access to metadata schema can create a new schema. Read the Metadata schema and custom event schema section for more details.
Additional notes
When you click Confirm in Campaign Resources Summary, the new resources listed there will be created or cloned, respectively, within the project, even if you leave the campaign creation wizard.
In the campaign wizard, you can replace the resources from the template with other resources that already exist in this project or create new ones.
Only the configuration of the dynamic customer segments is copied. To fill a segment, you can import customers from the other project.
For product collections, the process is the same. However, if the campaign is focused on a specific item and/or its SKUs, they will be created in the new project:
- When discounting a main product, all its SKUs will be recreated in the new project.
- When discounting an SKU, only the selected SKUs will be recreated, including the main product in the new project.
- When the product or SKU has been modified in the meantime in a given project, its current state is used. For example, if the price has been changed from $10 to $15, the product will be reused with the current price of $15 and not copied or recreated with the original $10 price.
Metadata Schema and Custom Event Schema
Definitions of metadata and custom events are never created by copying the template to a different project or if they have been deleted. However, products containing the metadata are completely recreated, meaning all products will have proper metadata.
The template stores information about:
- Metadata: Properties along with their required types.
- Custom Events: Only the names without properties and types.
Schemas, just like other resources, have their own statuses:
- Schemas matched: The schema present in the template matches the schema in the project; the campaign is created from the template.
- Schemas differ: The schema type in the template differs from the one in the project, so the campaign template cannot be created. This outcome is available for metadata schema only. Contact your project administrator or the account owner to modify the metadata definitions in this project.
- Schemas missing: The schema in the project does not correspond to any schema in the project. You can create the campaign from the template; however, the campaign may not work correctly. Ask the project administrator or the account owner to configure the definitions manually or through the Management API (Enterprise feature).
If the metadata types saved in the template differ from those defined in the project, you cannot create a campaign from the template. Contact your account administrator to modify the metadata definitions in this project.