Configuring Automated Wave Campaigns - Revision history

>Johno at 00:41, 13 February 2016

2016-02-13T00:41:58Z

>Johno: /* Selection Worksheet */

2016-02-13T00:40:27Z

‎Selection Worksheet

>Johno: /* Campaigns Worksheet */

2016-02-12T01:33:18Z

‎Campaigns Worksheet

>Johno: /* Selection Worksheet */

2016-02-12T01:30:20Z

‎Selection Worksheet

>Johno: /* Selection Worksheet */

2016-02-12T01:25:52Z

‎Selection Worksheet

>Johno at 01:14, 12 February 2016

2016-02-12T01:14:54Z

>Johno: /* Selection Worksheet */

2016-02-12T01:14:33Z

‎Selection Worksheet

Show changes

>Johno: /* Selection Worksheet */

2016-02-12T00:55:44Z

‎Selection Worksheet

>Johno: /* Campaigns Worksheet */

2016-02-12T00:47:15Z

‎Campaigns Worksheet

>Johno: Created page with "== Summary == Automated Wave Campaigns are configured in a spreadsheet called '''WaveCampaigns''', located in the ''data/config'' directory. The file contains two global wor..."

2016-02-12T00:26:47Z

Created page with "== Summary == Automated Wave Campaigns are configured in a spreadsheet called '''WaveCampaigns''', located in the ''data/config'' directory. The file contains two global wor..."

New page

== 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:

{| class="wikitable"
| '''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.
|}

# 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.
# The specified path is a sub-directory of ''data/config'' and must exist.
# 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:

{| class="wikitable"
| '''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:

{| class="wikitable"
| '''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:

{| class="wikitable"
| '''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
| 5;17;21
|-
| Welcome
| 5
| Survey
| Export
| MBR_ADDR_DATA
|
|
|}

== Selection Worksheet ==

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

{| class="wikitable"
| '''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:

{| class="wikitable"
| '''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
| 5;17;21
|-
| Welcome
| 5
| Survey
| Export
| MBR_ADDR_DATA
|
|
|}
The configuration file is called VSCampaigns.

{| class="wikitable"
| '''Excel Column (Note)'''
| '''Purpose'''
|-
| NAME (1)
| The unique campaign name.
|-
| START-DATE (2)
| The launch date of the campaign. Leave blank for Wave campaigns.
|-
| PROD_TYPE
| One of: Share, Loan, Service, Member, Dormant.
|-
| PROD_CODES (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:
:# The campaign '''must''' be unique, and must not conflict with any automatically generated 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.
:# 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 ==

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.

@@ Line 59: / Line 59: @@
 | WaveName
 | The unique wave campaign name.
 |-
 | StepName
 | The name of the individual step.
 |-
 | ExportType
@@ Line 251: / Line 251: @@
 # The step '''JoinLetter''' uses the '''Global''' selection and does not have any additional selection criteria.
 # The age restriction is repeated in all steps except '''JoinLetter''' since members under 18 will still get the welcome letter.
 Back to [[Automated Wave Campaigns]].
 Back to [[Campaign Fundamentals]].

@@ Line 215: / Line 215: @@
 | 2
 | Field
-| MBR_TOT_SH_BALANCE
+| MBR_TOTAL_SH_BAL
 | >=5000
 |-
@@ Line 233: / Line 233: @@
 | 2
 | Field
-| MBR_TOT_LN_COUNT
+| MBR_TOTAL_LN_CNT
 | <1
 |-
@@ Line 251: / Line 251: @@
 # The step '''JoinLetter''' uses the '''Global''' selection and does not have any additional selection criteria.
 # The age restriction is repeated in all steps except '''JoinLetter''' since members under 18 will still get the welcome letter.
-# The syntax shown here is currently untested.

@@ Line 176: / Line 176: @@
 | Global
 | 4
 | Field
 | OK_TO_MAIL
@@ Line 194: / Line 188: @@
 | eStatements
 | 1
 | Field
 | eSTATEMENTS
@@ Line 203: / Line 203: @@
+|
+|
 |-
 | CDs
-| 1
+| 2
 | Field
 | MBR_TOT_SH_BALANCE
@@ Line 219: / Line 225: @@
 | 1
 | Field
-| MBR_TOT_SH_BALANCE
+| MBR_ACCOUNT
-| >10000
+| =age(only(Wave_Start_Date), MBR_BIRTH_DATE)>=18
 |-
 | Loans
 | 2
 | Field
 | MBR_CREDIT_SCORE
 | >620
 |}
-# The steps '''JoinLetter''' and '''Survey''' use the '''Global''' selection and do not have any additional selection criteria.
+# The step '''JoinLetter''' uses the '''Global''' selection and does not have any additional selection criteria.
 # The syntax shown here is currently untested.

@@ Line 208: / Line 208: @@
 | Field
 | MBR_TOT_SH_BALANCE
-| >10000
+| >=5000
 |-
+|

← Older revision		Revision as of 01:14, 12 February 2016
Line 231:		Line 231:
	# The steps '''JoinLetter''' and '''Survey''' use the '''Global''' selection and do not have any additional selection criteria.		# The steps '''JoinLetter''' and '''Survey''' use the '''Global''' selection and do not have any additional selection criteria.
	# The syntax shown here is currently untested.		# 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.

@@ Line 60: / Line 60: @@
 | The unique wave campaign name.
 |-
-| CampaignName
+| StepName
-| The name of the campaign for that wave step.
+| The name of the individual step.
 |-
 | Step
@@ Line 130: / Line 130: @@
+|
 |}
 == Selection Worksheet ==

@@ Line 133: / Line 133: @@
 == Selection Worksheet ==
-The '''Campaigns''' worksheet contains one record for each '''step''' of each different wave campaign:
+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.
 {| class="wikitable"

@@ Line 120: / Line 120: @@
 | MBR_ADDR_DATA
 | Loan
-| 5;17;21
+| 21;31;41
 |-
 | Welcome