Difference between revisions of "Configuring Campaigns"

From Vital Soft Wiki
Jump to: navigation, search
>Johno
(Configuration File)
>Johno
(Creating Campaign Files)
 
(10 intermediate revisions by the same user not shown)
Line 1: Line 1:
== Summary ==
+
=Summary=
  
 
Before a campaign can be tracked, it must be added to the VSCampaigns master spreadsheet.
 
Before a campaign can be tracked, it must be added to the VSCampaigns master spreadsheet.
Line 7: Line 7:
 
This spreadsheet is located in the ''data/config'' directory and is described below.
 
This spreadsheet is located in the ''data/config'' directory and is described below.
  
Note: [[Automated Wave Campaigns]] (GenWaveData) should not be included here since they are defined in the WaveCampaigns configuration file.
+
Note: [[Automated Wave Campaigns]] (GenWaveData) should '''not''' be included since they are defined in the WaveCampaigns configuration file.
  
== Configuration File ==
+
=Configuration File=
  
 
The configuration file for all campaigns (except automated wave campaigns) is called VSCampaigns.   
 
The configuration file for all campaigns (except automated wave campaigns) is called VSCampaigns.   
Line 17: Line 17:
 
| '''Purpose'''
 
| '''Purpose'''
 
|-
 
|-
| NAME (1)
+
| Name (1)
 
| The unique campaign name.
 
| The unique campaign name.
 
|-
 
|-
| START-DATE (2)
+
| StartDate (2)
 
| The launch date of the campaign.  Leave blank for Wave campaigns.
 
| The launch date of the campaign.  Leave blank for Wave campaigns.
 
|-
 
|-
| PROD_TYPE
+
| ProdType
 
| One of:  Share, Loan, Service, Member, Dormant.
 
| One of:  Share, Loan, Service, Member, Dormant.
 
|-
 
|-
| PROD_CODES (3)
+
| ProdCodes (3)
 
| The specific product code(s) for the target product.
 
| The specific product code(s) for the target product.
 
|-
 
|-
| FILENAME (4)
+
| Filename (4)
 
| The name of a file containing the members who are part of the campaign.
 
| The name of a file containing the members who are part of the campaign.
 
|}
 
|}
Line 35: Line 35:
 
:Notes:
 
:Notes:
 
:# The campaign '''must''' be unique, and must not conflict with any automated wave campaign names.
 
:# The campaign '''must''' be unique, and must not conflict with any automated wave campaign names.
:# Standard campaigns have a single start date which is entered here.  Since wave campaigns have multiple start dates, no start date should be entered here.  The start date of a wave campaign '''must''' be appended to the FILENAME in the form YYYYMMDD.
+
:# Standard campaigns have a single start date which is entered here.  Since wave campaigns have multiple start dates, no start date should be entered here.  The start date of a wave campaign '''must''' be appended to the filename in the form YYYYMMDD.
 
:# For Share, Loan and Service campaigns, the target product(s) must be identified here.  The field should contain a semi-colon delimited list of share desc-abrv(s), loan collateral code(s) or service control flag number(s).  Leave blank for Member and Dormant campaigns.
 
:# For Share, Loan and Service campaigns, the target product(s) must be identified here.  The field should contain a semi-colon delimited list of share desc-abrv(s), loan collateral code(s) or service control flag number(s).  Leave blank for Member and Dormant campaigns.
:# Enter the name of the file in ''data/config/Campaigns'' that identifies the members who received the campaign.  If this is a '''manually''' generated wave campaign, enter the file name prefix.  The actual filenames will be this prefix followed by the start date in the format YYYYMMDD.  For example, if the actual files are called NewIRAPromo20160315, NewIRAPromo20160615 and NewIRAPromo20160915, enter NewIRAPromo as the filename (and leave the START_DATE blank).   
+
:# Enter the name of the file in ''data/config/Campaigns'' that identifies the members who received the campaign.  If this is a '''manually''' generated wave campaign, enter the file name prefix.  The actual filenames will be this prefix followed by the start date in the format YYYYMMDD.  For example, if the actual files are called NewIRAPromo20160315, NewIRAPromo20160615 and NewIRAPromo20160915, enter NewIRAPromo as the filename (and leave the StartDate blank).   
  
* Vital Signs will track campaigns that have been configured in the VSCampaigns file '''plus''' all automatically generated wave campaigns configured in WaveCampaigns.
+
* Vital Signs will track campaigns that have been configured in the VSCampaigns file '''plus''' all automated wave campaigns configured in [[Automated Wave Campaigns|WaveCampaigns]].
  
==FILENAME Layout==
+
==Filename Layout==
  
For all campaigns (except New Member), the file '''must''' contain a list of member account numbers in a column called MBR_ACCOUNT.  The file may contain other columns, but only the MBR_ACCOUNT column is required/used.  The file must be stored in the ''data/config/Campaigns'' directory.  For New Member campaigns designed to attract new members to the Credit Union, the file will have a different layout described here.
+
For all campaigns (except New Member), the file '''must''' contain a list of member account numbers in a column called Account or MBR_ACCOUNT.  The file may contain other columns, but only the Account column is required/used.  The file must be stored in the ''data/config/Campaigns'' directory.  For New Member campaigns designed to attract new members to the Credit Union, the file will have a different layout described here.
 +
 
 +
=Creating Campaign Files=
 +
 
 +
The Membership Analysis document is designed to select members for a marketing campaign.  It is easy to select members with/without certain products, as well select members by their age or location.  The ''OK to Mail'' attribute should also be used for most campaigns.
 +
 
 +
Once the appropriate members have been selected:
 +
* Open the ''View Details'' tab
 +
* Export the ''Account Address Info'' table to Excel.
 +
:The file you export, can be edited (columns removed) before you send it for processing.
 +
 
 +
'''The following steps are required to track the campaign results in Vital Signs:'''
 +
* Edit the campaign data file (created by the export above) and delete '''all columns except the Account number'''.
 +
* Save the file in ''data/config/Campaigns'' with a meaningful name.
 +
:* If this is a campaign that will be repeated (a wave campaign), the name must finish with the current date in CCYYMMDD format.  (For example, NewIRAPromo20160815.xlsx.)
 +
* Edit VSCampaigns and add a row to describe the campaign (see above).
 +
:* Include the name of the file you just saved.
 +
:* If this is a new step for an existing wave campaign there is no need to update VSCampaigns (the campaign should already be listed).
 +
 
 +
 
 +
 
 +
Back to [[Campaign Fundamentals]].

Latest revision as of 00:42, 13 February 2016

Summary

Before a campaign can be tracked, it must be added to the VSCampaigns master spreadsheet.

Each campaign is assigned a name, start date, target product information and the name of a file that contains the member account numbers that were part of the campaign.

This spreadsheet is located in the data/config directory and is described below.

Note: Automated Wave Campaigns (GenWaveData) should not be included since they are defined in the WaveCampaigns configuration file.

Configuration File

The configuration file for all campaigns (except automated wave campaigns) is called VSCampaigns.

Excel Column (Note) Purpose
Name (1) The unique campaign name.
StartDate (2) The launch date of the campaign. Leave blank for Wave campaigns.
ProdType One of: Share, Loan, Service, Member, Dormant.
ProdCodes (3) The specific product code(s) for the target product.
Filename (4) The name of a file containing the members who are part of the campaign.
Notes:
  1. The campaign must be unique, and must not conflict with any automated wave campaign names.
  2. Standard campaigns have a single start date which is entered here. Since wave campaigns have multiple start dates, no start date should be entered here. The start date of a wave campaign must be appended to the filename in the form YYYYMMDD.
  3. For Share, Loan and Service campaigns, the target product(s) must be identified here. The field should contain a semi-colon delimited list of share desc-abrv(s), loan collateral code(s) or service control flag number(s). Leave blank for Member and Dormant campaigns.
  4. Enter the name of the file in data/config/Campaigns that identifies the members who received the campaign. If this is a manually generated wave campaign, enter the file name prefix. The actual filenames will be this prefix followed by the start date in the format YYYYMMDD. For example, if the actual files are called NewIRAPromo20160315, NewIRAPromo20160615 and NewIRAPromo20160915, enter NewIRAPromo as the filename (and leave the StartDate blank).
  • Vital Signs will track campaigns that have been configured in the VSCampaigns file plus all automated wave campaigns configured in WaveCampaigns.

Filename Layout

For all campaigns (except New Member), the file must contain a list of member account numbers in a column called Account or MBR_ACCOUNT. The file may contain other columns, but only the Account column is required/used. The file must be stored in the data/config/Campaigns directory. For New Member campaigns designed to attract new members to the Credit Union, the file will have a different layout described here.

Creating Campaign Files

The Membership Analysis document is designed to select members for a marketing campaign. It is easy to select members with/without certain products, as well select members by their age or location. The OK to Mail attribute should also be used for most campaigns.

Once the appropriate members have been selected:

  • Open the View Details tab
  • Export the Account Address Info table to Excel.
The file you export, can be edited (columns removed) before you send it for processing.

The following steps are required to track the campaign results in Vital Signs:

  • Edit the campaign data file (created by the export above) and delete all columns except the Account number.
  • Save the file in data/config/Campaigns with a meaningful name.
  • If this is a campaign that will be repeated (a wave campaign), the name must finish with the current date in CCYYMMDD format. (For example, NewIRAPromo20160815.xlsx.)
  • Edit VSCampaigns and add a row to describe the campaign (see above).
  • Include the name of the file you just saved.
  • If this is a new step for an existing wave campaign there is no need to update VSCampaigns (the campaign should already be listed).


Back to Campaign Fundamentals.