Kampagnen-Verwaltung
Introduction
The "campaign"-extension for Magento2.x supports marketing departments in the planning, in the execution of time-limited sales- and marketing-campaigns and in the related communication with potential campaign participants.
Campaigns visualising all relevant data in several different pages and views like the campaign detail page, the campaign portal page, timeline views etc.
A detailed (email) communication informs the (potential) participants about upcoming, actual and closed campaigns and their detailed status.
Module
extension-name: enobis/campaign
Latest stable version
version: 1.0.3
Install & Update
First you need to add our private repo to your composer.json of your magento installation:
composer config repositories.enobis-your-reponame composer https://satis.enobis.de/customers/your-reponame/
Important: All repos are secured by an ip-protection or an user-authentication. Access Credentials are provided by us!
To install the CHILIconnector-extension use composer via ssh:
composer require enobis/extension-name
To update the CHILIconnector-extension use composer via ssh:
composer update enobis/extension-name
Afterwards you have to complete your Magento2.x installation by
php bin/magento setup:upgrade
php bin/magento setup:di:compile
php bin/magento setup:static-content:deploy
php bin/magento cache:clean
php bin/magento indexer:reindexChangelog
- 1.2.0 optimization - general optimization of related budgets and budget request-functionality
- 1.1.0 feature - budget as payment method incl. related budgets and budget request-functionality
- 1.0.0 Initial Release
Roadmap
- possibility to transfer budget values from the storefront between related budgets
Prerequisites
Our extensions are not available via the magento-marketplace or packagist.org! The extensions are only available via a (private) repository!
In order to get access, a valid license-agreement is required!
If you have no access to our repositories, please contact us!
Addons
The following modules are available as addons:
- n/a
Support
If you need help with one of our extensions, please get in touch with us by sending an email to support@enobis.de.
Features overview
Visualization of campaign related information
Campaigns visualize products and other relevant information. Visualisize information in a chronological context using the timeline widget.
Access to campaigns
Campaigns can be accessed in different ways. The campaign portal page gives an overview about all campaigns. The portal page shows active, past and upcoming campaigns. Additionaly campaigns can be accessed by an optional campaign menu navigation or an campaign widget.
The access to campaigns can be restricted at customer group level, so that only authorized users can access the campaigns.
Support for different campaigns phases
The extension supports different phases during a campaign such as
demand determination phase
production phase
distribution- or sales phase
Campaign related communication
Each campaign phase is flanked by email communication, which informs or remindes users about all relevant campaign information (announcements, reminders, expiration emails).
Participation status
A customer's participation status is tracked by the customer's campaign order.
Visualization of campaign related information
Campaign Portal
The Campaign Portal page provides an overview of all campaigns. It consists of a "Campaign Timeline View", an introductory text and list views of current, past and upcoming campaigns.
"campaign timeline view"
The "campaign timeline view" shows all active campaigns in a timeline view for the next 3 quarters of the year. The campaigns are grouped by their campaign category.
"list views of active, past and upcoming campaigns"
The list views shows campaign filtered by their actual state (active, upcoming and past campaigns).
Campaign Navigation
The "campaign navigation" can be activated optionally and adds extra items to the main navigation.
Each item can be activated separately. These items are
- "Campaigns"-item: Offers a link to the main campaign overview page. All active campaings are added as submenu entries.
- "Active campaigns"-item: Offers a link to campaign page, which shows all active campaigns in an overview page
- "Upcoming campaigns"-item: Offers a link to campaign page, which shows all upcoming campaigns in an overview page
- "Past campaigns"-item: Offers a link to campaign page, which shows all past campaigns in an overview page (archive)
Each overview page shows the campaigns with relevant information in a list view.
Campaign detail page
The campaign detail page shows all relevant information of the campaign. E.g. name of campaign, status of campaign (open, participated, closed), campaign start- and end date, description of campaign, items of campaign in a timeline grid and products of campaign in a grid view. It's also the "access point" to participate in a campaign.
Campaign description
The campaign description gives an overview about the campaign and shows the campaign start- and enddate incl. the actual status of the campaign.
Timeline
The timeline-element shows all time-relevant information in a monthly based timeline view.
The timeline shows
- all relevant timeline information
- a today marker for a better overview
- the campaign in the actual context of the year (upcoming months and quarters)
Product Grids
Products are visualised in product grids (Each phase has a separate product grid). The user can add the products (depends on phase and status) to the cart.
Participation status
A customer's participation status is tracked by the customer's campaign order.
Campaign widgets
The campaign detail page shows all relevant information of the campaign. E.g. name of campaign, status of campaign (open, participated, closed), campaign start- and end date, description of campaign, items of campaign in a timeline grid and products of campaign in a grid view. It's also the "access point" to participate in a campaign.
Access to campaigns
Campaign portal page
Charged budgets will be displayed in the item row of the cart. Please note: Budgets which are for payment won't be shown here. Optional budgets (like optional budgets or budgets configured as payment) are displayed in the "budgets"-step in the checkout (see below).
Backend -> Order
The charged budgets are displayed in the order details. They are displayed in the order item row and additionally in the order-totals too. In this case the order-item is paid by the budget "Default" and additionally the "shipping & handling"-costs are charged too.
Support for different campaigns phases
Different campaign phases
Charged budgets will be displayed in the item row of the cart. Please note: Budgets which are for payment won't be shown here. Optional budgets (like optional budgets or budgets configured as payment) are displayed in the "budgets"-step in the checkout (see below).
Backend -> Order
The charged budgets are displayed in the order details. They are displayed in the order item row and additionally in the order-totals too. In this case the order-item is paid by the budget "Default" and additionally the "shipping & handling"-costs are charged too.
Phase "Demand assesment"
Every transaction of a budget will be stored in a budget record. Different transactions are stored in different records of the budget history. To create a new budget entry you need to define
Possible entry codes for transaction are:
- start (identifies the initial transaction of the budget e.g. budget will be created)
- closing (identifies the last transaction of the budget e.g. budget will be closed)
- adjustment (identifies different transaction (plus/minus) ) e.g. manual adjustment of a budget from the backend
- transfer (reserved for budget transaction between two budgets after a budget request)
- order (reserved for budgets transaction within an order)
- payment (reserved for a budgets transaction for a budget which is used as a payment)
- refund (reserved for a budgets transaction which is a result of an order cancellation)
- bonus code
- deactivation
- request (reserved for requesting budgets amounts at the connected budget (supervisor budget))
- refill (reserved for automatic replenishment)
Each transaction will be stored as a record in the budget history.
Create budget records automatically
The budget-extension offers the possibility to replenish budges in a certain period of time automatically. The budgets will be replenished to the configured "fill" amount at the end of the selected period of time. Possible options are: daily, weekly, monthly or "none".
The refill function creates a budget entry as the difference between your actual and the specified fill quantity.
Phase "Production"
Budgets can be configured as payment too. Available budgets are displayed in the dropdown of the "budget"-payment method in the checkout. The "budget"-payment needs at least one active budget - if not available, the budget-payment method isn't displayed. If the budget is sufficient, the cart amount will be charged to the budget. If it's not sufficient, a checkout is not possbile and a message "Budget is not sufficient" is displayed.
Phase "Order and Release"
Budgets can be configured as payment too. Available budgets are displayed in the dropdown of the "budget"-payment method in the checkout. The "budget"-payment needs at least one active budget - if not available, the budget-payment method isn't displayed. If the budget is sufficient, the cart amount will be charged to the budget. If it's not sufficient, a checkout is not possbile and a message "Budget is not sufficient" is displayed.
Campaign (email) communication
Different campaign phases
Charged budgets will be displayed in the item row of the cart. Please note: Budgets which are for payment won't be shown here. Optional budgets (like optional budgets or budgets configured as payment) are displayed in the "budgets"-step in the checkout (see below).
Backend -> Order
The charged budgets are displayed in the order details. They are displayed in the order item row and additionally in the order-totals too. In this case the order-item is paid by the budget "Default" and additionally the "shipping & handling"-costs are charged too.
Participation status
Participation status
Charged budgets will be displayed in the item row of the cart. Please note: Budgets which are for payment won't be shown here. Optional budgets (like optional budgets or budgets configured as payment) are displayed in the "budgets"-step in the checkout (see below).
Backend -> Order
The charged budgets are displayed in the order details. They are displayed in the order item row and additionally in the order-totals too. In this case the order-item is paid by the budget "Default" and additionally the "shipping & handling"-costs are charged too.
Configuration in detail
Stores->Configuration->Enobis->Campaign->Checkout
Option Type Description Scope Yes, No (Default) Enables/ Disables campaign extension System->Storeview Demand Phase Enabled Yes, No (Default) Enables/ Disables "demand phase" of campaign System->Website Yes, No (Default) Enables/ Disables "production phase" of campaign System->Website Yes, No (Default) Enables/ Disables "product release phase" of campaign
System->Website Block for the overview page Dropdown Block for additional information in campaign System->Storeview Stores->Configuration->Enobis->Budgets->Budget as Payment
Option Type Description Scope Consider Budget Categories Yes, No (Default) By default a budget configured as payment covers all products items of the cart without considering the budget categories. If activated the payment budget covers only product item of matching budget categories. Important: This adds the possibility that the user is not able to pay the whole cart by the budget, because it's covering all cart items! System->Website Stores->Configuration->Enobis->Budgets->Budget Request Info Email
Option Type Description Scope Enabled Yes, No (Default) Possiblity to enable/ disable the "my documents" feature System->Storeview Budget Request Info Email Sender Dropdown list of possible email senders (from email settings)
System->Storeview Dropdown list of possible email templates (Template for budget request (email from customer to supervisor) System->Storeview Dropdown list of possible email templates (Template for budget release templates (email supervisor to customer)
System->Storeview Dropdown Status after order confirmation Please note: Cancelling the order through the supervisor sets the order automatically into the "canceled"-status.
System->Website
Stores->Configuration->Enobis->Budgets->Fill Budgets
Enables an automatic replenishment of budgets in a given period of time.
Option Type Description Scope Enabled Yes, No (Default) Possiblity to enable/ disable the automatic replishment feature for budgets.
Important:
This feature must be activated here and for every budget!
Make sure the magento cron jobs are setup and running properly. Learn more about magento cron jobs.
System->Global Value Default budget value for automatic budget replenishment
System->Global Stores->Configuration->Enobis->Budgets->Automatic Budget Creation
Option Type Description Scope Enabled Yes, No (Default) Possiblity to enable/ disable the "automatic budget creation"-feature System->Storeview Events Multiple Select List of possible events (Magento Events) [Default: Customer registration], after which a budget is created and associated with a customer account.
System->Storeview Dropdown List of possible budgets which is used as a template for the automatic budget creation. Name and value will be copied! System->Storeview
Budget configuration in detail
Customers->Budget->Manage Budgets
Option Type Description Scope string name of budget (think about unique name - used for backend processing)
System->Global string System->Global is active
Yes (Default), No System->Global Dropdown (optional, automatic) - an optional budget is a budget which will be used by the customer manually. Automatic budgets are applied automatically.
System->Global group
Dropdown apply budget group - see topic "budget groups" below
System->Global valid from, valid to - date date Enables the budget for that period of time
System->Global factor value 1 is default. Possibility to use a factor for budget transactions. If you use e.g. 0.5 only 50% of the cart value will be applied to the budget. Important: Only usefull if you are not using budgets as payment (see below), since you won't be able to checkout.
System->Global priority value 0 is default. Priority of appling the cart values to the according budgets. Budgets with higher priority will be charged earlier.
System->Global used for payment Yes, No(Default) Budget will be available in budget-list in the budget-payment in the checkout. Important: If activated, the budget-type must be "optional"!
System->Global automatic correct qty Yes, No(Default) If enabled, the budget acts like a limit and the cart quantities will be adjusted to the maximum possible amount automatically. Important: If activated, the budget-type must be "automatic"!
System->Global Budget can include Shipping Amount Yes, No(Default) If enabled, the shipping amount will be covered by the budget too.
System->Global Info string just an information text (optional)
System->Global free quantity value amount of pieces for free of charge
System->Global fill intervall value (daily, weekly, monthly, disable) possiblity to replenish the budget in a given intervall to the fill amount
System->Global fill amount value budget amount for automatic budget replenishment
System->Global Address Tab with Address related information Optional additional information like
- firstname, lastname, company, street, postcode, city etc.
Important: These additional information has no specific functionality! These are just additional budget related information. E.g. to use in custom exports etc.
System->Global Categories Grid with related budget categories Budget categories give the possibility to apply budgets to certain budget categories. Products are applied to budget categories also. Budgets will be charged by matching "product and customer budget categories". If multiple budgets will be charged - budgets with a higher priority will be charged!
System->Global Related Budgets Grid with related budgets Budget can have a relation with each other. Relations between budgets are necessary if you want to transfer budget values between them. There are two possible ways to transfer budget values
- During payment - If a budget (configured as payment) has not enough value for paying the current cart amount (and it has a relation to another budget), it's possible to request the missing value at the related budget.
- Transfering values between related budgets by creating transactions from the storefront (upcoming feature!)
Important: For creating relations between budgets it's important to know the "direction" (parent-child) of that relation. If you want to create a "request" relation, you need to create the relation from the budgets that requests(child) the value at his parent budget. If you want to create budget relations for transfering values from a parent budget to it's child, you need to create that relation from the parent budget.
System->Global Entries Grid with budget transactions All budget transactions are shown in the budget history
System->Global Customers->Budget->Manage Budgets Categories
Budget Categories will be applied to a budget and a product. Budgets will be charged by matching budget categories. E.g. If a t-shirt is applied to a budget category "marketing" and the budget is applied to that category too, the budget will be charged if the customer adds the product to the cart.
Option Type Description Scope Name String Name of Category System->Global Customers->Budget->Manage Budget Groups
Budget groups are just for your budget management. They have no further functionalities - you can just use them for organizing your budgets internally.
Option Type Description Scope Name String Name of Group
System->Global
Prerequisites
Our extensions are not available via the magento-marketplace or packagist.org! The extensions are only available via a (private) repository!
In order to get access, a valid license-agreement is required!
If you have no access to our repositories, please contact us!
Addons
- enobis/module-quota - restricted product quantities per customer / customer group
Support
If you need help using the CHILIconnector, please get in touch with us by sending an email to support@enobis.de.