Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Publish/unpublish to active #304

Merged
merged 14 commits into from
Jun 14, 2024
Merged
4 changes: 2 additions & 2 deletions docs/campaigns/creating_campaigns.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Creating Campaigns

.. vale on

Creating Campaigns is a central part of the marketing automation process. When you create a new Campaign, you perform the basic administrative tasks such as choosing a name for the Campaign, creating a description, assigning a Category and defining publishing information for the Campaign.
Creating Campaigns is a central part of the marketing automation process. When you create a new Campaign, you perform the basic administrative tasks such as choosing a name for the Campaign, creating a description, assigning a Category and defining activating information for the Campaign.

At the heart of any marketing automation Campaign is the Campaign Builder. This allows you to specify how Contacts enter the Campaign, and what happens at every point after they enter the workflow.

Expand Down Expand Up @@ -51,7 +51,7 @@ To begin creating Campaigns, perform the following steps:

- **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`.
- **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.
- **Published** - Click the toggle switch to publish or un-publish the Campaign. Ensure that you don't publish a Campaign until you're actually ready for it to go live. You can also schedule to publish or un-publish a Campaign at a future date by selecting a time and date.
- **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.

#. 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/creating_campaigns`.
Expand Down
2 changes: 1 addition & 1 deletion docs/campaigns/managing_campaigns.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ The following image shows a sample Campaign overview with its highlighted panels
:width: 600
:alt: Screenshot showing the Campaign overview

The **Details** drop-down menu gives a quick overview of the most important information about your Campaign. This information includes the name of the User who created the Campaign, Category of the Campaign, creation date and time, publishing date and time, Contact Segments in your Campaign and more.
The **Details** drop-down menu gives a quick overview of the most important information about your Campaign. This information includes the name of the User who created the Campaign, Category of the Campaign, creation date and time, activating date and time, Contact Segments in your Campaign and more.

The **Campaign Statistics** panel shows the number of Contacts added to the Campaign over the specified period of time in graphical format. To specify the time period, use the From and To date selectors, and click Apply.

Expand Down
8 changes: 4 additions & 4 deletions docs/channels/focus_items.rst
Original file line number Diff line number Diff line change
Expand Up @@ -154,13 +154,13 @@ When creating a new Focus Item, you can set the following fields:

**Category** - Assign a Category to help you organize your Focus Items.

**Published** - Whether the Focus Item is available for use - published - or not available - unpublished
**Active** - Whether the Focus Item is available for use - active - or not available - inactive.

.. vale off

**Publish at (date/time)** - This allows you to define the date and time at which this Text Message is available for sending to Contacts
**Activate at (date/time)** - This allows you to define the date and time at which this Text Message is available for sending to Contacts

**Unpublish at (date/time)** - This allows you to define the date and time at which this Text Message ceases to be available for sending to Contacts.
**Deactivate at (date/time)** - This allows you to define the date and time at which this Text Message ceases to be available for sending to Contacts.

.. vale on

Expand Down Expand Up @@ -195,7 +195,7 @@ You can use the menu on the sidebar to configure the Focus Item to your liking.
Using Focus Items
*****************

Once you have created your Focus Item, you're ready to publish it to your website. If you're not quite ready for the Focus Item to go live but you need to get it set up on your website, you can set the Focus Item to Unpublished.
Once you have created your Focus Item, you're ready to activate it to your website. If you're not quite ready for the Focus Item to go live but you need to get it set up on your website, set the Focus Item to inactive.

Deploying to a website
======================
Expand Down
12 changes: 6 additions & 6 deletions docs/channels/social_monitoring.rst
Original file line number Diff line number Diff line change
Expand Up @@ -42,13 +42,13 @@ When selecting the Twitter Mention monitoring method, the following fields are a

There are also the standard Mautic fields available:

**Published** - This allows you to set the published status of the Social Monitor. Unpublished Social Monitors won't collect new Contacts.
**Active** - This allows you to set the activation status of the Social Monitor. Deactivated Social Monitors won't collect new Contacts.

.. vale off

**Publish at (date/time)** - This allows you to define the date and time at which this Social Monitor is monitoring for new Contacts. You might use this to coincide with an event, for example.
**Activate at (date/time)** - This allows you to define the date and time at which this Social Monitor is monitoring for new Contacts. You might use this to coincide with an event, for example.

**Unpublish at (date/time)** - This allows you to define the date and time at which this Social Monitor is monitoring for new Contacts.
**Deactivate at (date/time)** - This allows you to define the date and time at which this Social Monitor is monitoring for new Contacts.

.. vale on

Expand All @@ -69,13 +69,13 @@ When selecting the Twitter Hashtags monitoring method, the following fields are

There are also the standard Mautic fields available:

**Published** - This allows you to set the published status of the Social Monitor. Unpublished Social Monitors won't collect new Contacts.
**Active** - This allows you to set the activation status of the Social Monitor. Deactivated Social Monitors won't collect new Contacts.

.. vale off

**Publish at (date/time)** - This allows you to define the date and time at which this Social Monitor is monitoring for new Contacts. This might be used to coincide with an event, for example.
**Activate at (date/time)** - This allows you to define the date and time at which this Social Monitor is monitoring for new Contacts. This might be used to coincide with an event, for example.

**Unpublish at (date/time)** - This allows you to define the date and time at which this Social Monitor ceases to monitor for new Contacts.
**Deactivate at (date/time)** - This allows you to define the date and time at which this Social Monitor ceases to monitor for new Contacts.

.. vale on

Expand Down
2 changes: 1 addition & 1 deletion docs/configuration/command_line_interface.rst
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ These are the commands you may need to use in relation to your Mautic instance.
- Rebuild Campaigns based on Contact Segments.
- ``mautic:campaigns:update``
* - ``mautic:campaigns:trigger``
- Trigger timed events for published Campaigns.
- Trigger timed events for active Campaigns.
-
* - ``mautic:campaigns:validate``
- Validate if a Contact has been inactive for a decision and execute events if so.
Expand Down
6 changes: 3 additions & 3 deletions docs/configuration/settings.rst
Original file line number Diff line number Diff line change
Expand Up @@ -378,7 +378,7 @@ Unsubscribe settings

* **Show Contact preference settings** - Select **Yes** to direct the unsubscribe link to your configured Preference enter. If you haven't created a Preference Center, Mautic creates a default page based on the next 5 settings. The created page uses the default Theme for styling.

* **Show Contact Segment preferences** - Select **Yes** to allow a Contact to change which Segments they're part of on the Preference Center page. Segments won't display on the Preference Center page if they aren't published and public.
* **Show Contact Segment preferences** - Select **Yes** to allow a Contact to change which Segments they're part of on the Preference Center. Segments won't display on the Preference Center if they aren't active and public.

* **Show Contact frequency preferences** - Select **Yes** to allow an individual to limit the number of Marketing Messages they receive on each Channel from the Preference Center.

Expand Down Expand Up @@ -620,9 +620,9 @@ Notification settings
:width: 600
:alt: Screenshot showing Webhook Notification Settings Configuration in Mautic

If a Campaign or Webhook is automatically unpublished because of a high volume of errors, Mautic sends a notification alerting Users.
If a Campaign or Webhook is automatically deactivated because of a high volume of errors, Mautic sends a notification alerting Users.

* **Send notification to author** - Set this field to Yes to send an Email notification to the User who created the unpublished Campaign or Webhook. Deleted Users don't receive notifications.
* **Send notification to author** - Set this field to Yes to send an Email notification to the User who created the deactivated Campaign or Webhook. Deleted Users don't receive notifications.

.. vale off

Expand Down
6 changes: 3 additions & 3 deletions docs/contacts/import_contacts.rst
Original file line number Diff line number Diff line change
Expand Up @@ -172,13 +172,13 @@ How to stop a background import

2. In the top right corner of the Contacts page, open the sub menu of actions and select the :ref:`Import History<import job list>` option.

3. Unpublish the import job you want to stop. The import changes :ref:`status<import job status>` to Stopped. It finishes importing the current batch and then stops.
3. Deactivate the import job you want to stop. The import changes :ref:`status<import job status>` to Stopped. It finishes importing the current batch and then stops.

4. To start the import again, publish it, and the background job continues with the next :doc:`cron job execution</configuration/cron_jobs>`.
4. To start the import again, activate it, and the background job continues with the next :doc:`cron job execution</configuration/cron_jobs>`.

.. image:: images/import-publish.png
:align: center
:alt: Screenshot of Import publish
:alt: Screenshot of Import activation

|

Expand Down
2 changes: 1 addition & 1 deletion docs/contacts/manage_contacts.rst
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ Add new Contact

|

This opens the new Contact screen, where you can enter all the information you have about the Contact. It also displays all published Contact fields when creating a new Contact.
This opens the new Contact screen, where you can enter all the information you have about the Contact. It also displays all available Contact fields when creating a new Contact.

Use the tabs at the top to populate existing Custom Fields and social network profiles.

Expand Down
4 changes: 2 additions & 2 deletions docs/plugins/hubspot.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Configure the HubSpot CRM Plugin

.. note::

Be sure to complete all steps before you publish the Plugin.
Be sure to complete all steps before you activate the Plugin.

1. Log in to Mautic instance.

Expand Down Expand Up @@ -63,7 +63,7 @@ Configure the HubSpot CRM Plugin

9. Click **Save** to save the Plugin configuration.

* If you want to use the Plugin, set the *Publish* switch to **Yes**. Only do this when you have fully configured the Plugin settings.
* If you want to use the Plugin, set the *Active* switch to **Yes**. Only do this when you have fully configured the Plugin settings.

10. Set up the :ref:`cron job<configure Mautic integration cron jobs>` if you haven't already configured it.

Expand Down
6 changes: 3 additions & 3 deletions docs/plugins/vtiger.rst
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@

* Vtiger username - The username, email address usually, which you use to log in to your Vtiger.

* Vtiger access key - The access key published in your Vtiger profile. To get it, go to Vtiger's **My Preferences**. The Access Key hash is at the bottom of the page.
* Vtiger access key - The access key activated in your Vtiger profile. To get it, go to Vtiger's **My Preferences**. The Access Key hash is at the bottom of the page.

Check warning on line 34 in docs/plugins/vtiger.rst

View workflow job for this annotation

GitHub Actions / prose

[vale] reported by reviewdog 🐶 [Google.FirstPerson] Avoid first-person pronouns such as 'My'. Raw Output: {"message": "[Google.FirstPerson] Avoid first-person pronouns such as 'My'.", "location": {"path": "docs/plugins/vtiger.rst", "range": {"start": {"line": 34, "column": 100}}}, "severity": "WARNING"}

Check warning on line 34 in docs/plugins/vtiger.rst

View workflow job for this annotation

GitHub Actions / prose

[vale] reported by reviewdog 🐶 [Mautic.FeatureList] Is this referring to a Mautic feature? If so, use 'Landing Page' instead of 'page'. Raw Output: {"message": "[Mautic.FeatureList] Is this referring to a Mautic feature? If so, use 'Landing Page' instead of 'page'.", "location": {"path": "docs/plugins/vtiger.rst", "range": {"start": {"line": 34, "column": 162}}}, "severity": "INFO"}

.. image:: images/vtiger-mautic.png
:alt: Screenshot of Vtiger Mautic Integration
Expand All @@ -49,9 +49,9 @@

.. vale on

If you want to use the Plugin, you have to publish it.
If you want to use the Plugin, you have to activate it.

1. Set the *Publish* switch to **Yes**.
1. Set the *Active* switch to **Yes**.

2. In the **Features tab** is Push Contacts to this Integration checkbox and it's checked by default.

Expand Down
2 changes: 1 addition & 1 deletion docs/plugins/zoho_crm.rst
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ You can also configure other options:

If the values are empty for the Mautic object, a value of 'Unknown' is sent. If the ZohoCRM field is a pick list, be sure the list values of Mautic's field match those of the field in ZohoCRM.

8. Set the Publish switch to **Yes**.
8. Set the Active switch to **Yes**.
9. Click **Save & Close**.

.. vale on
Expand Down
8 changes: 4 additions & 4 deletions docs/points/points.rst
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ To add a new action:

* **Category** - Organize your Point Actions based on their goals, Campaigns, etc. For more information, see :doc:`Categories</categories/categories-overview>`. All Points accumulate on a Contact record, regardless of Category. There is one Points score for each Contact.

* **Published and Publish/Unpublish at date/time** - Once you have a Point action, Mautic awards Points when a Contact completes the action. Points aren't given for unpublished actions. If you have target behaviors that you want to award Points for within a certain time period, you can set the publish and unpublish dates
* **Active and Activate/Deactivate at date/time** - Once you have a Point action, Mautic awards Points when a Contact completes the action. Points aren't given for inactive actions. If you have target behaviors that you want to award Points for within a certain time period, you can set the activate and deactivate dates

* **Is repeatable** - To award Points each time a Contact completes an action, select **Yes**. If you want to award Points **only** the first time someone completes the action, select **No** - this is the default.

Expand All @@ -52,7 +52,7 @@ Once a Contact has accumulated a Point total, you may want to trigger an action
.. image:: images/points-trigger.png
:alt: Screenshot of Points trigger

Creating Point Triggers is like creating Point Actions. The **Name**, **Description**, **Category**, and **Publish** options are all the same. The trigger fires based on the minimum number of Points. Set a number and decide if you want to **Trigger for existing applicable Contacts upon saving - if published**.
Creating Point Triggers is like creating Point Actions. The **Name**, **Description**, **Category**, and **Active** options are all the same. The trigger fires based on the minimum number of Points. Set a number and decide if you want to **Trigger for existing applicable Contacts upon saving - if activated**.

Once you have decided and entered those options, go to the **Events** tab. Here, you can trigger one or more events once a Contact has reached your predetermined Point total. These Point Triggers and associated events are also fully customizable.

Expand All @@ -62,12 +62,12 @@ Once you have decided and entered those options, go to the **Events** tab. Here,
Campaign triggers
=================

**Modify Contact's Campaigns** - Add a Contact to or remove a Contact from any Campaigns you have published.
**Modify Contact's Campaigns** - Add a Contact to or remove a Contact from any Campaigns you have activated.

Contact triggers
================

**Modify Contact's Segments** - Add a Contact to or remove a Contact from any Segments you have published.
**Modify Contact's Segments** - Add a Contact to or remove a Contact from any Segments you have activated.

**Modify Contact's tags** - Add or remove any Tags on the Contact record. If a Tag doesn't exist, you may create a new one in the edit window for this event.

Expand Down
10 changes: 5 additions & 5 deletions docs/segments/manage_segments.rst
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Creating a Segment

* **Available in Preference Center** - If set to **Yes**, Contacts can see and opt into or out of the Segment on a **Preference Center** page. The Segments display if the Preference Center has the **Segment List** slot type.

* **Published** - If set to **No**, the Segment won't be available for use in filters for other Segments, as a Contact source in Campaigns, modify Segment actions, etc. You'll still see the Segment in your **Segment list**, but it essentially won't exist anywhere else in Mautic.
* **Active** - If set to **No**, the Segment won't be available for use in filters for other Segments, as a Contact source in Campaigns, modify Segment actions, etc. You'll still see the Segment in your **Segment list**, but it essentially won't exist anywhere else in Mautic.

On the Details tab, static, and dynamic Segments also have the option to display a different public name for a Segment.

Expand Down Expand Up @@ -500,15 +500,15 @@ It's necessary to configure the :ref:`cron jobs<segment cron jobs>`.

.. vale off

Deleting or unpublishing a Segment
Deleting or deactivating a Segment
**********************************

.. vale on

Since :xref:`Mautic 4` there is a step when deleting or unpublishing a Segment to ensure that it's not required as a filter by an existing Segment.
Since :xref:`Mautic 4` there is a step when deleting or deactivating a Segment to ensure that it's not required as a filter by an existing Segment.

.. image:: images/deleting-used-segment.png
:width: 300
:alt: Screenshot deleting or unpublishing a Segment
:alt: Screenshot deleting or deactivating a Segment

If you attempt to delete or unpublish a Segment which is in use by a filter in another Segment, an alert prompts you to edit the other Segment, removing the dependency before you delete the Segment.
If you attempt to delete or deactivate a Segment which is in use by a filter in another Segment, an alert prompts you to edit the other Segment, removing the dependency before you delete the Segment.
2 changes: 1 addition & 1 deletion docs/stages/stages.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Navigate to the **Stages** section in the left side menu, and then click **+New*

**Category** - Assign a Category to help you organize your Stages. For more information, see :ref:`categories`.

**Publish options** - The dashboard widget doesn't display data for an unpublished Stage. In addition, the Segment filters or Campaign conditions don't display the Stage. To avoid using the Stage while building it, set a future publish date and time. If you want the Stage to become unavailable after a certain time, set the date and time for unpublishing.
**Activation options** - The dashboard widget doesn't display data for an inactive Stage. In addition, the Segment filters or Campaign conditions don't display the Stage. To avoid using the Stage while building it, set a future activation date and time. If you want the Stage to become unavailable after a certain time, set the date and time for deactivating.

.. vale off

Expand Down
Loading
Loading