Insert excerpt

	_Banners
	_Banners
name	analysis
nopanel	true

Insert excerpt_standard_settings_standard_settingsnopaneltrue

This page is for data modellers who want to connect to an external database, either to load data or to export processed data back to it.

Overview

A datasource is a modelling object whose properties provide the information needed to connect to an external database and transfer data to and from it. You must have one datasource for each type of database to which you need to connect. Optionally, you can configure several datasources for the same type of database.

The datasource properties are affected by:

Panel

borderColor	#7da054
titleColor	white
titleBGColor	#7da054
borderStyle	solid
title	Sections on this page

Table of Contents

indent	12px
style	none

the Privilege Allow anonymous updates on datasources. Only a user with this privilege can change the Allow Anonymous Export tick box.
the System Configuration option Allow anonymous export by default. When selected, this system option sets Allow Anonymous Export to be ticked by default on new datasources.

Datasource Properties

In an analysis model, you can add:

a Database Collector to load data from a database.
a Database Exporter to update the database with processed data from the model.

The datasources you create appear in the Basic Settings → Datasource list in collector and exporter properties.

Each datasource must have at least one datasource instance. You can add several instances if you want to configure different settings. For example you may want to connect to the same database using a different username and password for different scheduled tasks.

In the properties for collectors and exporters, you can optionally specify the datasource instance using the Advanced → Datasource Instance Expression.

To add a new datasource to an analysis model:

Go to the model's toolbar → Create group.
Click
Insert excerpt
_database
_database
nopanel true
to expand the menu.
Drag a
Insert excerpt
_datasource
_datasource
nopanel true
onto the analysis model.

To add an existing datasource to an analysis model, in the model diagram toolbar:

Go to the model toolbar → List group.
Click
Insert excerpt
_database
_database
nopanel true
to expand the menu.
Click
Insert excerpt
_datasource
_datasource
nopanel true
to open the list of available datasources.
Drag a datasource into the analysis model.

Insert excerpt

	_property_toolbar
	_property_toolbar
nopanel	true

Datasource
Insert excerpt
_property_tabs
_property_tabs
name basic-h
nopanel true

Insert excerpt

	_parent
	_parent
nopanel	true

Basic Settings

In addition to the standard icons, the properties toolbar includes

Insert excerpt

	_datasource_show_tables
	_datasource_show_tables
nopanel	true

, which opens a list of tables visible for this datasource using the default login details; see the Table Details window

.Basic Settings

.

For a datasource, you must:

Enter a Name.
Select a Database Driver.
Add at least one datasource instance.
Tick the Enabled check box when it is ready to use.

We recommend you tick Protect during import to prevent this datasource being updated or deleted during import.

Field	Description
Name	Enter the name for this datasource

object. You will use this name to specify this datasource in other collector and exporter objects

. It is helpful to use a name that reflects the type of database to which it will connect. This name appears in the Datasource drop-down list for database collectors and exporters.

Enabled

Insert excerpt

	_check_box_

tickedtickedURLEnter the URL to connect to the datasource; see Connection URLs below. This option has gone. How does the datasource know where the database is?Allow Anonymous ExportUse this option when a datasource is connected to an exporter that will be run by a task, such as a scheduled task.

Protect during import

Insert excerpt

	_check_box_untick
	_check_box_untick
nopanel	true

to allow this datasource to be updated or deleted by import from another PhixFlow instance.

Insert excerpt

	_check_box_

tickedticked allow anonymous export of data via the datasource. The target database must permit anonymous updates.

The datasource uses the anonymous username and password configured ...where?.

The datasource can only use the logged in user's credentials (see Use user credentials below). (This statement from the orginal paragraph makes no sense with the sentence above.)

You must have the Allow anonymous updates on datasources privilege to change this option.

Use User Credentials on ExportUse this option when a datasource is connected to an exporter being run interactively. This may be via an application action or when a user clicks Insert excerpt_run_analysis_run_analysisnopaneltrue. Insert excerpt_check_box_ticked_check_box_tickednopaneltrue to connect to the target database using the PhixFlow username and password of the current user.

Note
The target database must already have the same username and password with the required permissions. Contact the database administrator to do this.

Protect during import

retain these settings if this datasource is imported from another PhixFlow instance.

Expand

title	More ...

Insert excerpt

	_protect_import
	_protect_import
nopanel	true

Note
Exception: If the datasource parent and the datasource have been deleted in the source instance, then the import deletes the datasource from the target instance. This prevents orphaned datasources persisting in PhixFlow.

Database Driver

Select the database driver for the type of database to which the datasource connects.

Tip
The drop-down list may contain database drivers that are deprecated and do not have the necessary jar files; see Database Driver.

When a database driver is selected, to open its properties, click the blue chevron Image Added next to the Database Driver heading.

Datasource Instances

This section has a toolbar with standard buttons.

The grid contains a list of datasource instances that belong to this datasource. Double-click on a row to open the datasource instance properties.

To add a datasource to the list, click

Insert excerpt

	_new
	_new
nopanel	true

. PhixFlow opens the properties for a new datasources instance; see Datasource Instance Properties, below.

To remove a datasource instance from the grid, use the toolbar button

Insert excerpt

	_delete
	_delete
nopanel	true

.

Database Collectors

This section has a toolbar with standard buttons.

The grid contains a list of database collectors that use this datasource. Double-click on a row to open the database collector properties. You can change whether or not the collector uses this datasource or whether the collector is enabled.

Note
Any changes you make will affect the analysis models in which the collector is used.

Rate Limiting

Insert excerpt

	HTTP Configuration
	HTTP Configuration
name	RateLimitingDesc
nopanel	true

For Database Exporters this set per batch of records committed to the database, controlled by its Commit Size option.

Insert excerpt

	HTTP Configuration
	HTTP Configuration
name	RateLimiting
nopanel	true

Advanced

Field	Description
Internal ID	Read-only. PhixFlow displays the identifier for this datasource. The PhixFlow support team may ask for this identifier during troubleshooting.

Analysis Models

This section has a toolbar with standard buttons.

The grid contains a list of analysis models that use this datasource. Double-click on a row to open the analysis model properties.

Insert excerpt

	_description
	_description
nopanel	true

Insert excerpt

	_audit
	_audit
nopanel	true

Anchor
instance
instance
Datasource Instance
Insert excerpt
_property_tabs
_property_tabs
name basic-h
nopanel true

Insert excerpt

	_parent
	_parent
nopanel	true

Basic Settings

For a datasource instance, you must:

Enter a Name.
Enter the URL for the database.
Specify the Username and Password.
Tick the Enabled check box when it is ready to use.

Other settings are optional.

Field

Description

Name

Enter the name for this instance. In the properties for collectors and exporters, you can specify this instance by using its name in the Datasource Instance Expression.

Enabled

Insert excerpt

	_check_box_

tickedticked

tick
nopanel	true

when the configuration is complete and the datasource is ready to be used.

URL

Enter the URL for the target database.

Example URLs

Oracle
jdbc:oracle:thin:@hostname:1521:phixflow
Oracle for versions above 12c, with PDB containers
jdbc:oracle:thin:@hostname:1521/phixflow
MySQL
jdbc:mysql://hostname/phixflow
Big Query
jdbc:bigquery://@hostname:@port;ProjectId=@Project;#
SQL Server

to prevent this datasource being updated or deleted during import.

When a parent application is deleted by the import, its datasources will also be deleted. This prevents orphaned datasources persisting in PhixFlow.

Driver Class

Required. Select the driver class for the type of database to which the datasource connects.

Tip
The drop-down list may contain driver classes that are deprecated and do not have the necessary database drivers; see Driver Classes.

Advanced have these gone away? I don't see an Advanced section?

jdbc:sqlserver://hostname\myservice;databaseName=phixflow;encrypt=false
- MS SQL Server JDBC driver version 12.6.1 onwards, defaults to using an encrypted connection which may require additional parameters to be added to the URL. If encryption is not required, add 'encrypt=false' to the URL. See Microsoft JDBC Driver for SQL Server - JDBC Driver for SQL Server.

Authorisation Type

Select:

Local: to provide user credentials from PhixFlow. When you select this option, the Username and Password properties are available.
External: to provide user credentials from the secure keystore. When you select this option, the Username Key and Password Key properties are available.
Use this option for greater security.

Username

Enter a username.

These options are available when Authorisation Type is Local.

This username and password must match an account that is configured to access the datasource instance. PhixFlow connects to the datasource using this username and password.

Password Enter a password.

Username Key

Enter the key that identifies the username in the keystore.

These options are available when Authorisation Type is External.

The keys must match a username and password stored in the keystore and these are configured to access the datasource instance. PhixFlow connects to the datasource using this username and password.

Insert excerpt

	_keystore
	_keystore
nopanel	true

Password Key Enter the key that identifies the password in the keystore.

Advanced

Only use these options if you know about database connections and SQL queries. For help with these options, contact support@phixflow.com.

Field	Description
Check Query	Use this field when connections to the target database might go

"", e.g. Setting this field causes PhixFlow to run "" See also database collectors for guidance on writing connections to have certain that are PhixFlow's default external Datasource configuration. The value entered in this field will determine which that this datasource instance Connection URLs Anchorurlurl Still needed if URL option has gone away?

A datasource instance must have a name, a URL, and a username and password used to connect to the external datasource. The URL should be in one of the following formats:

Panel

bgColor	#e6f0ff
titleBGColor	#99c2ff
title	Example connection strings

Platform

Connection String

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

jdbc:mysql://hostname/phixflow

Big Queryjdbc:bigquery://@hostname:@port;ProjectId=@Project;


Description	Optionally enter a information about the advanced configuration.

Remember to click

Insert excerpt

	_finish
	_finish
nopanel	true

to save and close the datasource instance properties and return to the datasource properties tab.

Insert excerpt

	_audit
	_audit
nopanel	true

Live Search
spaceKey @self
additional none
placeholder Search all help pages
type page

Panel

borderColor	#00374F
titleColor	white
titleBGColor	#00374F
borderStyle	solid
title	Sections on this page

Table of Contents

maxLevel	3
indent	12px
style	none

Learn More

For links to all pages in this topic, see Analysis Models for Batch Processing Data.

Insert excerpt

	_terms_changing
	_terms_changing
nopanel	true

Versions Compared

Old Version 24

New Version Current

Key

Overview

Datasource Properties

Datasource
Insert excerpt
_property_tabs
_property_tabs
name basic-h
nopanel true

Basic Settings

Datasource Instances

Database Collectors

Rate Limiting

Advanced

Analysis Models

Anchor
instance
instance
Datasource Instance
Insert excerpt
_property_tabs
_property_tabs
name basic-h
nopanel true

Basic Settings

Example URLs

Advanced

Live Search
spaceKey @self
additional none
placeholder Search all help pages
type page

Page Comparison

Versions Compared

Old Version 24

New Version Current

Key

Overview

Datasource Properties

Datasource Insert excerpt_property_tabs_property_tabsnamebasic-hnopaneltrue

Basic Settings

Datasource Instances

Database Collectors

Rate Limiting

Advanced

Analysis Models

AnchorinstanceinstanceDatasource Instance Insert excerpt_property_tabs_property_tabsnamebasic-hnopaneltrue

Basic Settings

Example URLs

Advanced

Live SearchspaceKey@selfadditionalnoneplaceholderSearch all help pagestypepage

Datasource
Insert excerpt
_property_tabs
_property_tabs
name basic-h
nopanel true

Anchor
instance
instance
Datasource Instance
Insert excerpt
_property_tabs
_property_tabs
name basic-h
nopanel true

Live Search
spaceKey @self
additional none
placeholder Search all help pages
type page