Install and Configure PoolParty GraphViews
We explain here how to install and configure PoolParty GraphViews with PoolParty.
Prerequisites
Java 17 is installed (OpenJDK).
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
andpp.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
Notice
The default directory of the graphview.properties
file is /opt/poolparty/tomcat/webapps/GraphViews/WEB-INF/classes
.
If PoolParty GraphViews is deployed on the same Tomcat server as PoolParty, the URL provided should be the localhost
. An external URL where PoolParty is running can also be specified.
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 required;
# 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 stored:
logging.level.root=WARN
catalina.home=<TOMCAT_HOME>/tomcat
logging.file=${catalina.home}/logs/ppgv.log
Package and Install in Tomcat
To package and install PoolParty GraphViews in Tomcat:
Download the
GraphViews.war
file;Copy it to the folder
<PPAppDir>/tomcat/webapps
(or if PoolParty is not installed totomcat/webapps
);Restart PoolParty (if PoolParty is installed).
Optionally Overwrite the Default Properties
Should it be required to overwrite the default properties, proceed as follows
Copy
graphviews.properties
to the corresponding configuration folder (e.g./opt/poolparty/tomcat/conf
).Edit the properties as required. This file will then overwrite the properties of the
.war
application.Set a
spring_config_location
environment variable pointing to the folder containing yourgraphviews.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=<TOMCAT_HOME>/tomcat/conf/