Overview

File Tables 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.

Properties Tab

Parent Details

If this item is within or belongs to another, its parent name is shown here. See the Parent Details section on the Common Properties page for more details.

Basic Settings

Field	Description
Name	The name of the File Table.
Enabled	Enable to capture a file and associated information when a file(s) is dragged and dropped onto an associated 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 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	Tick to signify that the file table's attributes cannot be amended.
Description	Enter a description to explain the purpose of this item.

Attributes

File Tables 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	Required for future feature.
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.
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.
Url	Provides a URL to access the file. 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.
Extension	The file type, e.g. png, MP4 or PDF
Label	TBC
Content Id	Required for future feature.
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.

Attribute Options

To add a new attribute to the list, click the icon
To edit the properties of an attribute, double-click the attribute name to open the Attribute properties
To remove an attribute from the table, right-click the attribute and select Delete
To add an attribute from another table, open the table and drag the attributes from one table to the other

Views

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

To edit the properties of a view, double-click its name. To add a view to the list, click Create New. PhixFlow opens the View properties tab.
To remove a view from the table, select the view and click Delete in the toolbar.

Sort Orders

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 Create New and PhixFlow opens the Sort Order properties
To remove a sort order from the table, select the sort order and click Delete in the toolbar

Errors

This section has a toolbar with standard buttons. See Menu Options and Toolbar Buttons.

When you save changes to the properties of a table or view attribute, PhixFlow validates that the properties are set correctly. If there is an issue with the properties, PhixFlow indicates this with a Model Validation Status of ERROR.

The Errors grid contains a list of the validation checks. For those that failed, the Validation Message indicates which properties need fixing. For example, PhixFlow reports an error if the steam has no Data Retention option set. Double-click on a row to view a full message.

PhixFlow can process data from tables or view attributes that have validation errors. The validation checks help you to configure tables and view attributes so that PhixFlow can continue to run efficiently. For example, PhixFlow reports an error if a table has no Data Retention option set because it can affect performance when all old tablesets are retained,

When a table or view attribute has validation errors, these are also be listed in the Errors section of the application or package to which the table or view belongs.

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

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

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 Create New. PhixFlow opens the Filter properties tab.

To remove a filter from the table, select the filter and click Delete in the toolbar.

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.

Data Retention Settings

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

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.

Field	Description	What Data is Deleted
Retain All Data	Untick to specify the criteria for keeping data in the Keep... properties below (recommended). Tick to allow old data to accumulate in PhixFlow. 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	Enter 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	Available when Track Superseded Data is selected. Enter the number of days to keep superseded records in the table data. 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	: Tick 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.

Analysis Models

If this item is used by an analysis model, its name is listed here. See the Common Properties page, Analysis Model section for more details.

Advanced

Only change the advanced properties with advice by PhixFlow support.

Field	Description
Advanced Properties	Only 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. See also Configuring Access to Database Views.
Audit Manual Changes	This toggle is available when the Analysis Options → Period is Transactional. 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 Options
Index Scheme	Select 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 Type	Select 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
Start Date	Enter the date on which this table starts or click Show Calendar 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 Size	Enter 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	Untick to restrict all users to the Table Download Limit. Tick 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. Tick 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	Tick 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 Tolerances	When 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 View	Select 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 By	PhixFlow displays the user that last ran analysis on this table.

Security Tab

Access Permissions

See the Common Properties page, Access Permissions section.

Audit Tab

Audit Summary

See the Common Properties page, Audit Summary section.

Sections on this page

Learn More

File Table