trytond-marketing-automation


Nametrytond-marketing-automation JSON
Version 7.0.0 PyPI version JSON
download
home_pagehttp://www.tryton.org/
SummaryTryton module to plan, coordinate and manage marketing campaigns
upload_time2023-10-30 17:31:06
maintainer
docs_urlNone
authorTryton
requires_python>=3.8
licenseGPL-3
keywords tryton marketing automation
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            Marketing Automation Module
###########################

The marketing_automation module allows marketing actions to be automated. It is
based on scenarios and activities that are executed on selected records.

Scenario
********

A scenario provides the entry point for records into an automated marketing
campaign. Each record can only enter a scenario once. A scenario is defined by:

    * Name
    * Model: the type of record for the scenario (by default Party and Sale)
    * Domain: used to filter records
    * State:

        * Draft
        * Running
        * Stopped

A cron task runs periodically to find new records to apply the scenario to.

Activity
********

The activities form a scenario. They define which action should be triggered
and when it should happen. The activities are organized as a tree and defined
by:

    * Name
    * Parent
    * Children
    * On: event from the parent that triggers the activity:

        * E-Mail Opened
        * E-Mail Not Opened
        * E-Mail Clicked
        * E-Mail Not Clicked

    * Condition: that the record must match to execute the activity
    * Delay: before the action is executed
    * Action: list of available actions

Actions
-------

Send E-Mail
...........

The activity send an e-mail to the party defined on the record.
The E-mail is composed using an HTML `Genshi <https://genshi.edgewall.org/>`_
template with ``record`` in the evaluation context.
All ``<a>`` elements have their ``href`` replaced by a shortened version used
to trigger children activities. If the ``href`` value is ``unsubscribe``, it is
replaced by the URL which allows the recipient to block their record for the
scenario.
A empty image is automatically added at the end of the ``<body>`` to track when
emails are opened.

Record
******

It stores a reference to the records included in each scenario. If the record
is blocked, no activity will be triggered for the record.

Record Activity
***************

It stores the state of a record for an activity of the scenario.

A cron task runs periodically to execute any waiting record activity that is
due.

Configuration
*************

The marketing_automation module uses parameters from the section:

- ``[marketing]``:

    - ``email_from``: The default ``From`` for the email.
    - ``automation_base``: The base URL without a path for the unsubscribe URL
      and the empty image.
      The default value is created using the configuration ``[web]``
      ``hostname``.

            

Raw data

            {
    "_id": null,
    "home_page": "http://www.tryton.org/",
    "name": "trytond-marketing-automation",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": "",
    "keywords": "tryton marketing automation",
    "author": "Tryton",
    "author_email": "foundation@tryton.org",
    "download_url": "https://files.pythonhosted.org/packages/de/48/bfdc34955462fbb9bf7a3a8047d626a970ae4ec7037aa5123c52e186a923/trytond_marketing_automation-7.0.0.tar.gz",
    "platform": null,
    "description": "Marketing Automation Module\n###########################\n\nThe marketing_automation module allows marketing actions to be automated. It is\nbased on scenarios and activities that are executed on selected records.\n\nScenario\n********\n\nA scenario provides the entry point for records into an automated marketing\ncampaign. Each record can only enter a scenario once. A scenario is defined by:\n\n    * Name\n    * Model: the type of record for the scenario (by default Party and Sale)\n    * Domain: used to filter records\n    * State:\n\n        * Draft\n        * Running\n        * Stopped\n\nA cron task runs periodically to find new records to apply the scenario to.\n\nActivity\n********\n\nThe activities form a scenario. They define which action should be triggered\nand when it should happen. The activities are organized as a tree and defined\nby:\n\n    * Name\n    * Parent\n    * Children\n    * On: event from the parent that triggers the activity:\n\n        * E-Mail Opened\n        * E-Mail Not Opened\n        * E-Mail Clicked\n        * E-Mail Not Clicked\n\n    * Condition: that the record must match to execute the activity\n    * Delay: before the action is executed\n    * Action: list of available actions\n\nActions\n-------\n\nSend E-Mail\n...........\n\nThe activity send an e-mail to the party defined on the record.\nThe E-mail is composed using an HTML `Genshi <https://genshi.edgewall.org/>`_\ntemplate with ``record`` in the evaluation context.\nAll ``<a>`` elements have their ``href`` replaced by a shortened version used\nto trigger children activities. If the ``href`` value is ``unsubscribe``, it is\nreplaced by the URL which allows the recipient to block their record for the\nscenario.\nA empty image is automatically added at the end of the ``<body>`` to track when\nemails are opened.\n\nRecord\n******\n\nIt stores a reference to the records included in each scenario. If the record\nis blocked, no activity will be triggered for the record.\n\nRecord Activity\n***************\n\nIt stores the state of a record for an activity of the scenario.\n\nA cron task runs periodically to execute any waiting record activity that is\ndue.\n\nConfiguration\n*************\n\nThe marketing_automation module uses parameters from the section:\n\n- ``[marketing]``:\n\n    - ``email_from``: The default ``From`` for the email.\n    - ``automation_base``: The base URL without a path for the unsubscribe URL\n      and the empty image.\n      The default value is created using the configuration ``[web]``\n      ``hostname``.\n",
    "bugtrack_url": null,
    "license": "GPL-3",
    "summary": "Tryton module to plan, coordinate and manage marketing campaigns",
    "version": "7.0.0",
    "project_urls": {
        "Bug Tracker": "https://bugs.tryton.org/",
        "Documentation": "https://docs.tryton.org/",
        "Download": "http://downloads.tryton.org/7.0/",
        "Forum": "https://www.tryton.org/forum",
        "Homepage": "http://www.tryton.org/",
        "Source Code": "https://code.tryton.org/tryton"
    },
    "split_keywords": [
        "tryton",
        "marketing",
        "automation"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "7db2b5bea6e8687d6d41fe254eef9e0f738c4f0bcb4bf7f1678c3baf87f045d3",
                "md5": "59c7a82a1b9e9bf7363079f4fcf2127f",
                "sha256": "b8cad350d83afe17fec5a83153772e5bb9c6d4bdff1746844b41e0ec63fd899c"
            },
            "downloads": -1,
            "filename": "trytond_marketing_automation-7.0.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "59c7a82a1b9e9bf7363079f4fcf2127f",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 94265,
            "upload_time": "2023-10-30T17:31:04",
            "upload_time_iso_8601": "2023-10-30T17:31:04.611240Z",
            "url": "https://files.pythonhosted.org/packages/7d/b2/b5bea6e8687d6d41fe254eef9e0f738c4f0bcb4bf7f1678c3baf87f045d3/trytond_marketing_automation-7.0.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "de48bfdc34955462fbb9bf7a3a8047d626a970ae4ec7037aa5123c52e186a923",
                "md5": "8ae99494ea0340ef22c1f042487e6bdc",
                "sha256": "a561c482fd0b216de36c19a15e2a39e47aadbf5dce0ace09095eeafb4332fcc3"
            },
            "downloads": -1,
            "filename": "trytond_marketing_automation-7.0.0.tar.gz",
            "has_sig": false,
            "md5_digest": "8ae99494ea0340ef22c1f042487e6bdc",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 50283,
            "upload_time": "2023-10-30T17:31:06",
            "upload_time_iso_8601": "2023-10-30T17:31:06.890179Z",
            "url": "https://files.pythonhosted.org/packages/de/48/bfdc34955462fbb9bf7a3a8047d626a970ae4ec7037aa5123c52e186a923/trytond_marketing_automation-7.0.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-10-30 17:31:06",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "trytond-marketing-automation"
}
        
Elapsed time: 0.13657s