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.

Sign up for GitHub

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

Add docs for scheduled export of contacts #298

Merged
merged 3 commits into from
May 3, 2024
Merged

Add docs for scheduled export of contacts #298

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b93812d
Add docs for scheduled export of contacts
RCheesley Apr 29, 2024
7024e4f
Merge branch '5.x' into scheduled-export-cron
RCheesley Apr 29, 2024
a65501f
Merge branch '5.x' into scheduled-export-cron
RCheesley May 3, 2024
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
5 changes: 4 additions & 1 deletion docs/configuration/command_line_interface.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,10 @@ These are the commands you may need to use in relation to your Mautic instance.
-
* - ``mautic:contacts:deduplicate``
- Merge Contacts based on same unique identifiers
-

* - ``mautic:contacts:scheduled_export``
- Processes exports of Contacts to a CSV file and sends the results via Email.
-
* - ``mautic:custom-field:create-column``
- Creates the actual column in the table
-
Expand Down
15 changes: 15 additions & 0 deletions docs/configuration/cron_jobs.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -157,6 +157,21 @@

The time taken for this command to execute depends on the number of Contacts in the CSV file. However, on successful completion of the import operation, a notification appears on the Mautic dashboard.

.. vale off

Export Contacts cron job
========================

.. vale on

To export Contacts to CSV - sending the results via Email - use the following command:

.. code-block:: bash

php /path/to/mautic/bin/console mautic:contacts:scheduled_export

The time taken for this command to execute depends on the number of Contacts in the CSV file. However, on successful completion of the export operation, Mautic sends an email with the link to download the CSV.

Check warning on line 173 in docs/configuration/cron_jobs.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 'Email' instead of 'email'.

Raw Output:
{"message": "[Mautic.FeatureList] Is this referring to a Mautic feature? If so, use 'Email' instead of 'email'.", "location": {"path": "docs/configuration/cron_jobs.rst", "range": {"start": {"line": 173, "column": 170}}}, "severity": "INFO"}

Webhooks cron job
=================

Expand Down
Binary file added docs/configuration/images/export-settings.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
15 changes: 12 additions & 3 deletions docs/configuration/settings.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -319,12 +319,12 @@
Default frequency rule
======================

* **Do Not Contact more than <number> each <period>** - This limits the number of Marketing Messages a Contact receives in a certain period of time day, week, month. Transactional messages don't count towards this limit. You can adjust this at the individual Contact level, either manually or by Preference Center setting.

Check warning on line 322 in docs/configuration/settings.rst

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Google.Contractions] Feel free to use 'don't' instead of 'Do Not'.

Raw Output:
{"message": "[Google.Contractions] Feel free to use 'don't' instead of 'Do Not'.", "location": {"path": "docs/configuration/settings.rst", "range": {"start": {"line": 322, "column": 5}}}, "severity": "INFO"}
RCheesley marked this conversation as resolved.
Show resolved Hide resolved

.. image:: images/default-frequency-rule.png
:width: 600
:alt: Screenshot showing Default Frequency Rule Configuration in Mautic

* **Do not contact more than <number> each <period>** - This limits the number of Marketing Messages a Contact receives in a certain period of time day, week, month. Transactional messages don't count towards this limit. You can adjust this at the individual Contact level, either manually or by Preference Center setting.

.. note::

More information is available in the :doc:`Default Frequency Rule documentation</contacts/frequency_rules>`.
Expand Down Expand Up @@ -452,7 +452,16 @@
:alt: Screenshot showing Import Settings Configuration in Mautic

* **Automatically import in the background if the CSV has more rows than defined** - If there are more than the specified number of rows in an import file, the CSV automatically sets to import in the background which requires a :ref:`cron job<import contacts cron job>` to trigger. Set to 0 if you want to always import files in the background recommended for performance optimization.


Export settings
===============

.. image:: images/export-settings.png
:width: 600
:alt: Screenshot showing Export Settings Configuration in Mautic

* **Automatically export Contacts to CSV in the background** - If set to Yes, Mautic processes CSV exports of Contacts in the background and Mautic sends an Email with a link to download the file when it's processed.

Segment settings
****************

Expand Down
Loading