System Configuration

Owned by Former user (Deleted)
Last updated: Nov 14, 2024 by Zoe Baldwin
17 min read

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  Administration →  System →   Configuration.

For information about the properties toolbar, and about the sections Parent Details, Analysis Models, Description and Audit Summary, see Common Properties.  We recommend you always add a Description that explains the purpose of the item you are creating. 

For a full list of all the PhixFlow property tabs and windows, see Properties, Windows, Menus and Toolbars.


 Properties tab

General Settings

FieldDescription
Customer Name         This field is read-only. PhixFlow displays the customer name that was set in the PhixFlow database during system installation.

PhixFlow Instance

Any text entered here appears on the application banner. For example if you have multiple instances of PhixFlow installed (Live, Test etc.) then you can enter a value in this field so that users can easily see which system they are using.

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.

You can return the instance name using _system.instance in an expression. This can be useful when creating emails from a task plan or from a file exporter. 

Default Export Excel Version

The default version of Excel to be used when exporting data from PhixFlow to Excel. This is only used if a non-valid excel extension, such as "csv", is used in the file name extension specified in the exporter. Otherwise PhixFlow will determine the correct format from the extension specified in the file name. See file exporters for details.

System Locale

Select the default locale to use for the PhixFlow system.

You can set a different locale for users.

The list of locales available in PhixFlow is a standard list. The presence of a specific locale does not indicate that translations are available for the locale.

The locale sets the default date style. It can also change the language of an application if it has a translation table; see Translating an Application Interface.

Default Component PaletteSelect a default layout component palette.
Default Template PackageSelect a default template package. Applications created without a selected template package will use this value for the new application.
Decimal Places

The default number of decimal places to show for float values in view, unless a different value is set for an individual view attribute.

Suppress Trailing Zeroes

Select one of the following:

  • Keep trailing zeroes
    T    he number is displayed as entered, with trailing zeroes preserved.
  • Suppress trailing zeroes
    PhixFlow does not display trailing zeroes, except the first after a decimal point. Examples of a number entered as:
    • 1.50 is stored as 1.5
    • 23.000 is stored as 23.0

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

Allow access to data by defaultSpecifies the default data access permission on new tables. Possible values are:
  • "T" - By default, all users will be allowed access to the table data.
  • "F" - By default, no users will be allowed access to the table data unless they are a member of a user group which is explicitly added to the table.
Note that this is just a default behaviour as any user with the permission to add user groups to a table may change the data access rights for a table.
Notification Timeout (s)Specify how long, in seconds, PhixFlow should display the popup notifications before closing them automatically.
File Download Expiry 

By default, this option is set to 24 hours. 

Specify how long files remain available in the File Download Location before they are deleted. 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.

If you do not specify the time by d, h, m or s, PhixFlow defaults to the entered value as hours.

Example

To keep downloads for:

  • 10 days, enter: 10d
  • half an hour, enter: 30m
  • 2.5 days, enter: 5d 12h
  • 1 day, 2 hours, 3 minutes and 4 seconds enter: 1d 2h 3m 4s

Help UrlThe base URL for PhixFlow help. This is pre-set for each PhixFlow release, and should not be changed without consulting PhixFlow support.
Online Support Url

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 Support Home 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.

System Email Address

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.

It is important to set a system email address as the registered owner of the email account. This is because some email services reject emails that are not from the registered owner of the email account. 

If you do not set a System Email Address, PhixFlow sends the email as if it is from the person making the request. For example, if Georgia Smith requests a password reset, the email will be “from” georgia.smith@company.com. This email may not be delivered by some email services.

Feedback Email AddressSpecify an email address to receive any feedback emails.  These are sent from the Administration → Support Menu → Email Support option. We recommend that this email address is your onsite system administration email. Issues that cannot be resolved internally should then be forwarded to support@phixflow.com.
Error Reporting Email AddressSpecify an email address to receive emails sent when a user clicks the Report button on a system error message. We recommend that this is set to an onsite system administration. Issues that cannot be resolved internally should then be forwarded to support@phixflow.com.
Only allow users with the restricted login permission to log in

Use this option when you need maintain or upgrade PhixFlow and you need to prevent any users from logging in; see Restricting Access During System Maintenance.

 Tick to prevent users from logging into PhixFlow. Only users who have the Restricted Login Only privilege can log in.

Before using this option, make sure the Administrators role has the Restricted Login Only privilege. You may need to add this privilege to other roles for users who require system access, such as PhixFlow support or consultants.

Remember to untick this option when maintenance is complete.

Only allow restricted task plan run permission users

Use this option when you need maintain or upgrade PhixFlow and you need to prevent processes from running; see Restricting Access During System Maintenance.

 Tick to suspend processing for all users except those with the Restricted Login TaskPlan Processing privilege. Users without this privilege will be unable to run:

  • analysis on models
  • task plans
  • any table-actions
  • rollback.

Scheduled task plans will not run, although the Suspended tick box will not be ticked on individual task plans.

Before using this option, make sure the Administrators role has the Restricted Login TaskPlan Processing privilege. You may need to add this privilege to other roles for users who require system access, such as PhixFlow support or consultants.

Remember to untick this option when maintenance is complete.

Note: Any scheduled task plan that attempts to run and is prevented appears in the System Console console as a warning.

Suspend processing for non admin usersSuspend processing for all users except those in the administrators group. Non-admin users will be prevented from running analysis, task plans, table-actions and rollback. Scheduled task plans will also be suspended (but the suspended box will not be ticked on individual task plans).
Allow access to run actions by defaultIf ticked, by default all users will have access to run actions (providing they have functional rights to run actions), unless this is overridden at the level of individual actions.

Home Screen Message HTML

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

Banner ColourUse the colour picker to select a colour for the menu bar at the top of the screen.

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:

When you set a Restricted Directory, all other system directories, except the Database Driver File Directory, must be sub-directories of the restricted directory.


FieldDescription

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.

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

When you set a Restricted Directory, all other system directories, except the Database Driver File Directory, must be sub-directories of the restricted directory.

Also, for file collector or exporter properties with Ignore Base Directory selected, all paths must be in the restricted directory; see File Collector → Ignore Base Directory or File Exporter → Ignore Base 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. 

To set the restricted directory in the PhixFlow database, use an SQL statement, for example:

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

Restart Tomcat to make the change visible to the PhixFlow application.

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

To set the database driver file directory in the PhixFlow database, use an SQL statement, for example:

update system_configuration set driver_class_file_dir = '/opt/phixflow-drivers';
commit;

Restart Tomcat to make the change visible to the PhixFlow application.

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

  • 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 

Enter the directory path for the download area.

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. 

File Table Upload Location

Enter the directory path for where files can be stored that are uploaded using a File Display, e.g. /opt/phixflow/data/file

All uploaded files will be placed in this directory. The directory should be backed up in line with your local policy.

System Tuning

This section contains options related to the PhixFlow system. Only change key options related to PhixFlow infrastructure sizes and tuning with advice from PhixFlow support. For advice about using the other system tuning options, please contact support@phixflow.com.


FieldDescription
Thread Pool Size       

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.

Database Flush Size

Only change this option with advice from PhixFlow support.

How frequently objects are written to disc. 

This sets the default Commit Size for newly created Database Exporters (Advanced section) . If no value is provided the default Commit Size is 2000.

Result Expiry Time (sec)

Only change this option with advice from PhixFlow support.

The length of time the PhixFlow front end application will wait for a result from an asynchronous query before abandoning it. 
Default Page Size

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.

Default Buffer Size

Only change this option with advice from PhixFlow support.

When reading in data from a collector, how many rows are held in memory before passing them on for processing. This means that if PhixFlow is reading in 10,000,000 records, it doesn't have to wait until all have been loaded before it begins to process them, but can begin processing after the first 2000 have been read. 
Delete Batch Size

Only change this option with advice from PhixFlow support.

Defines the default number of rows to be deleted from a table in a single transaction when archiving or rolling back data.
Write Processes Per Recordset

Only change this option with advice from PhixFlow support.

Enables PhixFlow to multi-thread the process of writing table data to the database. The value of this parameter is dependent upon machine versus database performance.
Maximum Records Per Download File

This value affects how much data a user can export to a single Excel or CSV file using the  Download data to file button; see Download CSV or Excel Data.

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.

Default Download File Limit

This value affects how much total data a user can export to Excel or CSV files using the  Download data to file button; see  Download CSV or Excel Data

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 table data, you can override this value using the table properties in the Download Limits section.

Validate attribute exists at runtime

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

 Tick so that PhixFlow will raise an error. It is strongly recommended that this option is ticked.

 Untick If PhixFlow cannot find the attribute, it returns a null value.

Inactivity Time (sec)The amount of time (in seconds) that must pass after a user operation before the PhixFlow client application will start any background clean-up processes.
Maximum File Size Attachment (MB)

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.

Maximum Pivot ColumnsThe system-wide default for the maximum number of columns that can be generated by a pivot table. This applies unless a different maximum pivot columns setting is applied for an individual view.
Maximum Exporters Errors

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.

Log Statistics

 Tick to set PhixFlow to record performance statistics; see Processing Statistics.

Log statistics are very useful when troubleshooting, so we recommend this option is always selected.

Statistics PeriodThe period (in seconds) over which performance statics are aggregated, over which snapshots of values are taken.

Delete Statistics after Days

The number of days that statistics are kept. When a System Task runs, it deletes statistics that are older than this number of days.

Also see Task Plans and Processing Statistics.

Enforce Pipe Cache Size

 Tick to strictly enforce pipe cache sizes. A pipe lookup which tries to cache too many records will fail and an error will be reported.

 Untick to report a warning message when a pipe exceeds the cache size.

Default Pipe Cache SizeThe default cache size for a pipe, when it has not been set on the pipe.
Maximum Pipe Cache SizeThe maximum cache size that can be set on a pipe. A pipe with a cache size greater than this will cause an error during an analysis run.
Enforce In Memory Cache Size

 Tick to strictly enforce cache sizes for in-memory tables. An in-memory table which tries to cache too many records will fail and an error will be reported.

 Untick to report a warning message when an in-memory table exceeds the cache size.

Default In Memory Cache SizeThe default cache size for an in-memory table, when it has not been set on the table.
Maximum In Memory Cache SizeThe maximum cache size that can be set on an in-memory table. A table with a cache size greater than this will cause an error during an analysis run.
Maximum Bigstring Size (Characters)

The maximum allowed length of a Bigstring attribute. A value larger than this will cause an error during an analysis run.

Maximum Parallel File Exporters

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.

Maximum Parallel Excel ExportersThe maximum number of 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. The default value is 1.

Maximum Parallel HTTP Actions


The maximum number of parallel HTTP requests that can be sent at the same time. This is for Actionflows only.

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

DTO Building Thread Pool Size

Only change this option with advice from PhixFlow support.

When you restart the server, PhixFlow rebuilds recently-used object caches (DTOs). Specify the number of DTOs that can be generated at the same time. This number may affect how quickly PhixFlow is able to restart. 

See also Advanced → Delete DTO Usage Records after Days, below. 

Advanced

FieldDescription
Default Character Set

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

The character set must be supported by the Java virtual machine.

Multi-byte settings such as UTF8 (e.g. for Japanese etc.) are supported.

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.
  • MySQL 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.

For Oracle, if  the user does not have sufficient tablespace privileges, you can use the following database statements to set the privilege.

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

For more information, see the Oracle documentation on Managing Users and Resources.

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 StorageSelect 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.

This option refers to a role in the PhixFlow database  not in the PhixFlow application.

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 VersionDisplays 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 OnDisplays the date that the current Licence Key will expire. (Read-only)

Delete Log Messages after Days


Enter the number of days that log messages and managed files are kept. When a System Task runs, it deletes log messages and managed files that are older than this number of days. Managed files includes the files created by file exporters to send by email.

For information about the system task, see Task Plans.

Archive deleted log messages to file

 Tick to archive log messages to a file in the Archive Directory before they are deleted. You cannot archive managed files before deleting them.

Disable Scheduled Tasks

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

Only use disable scheduled tasks if it is essential. No task plans will run when the disabled option is set. Task plans will not run retrospectively when the option is cleared. Restore scheduled task plans to being able to run as soon as possible. Manually start any tasks plans that missed their scheduled start time.

 Untick to allow all tasks and task plans to run as scheduled.

 Tick to prevent any scheduled task plans from running.

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

Delete Emails after Days

Enter the number of days that emails are kept. When a System Task runs, it deletes emails that are older than this number of days. You cannot archive emails to a file before deleting them.

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 PolicySelect 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.


Users require an Export Password Policy to be able to download exports.

For external users, this is set by the External User Template when the user is created. If this is not set, the user will not have an Export Password Policy and will not be able to download exports.

Allow Reset Configuration

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

Resetting the configuration deletes all configuration data in the PhixFlow instance.

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

FieldDescription
External Login Groups
Enter the names of external login groups whose members are allowed to log in into PhixFlow.

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.
Use {mappingValue} to include the External User Group Mapping Prefix

External User Group Mapping Prefix

Used as the value for the {mappingValue} in the External Login Groups field.

This allows different login groups to be selected on a machine basis without needing to change other configuration settings.

External User Templates 

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.

 Styles tab

Style Settings

System Formats

FieldDescription
Default Date Format

The default format for dates in views, unless a different format is applied for an individual view attribute. 

Default Date/Time Format

The default format for datetimes in views, unless a different format is applied for an individual view attribute.

Form Views


FieldIn ViewStyle is applied to ...Description

Grid

Default Header Icon StyleIn grid viewsIcons in the header row




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


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

Default Header Dropdown Pane StyleDrop-down panes
Default Paging StyleThe paging bar
Grid Header StyleHeader row
Grid Header Button StyleButtons in the header row
Grid Header Dropdown Button StyleDrop-down buttons in the header row
Grid Row StyleRows
Grid Alternate Row StyleAlternate rows
Grid Row Hover StyleRows on mouse-over
Grid Column StyleColumns
Grid Column Header StyleColumn headers
Row Selection StyleThe currently selected row(s)

View Form

Form View Header StyleIn "old" forms that are based on views

Field headers

Form View Content Style

Field content

Default Components

Component TemplateDescription
String Component






Select the default style for components that appear in Screens. These are the templates used to create components on a screen by default.

For example, when dragging attributes onto a screen the corresponding Component Template is used such as when dragging a String attribute onto a screen the template defined for String Component will be used to generate the onscreen component.

Bigstring Component
Long Component
Float Component
Decimal Component
True/False Component
Date Component
DateTime Component
Table Action Component
Menu Button Component
Form Component
Card Component
Drop Down Component
Dynamic Text Component
Sections on this page