Installing Elixir Repertoire Server

1. Ensure Java is pre-installed.
   
   • The software requires a Java VM version 1.4.2 or later. Java 5
     (a.k.a version 1.5) is recommended as some features are only
     available when running in Java 5.
     
     
   • Tip, To test if your system is Java enabled, open a Command Prompt
     or equivalent Console and enter

     java -version

     . This will show
     the version of Java installed in your system, if any.
     
     
   • StartServer / StopServer script reference to JAVA_HOME that is defined on the machine.
     If it is not defined, modify the script to the JVM location.
     
     
   • Default of maximum 512 MB as defined in StartServer script.
     Ensure that it does not exceed the available memory on the machines.
     



2. Unzip or unpack the archive (e.g. ERS-5.1.1.zip) to a suitable location on your machine.
   
   • To unzip ElixirReportServer.zip, you can use either using a GUI
     utility like winzip or type the following command at the command
     prompt to unzip ElixirReportServer.zip into a location of your
     choice which will be referred to as .
     

                    unzip ElixirReportServer.zip
                 

     
     or
     

                  jar -xvf ElixirReportServer.jar 
                    

     
     (You will need Java to be installed to extract a jar file)
     
     

     where unzip ElixirReportServer.zip is replaced by the name of your
     Elixir Report package file name.
     
     This command will create an ElixirReportServer sub-directory (in
     the current directory) which contains everything that you needed to
     run Elixir Report Server.
     




3. Deploying License Keys
   
   • The license key is provided as a Java Archive(JAR). The key can be
     deployed using the command line with:
     
     In Console mode:-
     

                  java -jar product-license-deployer.jar -c
                

     
     In Graphical Interface mode:-
     

                  java -jar product-license-deployer.jar
               

   • You may also manually deploy the key by unjaring (unzip) the key file.
     file. If deploying manually, copy the license key to the your user
     License can be deployed / defined in either
     
     • $ERS_HOME/<ext> =Supported from version 6.0 onwards=
     • $USER_HOME
     • classpath



4. Third Party Library
   
   • To be placed in $ERS_HOME/<ext>.
   
   
   • Includes JDBC driver, customed Java classes.
   
   



5. Running the Report Server
   • The default Server Listener Port is 7001.
   
   
   • The default JMX HTML port is 8089.
   
   
   • To run the server for Unix-like operating systems, use the
     startServer.sh. You should then see log messages from Elixir
     Report Server components as they are deployed in the server log
     file (look in the log directory for server.log).
     
     The last few messages should say similar as below:-
     

           2006-04-11 09:27:57,410,INFO , ER.Server - Server started on 7001<br>
           2006-04-11 09:27:59,072,INFO , net.NetServer - Server accepting connections on port 7001<br>
          

   
   
   • Alternatively, you can use the Java Client application shipped with
     the report server to the test the connection to the report server.
     The Java Client application can be found in the
     $ERS_HOME\clients\demo\JavaClientApp
     



6. Troubleshooting the report server (Optional)
   
   • f the report server is not running, you might have to add in the
     "-Djava.awt.headless=true" in the startServer.sh then re-start the
     report server.
     
     For example:
     
     

          $JAVACMD -mx512M -Djava.awt.headless=true -Delixir.home=..<br>
          -Delixir.config=../config -jar<br>
          -Djava.security.auth.login.config=../config/auth.conf<br>
          -Djava.security.policy=../config/java2.policy<br>
          RepertoireServer-Launcher.jar<br>
          

   • Check through the server.log for possible cause.



7. You should only configure the report server after you have verified,
   the report server is properly installed and running.


-- TanDunlin - 28 Jul 2006