Insert excerpt

	_Banners
	_Banners
name	erd
nopanel	true

Overview

Insert excerpt

	_tableFile
	_tableFile
nopanel	true

s are used to hold the information about uploaded files, such as images, PDFs and CSVs. They can be used for File Display components and when Adding a File Gallery Display.

Insert excerpt
_property_tabs
_property_tabs
name basic-h
nopanel true

Insert excerpt

	_parent
	_parent
nopanel	true

Basic Settings

UIDNameOriginal File NameMime TypeCreated DTMCreated ByFile SizePathUrlExtensionLabelContent IdInlineFolder Id

Views

The grid contains a list of the data views for this table

file table.File Location

Field	Description
Name	The name of the File Table.
Enabled	Enable to allow a file to be uploaded and associated information captured, when a file(s) is dragged and dropped onto a File Display or File Gallery component.
File Location	This File Location is added to the end of the File Location defined in the System Console, it facilitates the	Enabled	association of a file belonging to this File Table being placed in a specific subdirectory. For Example, the system console defines "/opt/data/FileTableUpload" and the File Location on the File Table set "/secure". This means all file uploaded to this File Table will be placed in "/opt/data/FileTableUpload/secure"
Read Only	Signifies Tick to signify that the file table's attribute attributes cannot be amended.
Description	Enter a description to explain the purpose of this item

Attributes

Each attribute has a set of predefined settings, these are:

FieldDescription

.

Sort Orders

This section has a toolbar with standard buttons, see Menu Options and Toolbar Buttons. The grid contains a list of the sort orders for this table.

To edit the properties of a sort order, double-click its name. To add a sort order to the list, click

Attributes

AnchorkeepSupersededForXDayskeepSupersededForXDaysAvailable when Track Superseded Data is selected.

Enter the number of days to keep superseded records in the table data.

Tip

Remember to keep superseded records for as long as you want the option to roll back the data.

For example, when Keep Superseded for N Days is set to 4, you can run roll back on data that was superseded up to 4 days ago.

A table-data-delete task removes superseded records older than 4 days, so PhixFlow no longer has the data to be able to roll it back.

In a table where the superseded date is tracked, the table data contains a mixture of active records and records that have been superseded.

When a table-data-delete task runs for a table and:

Keep Superseded for N Days only is set, PhixFlow deletes data records that were superseded more than N days ago.
Keep Superseded for X Recordsets only is set, PhixFlow deletes superseded records from the recordsets that exceed X.
both Keep Superseded for N Days and Keep Superseded for X Recordsets are set, PhixFlow deletes the superseded records that meet both conditions.
neither Keep Superseded for N Days nor Keep Superseded for X Recordsets are set, PhixFlow keeps superseded records indefinitely. This can lead to performance issues.

Keep Superseded for X Tablesets

Available when Track Superseded Data is selected.

Enter the number of recent recordsets that will retain their superseded data records.

Apply Delete Filter

Image Removed: Insert excerpt_check_box_tick_check_box_ticknopaneltrue to open a filter tab where you can set filter conditions; see Filter. PhixFlow applies this filter when it runs a table-data-delete task. Only the records which match the filter are deleted. Insert excerpt_model_prop_model_propnopaneltrue

Advanced

Only change the advanced properties with advice by PhixFlow support.

FieldDescriptionAdvanced PropertiesOnly use this field with advice from PhixFlow support. Database View

Use this property if your database administrator wants to query table data in the PhixFlow database.

Enter a string in the format v_xxxx. When the table is published to the database, PhixFlow creates a view. If the table is deleted, the next system task that runs will clear the associated view from the database.

By default, this field is blank and no view is created in the database.

Audit Manual Changes

This toggle is available when the Analysis Options → Period is Transactional.

Insert excerpt_toggle_on_toggle_onnopaneltrue toggle on to update and delete initiated by actions (not those carried out by analysis runs) will automatically mark the existing record as superseded and create a new recordset. The new versions of the updated records will be placed in the new recordset. Inserts will simply create a new recordset, and add the inserted record into that recordset.

When Audit Manual Changes is first set, the attributes UpdateAction, UpdatedByName, UpdatedByID and UpdatedTime will be created if they do not already exist. If you do not require these attributes, delete them. For the UpdatedByName attribute, PhixFlow creates a field of 250 characters.

UpdateAction must be set to the type of action, such as INSERT, UPDATE or DELETE. The other attributes will be populated if they exist on the table:

UpdatedByName - the name of the user that performed the update,
UpdatedByID - the internal id of the user that performed the update
UpdatedTime - the date and time the update was made

Storage OptionsIndex Scheme Anchorindex_schemeindex_schemeSelect an option to determine how indexes on the table are organised.

All: indexes on the table are optimised for selecting from all recordsets (non-historied reads).
Latest: indexes on the table are optimised for selecting from the latest recordset (i.e. for historied reads).
Superseded: indexes on the table are optimised for self-updating tables which have a mostly superseded records.
None: no indexes are created on the table.
Partitioned: this index scheme is specific to partitioned tables; see Storage Type below. Partitioned tables must use this index scheme, and only partitioned tables can use it.

Storage TypeSelect an option to specify how data for the table should be stored:

Database: Store the data in a regular table within the PhixFlow database. This is the most common option
Database (Partitioned): Store the data in a partitioned table within the PhixFlow database. This option provides improved performance for rollback and retaining very large recordsets. The option is only available if "partitioning" is available within your database installation.
In Memory: Data for the table will not be written to the database. This option can be used (for example) when you want to aggregate large amounts of unsorted data which can then be written to a stored table.

Data Generation Options Anchordata-gendata-genStart DateEnter the date on which this table starts or click Insert excerpt_calendar_calendarnopaneltrue to select a date. Data will be populated into the table from this date onwards.Primary Key Generator

This option relates to an actionflow with a save node that inserts a new record into a table. Each new record requires a unique value for the record's primary key. Use this option to specify how PhixFlow generates the primary key value.

Internal: PhixFlow generates unique primary key values automatically. This is equivalent to setting the attribute expression to _NULL.
Sequence: display the Primary Key Generator Sequence option, in which you can select a sequence of values.

Primary Key Generator Sequence

Available when Primary Key Generator is Sequence.

Select a sequence to assign a new value to the primary key attribute of a new record; see Sequence.

The new record takes the next primary key value in a sequence. This is equivalent to setting the attribute expression to nextValue("sequenceName".

In Memory Cache SizeEnter the size of the cache that will be maintained when you are using an in-memory table. See Manage Unsorted Data Using an In-Memory Table.Allow Partial Set Processing Insert excerpt_check_box_untick_check_box_unticknopaneltrue to restrict all users to the Table Download Limit. Insert excerpt_check_box_tick_check_box_ticknopaneltrue so that, when analysis reaches the end of a buffer block, it submits the candidate set for processing, even if the next buffer block has a different key.Prevent Parallel Processing

Available when Period is Transactional.

Insert excerpt_check_box_tick_check_box_ticknopaneltrue to ensure only a single recordset can be generated at a time even if the table receives several concurrent requests to generate data.

This can be useful where you want to make sure that two analysis runs do not attempt to update the same records at the same time e.g. as a result of two people selecting the same records in a view and then hitting the same action button at the same time to process those records.

Run Alone Insert excerpt_check_box_tick_check_box_ticknopaneltrue so that, whenever the analysis engine needs to generate data for this table, it will first wait for all running tasks to complete before it starts.

Any additional analysis tasks submitted while this table is waiting to start, or while it is generating data, will wait until this table has completed its analysis before they start.

Key TolerancesWhen building a candidate set, data can be grouped together using a specific key value, e.g. Account Number. If the key value is a number, enter a key tolerance to identify numbers within the given tolerance as the same key value.Default ViewSelect the default view for the table; see Views for details of creating views on tables.Last Run Date (Read only)PhixFlow displays the date and time that analysis was last run for this table. This date is taken from the "to date" of the most recent recordset for this table.Last Run ByPhixFlow displays the user that last ran analysis on this table.

Insert excerpt

	_

new

tableFile
	_

new

tableFile
nopanel	true

. PhixFlow opens the Sort Order properties.To remove a sort order from the table, select the sort order and click Insert excerpt_delete_deletenopaneltrue in the toolbar.

Errors

Insert excerpt_validate_validatenameerrornopaneltrue

ERDs

The grid displays a read-only list of the Entity Relationship Diagrams (ERDs) that this table is part of. Double-click an ERD to open it. See Entity Relationship Diagrams.

Relations

This section has a toolbar with standard buttons, see Menu Options and Toolbar Buttons. The grid displays a read-only list of the relationships that this table has to attributes in other tables. Double-click a relationship to display it's properties; see Relationship and Entity Relationship Diagrams.

Filters

This section has a toolbar with standard buttons, see Menu Options and Toolbar Buttons. The grid contains a list of the filters that can be applied to this table. You can add filters to view based on this table.

All filters in this list are available in the default view for this table. For views that you create, in the View properties tab → Filters section, you can add filters. The list of available filters is populated by the filters defined for the table.

To edit the properties of a filter, double-click its name. To add a filter to the list, click Insert excerpt_new_newnopaneltrue. PhixFlow opens the Filter properties tab.To remove a filter from the table, select the filter and click Insert excerpt_delete_deletenopaneltrue in the toolbar.

Tip
In a view grid, the header row has a drop-down list of filters. The drop-down list is populated by the filters that are selected on the view. The filters must first be defined for the table here.

Inputs

This section lists all pipes that connect into the table. Double-click a pipe to view more details and make changes. See Pipe.

This section has a toolbar with Insert excerpt_detailed_list_detailed_listnopaneltrue and Insert excerpt_refresh_refreshnopaneltrue buttons; see standard buttons, see Menu Options and Toolbar Buttons.

Data Retention Settings

Use the following options to specify how PhixFlow manages old data when a table-data-delete task runs.

Warning

We recommend that you always specify the data retention values for every table you create.
PhixFlow checks that a table has:

either data retention settings (recommended)
or Retain All Data selected.

If no data retention option is set, PhixFlow displays an error in the Errors section, above.

Using Tasks and Task Plans for information about tasks.
Deleting Old Data to see how you can use these values in data management strategies.

FieldDescriptionWhat Data is Deleted

Retain All Data

Insert excerpt_check_box_untick_check_box_unticknopaneltrue to specify the criteria for keeping data in the Keep... properties below (recommended). Insert excerpt_check_box_tick_check_box_ticknopaneltrue to allow old data to accumulate in PhixFlow.

Warning
Tables with Retain All Data ticked never have their data deleted and the data will accumulate. This can lead to performance issues.

Keep for N Days

AnchorkeepForXDayskeepForXDaysEnter the number of days to keep data in the table.

The age of data in a recordset is its 'to' date, relative to the 'to' date of the newest valid recordset in the table .

When a table-data-delete task runs for a table and:

Keep for X Days only is set, PhixFlow deletes table data that is older than N days.
Keep for Y Recordsets only is set, PhixFlow keeps the most recent X recordsets and deletes recordsets that exceed X.
both Keep for X Days and Keep for Y Recordsets are set, PhixFlow deletes the table data that meets both conditions.
neither Keep for N Days nor Keep for X Recordsets are set, PhixFlow keeps table data indefinitely. This can lead to performance issues.

Keep for X Recordsets

The number of recordsets to keep in the table.

Keep Superseded for N Days

s have a set of predefined attributes that cannot be changed, deleted or added to. These attributes are:

Field	Description
UID	The file's image or placeholder image. Hover over the image to see the unique identifier.
Name	A spare field that can be set by the user.
Original File Name	The name of the file before it was uploaded to PhixFlow.
Mime Type	A two-part identifier used to indicate the intended datatype of a file.
Created DTM	The date and time the file was uploaded to PhixFlow.
Created By	The User who uploaded the file. The information is taken from the users profile in the format, FirstName FamilyName (emailaddress).
File Size	The file size, in KB. This attribute is read only by default.
Path	The directory where the files are stored, as specified by the File Table Upload Locations in the System Configuration and in the Basic Properties. This attribute is read only by default.
Url	Provides a URL to access the file, using the System URL, defined in System Configuration, as the base for the URL it creates. It can be used as a link for a download or sent to a PhixFlow URL component to display the file (where appropriate) on a screen. Note: The URL created will automatically escape non-URL safe characters, such as spaces.
Extension	The file type, e.g. png, MP4 or PDF
Label	A spare field that can be set by the user.
Content Id	The ID of the attachment within an email. This allows associated email attachments to be seen.
Inline	Defines if the file is to be displayed within an email body.
Folder Id	An ID that links files uploaded at the same time, e.g. files uploaded together will have the same Folder Id such as files received by an email or where multiple files have been dragged onto a File Gallery component.

See All Sections

Expand

title	Click here to see details of all sections...

Insert excerpt

	Table
	Table
name	Views
nopanel	true

Insert excerpt

	Table
	Table
name	SortOrders
nopanel	true

Errors

Insert excerpt

	_validate
	_validate
name	error
nopanel	true

Insert excerpt

	Table
	Table
name	ERDs
nopanel	true

Insert excerpt

	Table
	Table
name	Relations
nopanel	true

Insert excerpt

	Table
	Table
name	Filters
nopanel	true

Insert excerpt

	Table
	Table
name	DataRetentionSettings
nopanel	true

Insert excerpt

	_model_prop
	_model_prop
nopanel	true

Insert excerpt

	Table
	Table
name	Advanced
nopanel	true

Insert excerpt

	_access
	_access
nopanel	true

Insert excerpt

	_audit
	_audit
nopanel	true

Live Search
spaceKey @self
additional none
placeholder Search all help pages
type page

Panel

borderColor	#00374F
titleColor	white
titleBGColor	#00374F
borderStyle	solid
title	Sections on this page

Table of Contents

maxLevel	3
indent	12px
style	none

Learn More

Version	Old Version 2	New Version Current
Changes made by	Zoe Baldwin	Zoe Baldwin
Saved on	Nov 14, 2024	Dec 16, 2024

Content Comparison

Versions Compared

Key

Overview

Insert excerpt_property_tabs_property_tabsnamebasic-hnopaneltrue

Basic Settings

Views

Attributes

Sort Orders

Attributes

Advanced

Errors

ERDs

Relations

Filters

Inputs

Data Retention Settings

See All Sections

Errors

Live SearchspaceKey@selfadditionalnoneplaceholderSearch all help pagestypepage

Insert excerpt
_property_tabs
_property_tabs
name basic-h
nopanel true

Live Search
spaceKey @self
additional none
placeholder Search all help pages
type page