Deploying BIRT

You must follow a set of guidelines when you deploy BIRT in your web application server. There is a different set of guidelines for deploying BIRT on WebLogic and on WebSphere. When you run the Unica installer, you completed the following actions:

• You created the WAR file of BIRT (hcl-birt.war).

We assume that you possess the information on how to work with your web application server. For details, such as navigation in the Administration console, see your web application server documentation.

Guidelines for deploying BIRT on WebLogic

You must follow a set of guidelines when you deploy BIRT on the WebLogic application.

Use the following guidelines when you deploy the BIRT products on any supported version of WebLogic:
  • Unica products customize the Java virtual machine (JVM) used by WebLogic. If you encounter errors related to JVM, you can create a WebLogic instance that is dedicated to Unica products.
  • Open the startWebLogic.cmd file and verify that the SDK that is selected for the WebLogic domain that you are using is the Sun SDK for the JAVA_VENDOR variable. The JAVA_VENDOR variable must be set to Sun (JAVA_VENDOR=Sun).

    If the JAVA_VENDOR variable is set to JAVA_VENDOR, it means that JRockit is selected. You must change the selected SDK as JRockit is not supported. See the BEA WebLogic documentation to change the selected SDK.

  • Deploy BIRT as a web application.
  • If you are configuring WebLogic to use the IIS plug-in, review the BEA WebLogic documentation.
  • Complete the following tasks if your installation must support non-ASCII characters, for example for Portuguese or for locales that require multi-byte characters:
    1. Edit the setDomainEnv script in the bin directory under your WebLogic domain directory to add -Dfile.encoding=UTF-8 to JAVA_VENDOR.
    2. In the WebLogic console, click the Domain link on the home page.
    3. In the Web Applicationstab, select the Archived Real Path Enabled check box.
    4. Restart WebLogic.
    5. Deploy and start the hcl-birt.war file.
  • If deploying in a production environment, set the JVM memory heap size parameters to 1024 by adding the following line to the setDomainEnv script: Set MEM_ARGS=-Xms1024m -Xmx1024m -XX:MaxPermSize=256m

Guidelines for deploying BIRT on WebSphere

You must follow a set of guidelines when you deploy BIRT on Websphere. Ensure that the version of WebSphere meets the requirements that are described in the Recommended Software Environments and Minimum System Requirements document, including any necessary fix packs. Use the following guidelines when you deploy BIRT on WebSphere:
  1. Specify the following custom property in the server:
    • Name: com.ibm.ws.webcontainer.invokefilterscompatibility
    • Value: true
  2. Set a custom property in WebSphere.
  3. Deploy the unica.war file as an enterprise application. When you deploy the unica.war file, ensure that the JDK source level of the JSP compiler is set to Java 17 for SDK 1.7 and 18 for SDK 1.8, and that JSP pages are precompiled according to the following information:
    • In the form where you browse to and select the WAR file, select Show me all installation options and parameters so the Select Installation Options wizard runs.
    • In step 1 of the Select Installation Options wizard, select Precompile JavaServer Pages files.
    • In step 3 of the Select Installation Options wizard, ensure that the JDK Source Level is set to 17 for SDK 1.7 and set to 18 for SDK 1.8.
    • In step 8 of the Select Installation Options wizard, select UnicaPlatformDS as the matching Target Resource.
    • In step 10 of the Select Installation Options wizard, the context root must be set to /birt-hcl, all lower case.
  4. In the Web Container Settings > Web Container > Session Management section of the server, enable cookies. Specify a different session cookie name for each application that is deployed. Use one of the following procedures to specify a cookie name:
    • Select the Override session management check box under Session Management. If you deployed separate WAR files for your Unica products, in the WebSphere console, in the Applications > Enterprise Applications > [deployed_application] > Session Management > Enable Cookies > Cookie Name section of the server, specify a unique session cookie name].
    • If your installation must support non-ASCII characters, for example for Portuguese or for locales that require multi-byte characters, add the following arguments to Generic JVM Arguments at the server level.

      -Dfile.encoding=UTF-8

      -Dclient.encoding.override=UTF-8

  5. Navigation tip: Select Servers > Application Servers > Java and Process Management > Process Definition > Java Virtual Machine > Generic JVM Arguments. See the WebSphere documentation for additional details.
  6. In the Applications > Enterprise Applications section of the server, select the WAR file that you deployed, then select Class loading and update detection and specify the following properties. If you are deploying a WAR file:
    • For Class loader order, select Classes loaded with local class loader first (parent last).
    • For WAR class loader policy, select Single class loader for application.
  7. Start your deployment. If your instance of WebSphere is configured to use a JVM version 1.7 or newer, complete the following steps to work around an issue with the time zone database.
    • Stop WebSphere.
    • Download the Time Zone Update Utility for Java (JTZU).
    • Follow the steps provided by the IBM (JTZU) to update the time zone data in your JVM.
    • Restart WebSphere.
  8. In Websphere Enterprise Applications, select Your Application > Manage Modules > Your Application> Class Loader Order > Classes loaded with local class loader first (parent last).
    • The recommended minimum heap size for the basic functioning of the application is 512 and the recommended maximum heap size is 1024. Complete the following tasks to specify the heap size:
      • In WebSphere Enterprise Applications, select Servers > WebSphere application servers > server1 > Server Infrastructure > Java and Process Management > Process definition > Java Virtual Machine.
      • Set the initial heap size to 512.
      • Set the maximum heap size to 1024. See the WebSphere documentation for more information about sizing. For DB2, set progressiveStreaming = 2 in WebSphere console at following path: JDBC >Data sources > UnicaPlatformDS > Custom properties.

Guidelines for deploying BIRT on JBoss

Before deploying hcl-birt.war in JBOSS application server, update the hcl-birt.war file.

  1. Extract hcl-birt.war.
  2. Remove the following jar files from hcl-birt/WEB-INF/lib directory.
  3. Create hcl-birt.war after removing the above mentioned jar files.
    • saaj.jar
    • javax.xml.stream_1.0.1.v201004272200.jar
    • javax.xml_1.3.4.v201005080400.jar
    • jaxrpc.jar
    • org.apache.xerces_2.9.0.v201101211617.jar

You must follow a set of guidelines when you deploy BIRT on JBoss. Make sure that the version of JBoss meets the requirements that are described in the Recommended Software Environments and Minimum System Requirements document. Use the following guidelines when you deploy BIRT on JBoss:

Use the following guidelines when you deploy the BIRT products on any supported version of JBoss:
  1. Deploy the birt-hcl.war file as an enterprise application. For example: deploy <Platform_Install>\ birt-hcl.war.

    See https://docs.jboss.org/jbossweb/3.0.x/deployer-howto.html for instructions on Deploying Web Server Application in JBoss.

  2. Complete the following tasks if your installation must support non-ASCII characters, for example for Portuguese or for locales that require multi-byte characters:
    • Edit the standalone.conf script in the bin directory under your JBOSS /bin directory to add -Dfile.encoding=UTF-8.

      -Dclient.encoding.override=UTF-8

      -Djboss.as.management.blocking.timeout=3600

      to JAVA_VENDOR.
    • Restart JBoss server.

Guidelines for deploying BIRT on Apache Tomcat

You must follow a set of guidelines when you deploy BIRT on Apache Tomcat.

Ensure that the version of Apache Tomcat meets the requirements that are described in the HCL Enterprise Products Recommended Software Environments and Minimum System Requirements document. Use the following guidelines when you deploy BIRT on Apache Tomcat:
  1. Deploy the HCL hcl-birt.war file as an enterprise application on Tomcat Apache server.
  2. Complete the following tasks if your installation must support non-ASCII characters, for example for Portuguese or for locales that require multi-byte characters:
    • Edit the setenv.sh file for the respective product instances script in the bin directory under your tomcat instances directory to add -Dfile.encoding=UTF-8 - Dclient.encoding.override=UTF-8 to JAVA_VENDOR.
    • Edit the setenv.sh file for the respective product instances script in the bin directory under your tomcat instances directory to add -Dfile.encoding=UTF-8 - Dclient.encoding.override=UTF-8 to JAVA_VENDOR.
    • Edit the setenv.sh file for the respective product instances script in the bin directory under your tomcat instances directory to add -Dfile.encoding=UTF-8 - Dclient.encoding.override=UTF-8 to JAVA_VENDOR.
    • Edit the setenv.sh file for the respective product instances script in the bin directory under your tomcat instances directory to add -Dfile.encoding=UTF-8 - Dclient.encoding.override=UTF-8 to JAVA_VENDOR.
    • Restart Tomcat.
  3. If deploying in a production environment, you can add JVM heap setting for that tomcat instance in app-one/bin/setenv.sh file respectively for all the instances.