User Tools

Site Tools


start

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
Next revisionBoth sides next revision
start [2020/01/04 18:33] – [8.2 Fixed Issues] mastart [2020/09/11 09:32] – [11. New features of OpenEMM 20.10 (major changes)] ma
Line 1: Line 1:
 ====== OpenEMM Install & Configuration Wiki ====== ====== OpenEMM Install & Configuration Wiki ======
 Latest Version of **OpenEMM 19.04**: Backend: 19.04.000.**441**, Frontend: 19.04.000.**488**\\ Latest Version of **OpenEMM 19.04**: Backend: 19.04.000.**441**, Frontend: 19.04.000.**488**\\
-Latest Version of **OpenEMM 19.10**: Backend: 19.10.000.**128**, Frontend: 19.10.000.**133**\\ +Latest Version of **OpenEMM 19.10**: Backend: 19.10.000.**128**, Frontend: 19.10.000.**170**\\ 
-Utility Package for Deployment & Runtime: 19.10.009.015\\ +Latest Version of **OpenEMM 20.04**: Backend: 20.04.000.**190**, Frontend: 20.04.000.**188**\\ 
-(as of December 10, 2019)+Utility Package for OpenEMM Deployment & Runtime: 20.04.000.043\\ 
 +(as of September 10, 2020)
  
-**This wiki provides the brief version of the extensive {{ ::openemm_install_admin_guide_2019_1.2.0.pdf|OpenEMM Installation & Administration Guide 1.2.0}} (including SLES instructions).\\+This wiki provides the brief version of the extensive {{ ::openemm_install_admin_guide_2019_1.2.0.pdf|OpenEMM Installation & Administration Guide 1.2.0}} (including SLES instructions) for OpenEMM 19.x.\\ 
 + 
 +The lastest runtime version offers you to upgrade to OpenEMM 20.04 BETA. **Because several things have changed in OpenEMM version 20.04, we created a new {{ ::openemm_install_admin_guide_2020_1.3.4.pdf|Installation & Administration Guide for OpenEMM 2020}}. For OpenEMM 20.x, use that PDF guide instead of this wiki.**\\
 \\ \\
- We kindly ask you to contribute your feedback and questions to improve the documentation, installation, configuration and administration of OpenEMM! Please leave your questions and comments in the OpenEMM forum at [[https://forum.openemm.org|forum.openemm.org]].**+ We kindly ask you to contribute your feedback and questions to improve the documentation, installation, configuration and administration of OpenEMM! Please leave your questions and comments in the OpenEMM forum at [[https://forum.openemm.org|forum.openemm.org]].
 \\ \\
 \\ \\
Line 17: Line 20:
 ===== 2. Requirements ===== ===== 2. Requirements =====
  
-  * RedHat 7 or CentOS 7 64 bit, or [[suse|SLES 15]] (OpenEMM 19.10 and later)+  * RedHat 7 or 8; CentOS 7 or 8; [[suse|SLES 15]] (OpenEMM 19.10 and later)
     * with VirtualBox: Windows, macOS or any other Linux -> see section [[virtualbox|OpenEMM on VirtualBox]] for details     * with VirtualBox: Windows, macOS or any other Linux -> see section [[virtualbox|OpenEMM on VirtualBox]] for details
-  * Java Open JDK 8+  * Java Open JDK 8 (any OpenEMM) or Java Open JDK 11 (OpenEMM 20.04)
   * Apache Tomcat 9   * Apache Tomcat 9
-  * Python 2.7 (3.x with future version OpenEMM 20.04) +  * Python 2.7 (OpenEMM 19.x) or Python 3.8 (OpenEMM 20.04) 
-  * MySQL 5.6 or 5.7, or MariaDB 10.1, 10.2 or 10.3 +  * DBMS: MariaDB 10.1, 10.2 or 10.3; MySQL 5.6 or 5.7 
-  * Sendmail 8.10 or later, or Postfix 2.6 or later+  * MTA: Postfix 2.6 or later; Sendmail 8.10 or later
   * wkhtmltox 0.12.2.1 or later   * wkhtmltox 0.12.2.1 or later
   * for HTTPS support: Apache Tomcat Native Library   * for HTTPS support: Apache Tomcat Native Library
-\\ +**If you want to install or upgrade to OpenEMM 20.04, please use the PDF guide mentioned above.** 
-\\ +---- 
-===== 3. Preparations =====+===== 3. Preparations (for 19.04 and 19.10) =====
  
 OpenEMM consists of 2 packages: OpenEMM consists of 2 packages:
Line 206: Line 209:
 # firewall-cmd --reload # firewall-cmd --reload
 </code> </code>
-\\ +---- 
-\\ +===== 4. Installation (for 19.04 and 19.10) =====
-===== 4. Installation =====+
 ==== 4.1 Group and User ==== ==== 4.1 Group and User ====
 Create group and user for OpenEMM: Create group and user for OpenEMM:
Line 266: Line 268:
 </code> </code>
 When the frontend is installed, the OpenEMM database is automatically filled with its initial content. When the frontend is installed, the OpenEMM database is automatically filled with its initial content.
-\\ +---- 
-\\ +===== 5. Configuration (for 19.04 and 19.10) =====
-===== 5. Configuration =====+
  
 ==== 5.1 Log Access ==== ==== 5.1 Log Access ====
Line 287: Line 288:
   * Set //system.url// and //birt.drilldownurl// to the protocol and FQDN of your OpenEMM server (like https://openemm.example.com)   * Set //system.url// and //birt.drilldownurl// to the protocol and FQDN of your OpenEMM server (like https://openemm.example.com)
   * Set //birt.url// to the same value as //birt.drilldownurl// and add "/birt" at the end (like https://openemm.example.com/birt)   * Set //birt.url// to the same value as //birt.drilldownurl// and add "/birt" at the end (like https://openemm.example.com/birt)
 +  * If your OpenEMM server is not accessable via the default port (http: 80, https: 443), add the port to the URLs (like https://openemm.example.com:8080 and https://openemm.example.com:8080/birt)
  
 Use menu "Configuration", sub-menu "Change client/account data in db" to set important values in the OpenEMM database: Use menu "Configuration", sub-menu "Change client/account data in db" to set important values in the OpenEMM database:
Line 309: Line 311:
 ==== 5.4 Mailloop Configuration ==== ==== 5.4 Mailloop Configuration ====
 The mailloop service of OpenEMM pocesses asynchronous bounces, i.e. bounces that are not sent back instantly by the receiving MTA, but only after a delay. There are several options to configure the mailloop service. See section [[mailoop|OpenEMM Mailloop Configuration]] for details. The mailloop service of OpenEMM pocesses asynchronous bounces, i.e. bounces that are not sent back instantly by the receiving MTA, but only after a delay. There are several options to configure the mailloop service. See section [[mailoop|OpenEMM Mailloop Configuration]] for details.
-\\ +----
-\\+
 ===== 6. Updates ===== ===== 6. Updates =====
 The top of this Wiki lists the latest available versions of OpenEMM backend, frontend and the deployment & runtime package.  The top of this Wiki lists the latest available versions of OpenEMM backend, frontend and the deployment & runtime package. 
Line 316: Line 317:
 You can download the latest versions of packages with menu "Install or update package from AGNITAS Website" of OpenEMMInstaller. An update of the frontend package will also update the schema of the OpenEMM database, if necessary. Please keep in mind that you have to start OpenEMMInstaller as user root, if you want to update the backend, too. You can download the latest versions of packages with menu "Install or update package from AGNITAS Website" of OpenEMMInstaller. An update of the frontend package will also update the schema of the OpenEMM database, if necessary. Please keep in mind that you have to start OpenEMMInstaller as user root, if you want to update the backend, too.
  
-If you use runtime version 19.10.009.010 or later, you are offered to upgrade to new release OpenEMM 19.10. If you are not happy with the new release (or any other version of OpenEMM), you can roll back OpenEMM to an earlier (or later) version with menu "Switch OpenEMM version".+If you use runtime version 20.04.000.001 or later, you are offered to upgrade to new release OpenEMM 20.04. If you are not happy with the new release (or any other version of OpenEMM), you can roll back OpenEMM to an earlier (or later) version with menu "Switch OpenEMM version".
  
 Do not forget to restart OpenEMM with menu "Restart OpenEMM" after you have downloaded and installed an update package to activate it. But do the restart at an convenient time: Do not restart OpenEMM during a dispatch of a mailing, or right after the dispatch (due to the brief downtime of the redirect service causing missed openings and click redirects). Do not forget to restart OpenEMM with menu "Restart OpenEMM" after you have downloaded and installed an update package to activate it. But do the restart at an convenient time: Do not restart OpenEMM during a dispatch of a mailing, or right after the dispatch (due to the brief downtime of the redirect service causing missed openings and click redirects).
- +----
-Beginning with runtime version 19.07.011 you can simplify the update process even more. Simply start OpenEMMInstaller from the command line with option "-update" (use //sudo// to be able to update the backend): +
-<code> +
-$ sudo /home/openemm/bin/OpenEMMInstaller.sh -update +
-</code> +
-In this case, if OpenEMMInstaller finds and applies an update, and it automatically restarts OpenEMM afterwards. +
-\\ +
-\\+
 ===== 7. Administration ===== ===== 7. Administration =====
 ==== 7.1 Ressources ==== ==== 7.1 Ressources ====
Line 365: Line 359:
  
 At next server reboot, OpenEMM will be started automatically. At next server reboot, OpenEMM will be started automatically.
 +----
 ===== 8. Known Issues ===== ===== 8. Known Issues =====
  
 ==== 8.1 Open Issues ==== ==== 8.1 Open Issues ====
-  * O-291content for help menu is not available yet for download. **Workaround:** Beta version of PDF manual at https://www.agnitas.de/en/download/openemm-manual/+  * O-409openings and clicks are always shown for end user device class "PC" independent from its real origin
  
 ==== 8.2 Fixed Issues ==== ==== 8.2 Fixed Issues ====
 +Frontend 20.04.000.188 or later:
 +  * E-7052: no limit for no. of recipient profile fields
 +Frontend 20.04.000.185 or later:
 +  * O-447: statistics for mailing comparision do not work
 +Frontend 20.04.000.155 or later:
 +  * O-416: database update script reports error due to missing database entry
 Frontend 19.10.000.133 or later: Frontend 19.10.000.133 or later:
   * O-400: Export wizard does not allow change of character set   * O-400: Export wizard does not allow change of character set
Line 400: Line 401:
   * O-328: validator prevents some mailings from being saved   * O-328: validator prevents some mailings from being saved
 \\ \\
 +Backend 20.04.000.190 or later:
 +  * O-465: binary backend now works with both CentOS 8 **and** 7 out of the box
 +Backend 20.04.000.181 or later:
 +  * L-511: during busy times process table is not cleaned up properly from defunct python processes
 Backend 19.04.000.441 or later: Backend 19.04.000.441 or later:
   * O-362: optional individual setting of envelope email address is ignored   * O-362: optional individual setting of envelope email address is ignored
Line 409: Line 414:
   * O-340: mailloop service not reachable due to invalid path   * O-340: mailloop service not reachable due to invalid path
 \\ \\
 +Runtime 19.10.009.016 or later:
 +  * O-404: OpenEMMInstaller uses incorrect path for Tomcat Native (TLS support)
 Runtime 19.10.009.015 or later: Runtime 19.10.009.015 or later:
   * O-403: Tomcat updates by the OpenEMMInstaller could overwrite individual configuration (like TLS settings)   * O-403: Tomcat updates by the OpenEMMInstaller could overwrite individual configuration (like TLS settings)
Line 432: Line 439:
   * O-272: sub-menu 3 of menu 2 in OpenEMMInstaller does not work   * O-272: sub-menu 3 of menu 2 in OpenEMMInstaller does not work
 \\ \\
-===== 9. New Features of OpenEMM 19.10 =====+Manual 20.04.010 or later: 
 +  * O-291: content for help menu is not available yet for download 
 + 
 +---- 
 +===== 9. New Features of OpenEMM 19.10 (major changes) =====
  
   * E-6653: (reminder) campaigns can be sent to recipients with status "waiting for confirmation"   * E-6653: (reminder) campaigns can be sent to recipients with status "waiting for confirmation"
Line 441: Line 452:
   * E-6249: improved usability for visual target group editor   * E-6249: improved usability for visual target group editor
   * E-5438: email header "List-Unsubscribe" supports RFC 8058 for one-click unsubscriptions   * E-5438: email header "List-Unsubscribe" supports RFC 8058 for one-click unsubscriptions
-  * O-363: make OpenEMM work with Suse Linux 15+  * O-0363: make OpenEMM work with Suse Linux 15
   * G-4051: context-sensitive auto-complete suggestions for EQL editor   * G-4051: context-sensitive auto-complete suggestions for EQL editor
-  * B-849: new field entry_mailing_id in customer_binding_tbl for mailing that caused opt-in +  * B-0849: new field entry_mailing_id in customer_binding_tbl for mailing that caused opt-in 
-  * B-844: new link hash tag for encyption of data field+  * B-0844: new link hash tag for encyption of data field
   * various minor usability improvements like easier navigation, better formatting and sorting, optimized default settings, more precise notifications, better warning and error messages, new help balloons, additional logging of user activities, etc.   * various minor usability improvements like easier navigation, better formatting and sorting, optimized default settings, more precise notifications, better warning and error messages, new help balloons, additional logging of user activities, etc.
-  + 
-===== 10. Roadmap for OpenEMM 20.04 (as of November 15) =====+---- 
 +===== 10. New Features of OpenEMM 20.04 (major changes) ===== 
 +  * E-7114: new methods getMailingName and getMailingSubject for use in Velocity scripts 
 +  * E-7053: edit mode for comments in blacklist records 
 +  * E-7022: warning when saving a mailing with obsolete tags 
 +  * E-6956: prevent disabling of mailings used in activated autoresponder 
 +  * E-6955: new field "reason" for blacklist entries 
 +  * E-6954: action-based mailings used by bounce filters can not be deactivated 
 +  * E-6947: show relations of custom profile fields to target groups
   * E-6934: show fields of default salutations as read-only   * E-6934: show fields of default salutations as read-only
   * E-6905: show by which actions an action-based mailings is used   * E-6905: show by which actions an action-based mailings is used
Line 454: Line 473:
   * E-6841: improved usability for creating date-based target groups   * E-6841: improved usability for creating date-based target groups
   * E-6824: "used in" tab of target groups extended with mailing content blocks and export profiles as "used in" sources   * E-6824: "used in" tab of target groups extended with mailing content blocks and export profiles as "used in" sources
-  * E-6762: improve usability of page to edit mailing contents+  * E-6762: improved usability for page to edit mailing contents 
 +  * E-6526: improved usability for HTML-to-text conversion option
   * E-6468: redesign of configuration page in tab "send mailing"   * E-6468: redesign of configuration page in tab "send mailing"
 +  * E-6431: email confirmation for password changes
 +  * E-6329: improved usability of configuration for bounce filter and autoresponder
   * E-5987: edit lock for mailing content if more than one user tries to change it at the same time   * E-5987: edit lock for mailing content if more than one user tries to change it at the same time
   * E-5839: when a newly entered email address already exist, offer to show (and edit) its profile data   * E-5839: when a newly entered email address already exist, offer to show (and edit) its profile data
 +  * E-5586: new permission for every web service method to grant fine-grained permission schemas to web service accounts
   * E-5583: new math tag agnDAYS_UNTIL   * E-5583: new math tag agnDAYS_UNTIL
   * E-5496: show anonymous openings and clicks over time in separate charts   * E-5496: show anonymous openings and clicks over time in separate charts
   * E-5223: detect duplicate recipients in EMM database   * E-5223: detect duplicate recipients in EMM database
 +  * E-4686: brute-force login protection for webservices API
   * E-4542: end device type as selector for heatmap statistics   * E-4542: end device type as selector for heatmap statistics
   * E-2609: assess complexity of target groups and show resulting performance indicators   * E-2609: assess complexity of target groups and show resulting performance indicators
   * E-0707: redesign of left navigation bar   * E-0707: redesign of left navigation bar
   * G-4289: reworked link tab for user forms    * G-4289: reworked link tab for user forms 
 +  * G-4376: A/B test campaigns for workflow manager and new tab "Auto Optimization" in sub-menu Archive of Mailing menu
 +  * S-1791: ability to stop and resume mailings even when generation or sending of mailing has already started
   * various minor usability improvements like easier navigation, better formatting and sorting, optimized default settings, more precise notifications, better warning and error messages, new help balloons, additional logging of user activities, etc.   * various minor usability improvements like easier navigation, better formatting and sorting, optimized default settings, more precise notifications, better warning and error messages, new help balloons, additional logging of user activities, etc.
  
-===== 11. Building OpenEMM yourself =====+---- 
 +===== 11. New features of OpenEMM 20.10 (major changes) ===== 
 +  * E-7664: User roles can be assigned to another user role 
 +  * E-7639: support more than one forward email address for response mail filters 
 +  * E-7518: more granular data types: for numbers integer and float can be selected, for dates datetime and date only are possible 
 +  * E-7438: univeral RESTful API 
 +  * E-7396: new script methods for subscription forms to filter accepted and rejected email address domains 
 +  * E-7105: period of validity for passwords and 2FA cookies can be configured via GUI 
 +  * E-7103: number of login retries and blocking time can be configured via GUI 
 +  * E-7101: revised requirements for complexity of GUI passwords and WS passwords (can be modified by user) 
 +  * E-7084: sort option for link list in link tab of mailing menu 
 +  * E-6793: OpenEMM users can be assigned more than one role 
 +  * E-6529: statistic summary for auto-optimized list split mailings 
 +  * E-6294: allow date calculations for target groups using binding information 
 +  * E-0712: dark mode for GUI 
 +  * G-4162: export of web forms as JSON file 
 +  * G-4157: export of mailings as JSON file 
 +  * L-0483: extend system status page with download of individual configuration parameters (backup) 
 +  * O-0417: backend and frontend merged into one single tarball 
 +  * various minor usability improvements like easier navigation, better formatting and sorting, optimized default settings, more precise notifications, better warning and error messages, new help balloons, additional logging of user activities, etc. 
 + 
 +---- 
 +===== 12. Building OpenEMM yourself =====
  
 Download the source code of OpenEMM 2019 from GitHub at https://github.com/agnitas-org/openemm to a directory of your choice. Download the source code of OpenEMM 2019 from GitHub at https://github.com/agnitas-org/openemm to a directory of your choice.
Line 479: Line 527:
 </code> </code>
  
 +If you want to compile the OpenEMM backend on a Linux platform that does not offer static libraries (like CentOS 8), the static libraries for //libssl// and //libcrypto// will be missing. To fix that, edit file //Makefile// in directory //src/c/xmlback/// and remove parameters
 +<code>
 +-Wl,-Bstatic
 +</code>
 +and
 +<code>
 +-Wl,-Bdynamic
 +</code>
 +from the "LIBS" definition.
 ==== Frontend ==== ==== Frontend ====
 Copy template files //build.properties.default//, //build-birt.properties.default// and //build-ws.properties.default// to files with names //build.properties//, //build-birt.properties// and //build-ws.properties// and adapt the paths mentioned in these 3 files to your needs. Copy template files //build.properties.default//, //build-birt.properties.default// and //build-ws.properties.default// to files with names //build.properties//, //build-birt.properties// and //build-ws.properties// and adapt the paths mentioned in these 3 files to your needs.
Line 485: Line 542:
 $ ant -f build.xml $ ant -f build.xml
 </code> </code>
-We have built the binaries with Linux distribution CentOS 7. We are preparing a separate wiki page with instructions on how to build OpenEMM 2019 with Linux distribution Suse 15. 
start.txt · Last modified: 2024/03/27 13:50 by ma