Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
30 commits
Select commit Hold shift + click to select a range
7606ac4
feat: [DPMMA-2095] point leagues documentation
patrykgruszka Mar 24, 2023
41bbc8f
feat: [DPMMA-2095] update sidebar
patrykgruszka Mar 24, 2023
8ff47f5
feat: [DPMMA-2095] cw correct
patrykgruszka Mar 24, 2023
f0dd285
fix: [DPMMA-2242] rename league to group
patrykgruszka Jun 22, 2023
2432477
Merge branch 'main' into DPMMA-2095_point-leagues
patrykgruszka Jun 22, 2023
1ac2bd8
Merge pull request #175 from mautic/main
RCheesley Jun 26, 2023
442b944
Merge branch '5.x' into DPMMA-2095_point-leagues
patrykgruszka Jul 18, 2023
e94fd65
fix: [DPMMA-2252] group points action and webhook info
patrykgruszka Jul 19, 2023
06457fa
fix: [DPMMA-2252] fix section title
patrykgruszka Jul 19, 2023
6e635cc
Merge pull request #152 from patrykgruszka/DPMMA-2095_point-leagues
RCheesley Jul 27, 2023
96adfdf
email_transport queue is now called just email
escopecz Aug 4, 2023
71c9a97
Merge pull request #194 from escopecz/email_transport-to-email
RCheesley Aug 4, 2023
b97da77
Add locale definition for translations
RCheesley Jul 6, 2023
2cea243
add custom fields to chron docs
roboparker Jul 11, 2023
bbfd13b
Update docs/configuration/cron_jobs.rst
roboparker Aug 8, 2023
9bad1c3
Update docs/configuration/cron_jobs.rst
roboparker Aug 8, 2023
0f75b52
Move email settings to config section
RCheesley Jun 27, 2023
c7b70cf
Move to top and rename to transport
RCheesley Jun 27, 2023
79f4ba7
Fix leftover from rebase :blush:
RCheesley Aug 8, 2023
7106ba9
Remove section that was moved to config
RCheesley Aug 8, 2023
dea0873
Vale fixes 🙇🏻‍♀️
RCheesley Aug 8, 2023
d7dc5ad
Missed one 👀🫣
RCheesley Aug 8, 2023
ea326d2
Merge pull request #177 from mautic/refactor-email-dsn-info
RCheesley Aug 8, 2023
12bcfe8
Merge branch '5.x' into custom-fields-chron
RCheesley Aug 8, 2023
d9e5d79
Merge pull request #183 from diaboloshogunate/custom-fields-chron
RCheesley Aug 8, 2023
acffe47
Resolve conflicts
RCheesley Nov 21, 2023
464b705
Resolve conflicts
RCheesley Nov 21, 2023
d6799a8
remove translation files
RCheesley Nov 21, 2023
8bdde37
Merge pull request #213 from RCheesley/remove-translations-5.x
RCheesley Nov 21, 2023
4890e08
Merge remote-tracking branch 'upstream/main' into main-2-5
escopecz Nov 22, 2023
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .github/styles/Mautic/FeatureList.yml
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,8 @@ swap:
point actions: Point Actions
point triggers: Point Triggers
points: Points
group: Group
groups: Groups
plugin: Plugin
plugins: Plugins
report: Report
Expand Down
4 changes: 3 additions & 1 deletion docs/campaigns/campaign_builder.rst
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ The actions that Mautic offers in a Campaign include:
* - **Add Company action**
- Associates a Contact with a Company and sets the Company as the primary Company for the Contact.
* - **Adjust Contact Points**
- Adds or subtracts Points from the Contact’s Point total.
- Adds or subtracts Points from the Contact’s Point total or Group.
* - **Change Campaigns**
- Removes a Contact from the existing Campaign, moves them into another Campaign, restarts the current Campaign or a combination of these. You must remove a Contact from a Campaign before restarting the Campaign.
* - **Change Contact's Stage**
Expand Down Expand Up @@ -205,6 +205,8 @@ Here are the different conditions that Mautic offers in the Campaign Builder:
- Checks if the Contact is a member of selected Segments.
* - **Contact Tags**
- Checks if specified Tags are on the Contact record.
* - **Contact points**
- Checks if the Contact has a certain number of Points or a Group score.
* - **Form field value**
- Checks if values submitted for a selected field on a selected Form matches specified criteria.
* - **Has active notification**
Expand Down
15 changes: 14 additions & 1 deletion docs/configuration/cron_jobs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,19 @@ You can also limit the number of Contacts to process per script execution using

that these messages are only added to the queue when frequency rules apply either system wide or per Contact.

.. vale off

Custom Field cron jobs
=======================

.. vale on

**To keep Contacts and Company Custom Fields updated**

.. code-block:: php

php /path/to/mautic/bin/console mautic:custom-field:create-column

Optional
********

Expand All @@ -101,7 +114,7 @@ If the system configuration is queueing Emails, a cron job processes them.

.. code-block:: php

php /path/to/mautic/bin/console messenger:consume email_transport
php /path/to/mautic/bin/console messenger:consume email

.. vale off

Expand Down
185 changes: 158 additions & 27 deletions docs/configuration/settings.rst

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -181,6 +181,7 @@ There are different types of documentation available to help you navigate your w

points/points
points/points_troubleshooting
points/point_groups

.. toctree::
:maxdepth: 2
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/points/images/contact-group-points.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/points/images/group-report.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/points/images/new-group.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/points/images/point-action-with-group.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/points/images/point-trigger-with-group.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/points/images/segment-group-filter.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
93 changes: 93 additions & 0 deletions docs/points/point_groups.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
.. vale off

Point Groups
#############

.. vale on

Point Groups is a feature that allows users to categorize the score of their Contacts. By setting up Point Groups, users can assign a specific number of Points to each action taken by a Contact, such as opening an Email, visiting a Landing page, or downloading an Asset.

Managing Point Groups
======================
To access the currently defined Point Groups in Mautic, navigate to the Points Menu and click the "Manage Groups" link. To create a new Group, simply click the "New" button.

.. image:: images/new-group.png
:width: 600
:alt: Screenshot of the create a new Group interface

Enter a name and a description for the Group and click the "Save & Close" button to create the Group.

Point Groups usage
===================

Point actions
-------------
You can change Contact's Points within a Points Group by using Points Actions.

.. image:: images/point-action-with-group.png
:width: 600
:alt: Screenshot of Points action with Group

Point triggers
--------------
You can use Point triggers based on Point Groups to automatically trigger specific events within the system.

.. image:: images/point-trigger-with-group.png
:width: 600
:alt: Screenshot of Points trigger with Group

Campaign condition
------------------
You can use a condition based on Group Contact score in a Campaign.

.. image:: images/campaign-point-condition-with-group.png
:width: 600
:alt: Screenshot of Points trigger with Group

Campaign action
---------------
You can use a Campaign action to increase or decrease the Group Contact score.

.. image:: images/campaign-point-action-with-group.png
:width: 600
:alt: Screenshot of Campaign Point action with Group

Form action
---------------
You can use a Form action to increase or decrease the Group Contact score.

.. image:: images/form-action-with-point-group.png
:width: 600
:alt: Screenshot of Form Adjust contact's points action with Group

Segment filters
---------------
Each Point Group adds a new filter that can be used to configurate the Segment.

.. image:: images/segment-group-filter.png
:width: 600
:alt: Screenshot of Segment Group filter

.. image:: images/segment-group-filter-element.png
:width: 600
:alt: Screenshot of Segment Group filter element

Contact details
---------------
You can display Point Groups in the Contact details.

.. image:: images/contact-group-points.png
:width: 600
:alt: Screenshot of Contact Details with Group Points

Group Report
-------------
You can generate a Report that contains information about Contact Point Groups.

.. image:: images/group-report.png
:width: 600
:alt: Screenshot of Group Report

Webhooks
--------
Changing the Contact Group Points will not trigger the Contact Points Changed Event Webhook
1 change: 1 addition & 0 deletions docs/reports/reports.rst
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@ The **Details** tab on a Report contains the same options across all Reports and
* Segment Membership
* Do Not Contact
* UTM Codes
* Group score

7. :doc:`Companies</companies/companies_overview>`

Expand Down