...
...
...
...
These instructions are written assuming configuration will be in the local.properties file. However, this isn't the only place that configuration options can be configured.
| Table of Contents | ||||
|---|---|---|---|---|
|
Configuration Files
| Insert excerpt | ||||||||
|---|---|---|---|---|---|---|---|---|
|
Step 1 Shutdown Tomcat
If Tomcat is currently running then shut it down before proceeding with the following steps.
Step 2 Copy the PhixFlow Webapp into Tomcat
To install the PhixFlow web application into Tomcat:
Copy $RELEASE/webapps/phixflow to $TOMCAT/webapps/phixflow
...
Configure the Webapp
A number of configuration files must be copied from supplied templates and configured.
...
The PhixFlow webapp can be configured to authenticate users’ usernames and passwords against an external Domain / Active Directory or SAML Single Sign-on server e.g. Active Directory Federation Services server.
Initially, simply copy the example file phixflow-login.xml.example to phixflow-login.xml.
...
The logback.xml file controls detailed event/error logging on the server.
Initially, simply copy the example file logback.xml.example to logback.xml.
For instructions on how to change the name of the log file generated, see below.
Please contact PhixFlow Support for instructions on how to integrate this into other logging frameworks (e.g. Google Cloud's stackdriver).
It is not normally necessary to make any further changes to this file unless so instructed by PhixFlow Support.
| Info |
|---|
| If it is ever necessary to change the logback.xml, those changes will take effect within a minute or so, without having to restart the Tomcat server. |
...
The phixflow-logging.xml file contains a list of directories that contain log files, and is used when downloading log files from the GUI.
Initially, simply copy the example file phixflow-logging.xml.example to phixflow-logging.xml.
It is not necessary to make any further changes to this file unless so instructed by PhixFlow Support.
Using Your own Logo in PhixFlow
Optionally, you can configure PhixFlow to display your own company logo. You need a vector graphic .svg file of your logo, renamed as customerLogo.svg (case sensitive). Add the file to $TOMCAT/webapps/phixflow/gui/images/
...
Linux
Make sure that the file ownership is set correctly for the installed webapp(s):
| Code Block |
|---|
sudo chown -R tomcat:tomcat $TOMCAT/webapps/phixflow |
Step 3 Create Configuration Files
Copy the following example configuration files and, where required, update them for your system.
| Info |
|---|
The files are in |
Configure phixflow-datasource.xml
The PhixFlow webapp must be configured to give access to the database user that has been created to hold the PhixFlow data.
Copy phixflow-datasource.xml.<database>.example to phixflow-datasource.xml, then
Edit the properties for <bean id="dataSource"..... For example:
| Code Block | ||
|---|---|---|
| ||
<property name="url">
<value>[CONNECTION STRING]</value>
</property>
<property name="username">
<value>[USERNAME]</value>
</property>
<property name="password">
<value>[PASSWORD]</value>
</property> |
Connection Strings
The connection strings given here should cover most cases of connecting to PhixFlow's own database. For information about how connection strings are constructed for the various database platforms supported by PhixFlow, see Database URLs.
The platform-specific [CONNECTION STRING]s are:
Oracle:
| Code Block |
|---|
jdbc:oracle:thin:@hostname:1521:phixflow |
Oracle (> 12c with PDB containers):
| Code Block |
|---|
jdbc:oracle:thin:@hostname:1521/phixflow |
SQL Server:
| Code Block |
|---|
jdbc:sqlserver://hostname\myservice;databaseName=phixflow |
MySQL:
| Code Block |
|---|
jdbc:mysql://hostname/phixflow |
Configure phixflow-instance.xml
phixflow-instance.xml identifies the webapp instance in a resilient configuration and sets whether the instance is active on startup.
Initially, simply copy the example file phixflow-instance.xml.example to phixflow-instance.xml.
...
- Make a copy of local.example.properties and rename it to local.properties
- Make a copy of logback.phixflow.xml.example and rename it to logback.phixflow.xml
Step 4 Create PhixFlow File System
| Note |
|---|
Strictly speaking, all of the steps in this section are options - you can configure the file system as you wish, providing that you update System Configuration with the paths you have set up. However, this is PhixFlow's recommended set up, and is widely used across many PhixFlow installations. This section also includes instructions for creating a soft-link from the PhixFlow file system area to Tomcat. It is recommended that you create this because it is needed to support creation of most applications in PhixFlow. In the commands below, a soft link is created from |
- C:/app/phixflow/data/$WEBAPP
- C:/app/phixflow/data/$WEBAPP/upload
- C:/app/phixflow/data/$WEBAPP/temp
- C:/app/phixflow/data/$WEBAPP/import
- C:/app/phixflow/data/$WEBAPP/export
- C:/app/phixflow/data/$WEBAPP/datalink
- C:/app/phixflow/data/$WEBAPP/templates
- C:/app/phixflow/data/$WEBAPP/archive
- C:/app/phixflow/data/$WEBAPP/driverFiles
- C:/app/phixflow/data/$WEBAPP/download
Create the soft-link in a CMD or Powershell session:
| Code Block |
|---|
mklink /D C:\app\tomcat\webapps\$WEBAPP\datalink C:\app\phixflow\data\$WEBAPP\datalink |
Linux
| Code Block |
|---|
export WEBAPP=[webapp name, e.g. phixflow]
sudo mkdir /opt/phixflow/data/$WEBAPP
sudo mkdir /opt/phixflow/data/$WEBAPP/upload
sudo mkdir /opt/phixflow/data/$WEBAPP/temp
sudo mkdir /opt/phixflow/data/$WEBAPP/import
sudo mkdir /opt/phixflow/data/$WEBAPP/export
sudo mkdir /opt/phixflow/data/$WEBAPP/datalink
sudo mkdir /opt/phixflow/data/$WEBAPP/templates
sudo mkdir /opt/phixflow/data/$WEBAPP/archive
sudo mkdir /opt/phixflow/data/$WEBAPP/driverFiles
sudo mkdir /opt/phixflow/data/$WEBAPP/download
sudo chown -R tomcat:tomcat /opt/phixflow/data/$WEBAPP
cd /opt/phixflow/data/$WEBAPP; sudo chmod g+w upload temp export datalink
sudo ln -sf /opt/phixflow/data/$WEBAPP/datalink /opt/tomcat/webapps/$WEBAPP/datalink |
Step 5 Configure Essential Properties
Refer to Server Configuration Properties for the full list of available configuration properties. Refer to Configure a Keystore and Aliases if a keystore is being used.
The recommended minimum for a basic install in the local.properties file is as follows. This will create a new user called admin. The password will be autogenerated and written to the security.log file. It is strongly recommended that this password is changed immediately after installation.
| Code Block |
|---|
install.customer_name=<your customer name as provided with your licence>
install_licence_key=<Licence key as provided with your licence>
install.data.base=<C:/app/phixflow/data/$WEBAPP, /opt/phixflow/data/$WEBAPP, or other selected directory>
db.url=<database jdbc url>
phixflow-database-user=<database username>
phixflow-database-password=<database password> |
| Note |
|---|
For new installations, install.data.base should be explicitly configured in the local.properties file to configure the location of the data folders. |
The configuration settings are show below:
| Insert excerpt | ||||||||
|---|---|---|---|---|---|---|---|---|
|
Step 6 Restart Tomcat
Whenever you make changes in $TOMCAT/webapps/phixflow, remember to restart Tomcat, so that the changes are used.
Linux
If you have followed PhixFlow's recommended installation for PhixFlow, you can use the commands:
| Code Block |
|---|
sudo systemctl stop tomcat
sudo systemctl start tomcat |
Either do Minimum Set-up After Installation on page Administration, or instruct the people you are delivering this to to complete these steps immediately
Multiple PhixFlow Webapps
| Anchor | ||||
|---|---|---|---|---|
|
To install multiple instances of PhixFlow on a single server, complete the installation steps above to create a first PhixFlow instance. Then install a further instance:
- Create a second database user to hold the data for the new instance.
- Copy the PhixFlow web application into the Tomcat again:
| Code Block |
|---|
cp $RELEASE/webapps/phixflow to $TOMCAT/webapps/ |
...
<mywebapp> |
where
...
<mywebapp> is the name of your
...
new instance.
phixflow-datasource.xml
Remember to set up a separate user and schema in the database for the new PhixFlow instance and to
...
configure phixflow-datasource.xml
...
with the user, password and connection-string.
Renaming the Log File
By default, the settings in
...
logback.xml send log messages from all
...
PhixFlow webapps to the same log file
...
, phixflow.log
...
. When you have multiple instances, it is then not clear which webapp has generated which messages
...
. In this case, we recommend that
...
you change each webapp to log
...
into a separate log file
...
This example shows
line 3: messages re-directed initially to logs/mywebapp.log
line 6: messages re-directed after daily rollover to logs/mywebapp.yyyy-MM-dd.log.
...
| language | xml |
|---|---|
| title | logback.xml |
| linenumbers | true |
...
.
For each webapp, edit the local.properties file and set the change the name of the log file to something that uniquely identifies which webapp it has been generated by - we recommend phixflow_webappName.log (where webappName should be changed to the name of the webapp). This can be configured by setting logging.file.phixflow.base=phixflow_webappName