This page is for administrators who need to configure system-wide options for PhixFlow.

Overview

The System Configuration can be accessed via the header bar by clicking 

Insert excerpt
_property_tabs _property_tabs nopanel true

General Settings

System Directories

Use these options to configure root directories that PhixFlow needs on its server. On a Windows-hosted system, prefix directory paths with a drive letter, for example C:

Field

Description

Plugin Location    

Enter the path to a directory for any PhixFlow plugin applications.

Application Location

Enter the path to a directory for the PhixFlow installation.

Import File Location

Enter the path to a root directory for files to be imported into PhixFlow. This directory is used as the default location. This field can be left blank. See File Collectors for further details.

Export File Location

Enter the path to a root directory for files to be exported from PhixFlow. This directory is used as the default location. This field can be left blank. See File Exporters for further details.

Template Location

Enter the path to a directory for the templates that PhixFlow uses when creating Microsoft Excel file downloads.

Temporary File Location

Enter the path to a directory where PhixFlow can save temporary files that it generates.

Performance File Location

Deprecated. This directory is no longer used by any feature.

In previous versions, this was where PhixFlow stored performance analysis files.

Archive Directory

This directory is used when Archive deleted log messages to file is ticked.

Enter the path to a root directory where log messages can be archived. This directory is used as the default location. This field can be left blank. 

Restore Directory

Enter the path to a root directory from which data can be restored. This directory is used as the default location. This field can be left blank.

Restricted Directory

Read-only.  PhixFlow displays the directory path that is set in the PhixFlow database.

For security reasons, we recommend that you configure a restricted directory so that Phixflow only reads data from the restricted directory. 

Database Driver File Directory

Read-only. PhixFlow displays the directory path that is set in the PhixFlow database. Use this directory to store driver jar files to enable PhixFlow to communicate with different databases. To avoid your files being overwritten during Tomcat or PhixFlow upgrades, we recommend that you specify a directory outside of tomcat. For example:

• Linux:  /opt/phixflow-drivers

• Windows:  C:\opt\phixflow-drivers

See also Database Driver.

If the Restricted Directory is set, this directory does not need to be within the restricted directory.

File Upload Directory

Enter the path to a root directory where PhixFlow stores all loaded files, for example from file collectors, and received email messages.

Loaded files and processed emails are saved in standard sub-directories as follows:

.../tag/in/yyyymmdd/uid/

where

For each email message received, the folder has:

• a file called body.txt, containing the main body content of the email

• any email attachment files.

Download Location 

The download area is where PhixFlow saves files generated by analysis models or actions in applications. These are CSV or Excel files. Users can download the files from this area. To ensure data security, the files are encrypted and are deleted after a period of time; see File Download Expiry. 

System Tuning

System Directories

Use these options to configure root directories that PhixFlow needs on its server. On a Windows-hosted system, prefix directory paths with a drive letter, for example C:

update system_configuration set restricted_dir = '/opt/phixflow/data';
commit;

System Tuning

Style Settings

Field

In View

Style is applied to ...

Description

Grid Header Style      

In grid views

Header row

Select the default style for layout components that appear in dashboards or views. 

PhixFlow uses the default style when the layout component does not have its own style set; see Component.

Grid Header Button Style

Buttons in the header row

Grid Header Icon Style

Icons in the header row

Grid Header Drop-down Button Style

Drop-down buttons in the header row

Grid Header Drop-down Pane Style

Drop-down panes

Grid Paging Style

The paging bar

Grid Row Style

Rows

Grid Column Header Style

Column headers

Row Selection Style

The currently selected row(s)

Form View Header Style

In "old" forms that are based on views

Field headers

Form View Content Style

Field content

Advanced

Field

Description

Default Character Set

Enter the character set PhixFlow assumes when reading from or writing to any plain text or CSV file.

Data Storage Group

Enter the data storage group to use when creating tables to store table data. This field is interpreted differently depending on the underlying database:

• On Oracle, a data storage group is equivalent to a Tablespace.

• On SQL Server, a Data Storage Group is equivalent to a Filegroup.

• MariaDB does not support data storage groups.

• If you use the unsupported MySQL, a data storage group is equivalent to a Tablespace.

If no Data Storage Group is specified, the database user's default setting will be used. Ensure the database user has sufficient privileges.

ALTER USER <username> 
  QUOTA 1000M ON <tablespace name>
  GRANT UNLIMITED <tablespace name> TO <username>;

Line Separator Style

Select the default line separator style that will be used by file exporters where no particular line separator has been specified. If you do not specify a default line separator here, PhixFlow will use the default of the operating system.

Where a specific file exporter needs to use a different line separator, use the File Exporter → Line Separator Style property.

Default Table Storage

Select the default storage type to use when creating a new table.

• Database: store the data in a regular table within the PhixFlow database. This is the usual storage type for PhixFlow.

• Database (Partitioned): store the data in a partitioned table within the PhixFlow database .
  This option is available if partitioning is available within your database installation.
  This option provides improved performance for rollback and archiving of very large recordsets. 

• In Memory: the data for the table will not be written to the database.
  This is useful when working with large data sets. For example, when you want to aggregate large amounts of unsorted data, which is then be written to a stored table.

Database View Role

Only set this option if you have database users who want to generate reports directly from the PhixFlow database.

Select this option as part of Configuring Access to Database Views. PhixFlow creates a database role that can access views of table data. This role can only see the views, not any other PhixFlow data.

Schema Version

Displays the version of the schema currently installed. (Read-only)

Licence Key

The licence key for your PhixFlow Installation, provided by PhixFlow Customer Support. If PhixFlow is not configured with a valid key, analysis tasks will not run and an error message will be displayed in the log file.

A licence key issued with an expiry date. If the licence has expired, an additional field will show the expiry date.

After a licence has expired PhixFlow will generate warning messages in the analysis logs for 28 days beyond the expiry date. After this time analysis tasks will cease to run.

Expires On

Displays the date that the current Licence Key will expire. (Read-only)

Delete Log Messages after Days

For information about the system task, see Task Plans.

Archive deleted log messages to file

Disable Scheduled Tasks

In some cases, you may want to run an instance of PhixFlow without any of the scheduled tasks automatically running.

You can also disable scheduled tasks when starting a PhixFlow instance; see Disabling Scheduled Tasks.

Delete Emails after Days

For information about the system task, see Task Plans.

Delete Temp Tables after Days

Enter the number of days that temporary tables created by publishing are kept. When a System Task runs it records all temporary tables and will delete the tables after this number of days.

If no value is specified, PhixFlow defaults to retaining temporary tables for 30 days.

Delete Orphaned Table after Days

Enter the number of days that orphaned database tables are kept. These tables contain the data for tables that have been deleted. When a System Task runs it records all orphaned tables and will delete the tables after this number of days.

If no value is specified, PhixFlow defaults to retaining orphaned tables for 30 days.

Delete DTO Usage Records after Days

Only change this option with advice from PhixFlow support.

The number of days that DTO usage records are kept. This is set to 7 days by default.

PhixFlow monitors when objects have been used (DTO usage records).  Objects used within this number of days will be re-cached automatically when the server restarts.  Keeping usage records for longer periods of time will result in more objects being re-cached after a server restart.

Password Policy

Select the password policy that is applies to user passwords. This policy is set in new user accounts when you create them; see Password Policy.

Export Password Policy

Select the password policy that applies to security passwords on configuration export files. This policy is set in new user accounts when you create them; see Password Policy.

Allow Reset Configuration

Before performing a 'Reset Configuration' the administrator must tick this check box; see Configuration Reset.

Allow Missing On Import

By default, import fails if there is a reference to an item that does not exist either in the import file or in the target system.  PhixFlow reports the names of missing items or fields in the error messages from a failed import.

If you want to complete the import, even with references to missing items, specify a comma-separated list of missing items or fields here. Next time you run the import, PhixFlow overrides the error messages and completes the import process.

External Login

Field

Description

External Login Groups

Names can be separated by a semicolon but spaces around the semi-colon are considered part of the group name. For example, 'group_1;group_2' is valid, but 'group_1;  group_2' is not valid.

Names are case-independent.

Use {instance} to include the PhixFlow instance name if required.

This section displays a grid listing the external user templates that have been configured. The order of the templates in this grid is the order in which templates will be matched to external users; see External User Template for details. 

To reorder the templates, you can:

• either double-click on a name to open its property tab, then change the Order value.

• or drag template names in the grid. PhixFlow automatically updates their Order.

Advanced

ALTER USER <username> 
  QUOTA 1000M ON <tablespace name>
  GRANT UNLIMITED <tablespace name> TO <username>;

External Login

External User Templates 

Anchor
external_user_config external_user_config

This section displays a grid listing the external user templates that have been configured. The order of the templates in this grid is the order in which templates will be matched to external users; see External User Template for details. 

To reorder the templates, you can:

• either double-click on a name to open its property tab, then change the Order value.
• or drag template names in the grid. PhixFlow automatically updates their Order.

Insert excerpt
_property_tabs _property_tabs name style nopanel true

Style Settings

System Formats

Form Views

Default Components