Difference between revisions of "Configuring Automated Wave Campaigns"

From Vital Soft Wiki
Jump to: navigation, search
>Johno
(→‎Selection Worksheet)
>Johno
(→‎Selection Worksheet)
Line 137: Line 137:
 
The column names in this worksheet are the same as a selection worksheet in document distribution.
 
The column names in this worksheet are the same as a selection worksheet in document distribution.
  
−
{| class="wikitable"
+
See [[Defining a Selection|defining a selection]] for more information on how to create a selection.
−
| '''Excel Column (Note)'''
+
 
−
| '''Purpose'''
+
With wave campaigns, an optional '''Global''' selection is followed by an optional selection specific for that step in the wave. The StepName is used as the selection name.
−
|-
 
−
| WaveName
 
−
| The unique wave campaign name.
 
−
|-
 
−
| CampaignName
 
−
| The name of the campaign for that wave step.
 
−
|-
 
−
| Step
 
−
| The step number.
 
−
|-
 
−
| ExportType
 
−
| The export type is usually '''Export''', but can be any type supported by document distribution.
 
−
|-
 
−
| Definition
 
−
| The ID of the object being exported. Usually one of MBR_ADDR_DATA or MBR_PHONE_DATA.
 
−
|-
 
−
| ProdType
 
−
| The product type being promoted.  One of: Share, Loan or Service.
 
−
|-
 
−
| ProdCodes
 
−
| A list of valid product codes.
 
−
|}
 
  
−
For example, the Welcome wave campaign might look like this:
+
The following table shows an example for the Welcome wave campaign:
  
 
{| class="wikitable"
 
{| class="wikitable"
−
| '''WaveName'''
+
| '''Name'''
 
| '''Step'''
 
| '''Step'''
−
| '''CampaignName'''
+
| '''Type'''
−
| '''ExportType'''
+
| '''TypeName'''
−
| '''Definition'''
+
| '''TypeValue'''
−
| '''ProdType'''
 
−
| '''ProdCodes'''
 
 
|-
 
|-
−
| Welcome
+
| Global
 
| 1
 
| 1
−
| JoinLetter
+
| SetVar
−
| Export
+
| OpenStartDate
−
| MBR_PHONE_DATA
+
| =Date(MonthStart(Only(Wave_Start_Date)),'YYYY-MM-DD')
−
|  
+
|-
−
|  
+
| Global
 +
| 2
 +
| SetVar
 +
| OpenEndDate
 +
| =Date(MonthEnd(Only(Wave_Start_Date)),'YYYY-MM-DD')
 
|-
 
|-
−
| Welcome
+
| Global
 
| 2
 
| 2
−
| eStatements
+
| SetVar
−
| Export
+
| OpenEndDate
−
| MBR_ADDR_DATA
+
| =Date(MonthEnd(Only(Wave_Start_Date)),'YYYY-MM-DD')
−
| Service
 
−
| 79
 
 
|-
 
|-
−
| Welcome
+
| Global
 
| 3
 
| 3
−
| CDs
+
| Field
−
| Export
+
| MBR_OPEN_DATE
−
| MBR_ADDR_DATA
+
| >=$(OpenStartDate)<=$(OpenEndDate)
−
| Share
 
−
| C06;C12;C18;C24
 
 
|-
 
|-
−
| Welcome
+
| Global
 
| 4
 
| 4
−
| Loans
+
| Field
−
| Export
+
| MBR_ACCOUNT
−
| MBR_ADDR_DATA
+
| =age(only(Wave_Start_Date), MBR_BIRTH_DATE)>=18
−
| Loan
 
−
| 5;17;21
 
 
|-
 
|-
−
| Welcome
+
| Global
 
| 5
 
| 5
−
| Survey
+
| Field
−
| Export
+
| OK_TO_MAIL
−
| MBR_ADDR_DATA
+
| Yes
 +
|-
 
|  
 
|  
 
|  
 
|  
−
|}
+
|  
−
The configuration file is called VSCampaigns. 
+
|
−
 
+
|
−
{| class="wikitable"
+
|-
−
| '''Excel Column (Note)'''
+
| eStatements
−
| '''Purpose'''
+
| 1
 +
| Field
 +
| eSTATEMENTS
 +
| No
 
|-
 
|-
−
| NAME (1)
+
|  
−
| The unique campaign name.
+
|  
 +
|
 +
|
 +
|
 
|-
 
|-
−
| START-DATE (2)
+
| CDs
−
| The launch date of the campaign.  Leave blank for Wave campaigns.
+
| 1
 +
| Field
 +
| MBR_TOT_SH_BALANCE
 +
| >10000
 
|-
 
|-
−
| PROD_TYPE
+
|  
−
| One of:  Share, Loan, Service, Member, Dormant.
+
|  
 +
|
 +
|
 +
|
 
|-
 
|-
−
| PROD_CODES (3)
+
| Loans
−
| The specific product code(s) for the target product.
+
| 1
 +
| Field
 +
| MBR_TOT_SH_BALANCE
 +
| >10000
 
|-
 
|-
−
| FILENAME (4)
+
| Loans
−
| The name of a file containing the members who are part of the campaign.
+
| 2
 +
| Field
 +
| MBR_CREDIT_SCORE
 +
| >620
 
|}
 
|}
  
−
:Notes:
+
# The steps '''JoinLetter''' and '''Survey''' use the '''Global''' selection and do not have any additional selection criteria.
−
:# The campaign '''must''' be unique, and must not conflict with any automatically generated wave campaign names.
+
# The syntax shown here is currently untested.
−
:# 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.
 
−
:# 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.
 
−
 
 
−
* Vital Signs will track campaigns that have been configured in the VSCampaigns file '''plus''' all automatically generated wave campaigns configured in 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 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.

Revision as of 01:14, 12 February 2016

Summary

Automated Wave Campaigns are configured in a spreadsheet called WaveCampaigns, located in the data/config directory.

The file contains two global worksheets (tabs) called WaveConfig and Campaigns, plus an additional worksheet (tab) for each Wave name. For example, a wave campaign called Welcome, will include a worksheet called Welcome containing all of the specific selection criteria needed to execute all steps of the wave campaign.

WaveConfig Worksheet

The WaveConfig worksheet contains one record for each different wave campaign:

Excel Column (Note) Purpose
WaveName The unique wave campaign name.
WaveStartDays (1) The ending month day number the wave uses. May be a semi-colon delimited list if the wave runs multiple times per month.
WaveMaxSteps The maximum number of steps executed by this wave campaign.
WaveFilePath (2) The output file path where the wave files are created.
WaveEmailList (3) A semi-colon delimited list of email addresses to receive confirmation that the wave files were created.
  1. This day number represents the day the wave was created and may be used as part of the selection criteria. If the wave runs more than once per month, this is a semi-colon delimited list.
  2. The specified path is a sub-directory of data/config and must exist.
  3. Not all configurations support email notifications. Since GenWaveData uses the Vital Signs document distribution engine, the ViewDocLog document is a good way to review the results of GenWaveData.

For example, a Welcome wave campaign might look like this:

WaveName WaveStartDays WaveMaxSteps WaveFilePath WaveEmailList
Welcome 15 5 WelcomeWave

Campaigns Worksheet

The Campaigns worksheet contains one record for each step of each different wave campaign:

Excel Column (Note) Purpose
WaveName The unique wave campaign name.
CampaignName The name of the campaign for that wave step.
Step The step number.
ExportType The export type is usually Export, but can be any type supported by document distribution.
Definition The ID of the object being exported. Usually one of MBR_ADDR_DATA or MBR_PHONE_DATA.
ProdType The product type being promoted. One of: Share, Loan or Service.
ProdCodes A list of valid product codes.

For example, the Welcome wave campaign might look like this:

WaveName Step CampaignName ExportType Definition ProdType ProdCodes
Welcome 1 JoinLetter Export MBR_PHONE_DATA
Welcome 2 eStatements Export MBR_ADDR_DATA Service 79
Welcome 3 CDs Export MBR_ADDR_DATA Share C06;C12;C18;C24
Welcome 4 Loans Export MBR_ADDR_DATA Loan 21;31;41
Welcome 5 Survey Export MBR_ADDR_DATA

Selection Worksheet

Each wave campaign needs a Selection worksheet to specify the selection criteria for each step of the wave. The worksheet name is the same as the WaveName.

The column names in this worksheet are the same as a selection worksheet in document distribution.

See defining a selection for more information on how to create a selection.

With wave campaigns, an optional Global selection is followed by an optional selection specific for that step in the wave. The StepName is used as the selection name.

The following table shows an example for the Welcome wave campaign:

Name Step Type TypeName TypeValue
Global 1 SetVar OpenStartDate =Date(MonthStart(Only(Wave_Start_Date)),'YYYY-MM-DD')
Global 2 SetVar OpenEndDate =Date(MonthEnd(Only(Wave_Start_Date)),'YYYY-MM-DD')
Global 2 SetVar OpenEndDate =Date(MonthEnd(Only(Wave_Start_Date)),'YYYY-MM-DD')
Global 3 Field MBR_OPEN_DATE >=$(OpenStartDate)<=$(OpenEndDate)
Global 4 Field MBR_ACCOUNT =age(only(Wave_Start_Date), MBR_BIRTH_DATE)>=18
Global 5 Field OK_TO_MAIL Yes
eStatements 1 Field eSTATEMENTS No
CDs 1 Field MBR_TOT_SH_BALANCE >10000
Loans 1 Field MBR_TOT_SH_BALANCE >10000
Loans 2 Field MBR_CREDIT_SCORE >620
  1. The steps JoinLetter and Survey use the Global selection and do not have any additional selection criteria.
  2. The syntax shown here is currently untested.

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.

Retrieved from "https://wiki.vital-soft.com/index.php?title=Configuring_Automated_Wave_Campaigns&oldid=2479"