Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Reverted from v. 40

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

  • the repository. Attributes are listed under their table
  • the Table properties → Attributes table
  • other attribute lists. 

...

Basic Settings

...

Enter the name of the attribute.

Tip

PhixFlow recognises the attribute name UID as a unique identifier for a record. As records are added, PhixFlow automatically increments the UID value.

...

Select the attribute type for the data.

  • String
  • Bigstring
  • Integer
  • Float
  • Decimal
  • Date
  • Datetime
  • Graphic
  • TrueFalse

...

Length

...

This field is available when Type is String. By default strings are 50 characters long. Optionally specify a different string length of between 1 and 4000.

For strings longer than 4000 characters, set a Type of Bigstring

...

This field is available when Type is Integer. Enter the maximum number of digits allowed in whole numbers. By default, integers are 10 digits long. Optionally specify a different integer precision of between 1 digit and 38 digits.

...

Panel
borderColor#01cff1
borderWidth4
titleBGColor#01cff1
titleExample

To specify numbers must have two digits before and after the decimal point, such as 12.34, enter:

Significant Figures  4

Decimal Places  2

...

This field is available when Type is Decimal. Enter the maximum number of digits allowed after the decimal point. By default, decimals have 2 decimal places.

This must be less than the number of significant figures.

...

The order of the attributes in the table. Table attribute expressions are evaluated in this order. 

This is important when you need to use the results of a calculation in another attribute:

  • either in its expression
  • or in a $ variable.

In the attribute list, the attribute that calculates the result must come before the attribute that requires the result.

...

Advanced

...

To improve performance, index an attribute when the table has a large data set and an output pipe from the table uses this attribute to:

  • filter the table data
  • sort or group the table data.

...

Note
This option affects the behaviour of filters for PhixFlow instances running on Oracle or MariaDB (MySQL) databases.
For PhixFlow instances running on a SQL Server database, filters are always case-independent.

...

Insert excerpt
_Banners
_Banners
nameanalysis
nopaneltrue

This page is for data modellers and application designers who need to work with data in tables.

Overview

Use the attributes properties to specify the characteristics of the data in a column.  You can open attribute properties from:

  • the repository. Attributes are listed under their table.
  • the Table properties → Attributes section
  • other attribute lists. 

 

Insert excerpt
_property_toolbar
_property_toolbar
nopaneltrue

Insert excerpt
_property_tabs
_property_tabs
namebasic-h
nopaneltrue

Insert excerpt
_parent
_parent
nopaneltrue

Basic Settings

FieldDescription
Name

Enter the name of the attribute.

Tip

PhixFlow recognises the attribute name UID as a unique identifier for a record. As records are added, PhixFlow automatically increments the UID value.


Type

Select the type of data this attribute contains; see Understanding Data Types.

  • String
  • Bigstring
  • Integer
  • Float
  • Decimal
  • Date
  • Datetime
  • Graphic
  • TrueFalse

Length

This field is available when Type is String. By default strings are 50 characters long. Optionally specify a different string length of between 1 and 4000.

For strings longer than 4000 characters, set a Type of Bigstring

Precision

This field is available when Type is Integer. Enter the maximum number of digits allowed in whole numbers. By default, integers are 10 digits long. Optionally specify a different integer precision of between 1 digit and 38 digits.

Significant FiguresThis field is available when Type is Decimal. Enter the maximum number of total digits for decimal numbers.  By default decimals have 10 significant figures.


Panel
borderColor#01cff1
borderWidth4
titleBGColor#01cff1
titleExample

To specify numbers must have two digits before and after the decimal point, such as 12.34, enter:

Significant Figures  4

Decimal Places  2



Decimal Places

This field is available when Type is Decimal. Enter the maximum number of digits allowed after the decimal point. By default, decimals have 2 decimal places.

This must be less than the number of significant figures.

Local

 

Insert excerpt
_check_box_

...

untick
_check_box_

...

untick
nopaneltrue
 to

...

Enter an expression to be evaluated for each table item (data record) in the table. The expression can:

  • either use the value of this attribute
  •  or calculate a different value

Once calculated, the cache key value persists throughout subsequent table calculation, rather than being created from scratch for each table item as normal. This allows you to keep track of the calculation as it progresses.

This means you can use a "persistent" attribute value in other expressions. 

Access Permissions

For details about how to control access to an attribute, see Common Properties → Access Permissions.

...

All attributes have a data type. When loading data from a source, such as a file or database, PhixFlow applies the data type from the source. If there is no data type specified, PhixFlow applies the default type of string.

You can change the type of an attribute before the data has been loaded into the table.

Once the table contains records, you may be able to change the attribute's data type, depending on the database on which PhixFlow runs. PhixFlow reports an error if you are not permitted to change the data type. In this case you can rollback all record-sets so that the table no longer contains records; see Rollback.

String

Apply a string type to sequences of characters, such as letters, numerals, symbols and punctuation marks. By default string attribute types have a default length of 50. Specify a different string length in Basic Settings → Length.

...

Apply a bigstring type to text strings over 4000 characters long. Bigstring is a different data type to string. For PhixFlow instances that use an Oracle database, bigstrings:

  • cannot be sorted or aggregated
  • can only be filtered with the conditions:
    • (not) contains
    • is (not) null
    • (not) starts with
    • (not) ends with.

The PhixFlow administrator can configure the length of a bigstring using System Configuration → System Tuning → Maximum Bigstring Size.

Integer

Apply an integer type to whole numbers (not a fractions or decimals) that can be positive, negative, or zero. By default integers have a precision of 10 digits. Specify a different integer length in the Basic Settings → Precision.

 If you store a number with decimal places as an integer it will be truncated.

Float

Apply a float type to non-integer numbers with an undefined level of precision.

...

Apply a decimal type to non-integer numbers with a set level of precision. Decimals have a specific number of:

  • significant figures: the total number of digits stored, 
  • decimal places: the number of digits after the decimal place.

The maximum number of integer digits is therefore the significant figure minus the decimal places. By default, decimals have 10 significant figures and 2 decimal places, and therefore 8 integer digits.

If the number of integer digits present in a decimal field exceeds the specified format, running analysis will fail and PhixFlow will report an error.

If the number of decimal digits present in a decimal field exceeds the specified format, PhixFlow will round to the required precision. For example, if a data record includes the number 12.3456, but the decimal type can have 4 significant figures and 2 decimal places, PhixFlow records 12.35.

Note

Ensure your decimal type has the number of decimal places you need for your data. Once the data is loaded into PhixFlow, you will not be able to recover excess decimal places.

The PhixFlow administrator can configure the default number of decimal places is set in System Configuration → General Settings → Decimal places.

Date

Apply a date type to representations of a calendar day. Word formats, such as Tuesday the fourteenth of February are not recognised. However, three letter month abbreviations are recognised, for example: 14 Feb 2019.

The following date formats, have:

  • y represents year digits
  • M represents month digits or MMM represents three letters
  • d represents day digits
  • separators can be forward slash / hyphen - or a space.

The default number of date format is set in System Configuration → General Settings → Default Date Format.

If the System Configuration or Number Format option to Suppress Trailing Zeroes is set, PhixFlow will display decimals and floating point numbers without trailing zeroes.

Recognised Date Formats

  • the international standard format has not separators and is yyyyMMdd, for example 20190214. 
  • the following variations (examples shown with space separators).

...

Datetime

Apply a datetime type to representations of a day and a time. It cannot be used to represent a time alone.

Datetimes can have any of the above date formats followed by a space separator and HH:mm:ss. for example MM/dd/yy HH:mm:ss represents a datetime such as 02/14/19 15:35:06.

  • H represents hour digits (24 hour)
  • m represents minute digits
  • s represents second digits
  • time separators are colons :

The international datetime uses a full stop/period as a separator between the date and time, yyyyMMdd.HHmmss, for example 20190214.15:35:06.

...

The default number of date format is set in System Configuration → General Settings → Default Date/Time Format.

Graphic

Apply a graphic type to fields that contain image files.

True or False Values

Apply the Basic SettingsType of TrueFalse to fields that can have the values that represent true or false.

...

keep both table data and any result of using it in a calculation. 

Insert excerpt
_check_box_tick
_check_box_tick
nopaneltrue
 if you need to use the attribute in a calculation, but you do not need to keep the result.

Indexed

Insert excerpt
_check_box_untick
_check_box_untick
nopaneltrue
 to prevent this attribute being indexed in the PhixFlow database.

Insert excerpt
_check_box_tick
_check_box_tick
nopaneltrue
 to index this attribute in the PhixFlow database.

To improve performance, index an attribute when the table has a large data set and an output pipe from the table uses this attribute to:

  • filter the data
  • sort or group the data.
Primary Key

Insert excerpt
_check_box_tick
_check_box_tick
nopaneltrue
 indicates this attribute is a primary key. This means it contains a unique identifier for every record in the table. 

Foreign Key
Insert excerpt
_check_box_tick
_check_box_tick
nopaneltrue
 indicates this attribute is a foreign key. This means and ERD links this attribute to a primary key attribute in an other table; see Understanding ERDs.
Display Name
Insert excerpt
_check_box_tick
_check_box_tick
nopaneltrue
 indicates the name of this attribute is used as the label rather than the primary key attribute name.
Order

The order of the attributes in the table. Attribute expressions are evaluated in this order. 

This is important when you need to use the results of a calculation in another attribute:

  • either in its expression
  • or in a $ variable.

In the attribute list, the attribute that calculates the result must come before the attribute that requires the result.

ExpressionThe expression used to generate the attribute value. This is written as and expression; see Expressions and PhixScripts. It must evaluate to a single value, of the type specified in the Type field.

Advanced

FieldDescription
Filter conditions are
case-independent by default

Available when Basic Settings → Type is String or Bigstring.

Insert excerpt
_check_box_untick
_check_box_untick
nopaneltrue
 to use filters that are case-sensitive.

Insert excerpt
_check_box_tick
_check_box_tick
nopaneltrue
 to set new filter conditions on this attribute to be case-insensitive by default. The filter window → Ignore Case check box inherits this setting; see Filters on Data Views. For case-insensitive filters, there is no difference if the attribute is also indexed. 

Note
This option affects the behaviour of filters for PhixFlow instances running on Oracle or MariaDB (MySQL) databases.
For PhixFlow instances running on a SQL Server database, filters are always case-independent.


Key

Insert excerpt
_check_box_untick
_check_box_untick
nopaneltrue
 for in-memory table, to specify that this field is not a key value.

Insert excerpt
_check_box_tick
_check_box_tick
nopaneltrue
 for in-memory table, to specify that this field will be used as a key value. 

Translate Values 
Anchor
translate
translate

Available when Basic Settings → Type is String or Bigstring.

Insert excerpt
_check_box_untick
_check_box_untick
nopaneltrue
 to ignore this attribute when translating text in PhixFlow (the default).

Insert excerpt
_check_box_tick
_check_box_tick
nopaneltrue
 to include this attribute when translating text that appears in PhixFlow. To be translated, the attribute text must be included in a translation table; see Translating an Application Interface and Translation Table.

Cache Key

Enter an expression to be evaluated for each record in the table . The expression can:

  • either use the value of this attribute
  •  or calculate a different value

Once calculated, the cache key value persists throughout subsequent calculation, rather than being created from scratch for each record as normal. This allows you to keep track of the calculation as it progresses.

This means you can use a "persistent" attribute value in other expressions. 

Insert excerpt
_description
_description
nopaneltrue

Insert excerpt
_access
_access
nopaneltrue

Insert excerpt
_audit
_audit
nopaneltrue

Live Search
spaceKey@self
additionalnone
placeholderSearch all help pages
typepage

Panel
borderColor#00374F
titleColorwhite
titleBGColor#00374F
borderStylesolid
titleSections on this page

Table of Contents
maxLevel3
indent12px
stylenone

Learn More


Insert excerpt
_terms_changing
_terms_changing
nopaneltrue