Install the PhixFlow Database Schema

Owned by Gary Parden
Last updated: Aug 29, 2024 by Samuel Kirby
4 min read

Version differences

The database installation process differs between version 10 and version 11, please follow the relevant instructions below:

 

Introduction

The schema installation and upgrade process in 11 onwards has been simplified so that Phixflow manages most of the process. 

A DBA however is required to configure the initial database user/schema that Phixflow will use. Phixflow manages its own tables and therefore requires being connected with a user with sufficient permissions to create and drop tables and indexes.

Create the database user

If you are  Database Administrator (DBA) and no database / login have previously been set up, you should use the following commands to create a new database / user.

Creating the database user is dependent on the database platform, and will often have to be varied to meet local requirements regarding naming and security. These example commands will be adequate basic installations.

Platform

Create the database user

Oracle:

This command will prompt for the name of the user to be created.

sqlplus SYS/SYSPassword@SID as SYSDBA @install/oracle/create_user

Sql Server:

Before creating the database, ensure that default collation is Latin1_General_100_CI_AI_SC_UTF8

SELECT SERVERPROPERTY('collation');

If it is not, please talk to the database administrator to get this updated to the required collation (see also Install MS SQL Server).

This command creates a local (SQL Server) login, a user with required user mappings, sets the password for the login and creates the database.

sqlcmd -S localhost\myservice -i /install/sql_server/create_database_and_user.sql -v dbName="phixflow" dbLogin="phixflow" dbUser="phixflow" dbPassword="mypass"

Run the following command to confirm the collation setting is correct.

MySQL:

Connect to the database as root (or an administrator):

If you followed the suggested PhixFlow installation notes for installing MySQL, you will be using unix_socket authentication (see Install MySQL), and the command to log into the database as root is simply:

Create the user, supplying the name of the database, the user and the password in the commands below:

Introduction

The schema installation prepares Phixflow to be able to use the database has 4 main steps, regardless of platform:

  1. Create the database user

  2. Create the tables required

  3. Populate them with initial configuration data

  4. Set the customer name

All of the commands below should be run from an operating system command window e.g. bash (Linux) or cmd (Windows), and the current directory should be set to that containing the installation instructions for the target platform. E.g.

Create the database user

If you are  Database Administrator (DBA) and no database / login have previously been set up, you should use the following commands to create a new database / user.

Creating the database user is dependent on the database platform, and will often have to be varied to meet local requirements regarding naming and security. These example commands will be adequate basic installations.

Platform

Create the database user

Oracle:

This command will prompt for the name of the user to be created.

Sql Server:

Before creating the database, ensure that default collation is Latin1_General_100_CI_AI_SC_UTF8:

If it is not, please talk to the database administrator to get this updated to the required collation (see also Install MS SQL Server).

This command creates a local (SQL Server) login, a user with required user mappings, sets the password for the login and creates the database.

MySQL:

Connect to the database as root (or an administrator):

If you followed the suggested PhixFlow installation notes for installing MySQL, you will be using unix_socket authentication (see Install MySQL), and the command to log into the database as root is simply:

Create the user, supplying the name of the database, the user and the password in the commands below:

Populate the Database

Once you have created the database and/or database user, run the installer to create the database tables and initial data.

  1. In your command console, change to the directory where you extracted the release zip  then to the install directory. 

  2. Run the installation command for your database (listed below).

The customer name in the commands below must exactly match the customer name used by PhixFlow Support to generate licence files. This argument (–customer="Your Customer Name") is optional, but if you don't specify a valid customer name you will not be able to install the licence key and you will not be able to run any tasks in PhixFlow.

The database connection strings given here should cover most cases of connecting to PhixFlow's own database. For more details, see Database URLs for how connection strings are constructed for the various database platforms supported by PhixFlow.

SQL Server:

If a database, with login details, was provided (i.e. you did not perform the step above for creating the login, user and database), please check that the database has the correct collation:

E.g.

Then run the command:

MySQL:

Oracle:

Oracle (> 12c with PDB containers):