Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents


You will need the Jasper Server zip file sent to you by AgileAssets to begin.

Setup the File

  1. Unzip the jasperserver-6.4.2.zip file that is provided as part of the release to your desired location.

    It will create several screens worth of directories similar to this:

  2. Create the specific directory for the Jasper Report Server:

    In the example above, ours is jasperreports-server-pro-6.4.2-bin

  3. Enter the Buildomatic Directory by typing cd buildomatic/

    This is the where all the install work will be done.

  4. Type cp where the cursor appears in the image below to tell the program that you want it to copy. Then copy the green text associated with your database type and paste it after cp to tell the program what to copy.

    The image above shows the information for several types of databases.

    Note
    Note: Oracle is the most commonly used database type in this instance. Verify with your IT team if needed.
  5. Then add the location where you unzipped the initial files to tell the program where you would like to copy to.. Enter the information for the type of database you'll be using.

    In the example above, our file location is usr/local/jasperreports-server-pro-6.4.2 but yours may be different.

  6. Add /buildomatic after your file location because we will be adding this to the Buildomatic directory.

    And now you will name your file. In the screenshot in step 5, we named ours default_master.properties. You can name your file anything you would like but you'll need to keep track of the name for future steps.

  7. Hit enter and it will look something like the sample below:

Install the File

Use the screenshot in Setup Step 7 for reference.

IF you already have a Tomcat server installed, follow these steps before installation:

  1. Stop your Tomcat server if it is already installed and running:
  2. And verify that it is stopped:
  3. Run the Jasper Server Install script with the minimal tag:
Note
Note: If you encounter this error, it may mean that you have a previous instance of the Jasper Server. Type y to continue the installation:


If not, follow these steps to install:

  1. Verify that your appServerType is tomcat as shown in Setup Step 7.
  2. Verify that everything else that appears has a # before it – this tells the program to ignore the row so that you can use it for reference but it won’t affect the installation.
  3. Set the location of your Tomcat to the location of your unzipped file from Setup Step 1.
  4. Update/verify the following fields:
    1. You must set your own system password.
    2. Only change the database password and system username from the default if you would like.
    3. Do not change the database username.

      Note

      Note: Keep track of any usernames or passwords you set yourself.

  5. Set Database Host, Database Port, Service Name/ID to tell the program how to connect to the database.
    You can now scroll down to the Setup Standard Oracle JDBC Driver section.
  6. Remove the # before the jdbc, drivermaker, maven.jdbc.artifactid, and maven.jdbc.version rows so that they are included in the installation.

  7. Update the Artifact ID and Version to match the screenshot above.
    The installer uses this information to identify the jar file it uses to the connect to the database.
    The rest of the automatically generated text is correct.
  8. Once the build is complete, you should see this message:

    Note
    Note: Total time will vary.
  9.   Copy this jar file to the tomcat lib directory:

    A successful copy will look similar to this:

  10. Change the ownership to tomcat tomcat:

  11. Copy it to the webapps directory:

    A successful copy will look something like this:

  12. Change the owner of that recursively:

    Which should look something like this:

The final two rows above indicate that the process has been successful. Then you can safely start Tomcat.

You can verify a successful installation by logging into the TIBCO Jaspersoft website with the login superuser and the password superuser. Once logged in, you can change this log in info for that site.

Edit the File

Now we’ll edit the file we just created.

  1. Start at the appServerDir line. Remove the # at the beginning of the line so that it will be included in the installation. Now add the path for the file location you unzipped the initial folder to and add your appServerType
    Our new appServerDir looks like this:
  2. Your database type should be set to Oracle.
  3. Set your system username and the passwords for the database and the system.

    Note

    Note: Keep track of any usernames or passwords you set yourself.

  4. The database username must remain jasperserver.

  5. Set the passwords for the database and system.
    There are no requirements for how long your password needs to be or what it needs to contain.

  6. The system username will be the database administrator’s username. This is the user who will have the abilities to create schemas and change the database going forward.
    In the example above we set our database password to jasperserver and our system username to system and the password has not been filled out.

  7. Once you’ve set your system password move down to the additional parameters section. Anything with a # at the beginning of the line will be ignored by the system, leave them with the # unless you need to make a change to one of these sections. 
  8. Verify your dbhost and dbport don't have a #. If there is one at the beginning of either row, remove it
  9. You can now scroll down to the  service name section.

    In the example above, we set ours to castordb.

The program uses a combination of the host, the port, and the service fields to identify the jar file it needs to use to connect to the database.

Once you’ve finished these changes you can save the file. Now you’ve successfully edited the Default Master Properties in the Buildomatic directory.

Copy the jasperserver-pro.war into the Buildomatic directory by typing the last line of the following screenshot:



Install AMS Reporting

ams-reporting is an executable jar file that contains an embedded tomcat server. You must decide where to run the ams-reporter service and what port to assign at configuration time.


  1. Create a new folder to copy ams-reporting.jar

    Code Block
    themeRDark
    mkdir -p /prod/ams
  2. Copy ams-reporting.jar to the folder created in step 1.

    Code Block
    themeRDark
    cp ams-reporting.jar /prod/ams
  3. Run ams-reporter using jar command and arguments. (java -jar /prod/ams/ams-reporting.jar ${options})

    Code Block
    themeRDark
    java -jar /prod/ams-reporting/ams-reporting.jar -Dspring.datasource.url='$JDBC_URL' -Dspring.datasource.username='$JDBC_USER' -Dspring.datasource.password='$JDBC_PASSWORD' --server.port=8082 -Djasper.external-url='$JASPER_EXT_URL' -Djasper.user-name='$JASPER_USER' -Djasper.password='$JASPER_PASSWORD' &

    Example:

    Code Block
    themeRDark
    java -jar ams-reporting-7.3.0.0-RELEASE.jar -Dspring.datasource.url='jdbc:oracle:thin:@//DB_SERVER:1521/SERVICE_NAME' -Dspring.datasource.username='FLEET_TXCPA' -Dspring.datasource.password='FLEET_TXCPA' --server.port=8082 --jasper.base-url='http://JASPER_SERVER:8080/jasperserver-pro' --jasper.user-name='superuser' --jasper.password='superuser' 

    NOTE

    Note

    When installing on another server with a different Java subversion, the above command created an "Unknown host specified" error. A differently formatted line worked instead and it is shown below:

    Code Block
    themeRDark
    java -jar ams-reporting-7.3.0.0-RELEASE.jar --spring.datasource.url=jdbc:oracle:thin:@//DB_SERVER:1521/SERVICE_NAME --spring.datasource.username=AMS_LA --spring.datasource.password=AMS_LA --server.port=8082 --jasper.base-url=http://JASPER_SERVER:8080/jasperserver-pro --jasper.user-name=superuser --jasper.password=superuser