Dodeca WAR File Preparation

Prerequisites

Below is a list of the tasks that must be performed, files that must be obtained, and information that must be gathered before you can use our tools to create your custom WAR file:

  1. You must have an Authenticode signing key from an authorized Certificate Authority (or "CA", such as VeriSign), the temporary key distributed by Applied OLAP, or a temporary key you have created yourself. The key must be in the form of a .pfx file. If you have a key from a CA that is in the form of public key/private key file pair, you can convert it to the .pfx format using the pvkimprt.exe tool available from Microsoft. See http://www.microsoft.com/downloads/details.aspx?FamilyID=F9992C94-B129-46BC-B240-414BDFF679A7&displaylang=EN for more information.
  2. You must have created a relational database for your Dodeca repository (we suggest you simply use the database name 'dodeca').
  3. You must obtain the proper JDBC driver (Note: the Microsoft SQL Server JDBC driver is shipped in the base Dodeca War file).
  4. You must determine the proper JDBC connection string, username, and password for Hibernate to function.

Step-by-Step Instructions to Create the War File

Once you have completed the above prerequisites, you are ready to start the creation of your WAR file for deployment. In order to create the WAR file, which is a Java archive of the \staging directory structure, follow these steps:

  1. First we need to modify the "dodeca.properties" file, located in the \staging\WEB-INF\classes subdirectory. There are two ways to modify the "dodeca.properties" file. The preferred method (a.) uses a tool shipped with the Dodeca Framework called dshell, but it requires that the Java Runtime Environment be installed on your computer. If you do not have or do not wish to install Java on your computer, or if you wish to configure some of the more advanced Hibernate properties available, you can use the alternate method (b.) below.

    1. From within the \bin directory, find the file "dshell.cmd" and double-click it to launch the dshell.

      image

      Once inside the dshell, type "jdbc-test" and press enter.

      image

      jdbc-test will ask you to select your JDBC Driver class. Choose your JDBC Driver class from the list provided and hit enter.

      image

      Next, you will be prompted for your Hibernate Dialect. Type in the appropriate hibernate dialect, or press enter to use the default. Jdbc-test will then prompt you for the connection username, connection password, database server, schema and JDBC URL. Once these parameters have been provided, Type "y" and enter to confirm the parameters are correct, and then press "y" and enter to test the conneciton

      image

      Once the connection successfully connects, type "y" and enter to encrypt the password. Next, type "y" and enter to update the existing dodeca.properties file. Lastly, type "y" and enter once more to write these settings to a connection file. The "dodeca-hibernate.properties" file has now been created to reflect the correct settings for your relational server and database.

  1. Locate the shortcut for the "ClickOnce Prep Utility" on the Start Menu or find it in the \bin subdirectory. Double-click it to run the ClickOnce Prep Utility application. In this utility, you will modify the property settings for your Dodeca system. At a minimum, the "DeploymentUrl" property must be updated to reference the application server/port/context where the completed WAR file will be deployed.

The ClickOnce Prep Utility will look something like this:

image

Note

The Deployment URL should include the application server name and port where the Dodeca servlet will be deployed. Its value will most likely vary from the value displayed in the screenshot above.

Note

The Certificate Password for the "dodeca_temp.pfx" key provided by Applied OLAP is "password".

Note

Once the property grid entries have been modified to suit your needs, you can use the ClickOnce Prep Utility to save the modified settings. To do this choose "Save Setting As" from the "File" menu. Enter the name under which you want to save your settings and press OK.

  1. When you are satisfied with your settings, compile the "dodeca.war" file by pressing the "Build Deployment" button at the bottom of the dialog. While the servlet is being compiled, its progress will be reported in the bottom panel:
image

Once the servlet is finished being compiled, the finished "dodeca.war" will be placed in the \servlet directory.