Difference between revisions of "Software Requirements"

From AgileApps Support Wiki
imported>Aeric
 
(118 intermediate revisions by 3 users not shown)
Line 1: Line 1:
===Software Requirements===
<includeonly>===Software Requirements===</includeonly>
<noinclude>__TOC__</noinclude>


====Installing MySQL Version 8.0.xx====
<!--
Stefka Dimitrova maintains the spreadsheet with OS and DB requirements:
DRAFT VERSION:
http://iwiki.eur.ad.sag:8080/display/RNDROS/%282015Oct%29+webMethods+and+Intelligent+Business+Operations+System+Requirements+9.9 (for webMethods 9.9)
 
PUBLISHED AT:
http://documentation.softwareag.com/webmethods/wmsuites/wmsuites_vers.htm
Marianne Fuller maintains the installation document for the standard SAG installation:
https://iwiki.eur.ad.sag/display/RNDWMSE/2015Oct+%289.9%29+Release+Installer+Designs+and+Install+Doc
  / Installation Guide
-->
{| border="1" cellpadding="5" cellspacing="0"
{| border="1" cellpadding="5" cellspacing="0"
|-valign="top"
|Operating System
|
* RedHat Enterprise Linux Server - Version 7, Version 8 (recommended), or Version 9
{{Note| For RedHat Enterprise Linux Server, ensure that you perform the steps mentioned in the [[Additional Step for RedHat]] article.}}
* SUSE Linux Enterprise Server - Version 11 or Version 12 (recommended)
* CentOS Linux - Release 7
{{Note| You must change the System Locale Language settings to English USA}}
* Windows Server 2016
|-valign="top"
|MySQL Server||
*MySQL Version 8.0.xx (i.e 8.0.29) (Community Edition or Enterprise Edition)
*MySQL Commercial or Community Client
*MySQL Commercial or Community Server
*MySQL Commercial or Community libraries
*MySQL Commercial or Community compatibility libraries
*MySQL Commercial or Enterprise common files
If you are a platform user, see [[Configure the MySQL Server]].
<br>To know more about MySQL 8 removed functionality, please click <span class="plainlinks">[https://dev.mysql.com/doc/refman/8.0/en/mysql-nutshell.html#mysql-nutshell-removals here]</span>
{{Note|
* The '''MySQL RDS version 8''' certification with the AgileApps version 10.16 is still '''in progress'''.
* The primary difference between MySQL v8 on-premises and MySQL v8 RDS is the restricted access to the parameters on RDS, which requires certain additional configuration steps to complete the setup and data migration.
* The deprecated ASC or DESC qualifiers for GROUP BY clauses are removed. This impacts the custom SQL used in the application and results in a database syntax error. It is recommended that the application designer reviews the custom SQL used in the application to adopt MYSQL 8.
** Java [[execSQL|execSQL API]]
** REST [[REST_API:execSQL_Resource|execSQL Resource]]
**SQL Browser [[SQL Browser|SQL Browser]] }}
|-valign="top"
| <span id="libs">Libraries</span> || Download the '''third-party libraries''' and save them in a folder.<br>You may want to integrate them into the system during the installation.
:* Download mysql-connector-java-8.0.29.jar [https://dev.mysql.com/downloads/connector/j/ here]
{{Note| If mysql j/connector 8 series is used then set below properties in jdbc connection url string}}
'''scrollTolerantForwardOnly=true'''
<br>'''Example''':
<br>Edit below files present in <Install-dir>/profiles/IS_default/configuration/com.softwareagplatform.config.propsloader folder and add '''scrollTolerantForwardOnly=true''' in jdbc connection url values in the below listed property files:
#com.softwareag.catalina.resource.pid-agileappsRN.properties
#com.softwareag.catalina.resource.pid-agileappsQuartz.properties


|}
====Installing MySQL Version 5.7.xx====
<!--
Stefka Dimitrova maintains the spreadsheet with OS and DB requirements:
DRAFT VERSION:
http://iwiki.eur.ad.sag:8080/display/RNDROS/%282015Oct%29+webMethods+and+Intelligent+Business+Operations+System+Requirements+9.9 (for webMethods 9.9)
 
PUBLISHED AT:
http://documentation.softwareag.com/webmethods/wmsuites/wmsuites_vers.htm
Marianne Fuller maintains the installation document for the standard SAG installation:
https://iwiki.eur.ad.sag/display/RNDWMSE/2015Oct+%289.9%29+Release+Installer+Designs+and+Install+Doc
  / Installation Guide
-->
{| border="1" cellpadding="5" cellspacing="0"
|-valign="top"
|-valign="top"
|Operating System ||
|Operating System
* RedHat Linux Enterprise Server (ES) Release 5 (Kernel version greater or equivalent to 2.6.18-xx) or any other distribution of Linux with kernel version greater or equivalent to 2.6.18
|
* 64 bit OS recommended
* RedHat Enterprise Linux Server - Version 7, Version 8 (recommended), or Version 9
* With Perl Installed (compatible with MySQL Server)
* SUSE Linux Enterprise Server - Version 11 or Version 12 (recommended)
* CentOS Linux - Release 7
{{Note| You must change the System Locale Language settings to English USA}}
* Windows Server 2016


|-valign="top"
|-valign="top"
|Java ||
|MySQL Server||
* J2SE 7.0 (JDK version 1.7.0, release _06 or above)
*MySQL Version 5.7.xx (Community Edition or Enterprise Edition)
*MySQL Commercial or Community Client
*MySQL Commercial or Community Server
*MySQL Commercial or Community libraries
*MySQL Commercial or Community compatibility libraries
*MySQL Commercial or Enterprise common files
If you are a platform user, see [[Configure the MySQL Server]].


|-valign="top"
|-valign="top"
|MySQL Server ||
| <span id="libs">Libraries</span> || Download the '''third-party libraries''' and save it in a folder.<br>You may want to integrate them into the system during the installation.
*MySQL Version 5.5.xx  (Community Edition or Community Enterprise Edition)
:* Download mysql-connector-java-5.1.24-bin.jar [http://dev.mysql.com/downloads/connector/j/ here].
*MySQL Client
:* Download jta.jar [http://download.oracle.com/otndocs/jcp/7287-jta-1.0.1a-class-oth-JSpec/?submit=Download here]
*MySQL Shared libraries
|}
*MySQL Shared compatibility libraries
*MySQL Headers and libraries
*Required configuration for the platform. (''See:'' [[Configuring the MySQL Server]])


====Required for Basic Platform Functionality====
{| border="1" cellpadding="5" cellspacing="0"
|-valign="top"
|-valign="top"
|Mail Server ||
|Mail Server
|
;Mail Server Configuration:  
;Mail Server Configuration:  
:*Choose any of postfix, sendmail, etc.  
:*Choose any postfix, sendmail or so on.  
:*This mail server should run on TCP Port 25
:*Run the mail server on TCP Port 25<br>The mail server should always be up and running for the platform functionality to work as expected
:*The mail server should always be up and running for the platform functionality to work as expected
:*Test and verify the Mail Server MTA ([http://en.wikipedia.org/wiki/Mail_transfer_agent Mail Transfer Agent]) with the following command:
:*Test and verify the Mail Server MTA ([http://en.wikipedia.org/wiki/Mail_transfer_agent Mail Transfer Agent]) with this command:
::<tt>echo "test mail" | mail -s "hello" admin-name@myserviceproviderdomain.com</tt>
::<tt>echo "test mail" | mail -s "hello" admin-name@myserviceproviderdomain.com</tt>
::An email message should be received at the specified address. If the confirmation message does not arrive, check the mail log to discover the cause.
An email message should be received at the specified address. If the confirmation message does not arrive, check the mail log to discover the cause.
 
<span id="Cache"></span>
|-valign="top"
|Cache
|
;Memcached 1.4.10 for caching:
:*Downloaded Memcached from http://memcached.org/<br/>
::Memcached requires installation of <tt>libevent</tt> library version 2.0.16 (An event notification library) for your Operating System. It can be downloaded from http://www.monkey.org/~provos/libevent/. For more information, see [[Configuring memcached]].
;Ehcache for caching:
Ehcache is available in the Common Tomcat profile. For more information, see [[Configuring Ehcache]].
 
|-valign="top"
| Web Server ||
;Apache HTTP server 2.2.21 (Optional, but recommended):
The Apache web server can be placed in front of the Tomcat appserver to deliver static content more efficiently.<br>It is recommended for systems with large numbers of [[Static Resources]] and Documents<br>The following modules must be compiled into Apache during installation:
:::* <tt>mod_proxy</tt>
:::* <tt>mod_ssl</tt>
:::* <tt>mod_expires</tt>
:::* <tt>mod_headers</tt>
For more information, see [[Installing and Configuring Apache for Use with the Platform]].
 
|-valign="top"
| Java ||
The installation and operation of the AgileApps Cloud platform requires Java 8. However, the custom code in Java Class continues to be validated against Java 6 syntax as the instrumentation engine responsible for monitoring resource utilization works only on Java 6 byte codes.


|-valign="top"
|-valign="top"
| Open Office ||
| Browser Support ||
* Install the appropriate version of Open Office for your system from http://www.openoffice.org/download/
;Application excluding Process:
* Add the following command to your system startup process:
:*Internet Explorer 11
:<tt>soffice -headless -accept="socket,host=127.0.0.1,port=8100;urp;" -nofirststartwizard</tt>
:*Microsoft Edge
:*Firefox 32 (Minimum requirement)
:*Chrome 48.0.2564 (Minimum requirement)
;Process Model:
:*Does not support Internet Explorer
:*Does not support Microsoft Edge
:*Firefox 32 (Minimum requirement)
:*Chrome 48.0.2564 (Minimum requirement)
As part of the security processes, the '''Remember me on this computer''' option is removed from the browser's login page.  
::{{Common:ProcessEditingNote}}
:: [[Accessibility Mode]] requires Firefox
|}


====Required for Additional Functionality====
{| border="1" cellpadding="5" cellspacing="0"
<span id="openoffice"></span>
|-valign="top"
|-valign="top"
|Memcached
| OpenOffice (optional) ||
|
;OpenOffice 3.2.0 or higher:
;Memcached 1.4.10 or later for caching:
:* This utility is required when generating PDFs from MS Word [[Document Templates]]
:* Memcached can be downloaded from http://memcached.org/<br/>
:* It also used to support one-click viewing of documents, when configured in [[networking.properties]]
:* Memcached requires installation of <tt>libevent</tt> library version 2.0.16 (An event notification library) for your Operating System. It can be downloaded from http://www.monkey.org/~provos/libevent/
:* Install the appropriate version of OpenOffice for your system from http://www.openoffice.org/download/
:* ''Learn More:'' [[Configuring memcached]]
:* Add the following command to your system startup process:
::<tt>soffice -headless -accept="socket,host=127.0.0.1,port=8100;urp;" -nofirststartwizard</tt>
{{Note|If you have a problem with glibc library version incompatibility while installing OpenOffice 3.4.x (for RedHat with version 5.6 and lower), you should download and install [http://ftp.rz.tu-bs.de/pub/mirror/openoffice-archive/stable/3.2.0/ OpenOffice 3.20]}}


|-valign="top"
|-valign="top"
| Web Server ||
| HornetQ (optional) ||
;'''Optional, but Recommended''':
;HornetQ 2.2.14:
;Apache HTTP server 2.2.21:
The Messaging Server is an optional platform component that:
:*The following modules must be compiled into Apache during installation:
<!--::* Handles messages sent by a [[Twitter Search]]. Commenting out due to LJP-8904-->
::<tt>mod_proxy</tt>
::* Handles the on-screen notifications to prevent editing collisions when users view the same Case.
::<tt>mod_ssl</tt>
Get HornetQ from http://www.jboss.org/hornetq/downloads.html. For more information, see [[Installing the Messaging Server]].
::<tt>mod_expires</tt>
::<tt>mod_headers</tt>
:*Instructions are provided on how to configure the Apache HTTPD server so that it can be in front of the Tomcat server to serve static content
::[[Installing and Configuring Apache for Use with the Platform]]


|-valign="top"
| Charting Libraries (optional) ||
Additional libraries are needed to email a chart or a report. For more information, see [[Install the Chart Handling Libraries]].
|}
|}
<noinclude>
<noinclude>

Latest revision as of 11:40, 2 November 2023

Installing MySQL Version 8.0.xx

Operating System
  • RedHat Enterprise Linux Server - Version 7, Version 8 (recommended), or Version 9

Notepad.png

Note: For RedHat Enterprise Linux Server, ensure that you perform the steps mentioned in the Additional Step for RedHat article.

  • SUSE Linux Enterprise Server - Version 11 or Version 12 (recommended)
  • CentOS Linux - Release 7

Notepad.png

Note: You must change the System Locale Language settings to English USA

  • Windows Server 2016
MySQL Server
  • MySQL Version 8.0.xx (i.e 8.0.29) (Community Edition or Enterprise Edition)
  • MySQL Commercial or Community Client
  • MySQL Commercial or Community Server
  • MySQL Commercial or Community libraries
  • MySQL Commercial or Community compatibility libraries
  • MySQL Commercial or Enterprise common files

If you are a platform user, see Configure the MySQL Server.
To know more about MySQL 8 removed functionality, please click here

Notepad.png

Note:

  • The MySQL RDS version 8 certification with the AgileApps version 10.16 is still in progress.
  • The primary difference between MySQL v8 on-premises and MySQL v8 RDS is the restricted access to the parameters on RDS, which requires certain additional configuration steps to complete the setup and data migration.
  • The deprecated ASC or DESC qualifiers for GROUP BY clauses are removed. This impacts the custom SQL used in the application and results in a database syntax error. It is recommended that the application designer reviews the custom SQL used in the application to adopt MYSQL 8.
Libraries Download the third-party libraries and save them in a folder.
You may want to integrate them into the system during the installation.
  • Download mysql-connector-java-8.0.29.jar here

Notepad.png

Note: If mysql j/connector 8 series is used then set below properties in jdbc connection url string

scrollTolerantForwardOnly=true
Example:
Edit below files present in <Install-dir>/profiles/IS_default/configuration/com.softwareagplatform.config.propsloader folder and add scrollTolerantForwardOnly=true in jdbc connection url values in the below listed property files:

  1. com.softwareag.catalina.resource.pid-agileappsRN.properties
  2. com.softwareag.catalina.resource.pid-agileappsQuartz.properties

Installing MySQL Version 5.7.xx

Operating System
  • RedHat Enterprise Linux Server - Version 7, Version 8 (recommended), or Version 9
  • SUSE Linux Enterprise Server - Version 11 or Version 12 (recommended)
  • CentOS Linux - Release 7

Notepad.png

Note: You must change the System Locale Language settings to English USA

  • Windows Server 2016
MySQL Server
  • MySQL Version 5.7.xx (Community Edition or Enterprise Edition)
  • MySQL Commercial or Community Client
  • MySQL Commercial or Community Server
  • MySQL Commercial or Community libraries
  • MySQL Commercial or Community compatibility libraries
  • MySQL Commercial or Enterprise common files

If you are a platform user, see Configure the MySQL Server.

Libraries Download the third-party libraries and save it in a folder.
You may want to integrate them into the system during the installation.
  • Download mysql-connector-java-5.1.24-bin.jar here.
  • Download jta.jar here

Required for Basic Platform Functionality

Mail Server
Mail Server Configuration
  • Choose any postfix, sendmail or so on.
  • Run the mail server on TCP Port 25
    The mail server should always be up and running for the platform functionality to work as expected
  • Test and verify the Mail Server MTA (Mail Transfer Agent) with the following command:
echo "test mail" | mail -s "hello" admin-name@myserviceproviderdomain.com

An email message should be received at the specified address. If the confirmation message does not arrive, check the mail log to discover the cause.

Cache
Memcached 1.4.10 for caching
Memcached requires installation of libevent library version 2.0.16 (An event notification library) for your Operating System. It can be downloaded from http://www.monkey.org/~provos/libevent/. For more information, see Configuring memcached.
Ehcache for caching

Ehcache is available in the Common Tomcat profile. For more information, see Configuring Ehcache.

Web Server
Apache HTTP server 2.2.21 (Optional, but recommended)

The Apache web server can be placed in front of the Tomcat appserver to deliver static content more efficiently.
It is recommended for systems with large numbers of Static Resources and Documents
The following modules must be compiled into Apache during installation:

  • mod_proxy
  • mod_ssl
  • mod_expires
  • mod_headers

For more information, see Installing and Configuring Apache for Use with the Platform.

Java

The installation and operation of the AgileApps Cloud platform requires Java 8. However, the custom code in Java Class continues to be validated against Java 6 syntax as the instrumentation engine responsible for monitoring resource utilization works only on Java 6 byte codes.

Browser Support
Application excluding Process
  • Internet Explorer 11
  • Microsoft Edge
  • Firefox 32 (Minimum requirement)
  • Chrome 48.0.2564 (Minimum requirement)
Process Model
  • Does not support Internet Explorer
  • Does not support Microsoft Edge
  • Firefox 32 (Minimum requirement)
  • Chrome 48.0.2564 (Minimum requirement)

As part of the security processes, the Remember me on this computer option is removed from the browser's login page.

Important:
To edit a Process Model, use Firefox or Chrome. Other browsers may work poorly, or not all.
Accessibility Mode requires Firefox

Required for Additional Functionality

OpenOffice (optional)
OpenOffice 3.2.0 or higher
soffice -headless -accept="socket,host=127.0.0.1,port=8100;urp;" -nofirststartwizard

Notepad.png

Note: If you have a problem with glibc library version incompatibility while installing OpenOffice 3.4.x (for RedHat with version 5.6 and lower), you should download and install OpenOffice 3.20

HornetQ (optional)
HornetQ 2.2.14

The Messaging Server is an optional platform component that:

  • Handles the on-screen notifications to prevent editing collisions when users view the same Case.

Get HornetQ from http://www.jboss.org/hornetq/downloads.html. For more information, see Installing the Messaging Server.

Charting Libraries (optional)

Additional libraries are needed to email a chart or a report. For more information, see Install the Chart Handling Libraries.