PhixFlow Help

streamAttribute

Owned by Former user (Deleted)
Last updated: Jul 28, 2016 by Dominic Sandhu (Unlicensed)
2 min read

Forms: Stream Attribute

Stream Attributes define the type, precision and expressions of how each individual attribute is calculated based on the inputs to the Stream.

Stream attributes are listed in the Stream Attributes tab in the Stream Details form.

The following details are configured for each stream attribute:

Form: Stream Attribute Details

FieldDescription
NameName of the Attribute.
TypeThis can be one of:
  • String
  • Integer
  • Float
  • Date
  • Datetime
  • TrueFalse
LocalTick this if this field is only required as part of the stream calculation, and it is not necessary to keep the result for further stream calculations, reports or alarms. If this is ticked, the Column Name field becomes optional.
Length/PrecisionFor a String, the maximum length of the String. For an Integer, the maximum number of digits.
OrderThe order in which the attributes are placed in the stream.
ExpressionThe expression used to generate the attribute value. This is written as a PhixFlow Expression. It must evaluate to a single value, of the type specified in the Type field.
Cache KeyIf a cache key is set, the value of this attribute persists throughout the stream calculation, rather than being created from scratch for each stream item as normal. This allows you to keep track of the calculation as it progresses. The cache key is an expression that is evaluated for each stream item, and of course it can use the existing value of the attribute, in other words, to value it had in the previous stream item processed in the stream calculation. This allows expressions to use the "persistent" attribute value on subsequent stream items. The expression provided in the Cache Key is evaluated for each stream item so that this "persistent" attribute can refer to multiple value keyed on the "Cache Key".
IndexedTick this option if this field should be indexed in the underlying database. An indexed field should be used to increase performance on very large streams in the following situations:-
  • When 1 or more output pipes from the stream uses the field to 'Filter' the stream.
  • When 1 or more output pipes from the stream uses the field in a 'Sort/Group' by action.
DescriptionDescription of the attribute.

Form Icons

 

The form provides the standard form icons as well as the following:

Shows the list of attribute functions available in PhixFlow.

See Also

Please let us know if we could improve this page feedback@phixflow.com