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.
The datasource properties are affected by:
.
Datasource Properties
Insert excerpt _standard_settings _standard_settings nopanel true
In addition to the standard icons, the properties toolbar includes
| Insert excerpt | ||||||
|---|---|---|---|---|---|---|
|
For a datasource, you must:
- Enter a Name.
- Select a Driver class.
- 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.
Basic Settings
| Field | Description | |||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Name | Enter the name for this datasource. 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 |
| Allow Anonymous Export | When an exporter uses this datasource to connect to a database, by default PhixFlow will use the PhixFlow username and password. Use this option when the PhixFlow username and password should not or cannot be used, for example in a scheduled task plan. The target database must permit anonymous updates. Insert excerpt | _check_box_ticked | _check_box_ticked | nopanel | true | You must have the Allow anonymous updates on datasources privilege to change this option. | Use User Credentials on Export | Use this option when a user interactively runs an exporter that uses this datasource to connect to a database. This may be via an application action or when a user clicks|||||||||||
| Insert excerpt | _run_analysis | _run_analysis | ||||||||||||||||||
| nopanel | true | |||||||||||||||||||
| Insert excerpt | _check_box_ticked | _check_box_ticked | ||||||||||||||||||
| nopanel | true |
| Note |
|---|
| The target database must already have the same username and password with the required permissions. Contact the database administrator to do this. |
to preserve this datasource during import. This prevents the datasource being updated or deleted. Insert excerpt _check_box_ticked _check_box_ticked nopanel true
Exception: The datasource will be deleted when its parent application is deleted by the import. This prevents orphaned datasources persisting in PhixFlow.
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. |
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 | ||||||
|---|---|---|---|---|---|---|
|
To remove a datasource instance from the grid, use the toolbar button
| Insert excerpt | ||||||
|---|---|---|---|---|---|---|
|
Database Collectors
This section has a toolbar with the
and Insert excerpt _list_show _list_show nopanel true
buttons; see standard buttons.Insert excerpt _refresh _refresh nopanel true
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. |
Datasource Instance Properties
| Anchor | ||||
|---|---|---|---|---|
|
Insert excerpt _standard_settings _standard_settings nopanel true
For a datasource instance, you must:
- Enter a Name.
- Enter the URL for the database.
- Specify the Anonymous username Username and Password.
- Tick the Enabled check box when it is ready to use.
Other settings are optional.
Basic Settings
| 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 |
| |||||||||
| URL | Enter the URL for the target database. Example URLs
| |||||||||
| Anonymous Authorisation Type | Select:
| |||||||||
| Username | Enter a username. | Password | Enter a passwordThese options are available when Authorisation Type is Local. | PhixFlow will use the username and password to connect to the database when the datasource property Allow Anonymous Export is ticked. | 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 alias that identifies the username in the keystore. | These options are available when Authorisation Type is External. The aliases 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.
| ||||||||
| Password Key | Enter the alias 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 stale. This can happen if the target database disconnects long-running connections. Enter a database query that will return a row from the database. PhixFlow runs the query against the database just before each use of a pooled connection. If the query does not return a row, the connection is discarded and a new connection is created. To avoid any performance impact, the query should execute quickly. See the Query String section of the Database Collector page for information about writing SQL queries in PhixFlow. |
| Datasource Profile | Use this field when the target database has additional requirements not covered by the datasource and datasource instance properties. Enter the path to an external datasource connection profile. PhixFlow will use the configuration information in the profile to connect to the target database. |
| Description | Optionally enter a information about the advanced configuration. |
Remember to click
| Insert excerpt | ||||||
|---|---|---|---|---|---|---|
|