Skip to content

Commit bf4fb31

Browse files
committed
Rewording to fit the UI changes
1 parent bf9ed15 commit bf4fb31

File tree

3 files changed

+45
-43
lines changed

3 files changed

+45
-43
lines changed

docs/campaigns/creating_campaigns.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ To begin creating Campaigns, perform the following steps:
5151

5252
- **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`.
5353
- **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.
5555
- **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.
5656

5757
#. Click **Launch Campaign Builder** to start building your Campaign, and add at least one event. For information about how to use the Campaign Builder, see :doc:`/campaigns/campaign_builder`.

docs/campaigns/managing_campaigns.rst

Lines changed: 40 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -35,97 +35,99 @@ The **Recent Activity** panel on the right displays the recent activities that h
3535

3636
.. vale off
3737
38-
.. _campaign republish behavior:
38+
.. _campaign reactivate behavior:
3939

40-
Campaign republish behavior
41-
***************************
40+
Campaign reactivation behaviour
41+
********************************
4242

4343
.. vale on
4444
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.
4646

4747
.. note::
4848
This setting only affects events that use relative delays (interval-based scheduling). Events with absolute dates aren't affected by this setting.
4949

50-
Configuring republish behavior
51-
===============================
50+
Configuring reactivation behaviour
51+
===================================
5252

53-
You can configure the republish behavior at two levels:
53+
You can configure the reactivation behaviour at two levels:
5454

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.
5656
2. **Per Campaign** - Set when creating or editing a Campaign. This overrides the global default for that specific Campaign.
5757

58-
Republish behavior options
59-
==========================
58+
Reactivation behaviour options
59+
===============================
6060

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

63-
Count delay regardless of publish state
64-
----------------------------------------
63+
Count delay regardless of activation statetate
64+
-------------------------------------------
6565

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.
6767

6868
**Example scenario:**
6969

7070
- Campaign trigger date: January 1
7171
- Event delay: 10 days
7272
- 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
7575

7676
**Result:** the event still executes on January 11, as originally scheduled.
7777

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.
7979

80-
Restart on republish
81-
--------------------
80+
Restart on reactivation
81+
---------------------
8282

83-
The delay counter resets completely when you republish the Campaign.
83+
The delay counter resets completely when you reactivate the Campaign.
8484

8585
**Example scenario:**
8686

8787
- Campaign trigger date: January 1
8888
- Event delay: 10 days
8989
- 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
9292

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.
9494

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.
9696

97-
Count delay only while published
98-
---------------------------------
97+
Count delay only while active
98+
------------------------------
9999

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.
101101

102102
**Example scenario:**
103103

104104
- Campaign trigger date: January 1
105105
- Event delay: 10 days
106106
- 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)
109109

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).
111111

112112
**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.
113113

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.
116118

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+
==================================
118121

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.
121123

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"
123125

124126
.. 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.
126128

127129
.. 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.
129131

130132
Tracking rescheduled events
131133
===========================

docs/configuration/settings.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -158,15 +158,15 @@ Campaign settings
158158

159159
* **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.
160160

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.
162162

163163
Available options:
164164

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.
166166

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.
168168

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.
170170

171171
Optimal for Contact event scheduler
172172
===================================

0 commit comments

Comments
 (0)