Versions Compared

Key

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

The following is a list of all key terms within PhixFlow and links to relevant help pages.

Insert excerpt
_terms_changing
_terms_changing
nopaneltrue

Defines action buttonaggregate attributeanalysis modelAllow users to logically represent archive taskarrayattribute functionPhixFlow audit summarycandidate set

Candidate sets are a fundamental concept of function calculation in PhixFlow.

Every time a function calculation file exporter

Used to write information from PhixFlow to external files.

File Exporter DetailsA web HTTP datasource instanceHTTP exporterinternal variablesrollbackTaskrollback taskstream actionstream action attributeIndividual record in a 9050674641.stream tablesstream viewstream view attributestream setsystem configurationtasktask plan

Contains a set of 9050674641 to run.

Task Plans
TermDescription

Anchor
action
action
action

, actionflow, table-action

Adds functionality to a screen. Actionflows (9.0 and later) or table-actions and record-actions (8.3 and earlier) define a set of operations on  the values of data in a stream.

 stream item. A stream action can be applied from the stream view properties.

Anchor
actionButtonsactionButtons

Used to group actions into drop-down lists or display a single 9050674641 as a button. In both cases Action Buttons are displayed on the top of 9050674641 .

Anchor
aggregateFieldaggregateField

Aggregate Attributes define the aggregated properties that are available when data is read from an aggregating 9050674641.

Anchor
analysisModelanalysisModel

that work on records or open screens.

Anchor
aggregateField
aggregateField
aggregate attribute

For an analysis model, where you need to combine data, use an aggregate attribute that reads data from a pipe.

Anchor
analysisModel
analysisModel
analysis model

A model that logically represents a business process / control flow using configured PhixFlow objects, e.g. streams, file collectors etc.

Analysis

objects that represent data (tables) and processes. You can run the model to process the data. 

Anchor
analysisTask
array
analysisTask
array
analysis task

The Analysis Engine is initiated whenever the generation of a Stream Set is requested. Users can do this by configuring Analysis Tasks in a 9050674641.

Anchor
archiveTaskRunarchiveTaskRun

A task to archive 9050674641 from 9050674641 with archiving configured on them.

Anchor
arrayarray

An object that contains an ordered list of other objects.

Anchor
attributeFunctionattributeFunction
array

An object that contains an ordered list of other objects.

Anchor
attributeFunction
attributeFunction
attribute function

PhixFlow provides an extensive list of Attribute Functions which may be used within all expression strings.

Anchor
auditSummary
auditSummary
audit summary
Anchor
auditDetail
auditDetail
audit detail

Details of an individual audited action performed on a PhixFlow object.

Anchor
auditSummaryauditSummary

PhixFlow records information about changes to data. You can see summary or more details. 

A summary of all audited action performed on PhixFlow objects. Can be viewed in the System Console.

Anchor
auditAffectedObjectcandidateSetauditAffectedObject
candidateSet
audited item

PhixFlow objects that have auditing switched on to allow for any changes in the system to be tracked.

Anchor
candidateSetcandidateSet
candidate set

Candidate sets are a fundamental concept of function calculation in PhixFlow.

Every time a function calculation is carried out, all the required input data is brought together and organised into sets of data - one set for each Key group.

The Key groups are worked out using the Pipe Grouping Attributes defined on input Pipe for each Streamtable.

Anchor
centerViewDatabase
centerViewDatabase
PhixFlow database

The database that stores the PhixFlow schema and all processed data.

Anchor
chart
chart
chart

A Chart displays data in table form, or in one of a number of graphs styles.

Anchor
comparator
comparator
comparator

Refers to the comparator types that can be used in a filter, e.g. greater than, starts with.

Anchor
collector
collector
collector

A generic term for a 9050674641, a 9050674641, or an 9050674641modelling object that loads data. This can be a file, data from a database, or data from a external site.

Anchor
contextMenu
contextMenu

context

popup menu

A context menu appears above each 9050674641 when the user hovers over it in a model view. This menu shows all of the actions that can be performed on that element.

Anchor
csvfilecsvfile

In many places on the PhixFlow interface you can:

  • hover your mouse pointer
  • right-click

to display a popup menu with more options.

Anchor
csvfile
csvfile
CSV file

A CSV (comma-separated variable) file is a plain text file where each line in the file consists of a number of fields separated by commas ','. If fields may contain spaces, commas or double quotes, they should be enclosed in double quotes '"'. A double quote may be represented by 2 double quotes.

A CSV file is always encoded using a specific character set. On Windows this is typically Cp1282, and on Unix/Linux US7ASCII, though the following are sometimes used: UTF-8, UTF-16, ISO-8859-1.

A CSV file typically has an extension '.csv'.

A CSV file can be created directly in a plain text editor (e.g. Wordpad/Notepad), in Excel (by saving as a CSV), or by some other application.

Anchor
cycle
cycle
cycle

Whenever an analysis model is run it will carry out a number of tasks e.g. read a number of files, generate a number of stream setsrecordsets, export a number of files. It is possible to configure an analysis model so that in a single analysis session it will actually run several times. When a model is configured in this way, each time it runs is termed a 'cycle' and all of the items processed or generated during that cycle (i.e. the files processed, stream sets  recordsets created, files exported etc) are flagged with the cycle number. This cycle number is visible in the Log File for that analysis run on each of the relevant tabs showing files and stream sets and recordsets processed.

The most common reason for configuring a model in this way is to allow a number of files to be processed in a single analysis session but to have the results from each file saved in a separate stream setrecordset. In this way, whenever a file fails to process the user can simply rollback the stream sets the recordsets associated with that file rather than rolling back all of the stream sets the recordsets associated with all of the files for the whole analysis session.

To achieve this, a model is configured with a push pipe from the final stream table in the model pointing back to itself. This push pipe is then given positive offsets. The file collector at the start of the model is then configured to process a single file at a time. When this model is run the file collector will read in one file, process it to create a stream set a recordsets (or a chain of stream sets of recordsets if there are several streams tables in the model) and will flag the file processed, the stream sets the recordsets generated and any associated output files with the cycle number 1. When the last stream table in the model has finished producing its stream set its recordset it will send a notification to itself down the push pipe. This notification (because of the positive offsets) will be taken as a signal to create another stream set another recordsets which will effectively cause the whole model to run again. This second run of the model will be deemed to be cycle 2 and all files processed, stream sets  recordsets produced or files output will be flagged with this cycle number.

When later viewing the log files the user can see which items were processed in which cycle and can choose how many cycles to roll back. In the case where the last file processed was unsuccessful the user can therefore choose to only roll back the last cycle.

Anchor
dashboard
dashboard

dashboard

screen

A dashboard screen allows the user to gather into a single view a set of charts. This grouping of related reports and statistics provides the user with preconfigured overviews of selected areas, making all the data that is required to view and monitor the health of the system both accessible and easy to read.

Anchor
dataGrid
dataGrid
data grid

A Data Grid is a particular type of view which displays the data in a table format.

Anchor
databaseCollector
databaseCollector
database collector

Used to gather information from a external database, defined as a PhixFlow Datasourcedatasource. It holds the SQL that will be sent to the datasource to retrieve data.

Anchor
driverClass
driverClass
database driver

The driver used to access the source database.
Anchor
databaseExporter
databaseExporter
database exporter

Used to write information from PhixFlow to external databases.

Anchor
datasource
datasource
datasource

Defines a connection to an external database.

Anchor
datasourceInstance
datasourceInstance
datasource instance

Allows for multiple connections for individual database instances to be configured for a specific 9050674641datasource.

Anchor
directedPipe
directedPipe
directed pipe

A Directed Pipe is used as a secondary input to a Merge StreamTable.

Primary Pipes to a Merge are implemented by reading all input records from all Primary Pipes in a single operation, ordered by the Group-By fields. The primary pipes determine the key values of the Candidate Sets that will be generated.

A Directed pipe is implemented after the Primary Pipes have run, by reading records matching each Candidate Set grouping key in turn. This can result in a significant performance improvement in certain circumstances.

A Pipe can be marked as a Directed Pipe on the Pipe Details / Advanced tab.

Anchor
expression
expression
expression

An expression returns a value, usually by manipulating or transforming input data, although some expressions can be very simple: e.g. the expression "hello" always returns the string "hello" and requires no input.

Anchor
fileCollector
fileCollector
file collector

Describes the structure, content, naming patterns and location of files of data to be imported into PhixFlow.

Anchor
fileCollectorAttribute
fileExporter
fileCollectorAttribute
fileExporter
file collector attribute

The data columns that a File Collector expects to be present when importing a file.

Anchor
fileExporterfileExporter
exporter

Modelling objects that you use to import or export files.

Anchor
filter
filter
filter

Filters are made up of a set of clauses; each clause in turn contains a number of conditions. These conditions must be satisfied for data to be passed through a pipe or returned in a filtered list.

Anchor
formBar
formBar
form bar

If you move your mouse pointer to the bottom of the screen the PhixFlow Form Bar will appear. Contains links to all open forms (both open and minimised).

Anchor
fTPSite
fTPSite
FTP site

A file system that is reachable via the FTP protocol.

Anchor
orderByField
orderByField
group by attribute

Groups the pipe data into candidate set, forms key for candidate set. However if data is coming from database or file collector, order by fields need to be specified in the collector SQL.

Anchor
http
http
HTTP

Hypertext transfer protocol - the language of the internet. In the context of PhixFlow, it means using standard internet communication as means of importing and exporting data.

9050674641

  • 9050674641
  • Anchor
    httpCollector
    httpCollector
    HTTP collector

    Collect data from an 9050674641.

    Anchor
    httpDatasource
    httpDatasource
    HTTP datasource
    Anchor
    httpDatasourceInstance
    httpDatasourceInstance
    HTTP datasource instance
    Anchor
    httpExporter
    httpExporter
    HTTP exporter

    Modelling objects available for importing or exporting data from s web site, web service or some other target that allows XML, HTML or text data to be collected from it, or exported to it, over HTTP. Data is collected from an HTTP Datasource using a 9050674641 , and exported to an HTTP Datasource using a 9050674641.

    An HTTP Datasource Instance must define at least one 9050674641.

    An HTTP Datasource Instance may define multiple 9050674641 to support 9050674641 expressions on 9050674641 .

    Anchor
    httpDatasourceInstancehttpDatasourceInstance

    An HTTP Datasource Instance provide a default username, password and URL to an 9050674641 or 9050674641.

    Anchor
    httpExporterhttpExporter

    Export data to an 9050674641.

    Anchor
    internalVariableinternalVariable

    Pre-JSON communication. Configure import using a datasoure/datasource instance to a collector. Configure export using an exporter and a datasource.

    Anchor
    internalVariable
    internalVariable
    internal variables

    Pre-defined variables for use in PhixFlow Expressions.

    Anchor
    cVLocale
    cVLocale
    language

    The display language of the user.

    Anchor
    logFile
    logFile
    log file

    A record of a task or action completed in PhixFlow, including any messages output and details about stream sets recordsets created.

    Anchor
    logMessage
    logMessage
    log message

    Within each log list, log messages are output by the Analysis Engine as it performs analysis.

    Anchor
    macro
    macro
    macro

    A macro is a user-defined function that can be called from other 9050674641.expressions

    A macro can be called with parameters. These parameters are available within the body of the macro as $arg.

    Anchor
    modelElement
    modelElement
    model element

    The individual objects that make up an 9050674641 eanalysis modele.g. streamstables, file collectors etc. These elements are added via drag and drop controls and context menus.

    Anchor
    paging
    paging
    paging

    Where a list is displaying more data than can be viewed in the display grid, paging allows the user to scroll through the whole list, e.g. log messages, Stream Set recordset data.

    Anchor
    period
    period
    period

    A period is set on a Table. This can be either a regular period, or variable. There are four possible settings:

    • Daily: generate or collect data every day.
    • Monthly: generate or collect data every month.
    • Variable: generate or collect data since the more recent run of the stream table to the current date.
    • Transactional: allows multiple users to run independent analysis tasks at the same time.
    Anchor
    pipe
    pipe
    pipe

    A pipe is a connector that links two elements in a PhixFlow model.

    Anchor
    privilege
    privilege
    privilege

    Privileges are used to define what actions can be performed in PhixFlow; see Privileges.

    Anchor
    repository
    repository
    repository
    The PhixFlow repository lists the files, modelling objects and application components to which you have access; see Using the Repository
    Anchor
    recordset
    recordset
    recordset

    A record set is a list of records returned, usually by a pipe, where each record consists of named attributes, each with a value.

    Anchor
    refreshAction
    refreshAction
    refresh action

    Represents an action that once completed will cause the enclosing view to be refreshed.

    Anchor
    role
    role
    role

    Roles represent the type of access required to do specific tasks (e.g. Designer, Operator etc). Roles are assigned to User Groups (or vice versa); see Roles.

    Anchor
    role
    role
    rollback

    Deletes a specified set of 9050674641 from recordset from a 9050674641 table and updates the tidemarks for that 9050674641table.

    Anchor
    rollbackTask

    A Rollback Task can be configured to rollback one or more streams. Users can do this by configuring Rollback Tasks in a 9050674641.

    Anchor
    sequence
    sequence
    sequence

    A Sequence is used to generate a numeric sequence of values.

    The Sequence lets you define the properties of the sequence e.g. the starting value.

    The nextValue function returns the next value in the sequence each time it is called.

    The curValue function returns the most recent value returned by nextValue.

    Anchor
    sql
    sql
    SQL

    SQL query used to retrieve data from, or SQL or PL/SQL statement used to update data in, a 9050674641datasource.

    Anchor
    stream
    stream

    stream

    table 

    Represent a structured store of data within PhixFlow receiving data from one or more components, processing it then storing it.  Tables have different types, that PhixFlow processes differently. The types are: aggregate, calculate, calculate by set, cartesian or merge.

    Anchor
    streamActionstreamAction

    Defines a set of updates to the values of a stream item. A stream action can be applied from the stream view properties.

    Anchor
    streamActionAttributestreamActionAttribute

    Each Stream Action Attribute There is an equivalent table in the PhixFlow database schema.

    Anchor
    streamActionAttribute
    streamActionAttribute
    table-action attribute

    Each table-action attribute defines the new value to be assigned to a single field of a 9050674641 record. The new value is defined as an 9050674641expression, which can refer to the original values of the Stream Item.record

    When a Stream Action table-action is applied, each attribute's expression is evaluated in turn and the result is saved back to the Stream Itemrecord.

    Anchor
    streamAttribute
    streamAttribute
    stream attribute

    Define the type, precision and expressions of how each individual attribute is calculated based on the inputs to the Streamtable.

    Anchor
    streamFunctionFactorystreamFunctionFactory
    stream function

    Defines the basic Stream operation. The type of stream may be aggregate, calculate, calculate by set, cartesian or merge.

    Anchor
    streamItem
    streamItem
    stream item
    record

    Like an Excel spreadsheet, a PhixFlow table has attributes that represent columns and records that represent rows. 

    Anchor

    streamItemDetails

    streamView

    streamItemDetails

    streamView

    stream item details

    A Stream Item Details form can be opened from a Grid 9050674641 by opening the view, selecting a 9050674641 then selecting Show Stream Item Details from the context menu.

    Anchor
    streamTablesstreamTables

    Physical table in PhixFlow schema that stores the 9050674641 data.

    Anchor
    streamViewstreamView

    Used to customise the display of data in one or more Stream Sets.

    Anchor
    streamViewAttributestreamViewAttribute

    9050674641 used in a 9050674641. Each attribute has a role that defines how the data will be displayed.

    Anchor
    streamSetstreamSet

    A set of data items for a given period.

    Anchor
    systemConfigurationsystemConfiguration

    Where all general system wide properties are configured in PhixFlow.

    view

    Used to customise the display of data in one or more recordsets.

    Anchor
    streamViewAttribute
    streamViewAttribute
    view attribute

    Attribute used in a view. Each attribute has a role that defines how the data will be displayed.

    Anchor
    streamSet
    streamSet
    recordset

    A set of data items for a given period.

    Anchor
    systemConfiguration
    systemConfiguration
    system configuration

    Where all general system wide properties are configured in PhixFlow.

    Anchor
    task
    task
    task

    Anchor
    systemTask
    systemTask
    system task

    A System Task runs standard system-wide housekeeping activities; see System Task for details. It must be run as part of a task plan. 

    The parameters controlling how long to keep files before deleting them, and whether first to archive log messages to file, are set in System Configuration.

    Anchor
    tasktask

    A Task can be set up to carry out an action or set of actions in PhixFlow. Tasks can be one of:

    Anchor
    taskPlantaskPlan
    Anchor
    taskPlan
    taskPlan
    task plan
    rollback task

    Use a task plan to automate running an analysis model, actions or housekeeping tasks. You can also back-out data updates using a rollback task. 

    You can configure how long to keep data or log messages.

    Anchor
    user
    user
    user

    Users represent the individuals working in the organisation that will be logging onto PhixFlow and performing tasks. Users are assigned to User Groups.

    Anchor
    userGroup
    userGroup
    user group

    Users belong to User Groups that represent the area of the business they work in (e.g. Customer Service, Finance, Billing Support etc.) User Groups are assigned to Roles (or vice versa).

    Anchor
    userNotificationRule
    userNotificationRule
    user notification rule

    Specifies the 9050674641 PhixFlow user that will be notified of the completion of a task plan based on a set of rules.

    Anchor
    xmlNamespace
    xmlNamespace
    XML namespace

    When parsing an XML response, the XPath on an 9050674641 HTTP collector determines the node in the XML response that will cause an output record to be generated. In general, XML node names are relative to namespaces, and are referred to by namespace aliases. An XPath can use any XML Namespace alias defined by the 9050674641 HTTP datasource linked to the 9050674641 HTTP collector.

    Anchor
    xPath
    xPath
    XPath

    An XPath expression on an 9050674641 HTTP collector determines the node in the XML response that will cause an output record to be generated.

    An XPath is a '/'-separated list of node names.

    If any of the node names in the XPath use non-default namespaces, these may be defined in 9050674641XML namespace.