Difference between revisions of "Configuring Campaigns"
>Johno (→Configuration File) |
>Johno (→Configuration File) |
||
| Line 39: | Line 39: | ||
:# 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 START_DATE blank). | ||
| − | * Vital Signs will track campaigns that have been configured in the VSCampaigns file '''plus''' all | + | * 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 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 19:54, 12 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 here 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. |
| 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 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.
- 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).
- 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 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.
