Install and Configure PoolParty GraphViews

We explain here how to install and configure PoolParty GraphViews with PoolParty.

Prerequisites

  • Java 11 is installed (OpenJDK or Oracle Java).
  • PoolParty is running on the server configured in graphviews.properties (pp.url).
  • A user with username and password is configured in graphviews.properties (pp.username and pp.password) and it exists as a PoolParty user.
  • The PoolParty instance has the user role API admin setup.
  • At least one group is configured in graphviews.properties and at least, one project is assigned to this group.

Installation Procedure

To install PoolParty GraphViews:

Configure the Application

Configure graphviews.properties based on the PoolParty server:

pp.groups=Public # the groups for which projects will be shown in GraphViews
pp.username=graphviews # the username of the API admin user configured in PoolParty pp.password=poolparty # the password of the API admin user configured in PoolParty pp.url=http://localhost:8081 # the url of the server where PoolParty is running

If PoolParty GraphViews is deployed on the same Tomcat server as PoolParty, the URL provided should be the localhost. However, an external URL where PoolParty is running can also be provided.

The name of the application is configured by the property server.servlet.context-path in application.properties.

server.servlet.context-path=/GraphViews

To allow the Tomcat server to handle the Javascript files with UTF-8 encoding the following lines in graphviews.properties are necessary.

# Charset of HTTP requests and responses. Added to the "Content-Type" header if not set explicitly.
spring.http.encoding.charset=UTF-8
# Enable http encoding support.
spring.http.encoding.enabled=true
# Force the encoding to the configured charset on HTTP requests and responses.
spring.http.encoding.force=true

The following properties define the logging level as well as the file where the logs are written:

logging.level.root=WARN
catalina.home=/opt/poolparty/tomcat
logging.file=${catalina.home}/logs/ppgv.log

Package and Install in Tomcat

To package and install PoolParty GraphViews in Tomcat:

  1. Download the GraphViews.war (external link) file,
  2. Copy it to the folder poolparty/tomcat/webapps (or if PoolParty is not installed to tomcat/webapps),
  3. Restart PoolParty (if PoolParty installed).

Overwrite the Default Properties

In order to overwrite the default properties:

  1. Copy graphviews.properties to the corresponding config folder (e.g. /opt/poolparty/tomcat/conf).
  2. Edit the properties accordingly (see Application Configuration). This file will overwrite the properties of the .war application.
  3. Set a spring_config_location environment variable pointing to the folder that contains your graphviews.properties file. In the case of Tomcat you can do this by adding the following line to your <TOMCAT_HOME>/bin/setenv.sh file (create the file if missing):

export spring_config_location=/opt/tomcat/conf/