Campaigns
Overview
The Campaign Module in SuiteCRM can be used to send and track different types of Emails, such as Marketing, Transactional and Survey, to selected Targets (Users, Contacts, Targets, Leads & Accounts).
With the tracking tools built into the Campaign Module, you can monitor the response you receive from your Campaign in real time. Allowing you to view recipient activity with your Campaign, such as those that view the email, click through and any blocked Emails.
Create a Campaign
From the Campaigns Module select "Create Campaign" from the module dropdown.
Overview
Name |
The name of the Campaign. |
Start Date |
This is a representative date and does not determine the start of the sending process for the campaign. |
End Date |
This is a representative date and does not determine the end of the sending process for the campaign. |
Description |
Optional Description for the Campaign. |
Suppression Lists |
Suppression Lists will exclude certain targets from your Campaign. If a Suppression List (By Id) is not added on creation, one will be created / added automatically. To see more information on Suppression Lists see here. |
Target Lists |
Lists of potential Targets that your campaign will send to. |
Please note that the Target Lists you select here will be the only Target Lists shown / selectable on the Marketing Record
Budget
Budget |
The budget for the Campaign. |
Expected Cost |
The expected cost of the Campaign. |
Actual Cost |
The actual cost of the Campaign. |
Expected Revenue |
The expected revenue of the Campaign. |
Objective |
The Objective of the Campaign. |
Impressions |
How many impressions the Campaign has had. |
Campaign Charts
Inside the Insights for Campaigns there are two new charts.
Campaign Response By Recipient Activity
Sent/Attempted |
The number of sent Emails. |
Viewed Message |
Of the sent emails, which have been viewed. |
Click-thru Link |
The number of unique users that have clicked-thru. |
Opted Out |
The number of targets that have opted out. |
Campaign Send Status
Message Queue |
The number of Emails currently in the queue to send. |
Sent/Attempted |
The number of sent Emails. |
Suppressed/Blocked |
Of the sent, which have been suppressed / blocked. |
Bounced Messages, Invalid Email |
The number of bounced messages / bounced because of an invalid email. |
Bounced Messages, Other |
The number of bounced messages for other reasons, such as being a duplicate email. |
Campaign Action Table
After creating the Campaign Record, you will see a new "Campaign Actions" table.
This table has four actions:
New Marketing Email |
This action will create a Marketing type Email Marketing Record; this record requires an unsubscribe link in the Email body. To add an unsubscribe link see here. |
New Transactional Email |
This action will create a Transactional type Email Marketing record; this record is required to not have an unsubscribe link within the Email body. |
New Survey Email |
This action will create a Survey type Email Marketing record; this record is also required to have an unsubscribe link. |
New Survey |
This action will create a new Survey. |
Creating an Email Marketing Record
Email Marketing Fields
Status
Draft |
* While in draft, the record will not start sending at the "Scheduled Run Date". * The record is only editable while in draft. * Test Emails can only be sent while in draft. |
Scheduled |
* When scheduled, the record will start sending out Emails in batches (based on the "Number of emails processed/sent per batch" setting) at the "Scheduled Run Date". * This status can be achieved by selecting the "Schedule" button. * To set the record back to draft, select the "Unschedule" button, you cannot do this when the sending process has started. |
Pending Send |
* If the record is "Scheduled" and "Scheduled Run Date" is in the past, the record will show as pending send and will be picked up the next time the Scheduler runs. * While in "pending send", this record can no longer be "Unscheduled". To stop the process, select the "Abort" button. |
Sending |
* This status will show if the Emails are being / have been queued and the sending process has started. * While "sending", this record can no longer be "Unscheduled". To stop the process, select the "Abort" button. |
Sent |
* This will show if all Targets have been sent to / attempted to send to. |
Aborted |
* This will show if the record was aborted during the sending process. |
Queuing Status
Not Started |
* This will show when no emails have been queued from this Email Marketing Record to send. |
In Progress |
* This will show when the Scheduler has picked up this Marketing Record and began queuing emails to send. * The number of emails it queues at a time is based on the "Number of emails processed/sent per batch" setting. |
Finished |
* This will show when all Emails have been queued to send. * Please note, when finished here, sending could still be in process. |
From
This is the Outbound Email that will be used to send from.
Target Lists
The Target Lists selected here will be the Targets that the Email will be sent to when "Scheduled".
Template
You can select an existing email template for this record and edit it after selection or not use one at all.
Scheduled Run Date
This is the scheduled date / time that the sending process will start for the Email Marketing Record.
Trackers Enabled
This is to enable trackers on this Email Marketing Record specifically.
Please Note if trackers are disabled globally, you cannot enable them on an Email Marketing record.
See more information about trackers here.
Duplicate Handling
Prevent sending to duplicate records |
This will prevent sending to the same record if selected on multiple target lists. |
Prevent sending to duplicate records and email addresses |
This will prevent sending to the same email address twice, if two records have the same email, it will only send it to one record, and the other will be blocked. |
Tracker Urls
Tracker URLs can be used to insert a link to your organization’s website or direct link to a new product that you have launched, for example. A unique id is added to the link for each recipient which allows SuiteCRM to track click-thrus.
The information gathered can be viewed collectively on the record charts or, more individually, on the subpanels below the record.
To enable trackers globally, go to the "Campaign Email Settings" via the Admin Menu.
How to add trackers
You can add trackers to your Email Marketing Record by adding a hyperlink via the Campaign Email body field.
Opt Out Tracker
An Opt-Out link allows the recipient to opt out of future Marketing Emails.
To add an opt-out tracker to your Email Marketing Record, you can select the icon:
This will add an unsubscribe link to the email.
Please note: An unsubscribe link is required on both a marketing and survey type Email Marketing record.
Email Marketing Record Actions
Send Test Email
You can send a test email to a User, test Target List or specific Email Address.
By doing this you can view the campaign as a recipient and double-check that it appears as it should.
Test Entries will generate views and click-thrus etc. which can be viewed from the record subpanels and charts.
After sending out test emails, a warning banner will display to show that the data show is test data.
Changing test_email_limit via config.php allows to send more test emails at once. The default for this is 50.
You cannot send a test email after Scheduling.
Delete Test Entries
This will remove all test entries created by sending test emails.
Test entries will be deleted when the record is "Scheduled".
Schedule
This will Schedule the Email Marketing Record to start queuing / sending at the Scheduled Run Date.
Scheduling also deletes test entries.
Please note: The Record CANNOT be edited / updated after scheduling.
Unschedule
Once the record has been scheduled, This action will set the record to Draft and allow the user to make further changes.
The Record can only be unscheduled before the sending process has begun. After this stage the record must be "Aborted" to stop the process.
Abort
This will stop the sending process for the record and will delete everything for this record on the message queue.
Email Marketing Insights
Email Marketing Status Check
Schedulers
This will show the interval for three schedulers related to Campaign Emails.
Send Campaign Emails |
How often will batched Campaign Emails be sent out. |
Queue Campaign Emails |
How often will Campaigns Emails be added in batches to the queue. |
Run Nightly Process Bounced Campaign Emails |
How often will there be a check for bounced campaign emails. |
Inbound Email
This will show you if there is currently an Inbound Email Record that exists that is of type Bounce.
A Bounce record can exist and not be configured correctly, be weary of this if running into issues.
Email Marketing Record Charts
As for the parent Campaign, you can track overall Recipient Activity and Send Status of each Email Marketing Record.
To see more information about the Charts shown, see here.
Campaign Email Subpanels
More information can be viewed in the subpanels below the record, where responses are detailed on an individual record level.
Campaign Settings
You can see the settings for your campaigns via the Admin Menu → "Campaign Email Settings".
On this page you can change different Campaign Settings:
Number of emails marketing records to process per run |
This is the maximum number of Email Marketing Records to process at once time during the Queue and Send Campaign Email Schedulers. |
Number of emails processed/sent per batch |
This is the maximum number of Emails to queue and send per run of Email Marketing Record. |
Trackers Enabled |
This is to enable / disable trackers globally. |
Location of campaign tracking files |
This is to define the location of the campaign tracking files. |
Keep copies of campaign messages |
This is if you want copies of individual Email Marketing Records. |