Recent changes to Installing Roth

Installing Roth modified by James M. Payne

James M. Payne — Sun, 09 Jun 2019 21:47:16 -0000

--- v13
+++ v14
@@ -21,11 +21,11 @@
     * javax.mail-1.6.2.jar
 * String Manipulation (**optional**; only needed if using Roth's JsonUtil class)
     * commons-text-1.6.jar ([Download](https://commons.apache.org/proper/commons-text/download_text.cgi))
-    * commons-lang3-3.8.1.jar ([Download](http://commons.apache.org/proper/commons-lang/download_lang.cgi))
-* PDFBox (**optional**; only needed if using Roth's PDF classes -- Still under development) ([Download](https://pdfbox.apache.org/download.cgi))
-    * pdfbox-2.0.13.jar
-    * fontbox-2.0.13.jar
-    * xmpbox-2.0.13.jar
+    * commons-lang3-3.9.jar ([Download](http://commons.apache.org/proper/commons-lang/download_lang.cgi))
+* PDFBox (**optional**; only needed if using Roth's PDF wrapper classes) ([Download](https://pdfbox.apache.org/download.cgi))
+    * pdfbox-2.0.15.jar
+    * fontbox-2.0.15.jar
+    * xmpbox-2.0.15.jar
 * POI (**optional**; only needed if using Roth's Excel classes -- Still under development) ([Download](https://poi.apache.org/download.html))
     * poi-3.17.jar
     * poi-ooxml-3.17.jar

Installing Roth modified by James M. Payne

James M. Payne — Sun, 03 Mar 2019 23:52:30 -0000

--- v12
+++ v13
@@ -94,11 +94,11 @@

 ~~~~~
 :::xml
-  <env-entry> 
-       <env-entry-name>rothTemp</env-entry-name>
-       <env-entry-type>java.lang.String</env-entry-type>
-       <env-entry-value>${catalina.base}/temp/</env-entry-value> 
-   </env-entry>
+<env-entry> 
+    <env-entry-name>rothTemp</env-entry-name>
+    <env-entry-type>java.lang.String</env-entry-type>
+    <env-entry-value>${catalina.base}/temp/</env-entry-value> 
+</env-entry>
 ~~~~~

 *Important:* You may instead choose to add the resource to *server.xml* with a resource link in *context.xml*.  The difference is that if the resource is defined in *server.xml*, then the same resource will be used by all contexts (applications) running in that Tomcat instance, and if the resource is defined in *context.xml*, then each context running in that Tomcat instance will have it's own resource.  What this means is that if a resource limits to 25 connections, the *server.xml* method would use at most 25 connections, where the *context.xml* method would use up to 25 connections per context (5 contexts would result in up to 125 connections).

Installing Roth modified by James M. Payne

James M. Payne — Sun, 03 Mar 2019 23:51:46 -0000

--- v11
+++ v12
@@ -88,6 +88,19 @@
           maxWaitMillis="10000" maxIdle="30" maxTotal="100"/>
 ~~~~~

+*web.xml*
+
+Add the **rothTemp** environment variable:
+
+~~~~~
+:::xml
+  <env-entry> 
+       <env-entry-name>rothTemp</env-entry-name>
+       <env-entry-type>java.lang.String</env-entry-type>
+       <env-entry-value>${catalina.base}/temp/</env-entry-value> 
+   </env-entry>
+~~~~~
+
 *Important:* You may instead choose to add the resource to *server.xml* with a resource link in *context.xml*.  The difference is that if the resource is defined in *server.xml*, then the same resource will be used by all contexts (applications) running in that Tomcat instance, and if the resource is defined in *context.xml*, then each context running in that Tomcat instance will have it's own resource.  What this means is that if a resource limits to 25 connections, the *server.xml* method would use at most 25 connections, where the *context.xml* method would use up to 25 connections per context (5 contexts would result in up to 125 connections).

 ##Start Tomcat

Installing Roth modified by James M. Payne

James M. Payne — Sun, 03 Mar 2019 21:43:04 -0000

--- v10
+++ v11
@@ -1,15 +1,15 @@
 Notice:  These instructions are for Tomcat.  Theoretically Roth should work with JBoss and GlassFish as well, but that has not be tested.

-**Minimum Requirements**
--
+##Minimum Requirements
+
 These instructions assume that the following are already installed.

 * MySQL 5.7+/8+
 * Java 11 (suggest OpenJDK 11)
 * Tomcat 9

-**Required JARs**
--
+##Required JARs
+
 (not included in zip file; see lib_requirements.zip)

 * MySQL ([Download](https://dev.mysql.com/downloads/connector/j/5.1.html))
@@ -37,8 +37,8 @@
     * log4j-1.2.17.jar
     * xmlbeans-2.6.0.jar

-**Installation**
--
+##Installation
+
 Copy **roth-lib.jar** and all other needed JARs (from above list) to Tomcat's *lib* folder.
 Copy **Roth.war**, **RothDeveloper.war**, and **RothInstaller.war** to Tomcat's *webapps* folder.

@@ -52,8 +52,8 @@

 *(please note that for better security, you should change the above statement to restrict the allowed user connection to a specific host; for example 'localhost' if MySQL and Tomcat are on the same server)*

-**Tomcat Configuration**
--
+##Tomcat Configuration
+
 *server.xml*

 Within the Engine section make sure that your Realm looks like this:
@@ -90,12 +90,12 @@

 *Important:* You may instead choose to add the resource to *server.xml* with a resource link in *context.xml*.  The difference is that if the resource is defined in *server.xml*, then the same resource will be used by all contexts (applications) running in that Tomcat instance, and if the resource is defined in *context.xml*, then each context running in that Tomcat instance will have it's own resource.  What this means is that if a resource limits to 25 connections, the *server.xml* method would use at most 25 connections, where the *context.xml* method would use up to 25 connections per context (5 contexts would result in up to 125 connections).

-**Start Tomcat**
--
+##Start Tomcat
+
 Now, start the Tomcat server and test by pointing your browser at http://localhost:8080/RothInstaller to get to the installation page.  It should read "Non Installed".  Click on the "Install Roth" button to create the database tables.  After installing, you will be automatically redirected to the **Roth** home page.

-**Additional Information**
--
+##Additional Information
+
 If using RothDeveloper with Oracle, you will need to add this startup argument to Tomcat: 

 ~~~~~

Installing Roth modified by James M. Payne

James M. Payne — Sun, 03 Mar 2019 21:39:22 -0000

--- v9
+++ v10
@@ -12,21 +12,21 @@
 -
 (not included in zip file; see lib_requirements.zip)

-* MySQL
+* MySQL ([Download](https://dev.mysql.com/downloads/connector/j/5.1.html))
     * mysql-connector-java-...-bin.jar
-* JSTL ([Download](https://tomcat.apache.org/download-taglibs.cgi)
+* JSTL ([Download](https://tomcat.apache.org/download-taglibs.cgi))
     * taglibs-standard-spec-1.2.5.jar
     * taglibs-standard-impl-1.2.5.jar
-* Mail (**optional**; only needed if using Roth's Email class)
+* Mail (**optional**; only needed if using Roth's Email class) ([Download](https://javaee.github.io/javamail/))
     * javax.mail-1.6.2.jar
 * String Manipulation (**optional**; only needed if using Roth's JsonUtil class)
-    * commons-text-1.6.jar
-    * commons-lang3-3.8.1.jar
-* PDFBox (**optional**; only needed if using Roth's PDF classes -- Still under development)
+    * commons-text-1.6.jar ([Download](https://commons.apache.org/proper/commons-text/download_text.cgi))
+    * commons-lang3-3.8.1.jar ([Download](http://commons.apache.org/proper/commons-lang/download_lang.cgi))
+* PDFBox (**optional**; only needed if using Roth's PDF classes -- Still under development) ([Download](https://pdfbox.apache.org/download.cgi))
     * pdfbox-2.0.13.jar
     * fontbox-2.0.13.jar
     * xmpbox-2.0.13.jar
-* POI (**optional**; only needed if using Roth's Excel classes -- Still under development)
+* POI (**optional**; only needed if using Roth's Excel classes -- Still under development) ([Download](https://poi.apache.org/download.html))
     * poi-3.17.jar
     * poi-ooxml-3.17.jar
     * poi-ooxml-schemas-3.17.jar

Installing Roth modified by James M. Payne

James M. Payne — Sun, 03 Mar 2019 21:32:29 -0000

--- v8
+++ v9
@@ -14,7 +14,7 @@

 * MySQL
     * mysql-connector-java-...-bin.jar
-* JSTL
+* JSTL ([Download](https://tomcat.apache.org/download-taglibs.cgi)
     * taglibs-standard-spec-1.2.5.jar
     * taglibs-standard-impl-1.2.5.jar
 * Mail (**optional**; only needed if using Roth's Email class)

Installing Roth modified by James M. Payne

James M. Payne — Sun, 03 Mar 2019 21:29:07 -0000

--- v7
+++ v8
@@ -2,7 +2,6 @@

 **Minimum Requirements**
 -
-
 These instructions assume that the following are already installed.

 * MySQL 5.7+/8+
@@ -40,7 +39,6 @@

 **Installation**
 -
-
 Copy **roth-lib.jar** and all other needed JARs (from above list) to Tomcat's *lib* folder.
 Copy **Roth.war**, **RothDeveloper.war**, and **RothInstaller.war** to Tomcat's *webapps* folder.

@@ -56,7 +54,6 @@

 **Tomcat Configuration**
 -
-
 *server.xml*

 Within the Engine section make sure that your Realm looks like this:
@@ -79,7 +76,7 @@

 *context.xml*

-Add the **roth** resource (you may also add this in server.xml with a resource link in context.xml):
+Add the **roth** resource:

 ~~~~~
 :::xml
@@ -91,6 +88,10 @@
           maxWaitMillis="10000" maxIdle="30" maxTotal="100"/>
 ~~~~~

+*Important:* You may instead choose to add the resource to *server.xml* with a resource link in *context.xml*.  The difference is that if the resource is defined in *server.xml*, then the same resource will be used by all contexts (applications) running in that Tomcat instance, and if the resource is defined in *context.xml*, then each context running in that Tomcat instance will have it's own resource.  What this means is that if a resource limits to 25 connections, the *server.xml* method would use at most 25 connections, where the *context.xml* method would use up to 25 connections per context (5 contexts would result in up to 125 connections).
+
+**Start Tomcat**
+-
 Now, start the Tomcat server and test by pointing your browser at http://localhost:8080/RothInstaller to get to the installation page.  It should read "Non Installed".  Click on the "Install Roth" button to create the database tables.  After installing, you will be automatically redirected to the **Roth** home page.

 **Additional Information**
@@ -102,4 +103,4 @@
 -Doracle.jdbc.useFetchSizeWithLongColumn=true
 ~~~~~

-Read here for more information: https://docs.oracle.com/cd/E11882_01/appdev.112/e13995/oracle/jdbc/OracleDriver.html
+Read here for more information, caveats, and other ways to implement this feature: https://docs.oracle.com/cd/E11882_01/appdev.112/e13995/oracle/jdbc/OracleDriver.html

Installing Roth modified by James M. Payne

James M. Payne — Sun, 03 Mar 2019 21:20:39 -0000

--- v6
+++ v7
@@ -93,3 +93,13 @@

 Now, start the Tomcat server and test by pointing your browser at http://localhost:8080/RothInstaller to get to the installation page.  It should read "Non Installed".  Click on the "Install Roth" button to create the database tables.  After installing, you will be automatically redirected to the **Roth** home page.

+**Additional Information**
+-
+If using RothDeveloper with Oracle, you will need to add this startup argument to Tomcat: 
+
+~~~~~
+:::script
+-Doracle.jdbc.useFetchSizeWithLongColumn=true
+~~~~~
+
+Read here for more information: https://docs.oracle.com/cd/E11882_01/appdev.112/e13995/oracle/jdbc/OracleDriver.html

Installing Roth modified by James M. Payne

James M. Payne — Sun, 03 Mar 2019 17:11:46 -0000

--- v5
+++ v6
@@ -18,16 +18,16 @@
 * JSTL
     * taglibs-standard-spec-1.2.5.jar
     * taglibs-standard-impl-1.2.5.jar
-* Mail (optional; only needed if using Roth's Email class)
+* Mail (**optional**; only needed if using Roth's Email class)
     * javax.mail-1.6.2.jar
-* String Manipulation (optional; only needed if using Roth's JsonUtil class)
+* String Manipulation (**optional**; only needed if using Roth's JsonUtil class)
     * commons-text-1.6.jar
     * commons-lang3-3.8.1.jar
-* PDFBox (optional; only needed if using Roth's PDF classes -- Still under development)
+* PDFBox (**optional**; only needed if using Roth's PDF classes -- Still under development)
     * pdfbox-2.0.13.jar
     * fontbox-2.0.13.jar
     * xmpbox-2.0.13.jar
-* POI (optional; only needed if using Roth's Excel classes -- Still under development)
+* POI (**optional**; only needed if using Roth's Excel classes -- Still under development)
     * poi-3.17.jar
     * poi-ooxml-3.17.jar
     * poi-ooxml-schemas-3.17.jar

Installing Roth modified by James M. Payne

James M. Payne — Sun, 03 Mar 2019 17:11:09 -0000

--- v4
+++ v5
@@ -9,7 +9,9 @@
 * Java 11 (suggest OpenJDK 11)
 * Tomcat 9

-**Required JARs** (not included in zip file; see lib_requirements.zip)
+**Required JARs**
+-
+(not included in zip file; see lib_requirements.zip)

 * MySQL
     * mysql-connector-java-...-bin.jar
@@ -37,6 +39,7 @@
     * xmlbeans-2.6.0.jar

 **Installation**
+-

 Copy **roth-lib.jar** and all other needed JARs (from above list) to Tomcat's *lib* folder.
 Copy **Roth.war**, **RothDeveloper.war**, and **RothInstaller.war** to Tomcat's *webapps* folder.
@@ -52,6 +55,7 @@
 *(please note that for better security, you should change the above statement to restrict the allowed user connection to a specific host; for example 'localhost' if MySQL and Tomcat are on the same server)*

 **Tomcat Configuration**
+-

 *server.xml*