Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This page is for administrators who need to connect PhixFlow to external databases using Driver Classes.

...

PhixFlow requires access to the database driver jar files in order to communicate with a database. Use the driver class properties to configure with the details of the database, its driver and the location of the Jar jar files.

PhixFlow is installed with a set of driver jar files and their associated Driver Classes

Insert excerpt
_driver_class_repo
_driver_class_repo
nopaneltrue
 in the full repository. You can use these driver classes in a datasource -. However, you cannot update or change the pre-configured driver classes, which are:

...

  1. An administrator with permission to add system files must download the required jdbc JDBC drivers and save them to the system.
    To avoid your drivers being overwritten during Tomcat or PhixFlow upgrades, we recommend that you save them in a different part of the system. 

  2. The PhixFlow administrator configures a driver class for the driverJDBC drivers, specifying the database driver name and its path.

...

To create a driver class, in the full repository scroll down to the ICON 

Insert excerpt
_driver_class_repo
_driver_class_repo
nopaneltrue
section. 

To add a new driver, right-click ICON and Driver Classes and select 

Insert excerpt
_add
_add
nopaneltrue
. PhixFlow opens a property tab where you can enter the details for the new driver.

To open an existing driver class, in the repository click on  on its name.

Tip

You cannot change the pre-configured driver classes supplied with your PhixFlow installation

...

. These have the System Defined property ticked.

Driver Classes and Driver Class File Properties

...

Insert excerpt
_standard_settings
_standard_settings
nopaneltrue

Basic Settings

FieldDescription

Name

Enter a unique name for the driver, which will appear in the PhixFlow repository.
Driver Class Name

Enter the driver class name, which you will find in the driver documentation. For example, for MySQL, the driver name is: com.mysql.jdbc.Driver

System Defined

Read-only.

Insert excerpt
_check_box_untick
_check_box_untick
nopaneltrue
 indicates this driver class is custom defined for your PhixFlow instance.

Insert excerpt
_check_box_ticked
_check_box_ticked
nopaneltrue
 indicates this driver is preconfigured when PhixFlow is installed. It is required for the system and cannot be updated.

DescriptionOptionally enter a description for the driver.

Driver Class File

This section has a toolbar with standard buttons.

The grid contains a list of jar files and their file path.  To add a jar file to the list:

  1. Click
    Insert excerpt
    _add
    _add
    nopaneltrue
     to open a the properties for a new Driver Class File Location.
  2. In the Basic Settings section, set:

    FieldDescription

    Name

    Enter a unique name for the driver.  
    Connector Jar File Location

    Enter the full path to the jar file.

    Windows example path

    Linux example path /lib/something/jar jar 


  3. Click 

    Insert excerpt
    _finish
    _finish
    nopaneltrue
     to save and close the properties for the driver class file.


...

To remove a jar file from the grid, use the toolbar button 

Insert excerpt
_delete
_delete
nopaneltrue
.Do driver class files need a jira need something to restrict where it will look for the Jar files.
Driver Classes have their own privilege??? - should be restricted to admins and import export.... but may not be at the moment

Using Drivers Across Multiple Instances

For application building, once you have a custom driver, you need the same driver on all instances - so you need to export/import or you will lose the refences.If you run multiple instances of PhixFlow, you must ensure that any custom driver classes you create:

  • are exported and then imported to other instances
  • have access to the database driver jar file from the other instances.

This ensures that  all datasource objects that use the database driver continue to work on the other instances. 

How PhixFlow Decides Which Driver to Use

(Needed??) The PhixFlow class path for finding drivers (but the drivers must be specified in the driver class so I'm not sure this is relevant any more

...

.

  1. The driver classes you configure In PhixFlow
  2. The system driver classes.
  3. Database drivers in the Tomcat class directory
  4. Drivers Database drivers in the Tomcat lib directory.

...