You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/campaigns/creating_campaigns.rst
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -51,7 +51,7 @@ To begin creating Campaigns, perform the following steps:
51
51
52
52
- **Category** - Choose a Category to assign your Campaign to. Categories help you organize your Campaigns. To learn more about creating and managing Categories, see :doc:`/categories/categories-overview`.
53
53
- **Allow Contacts to restart the Campaign** - Click the toggle switch to allow Contacts to restart the Campaign if you're building a Campaign for a recurring message - for example birthdays, subscriptions - or transactional operations - for example activity notifications, updating data. Enabling this option allows Contacts to go through the same Campaign multiple times.
54
-
- **Campaign Republish Behaviour** - Configure how scheduled events with relative delays should behave when the Campaign is republished after being unpublished. You can override the global default setting for this specific Campaign. See :ref:`Campaign Republish Behavior<campaign republish behavior>` for more information about the available options.
54
+
- **Campaign Reactivation Behaviour** - Configure how scheduled events with relative delays should behave when the Campaign is reactivated after being deactivated. You can override the global default setting for this specific Campaign. See :ref:`Campaign Reactivation Behaviour<campaign reactivate behavior>` for more information about the available options.
55
55
- **Active** - Click the toggle switch to turn the Campaign on or off. Ensure that you don't activate a Campaign until you're actually ready for it to go live. You can also schedule to activate or deactivate a Campaign at a future date by selecting a time and date.
56
56
57
57
#. Click **Launch Campaign Builder** to start building your Campaign, and add at least one event. For information about how to use the
Copy file name to clipboardExpand all lines: docs/campaigns/managing_campaigns.rst
+40-38Lines changed: 40 additions & 38 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -35,97 +35,99 @@ The **Recent Activity** panel on the right displays the recent activities that h
35
35
36
36
.. vale off
37
37
38
-
.. _campaign republish behavior:
38
+
.. _campaign reactivate behavior:
39
39
40
-
Campaign republish behavior
41
-
***************************
40
+
Campaign reactivation behaviour
41
+
********************************
42
42
43
43
.. vale on
44
44
45
-
When you Unpublish and then republish a Campaign, Mautic provides control over how scheduled events with relative delays - such as "Send Email 5 days after joining" - should behave. This feature gives you flexibility in managing Campaign timing based on your specific use case.
45
+
When you deactivate and then reactivate a Campaign, Mautic provides control over how scheduled events with relative delays - such as "Send Email 5 days after joining" - should behave. This feature gives you flexibility in managing Campaign timing based on your specific use case.
46
46
47
47
.. note::
48
48
This setting only affects events that use relative delays (interval-based scheduling). Events with absolute dates aren't affected by this setting.
49
49
50
-
Configuring republish behavior
51
-
===============================
50
+
Configuring reactivation behaviour
51
+
===================================
52
52
53
-
You can configure the republish behavior at two levels:
53
+
You can configure the reactivation behaviour at two levels:
54
54
55
-
1. **Global default** - Set in Configuration > Campaign Settings > Campaign Republish Behaviour. This applies to all Campaigns unless overridden.
55
+
1. **Global default** - Set in Configuration > Campaign Settings > Campaign Reactivation Behaviour. This applies to all Campaigns unless overridden.
56
56
2. **Per Campaign** - Set when creating or editing a Campaign. This overrides the global default for that specific Campaign.
57
57
58
-
Republish behavior options
59
-
==========================
58
+
Reactivation behaviour options
59
+
===============================
60
60
61
-
There are three options available for how scheduled events should behave after republishing:
61
+
There are three options available for how scheduled events should behave after reactivation:
62
62
63
-
Count delay regardless of publish state
64
-
----------------------------------------
63
+
Count delay regardless of activation statetate
64
+
-------------------------------------------
65
65
66
-
This is the default behavior. The original trigger date is used and unpublished time doesn't affect scheduling.
66
+
This is the default behaviour. The original trigger date is used and inactive time doesn't affect scheduling.
67
67
68
68
**Example scenario:**
69
69
70
70
- Campaign trigger date: January 1
71
71
- Event delay: 10 days
72
72
- Calculated event date: January 11
73
-
- Campaign unpublished: January 5
74
-
- Campaign republished: January 7
73
+
- Campaign deactivated: January 5
74
+
- Campaign reactivated: January 7
75
75
76
76
**Result:** the event still executes on January 11, as originally scheduled.
77
77
78
-
**When to use:** this option maintains the original scheduled timing, treating the Campaign's publish state as irrelevant to the delay calculation. Use this when you want consistency with the original schedule, or when temporarily using Unpublish on a Campaign shouldn't affect when events execute.
78
+
**When to use:** this option maintains the original scheduled timing, treating the Campaign's activation state as irrelevant to the delay calculation. Use this when you want consistency with the original schedule, or when temporarily deactivating a Campaign shouldn't affect when events execute.
79
79
80
-
Restart on republish
81
-
--------------------
80
+
Restart on reactivation
81
+
---------------------
82
82
83
-
The delay counter resets completely when you republish the Campaign.
83
+
The delay counter resets completely when you reactivate the Campaign.
84
84
85
85
**Example scenario:**
86
86
87
87
- Campaign trigger date: January 1
88
88
- Event delay: 10 days
89
89
- Original calculated event date: January 11
90
-
- Campaign unpublished: January 5
91
-
- Campaign republished: January 7
90
+
- Campaign deactivated: January 5
91
+
- Campaign reactivated: January 7
92
92
93
-
**Result:** the event is rescheduled to execute 10 days after republishing, on January 17.
93
+
**Result:** the event is rescheduled to execute 10 days after reactivation, on January 17.
94
94
95
-
**When to use:** this option is useful when you want to ensure all Contacts receive the full intended delay after any Campaign changes. For example, if you Unpublish a Campaign to make significant updates and want everyone to experience the complete updated workflow timing.
95
+
**When to use:** this option is useful when you want to ensure all Contacts receive the full intended delay after any Campaign changes. For example, if you deactivate a Campaign to make significant updates and want everyone to experience the complete updated workflow timing.
96
96
97
-
Count delay only while published
98
-
---------------------------------
97
+
Count delay only while active
98
+
------------------------------
99
99
100
-
Events only count days when the Campaign is published. Unpublished periods don't count toward the delay.
100
+
Events only count days when the Campaign is active. Inactive periods don't count toward the delay.
101
101
102
102
**Example scenario:**
103
103
104
104
- Campaign trigger date: January 1
105
105
- Event delay: 10 days
106
106
- Original calculated event date: January 11
107
-
- Campaign unpublished: January 5 (after 4 days published)
108
-
- Campaign republished: January 10 (after 5 days unpublished)
107
+
- Campaign deactivated: January 5 (after 4 days active)
108
+
- Campaign reactivated: January 10 (after 5 days inactive)
109
109
110
-
**Result:** the event is rescheduled to execute on January 16. The 4 days while published (January 1-5) count toward the 10-day delay, leaving 6 more days needed after republishing (January 10 + 6 days = January 16).
110
+
**Result:** the event is rescheduled to execute on January 16. The 4 days while active (January 1-5) count toward the 10-day delay, leaving 6 more days needed after reactivation (January 10 + 6 days = January 16).
111
111
112
112
**When to use:** this option is ideal when you want precise control over the actual time Contacts spend in an active Campaign state. Use this for compliance scenarios, trial periods, or when you need to pause Campaigns without affecting the intended engagement timeline.
113
113
114
-
Viewing last publish date
115
-
=========================
114
+
Viewing last activation date
115
+
=============================
116
+
117
+
On the Campaign details page, you can see the **Last Publish Date** which indicates when the Campaign was most recently activated. This date is used as the reference point for the "Restart on reactivate" option to recalculate scheduled event timings.
116
118
117
-
On the Campaign details page, you can see the **Last Publish Date** which indicates when the Campaign was most recently published. This date is used as the reference point for the "Restart on republish" option to recalculate scheduled event timings.
119
+
Activate and deactivate Campaigns
120
+
==================================
118
121
119
-
Publish and Unpublish Campaigns
120
-
======================================
122
+
When you activate or deactivate a Campaign, Mautic displays a confirmation message that shows the current reactivation behaviour setting. This helps you understand what happens to scheduled events before you confirm the action.
121
123
122
-
When you publish or Unpublish a Campaign, Mautic displays a confirmation message that shows the current republish behavior setting. This helps you understand what happens to scheduled events before you confirm the action.
124
+
For example: "All scheduled events execute according to the reactivation behaviour setting. Currently set to: Count delay regardless of activation state"
123
125
124
126
.. warning::
125
-
When you Unpublish a Campaign, all processing of Contacts and Campaign events - including scheduled events - stops immediately. Scheduled events remain in the queue but won't execute until you republish the Campaign.
127
+
When you deactivate a Campaign, all processing of Contacts and Campaign events - including scheduled events - stops immediately. Scheduled events remain in the queue but won't execute until you reactivate the Campaign.
126
128
127
129
.. note::
128
-
The recalculation of scheduled events happens when the Campaign event log is being evaluated by the Cron job, not at the moment you republish the Campaign. This means that if a recalculated trigger date is still in the past when evaluated, the event executes immediately. If it's in the future, the event is rescheduled accordingly.
130
+
The recalculation of scheduled events happens when the Campaign event log is being evaluated by the Cron job, not at the moment you reactivate the Campaign. This means that if a recalculated trigger date is still in the past when evaluated, the event executes immediately. If it's in the future, the event is rescheduled accordingly.
Copy file name to clipboardExpand all lines: docs/configuration/settings.rst
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -158,15 +158,15 @@ Campaign settings
158
158
159
159
* **Use summary statistics** - Improves performance when viewing a Campaign with thousands of events per day by using summarized data. When you first turn on this setting you need to run a :ref:`Cron job<campaign cron jobs>` to summarize existing data.
160
160
161
-
* **Campaign Republish Behaviour** - Configure how scheduled events with relative delays in the middle of the workflow should behave when the Campaign is republished after being unpublished for a while. This setting provides a global default that can be overridden per Campaign. See :ref:`Campaign Republish Behavior<campaign republish behavior>` for more information.
161
+
* **Campaign Reactivation Behaviour** - Configure how scheduled events with relative delays in the middle of the workflow should behave when the Campaign is reactivated after being deactivated for a while. This setting provides a global default that can be overridden per Campaign. This setting affects how the :ref:`Campaign cron jobs<campaign cron jobs>` schedule events. See :ref:`Campaign Reactivation Behaviour<campaign reactivate behavior>` for more information.
162
162
163
163
Available options:
164
164
165
-
- **Count delay regardless of publish state** - The original trigger date is used. Events execute based on the calendar days from when they were originally scheduled, regardless of whether the Campaign was published or unpublished during that period. This is the default behavior.
165
+
- **Count delay regardless of activation state** - The original trigger date is used. Events execute based on the calendar days from when they were originally scheduled, regardless of whether the Campaign was active or inactive during that period. This is the default behaviour.
166
166
167
-
- **Restart on republish** - The delay counter resets when the Campaign is republished. Events are rescheduled to execute the full delay period after the last publish date.
167
+
- **Restart on reactivation** - The delay counter resets when the Campaign is reactivated. Events are rescheduled to execute the full delay period after the last activation date.
168
168
169
-
- **Count delay only while published** - Events only count days when the Campaign is published. If the Campaign is unpublished, those days don't count toward the delay, and events are rescheduled accordingly when the Campaign is republished.
169
+
- **Count delay only while active** - Events only count days when the Campaign is active. If the Campaign is inactive, those days don't count toward the delay, and events are rescheduled accordingly when the Campaign is reactivated.
0 commit comments