Skip to content

Commit

Permalink
feat: [DPMMA-2688] optimal event scheduler config
Browse files Browse the repository at this point in the history
  • Loading branch information
patrykgruszka committed May 6, 2024
1 parent f9ad0d3 commit 79ae9cc
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 0 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
16 changes: 16 additions & 0 deletions docs/configuration/settings.rst
Original file line number Diff line number Diff line change
Expand Up @@ -158,6 +158,22 @@ Campaign settings

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

Optimal for Contact event scheduler
===================================

.. image:: images/optimal-event-scheduler-settings.png
:width: 600
:alt: Screenshot showing Optimal for Contact event scheduler settings configuration in Mautic

The optimal for Contact event scheduler settings allow you to configure the default timing and caching options used in the optimized event scheduler for Campaigns.

* **Default Optimal Start Hour** - Set the default start hour for the optimal interaction window when specific Contact data is unavailable.
* **Default Optimal End Hour** - Set the default end hour for the optimal interaction window when specific Contact data is unavailable.
* **Default Optimal Days** - Select the default days of the week that are considered optimal for interaction when specific Contact data is unavailable.

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

View workflow job for this annotation

GitHub Actions / prose

[vale] reported by reviewdog 🐶 [Google.Passive] In general, use active voice instead of passive voice ('are considered'). Raw Output: {"message": "[Google.Passive] In general, use active voice instead of passive voice ('are considered').", "location": {"path": "docs/configuration/settings.rst", "range": {"start": {"line": 172, "column": 71}}}, "severity": "INFO"}
* **Interaction Data Cache Timeout** - Choose how long the interaction data should be cached.

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

View workflow job for this annotation

GitHub Actions / prose

[vale] reported by reviewdog 🐶 [Google.Passive] In general, use active voice instead of passive voice ('be cached'). Raw Output: {"message": "[Google.Passive] In general, use active voice instead of passive voice ('be cached').", "location": {"path": "docs/configuration/settings.rst", "range": {"start": {"line": 173, "column": 84}}}, "severity": "INFO"}
* **Fetch Interactions From** - Select the time frame for fetching interaction data. This determines how far back the system will look for interactions.

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

View workflow job for this annotation

GitHub Actions / prose

[vale] reported by reviewdog 🐶 [Google.Will] Avoid using 'will'. Raw Output: {"message": "[Google.Will] Avoid using 'will'.", "location": {"path": "docs/configuration/settings.rst", "range": {"start": {"line": 174, "column": 126}}}, "severity": "WARNING"}
* **Interaction Fetch Limit** - Set the maximum number of interactions of each type (for example: Page hits, Email reads, Form submits) to retrieve for timing optimization.

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

View workflow job for this annotation

GitHub Actions / prose

[vale] reported by reviewdog 🐶 [Google.Parens] Use parentheses judiciously. Raw Output: {"message": "[Google.Parens] Use parentheses judiciously.", "location": {"path": "docs/configuration/settings.rst", "range": {"start": {"line": 175, "column": 85}}}, "severity": "INFO"}

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

View workflow job for this annotation

GitHub Actions / prose

[vale] reported by reviewdog 🐶 [Google.Colons] ': P' should be in lowercase. Raw Output: {"message": "[Google.Colons] ': P' should be in lowercase.", "location": {"path": "docs/configuration/settings.rst", "range": {"start": {"line": 175, "column": 97}}}, "severity": "WARNING"}

Check warning on line 175 in docs/configuration/settings.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/configuration/settings.rst", "range": {"start": {"line": 175, "column": 99}}}, "severity": "INFO"}

Email settings
**************

Expand Down

0 comments on commit 79ae9cc

Please sign in to comment.