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

General Settings

After changing this field you will need to restart the browser or reload the application (User → Reload Application) to see the new value in the banner.

Select the default locale to use for the PhixFlow system.

You can set a different locale for users.

This setting can be over-ridden using a Number Format.

• "T" - By default, all users will be allowed access to the stream data.
• "F" - By default, no users will be allowed access to the stream data unless they are a member of a user group which is explicitly added to the stream.

Specify the time using one or more of:

• days: nd
• hours: nh
• minutes: nm
• seconds: ns

where n is the number you require. Separate 2 or more time units with a space.

The URL to open when the user requests online support through PhixFlow. Under normal circumstances you should not need to update this setting. If you have problem with PhixFlow help, please contact the PhixFlow support team (see the welcome page for contact details).

After changing this field you will need to restart the browser or reload the application (User → Reload Application) to start using the new help location.

Specify the email address from which system-generated mails will be sent, such as password reset requests.  For example, create an email account for notifications@company.com and use it as the System Email Address.

Home Screen Message HTML

Enter and format a message which is displayed to users when they log in; see Configuring a Login Message.

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:

Plugin Location    

Application Location

Import File Location

Export File Location

Template Location

Temporary File Location

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

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. 

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 Driver Classes.

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

• tag is the file collector tag or the #tag extracted from an email subject line, or default
• yyyymmdd is the date the files were uploaded / received
• uid is a 32 character unique identifier.

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

Only change this option with advice from PhixFlow support.

The number of threads that can be in the pool at any time. This is an advanced option which should not be updated without advice from the PhixFlow support team. This is generally a small multiple of the number of CPU cores on your machine.

Only change this option with advice from PhixFlow support.

Only change this option with advice from PhixFlow support.

Only change this option with advice from PhixFlow support.

The default number of rows to be loaded into to a grid when displayed in PhixFlow. 

After changing this field you will need to restart the browser or reload the application (User → Reload Application) to apply the new default page size.

Only change this option with advice from PhixFlow support.

Only change this option with advice from PhixFlow support.

Only change this option with advice from PhixFlow support.

Specify the largest number of data records that a user can downloaded to a single file. Downloads with more than this number of records will be split into multiple files which are zipped together.

Specify the maximum number of records that a user can download. PhixFlow creates a file with this many records. Additional records will be ignored.  If no value is specified, PhixFlow applies no limit to the number of records that a user can download. 

For stream data, you can override this value using the stream properties in the Download Limits section.

Specifies whether or not PhixFlow should check that an attribute exists when a model attempts to read the value of an attribute from a stream record or a record supplied by a collector.

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

Outgoing emails will only attach files (zipped or unzipped) that do not exceed this size limit. An extra message will appear in the email's message subject/body indicating to the recipient that a file attachment has been removed due to this size restriction.

If left blank, PhixFlow does not restrict the file size of attachments. However, the email servers will determine whether or not the message is sent/received correctly.

The maximum number of errors found before exporters will stop attempting to export records.

This is useful where you process large number of records and do not want to wait until all records are processed in case of errors occurred. This value can be overridden in the properties for (database, file and HTTP) exporters.

Also see Task Plans and Processing Statistics.

The maximum number of non-Excel files that may be generated at the same time. This includes files generated:

• by file exporters
• from a grid view.

Requests above this limit will be queued. This value defaults to the value of Thread Pool Size.

This includes files generated:

• by file exporters
• from a grid view.

Style Settings

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

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

Field headers

Field content

Advanced

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

Enter the data storage group to use when creating tables to store stream 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>;

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.

• 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 stream sets. 
• In Memory: the data for the stream 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 stream.

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.

Delete Log Messages after Days

For information about the system task, see Task Plans.

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.

For information about the system task, see Task Plans.

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.

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

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

The number of days that DTO usage records are kept. This is set to 3 days by default. Only change this option on the advice of PhixFlow support.

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.

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

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

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:

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