...

...

Step 1  Copy the PhixFlow Webapp into Tomcat

To install the PhixFlow web application into Tomcat:

Copy $RELEASE/webapps/phixflow to $TOMCAT/webapps/phixflow

Step 2  Configure the Webapp

A number of Copy the following example configuration files must be copied from supplied templates and configuredand, where required, update them for your system.

...

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.

phixflow-datasource.xml

The PhixFlow webapp must be configured to give provide user access to the database user that has been created to hold the PhixFlow dataPhixFlow database. In phixflow-datasource.xml, enter an alias username and password. The actual username and password are stored in an encrypted keystore; see Configure a Keystore for Database Credentials

...

<property name="url">
	<value>[CONNECTION STRING]</value>
</property>
<property name="username">
	<value>[ALIAS-USERNAME]</value>
</property>
<property name="password">
	<value>[ALIAS-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:

...

4. Replace the temporary values with:

• USERNAME: the database user's name.
• PASSWORD: the database user's password.
• CONNECTION-STRING: this depends on the database platform, and is one of: 

Oracle:  jdbc:oracle:thin:@hostname:1521:phixflow

Oracle (> 12c with PDB containers):

...

   jdbc:oracle:thin:@hostname:1521/phixflow

SQL Server:

...

   jdbc:sqlserver://hostname\myservice;databaseName=phixflow

MySQL:

...

MariaDB:  jdbc:mariadb://

...

localhost/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.

...

These strings 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.

phixflow-secret.xml

If you have not already done so Configure a Keystore for Database Credentials. Use phixflow-secret.xml to specify the keystore details.

phixflow-login.xml

Anchor
phixflowDomainsXmlInstall phixflowDomainsXmlInstall

Copy the example file phixflow-login.xml.example to phixflow-login.xml

...

.

You will use this file if you need to configure PhixFlow to authenticate users’ usernames and passwords against an external

...

domain, or Active Directory, or a SAML Single Sign-on server

...

, such as the Active Directory Federation Services server.

...

Initially, simply copy the example file phixflow-login.xml.example to phixflow-login.xml.

See also Configure Login Forms.

...

For more information, see the pages in the User Administration topic.

logback.xml 

Anchor
logback logback

Copy the example file logback.xml.example to logback.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).

...

You only need to change this file:

• to rename the log file if you have multiple PhixFlow instances; see Multiple PhixFlow Webapps, below.
• to change the logging level when troubleshooting; see Server Log Files
• as requested by PhixFlow Support.

...

phixflow-logging.xml

Anchor
logging logging

Copy the example file phixflow-logging.xml.example to phixflow-logging.xml.

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.

...

You only need to change this file as requested 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/

Step 3  Restart Tomcat

Whenever you make changes in $TOMCAT/webapps/phixflow, remember to restart Tomcat, so that the changes are used.

Multiple PhixFlow Webapps

Anchor
renamingLogFile renamingLogFile

...

cp $RELEASE/webapps/phixflow to $TOMCAT/webapps/mywebapp<mywebapp>

where “mywebapp” <mywebapp> is the name of your test system.

phixflow-datasource.xml

Be sure Remember to set up a separate user and schema in the database for the new PhixFlow instance and to set phixflowconfigure phixflow-datasource.xml as needed.

logback.xml

By with the user, password and connection-string.

Renaming the Log File

For logback.xml, by default, the settings in this file will send messages from all phixflow PhixFlow webapps to the same log file (, phixflow.log); this can be confusing as it may not be . When you have multiple instances, it is not clear which webapp has generated which the messages, and for this reason . In this case, we recommend that when installing multiple PhixFlow webapps in the same tomcat, you change each webapp to log to into a separate log file, thus:

This example shows

...

.

For each instance, edit the logback.xml file and change all occurrences of the instance name to something unique. 

The following example uses the name mywebapp:

•  messages are re-directed initially to logs/mywebapp.log

...

• and logs/mysebapp-security.log
•  messages re-directed after daily rollover to logs/mywebapp.yyyy-MM-dd.log and logs/mywebapp-security.yyy-MM-dd.log.

... 
 <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
    <file>logs/mywebapp.log</file>
    <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">        
      <!-- daily rollover -->
      <fileNamePattern>logs/mywebapp.%d{yyyy-MM-dd}.log</fileNamePattern>
      <maxHistory>30</maxHistory>
    </rollingPolicy>
    <encoder>
      <pattern>%date %level [%thread] %logger{10} [%file:%line] %msg%n</pattern>
    </encoder>
  </appender>
...

...