Versions Compared

Old Version 74

changes.mady.by.user Fiona Sargeant

Saved on

compared with

New Version 75

changes.mady.by.user Fiona Sargeant

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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


Insert excerpt
_standard_settings
_standard_settings
nopaneltrue


Panel
borderColor#7da054
titleColorwhite
titleBGColor#7da054
borderStylesolid
titleSections on this page

Table of Contents
indent12px
stylenone



General Settings

FieldDescription
Customer Name         This field cannot be modified. The Customer Name is entered during system installation.

PhixFlow Instance

Anchor
phixflowInstance
phixflowInstance
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.

Default Export Excel Version

Anchor
defaultExportExcelVersion
defaultExportExcelVersion
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 LocaleSystem Locale will determine the default language used by the system e.g. for the login screen.
Default Component PaletteSelect a default layout component palette.
Decimal Places
Anchor
decimal
decimal
Decimal Places
The default number of decimal places to show for float values in view, unless a different value is set for an individual stream view attribute.
Default Date Format

Anchor
date
date

Default Date Format

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

Default Date/Time Format

Anchor
datetime
datetime

Default Date/Time Format

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

Allow access to data by defaultSpecifies the default data access permission on new streams. Possible values are:
  • "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.
Note that this is just a default behaviour as any user with the permission to add user groups to a stream may change the data access rights for a stream.
Allow anonymous export by defaultSpecifies the default access permission on exporting data from a Datasource. Possible values are:
  • "T" - By default, all users will be allowed access to export functionality.
  • "F" - By default, no users will be allowed access to export functionality unless they are specifically configured against the datasource.
Notification Timeout (s)Specify how long, in seconds, PhixFlow should display the pop-up notifications before closing them automatically.
File Download Expiry 

Anchor
expire
expire
Specify how long files remain available in the File Download Location before they are deleted. If you do not specify an expiry time, PhixFlow defaults to leaving downloads available for 24 hours.

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.

Panel
borderColor#01cff1
borderWidth4
titleBGColor#01cff1
titleExample

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

System Email AddressThe email address where system generated mails will be sent from.
Feedback Email AddressThe email address to which feedback emails (from the User drop-down menu) will be addressed. 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.
Restrict non admin logins onlyRestrict access to PhixFlow to only users who are part of the administrators group. This can be set if a system is being put into a maintenance state, and normal access needs to be revoked to everyone other than administration users.
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, Stream 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

Note

On Windows hosted systems, please be sure to prefix any directory names listed below with a drive letter, e.g. 'for example C:'


FieldDescription
Plugin Location         The location of any PhixFlow plugin applications.
Application LocationThe location of the PhixFlow installation.
Import File LocationThe default base directory path for files to be imported into PhixFlow. This field can be left blank. See File Collectors for further details.
Export File LocationThe default base directory path for files to be exported from PhixFlow. This field can be left blank. See File Exporters for further details.
Template LocationThe location templates when doing excel downloads.
Temporary File LocationThe location of any PhixFlow temporary files that are generated.
Performance File LocationThe location of the resultant analysis performance files when the system tuning 'Generate Performance Files' check box has been ticked.
Archive DirectoryThe default base directory path for data to be archived. This field can be left blank.
Restore DirectoryThe default base directory path for data to be restored from. This field can be left blank.
Restricted DirectoryThe root directory path that all files read using File Collectors must reside under. Note that this value is not editable through the GUI and must be set directly within the database.
File Upload Directory

The root location of all uploaded files and received email messages.

Uploaded files/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 will contain a file called body.txt representing the main body content of the email and also any corresponding email attachments.

File Download Location 

Anchor
location
location
Enter the directory path for the download directory.

The download directory 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 the download directory. To ensure data security, the files are encrypted and are deleted after a period of time; see File Download Expiry. 

System Tuning

Warning

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


Delete Batch SizeIf checked, PhixFlow will record performance statistics. See Processing Statistics for further detailMaximum Bigstring Size
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 SizeDefines how

Only change this option with advice from PhixFlow support.

How frequently objects are written to disc. This is an advanced option which should not be updated without advice from the PhixFlow support team. 
Result Expiry Time (sec)The length of

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. This is an advanced option which should not be updated without advice from the PhixFlow support team.		Default Page SizeDefines the  
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. This is an advanced option which should not be updated without advice from the PhixFlow support team. 

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 SizeWhen reading in

Only change this option with advice from PhixFlow support.

When reading in data from a collector, this defines 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. This is an advanced option which should not be updated without advice from the PhixFlow support team.		 
Delete Batch Size

Only change this option with advice from PhixFlow support.

Defines the default number of rows to be deleted from a Stream stream in a single transaction when Archiving archiving or Rolling rolling back data. This is an advanced option which should not be updated without advice from the PhixFlow support team.
Write Processes Per Stream SetThis is an advanced tuning feature which enables

Only change this option with advice from PhixFlow support.

Enables PhixFlow to multi-thread the process of writing Stream Data stream data to the database. The value of this parameter is dependent upon machine versus database performance.
Maximum Download SizeThis value defines the The largest number of records that can be downloaded from a chart in a single file. Downloads with more than this number of records will be split into multiple files which are zipped together.
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 stream record or a record supplied by a collector.

If not ticked, if no attribute could be found with the given name a null value is return. If ticked, PhixFlow

Insert excerpt
_check_box_ticked
_check_box_ticked
nopaneltrue
 so that PhixFlow will raise an error.

 It

 It is strongly recommended that this

flag

option is ticked.

Insert excerpt
_check_box_untick
_check_box_untick
nopaneltrue
 If PhixFlow cannot find the attribute, it returns a null value.

Inactivity Time (sec)This sets the 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 configuration 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 will not impose any upper limit to the size of the attached files if this field is left blank, hence in this case the underlying does not restrict the file size of attachments. However, the email servers will determine if whether or not the message is sent/received correctly or not.

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 stream view.
Maximum Exporters Errors

If required, you can set the 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 Exportersthe properties for (database, file and HTTP) exporters.

Log Statistics
Insert excerpt
_check_box_ticked
_check_box_ticked
nopaneltrue
 to set PhixFlow to record performance statistics; see Processing Statistics.
Statistics PeriodThis is the The period (in seconds) over which performance statics are aggregated, over which snapshots of values are taken.

Delete Statistics after Days

Anchor
deleteStatisticsAfterDays
deleteStatisticsAfterDays

If this field is set,

The number of days that statistics are kept. When a System Task runs,

when run, deletes Processing Statistics records from the Database

it deletes statistics that are older than this number of days.

See 

Also see Task Plans

for how to set up and run a System Task

 and Processing Statistics.

Enforce Pipe Cache Size

Anchor
enforcePipeCacheSize
enforcePipeCacheSize

If ticked, Pipe Cache sizes are strictly enforced; a

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

If not ticked, exceeding the cache size on a pipe will result in a warning message

Insert excerpt
_check_box_untick
_check_box_untick
nopaneltrue
 to report a warning message when a pipe exceeds the cache size.

Default Pipe Cache SizeThis value is used when a pipe's cache size The default cache size for a pipe, when it has not been set on the pipe.
Maximum Pipe Cache SizeThis value is the maximum value that Cache Size The maximum cache size that can be set to on any a pipe; a . A pipe with a Cache Size cache size greater than this will generate a run-time errorcause an error during an analysis run.
Enforce In Memory Cache SizeIf ticked,

Insert excerpt
_check_box_ticked
_check_box_ticked
nopaneltrue
 to strictly enforce cache sizes for in-memory streams

are strictly enforced; an in

. An in-memory stream which tries to cache too many records will fail and an error will be reported.

If not ticked, exceeding the cache size on an in memory stream will result in a warning message

Insert excerpt
_check_box_untick
_check_box_untick
nopaneltrue
 to report a warning message when an in-memory stream exceeds the cache size.

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

Anchor
bigstring
bigstring

The

The maximum allowed length of a Bigstring attribute. A value larger than this

will cause

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.

Style Settings

Grid Header Button Style
FieldIn ViewStyle is applied to ...Description
Grid Header Style      
Select the default style for the header section of grid views. The default will apply unless a local style is set for the application or individual grid view.
In grid viewsHeader row




Select the default style for

buttons in the header of grid views. The default will apply unless a local style is set for the application or individual grid view

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.

Grid Header
Icon
Button Style
Select the default style for icons
Buttons in the header
of grid views. The default will apply unless a local style is set for the application or individual grid view.
row
Grid Header Icon StyleIcons in the header row
Grid Header Drop-down Button Style
Select the default style for drop
Drop-down buttons in the header
of grid views. The default will apply unless a local style is set for the application or individual grid view.
row
Grid Header Drop-down Pane Style
Select the default style for drop
Drop-down panes
in the header of grid views. The default will apply unless a local style is set for the application or individual grid view.Grid Paging StyleSelect the default style for the paging bar of grid views. The default will apply unless a local style is set for the application or individual grid view.Grid Row StyleSelect the default style for rows in grid views. The default will apply unless a local style is set for the application or individual grid view.
Grid Paging StyleThe paging bar
Grid Row StyleRows
Grid Column Header Style
Select the default style for column headers in grid views. The default will apply unless a local style is set for the application or individual grid view.
Column headers
Row Selection Style
Select the default style for currently selected rows . This will apply to all selected rows in all grid views, unless a local selection style is set on that grid view.
The currently selected row(s)
Form View Header Style
Select the default header style for Form Views. This will apply to all 'old' Forms based on Stream Views.
In "old" forms that are based on stream views

Field headers

Form View Content Style
Select the default content style for Form Views. This will apply to all 'old' Forms based on Stream Views.

Field content

Advanced

FieldDescription
Default Character Set
The

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

Please note that this

Note

The character set must be

a character set

supported by the Java virtual machine

and that multi

.

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


Data Storage Group
The Data Storage Group

Enter the data storage group to use when creating tables to store

Stream

stream data. This field is interpreted differently depending on the underlying database:

  • On Oracle, a
Data Storage Group
  • data storage group is equivalent to a Tablespace.
  • On SQL Server, a Data Storage Group is equivalent to a Filegroup.

If no

Data Storage Group

data storage group is specified, the database user's default setting will be used.

Line Separator Style
The

Select the default line separator style that will be used by

File Exporters

file exporters where no particular line separator has been specified. If you do not specify a default

style here then the default will revert to be

line separator here, PhixFlow will use the default of the operating system

on which the PhixFlow server is running. In addition you can specify the line separator on each file exporter where a particular

.

Where a specific file exporter needs to use a

style other than the system default

different line separator, use the File Exporter → Line Separator Style property.

Default Stream Storage
This specifies
Select the default
Storage Type
storage type to use when creating a new
Stream
stream.
  • Database:
Store
  • store the data in a regular table within the PhixFlow database. This is the
most common option
  • usual storage type for PhixFlow.
  • Database (Partitioned):
Store
  • 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
Streamsets. The option is only available if "partitioning" is available within your database installation.
  • stream sets. 
  • In Memory:
Data
  • the data for the
Stream
  • stream will not be written to the database.
This option can be used (for example)

  • This is useful when working with large data sets. For example, when you want to aggregate large amounts of unsorted data, which
can
  • is then be written to a stored
Stream
  • stream.
Schema Version
Read only:
Displays the version of the schema currently installed. (Read-only)
Licence Key
This is the Licence Key

The licence key for your PhixFlow Installation

which is

, 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

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

Delete Log Messages after Days


Anchor
deleteLogMessagesAfterDays
deleteLogMessagesAfterDays

If this field is set,

Enter the number of days that log messages and managed files are kept. When a System Task runs,

when run, deletes Log Messages and Managed Files for Log Files

it deletes log messages and managed files that are older than this number of days.

Temporary

Managed files includes the files created by

File Exporters

file exporters to send by email

will also be deleted when the Managed File entry is deleted.See Task Plans for how to set up and run a System TaskThere is no option to archive Managed File entries to file

.

For information about the system task, see Task Plans.

Archive deleted log messages to file

Anchor
archiveDeletedLogMessagesToFile
archiveDeletedLogMessagesToFile

Whether to archive Log Messages to file before deletion. Archived Log Messages are written to archive files in the Archive Directory (see above).

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

Delete Emails after Days

Anchor
deleteEmailsAfterDays
deleteEmailsAfterDays

If this field is set,

Enter the number of days that emails are kept. When a System Task runs,

when run, deletes Emails

it deletes emails that are older than this number of days.

There is no option to archive Email entries to file before deleting them

You cannot archive emails to a file before deleting them.

For information about the system task, see Task Plans.

Password Policy
The password policy selected by default when creating new users. Password Policies can be edited in the Password Policies List
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
The export password policy selected by default when creating new users
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

checkbox to allow access to reset the configuration.WARNING:

check box; see Configuration Reset.

Warning

Resetting the configuration

will delete

deletes all configuration data in the PhixFlow

Instance. See Configuration Reset for how to reset the configuration

instance.


External Login

FieldDescription
External Login Groups
Anchor
externalLogin
externalLogin
Names of 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.

E.g.

For example, 'group_1;group_2' is valid, but 'group_1;  group_2' is

unlikely to be

not valid.

Names are case-independent.

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

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.