Configuring Application Engine on JBoss Application Server

After you install the Application Engine server, you must configure JBoss Application Server to work with Application Engine. You can also configure changes for optional modes like SSO.

About this task

Remember: In farm and cluster environments, configure Application Engine on JBoss Application Server on all nodes.

Remember: In high availability clustered server configurations, for steps that require Java™ Virtual Machine (JVM) settings to be made make sure to make these changes for every node in the application server configuration.

To configure JBoss Application Server for Application Engine:

1. Stop the JBoss Application Server instance if it is running.
2. Make a backup copy of the run.conf (AIX®, HPUX, Linux, Linux on System z®, Solaris) or run.conf.bat (Windows) file and the startup script, depending on your platform:

   Option	Description
   AIX, HPUX, Linux, Linux on System z, Solaris	run.sh
   Windows and JBoss 5.0	run.bat
   Windows and JBoss 5.1	run.conf.bat

3. Edit the run.sh, run.conf, or run.conf.bat file Java settings:
   1. Add a line to specify the path to the JDK provided by JBoss Application Server, as shown in the following example (Windows): set JAVA_HOME=C:\Program Files\Java\jdk1.5.0_06

      If your JDK is different from version 1.5.0, substitute your version for the one listed.

   2. Update the JAVA_OPTS memory settings.

      Adjusting this setting prevents the application server from running out of memory, a condition in which users would not be able to log in to Workplace.

      In the JAVA_OPTS line, change the -Xms and -Xmx values for your configuration.

      Example (Windows): set JAVA_OPTS=%JAVA_OPTS% -Xms 128m -Xmx 512 m

      See your application server vendor recommendation for Initial and Maximum heap size values. For IBM® specific recommendations, see Performance tuning IBM FileNet® P8 components.

   3. (Sun JVM users only) Set the value of MaxPermSize in JAVA_OPTS to 128m, as follows:

      AIX, HPUX, Linux, Linux on System z, Solaris

      JAVA_OPTS=%JAVA_OPTS% -Xms128m -Xmx512m -XX:MaxPermSize=128m

      Windows

      set JAVA_OPTS=%JAVA_OPTS% -Xms128m -Xmx512m -XX:MaxPermSize=128m

      This increased value prevents out of memory errors that can stop JBoss Application Server.

   4. If your application server uses the IBM JVM, edit the JAVA_OPTS variable in the run.conf or run.conf.bat file immediately after the line in the previous substep. This JAVA_OPTS edit improves performance.

      AIX, HPUX, Linux, Linux on System z, Solaris

      Find the following line in the run.conf file:

      JAVA_OPTS="$JAVA_OPTS

      and change it to this (without a carriage return):

      JAVA_OPTS="$JAVA_OPTS -Dfilenet.pe.peorb.pool.min=2 
      -Dfilenet.pe.peorb.pool.max=5"

      Windows

      Find the following line in the run.bat or run.conf.bat file:

      set JAVA_OPTS=%JAVA_OPTS%

      and change it to this (without a carriage return):

      set JAVA_OPTS=%JAVA_OPTS% -Dfilenet.pe.peorb.pool.min=2 
      -Dfilenet.pe.peorb.pool.max=5

   5. For high availability environments, configure JNDI lookup to connect to Content Engine and allow failover.
      On each node, edit the run.bat or run.sh file to include the following, entered as a single line:

      -DFileNet.EJB.ContextProperties=java.naming.factory.initial=
      org.jboss.naming.NamingContextFactory

   6. Save your edits and close the file.
4. Configure JAAS login.

   Add one of the following right after the "$JAVA" $JAVA_OPTS (AIX, HPUX, Linux, Linux on System z, Solaris) or "%JAVA%" %JAVA_OPTS (Windows) entry in the run.sh file or the run.bat file, respectively

   Important: Enter the jaas_login entry as a single line without line breaks. Do not copy and paste the text from this guide because hidden formatting can cause problems with the entry. Instead, type the entry into the script.

   Your path might be slightly different depending on the version of your client installations, or whether you have chosen a custom path for installation. Verify the location of the file before you enter the path.

   AIX, HPUX, Linux, Linux on System z, Solaris

   "$JAVA" $JAVA_OPTS 
   -Djava.security.auth.login.config=
   "/opt/FileNet/AE/CE_API/config/jaas.conf.JBoss"
   "-Djava.endorsed.dirs=$JBOSS_ENDORSED_DIRS" -classpath
   "$JBOSS_CLASSPATH" org.jboss.Main $@

   Windows

   "%JAVA%" %JAVA_OPTS%
   "-Djava.security.auth.login.config=C:\Program
   Files\FileNet\AE\CE_API\config\jaas.conf.JBoss"
   "-Djava.endorsed.dirs=%JBOSS_ENDORSED_DIRS%" -classpath
   "%JBOSS_CLASSPATH%" org.jboss.Main %*

5. Save and close the run.sh, run.bat, or run.conf.batfile.
6. Configure LDAP settings on Application Engine to exactly match the Content Engine settings.
   1. On the Application Engine server, open login-config.xml, located in JBoss_home/server/server_name/conf, for editing.
   2. Set the <application-policy name="FileNet"> entry identical to the corresponding entry in the login-config.xml file on the Content Engine server.
   3. Set the <application-policy name="FileNetP8Engine"> entry identical to the corresponding entry in the login-config.xml file on the Content Engine server.
   4. Copy the new <application-policy name="FileNetP8Engine"> entry, and paste the copied entry directly before the entry you copied (<application-policy name="FileNetP8Engine">).
   5. Change the first instance of the <application-policy name="FileNetP8Engine"> to <application-policy name="FileNetP8">.
   6. Move all the FileNet-related <application-policy name=> entries above the <application-policy name="other"> entry.
   7. Save changes to the login-config.xml file on the Application Engine server.
   8. Start the JBoss Application Server instance.
7. Set permissions for the user running the application server.

   On Windows, the following requirement applies only to NTFS formatted partitions.

   If the user that runs the application server is different from the user that installed Application Engine, you must give the user read and write permissions on the folder where you installed Application Engine (AE_install_path).

8. (Optional) Disable JBoss Application Server logging.

   In development mode, JBoss Application Server creates many HTTP Access, INFO, DEBUG, and TRACE log messages. This can cause unexpected behavior in the deployed IBM FileNet software. You can limit this type of excessive JBoss Application Server logging.

   When logging is disabled, error messages still display in the JBoss Application Server console.

   1. Open the log4j.xml file (JBOSS_home/server/server_name/conf/log4j.xml) for editing.
   2. Change all threshold values and priority values from INFO, DEBUG, or TRACE to ERROR.
   3. Delete or comment out the Preserve messages in a local file to turn off the server log.
   4. To turn off HTTP access logging, open jboss-service.xml with a text editor and delete or comment out the "Access logger" section.

      Location of jboss-service.xml:

      JBoss_Home/server/server_name/deploy/jbossweb-tomcat55.sar/META-INF

   5. Open web.xml for editing and change the logVerbosityLevel to FATAL.

      Location of web.xml:

      JBoss_Home/server/server_name/deploy/jbossweb-tomcat55.sar/conf

   6. Restart the JBoss Application Server instance.