PhixFlow Help
Glossary / Index
The following is a list of all key terms within PhixFlow and links to relevant help pages.
| Term | Description |
|---|---|
Action Button | Used to group Glossary / Index#streamAction into drop-down lists or display a single Glossary / Index#streamAction as a button. In both cases Action Buttons are displayed on the top of Glossary / Index#streamView . |
Aggregate Attribute | Aggregate Attributes define the aggregated properties that are available when data is read from an aggregating Glossary / Index#pipe. |
Analysis Model | Allow users to logically represent a business process / control flow using configured PhixFlow objects, e.g. streams, file collectors etc. |
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 Glossary / Index#taskPlan. |
ArchiveTask | A task to archive Glossary / Index#streamSet from Glossary / Index#stream with archiving configured on them. |
Array | An object that contains an ordered list of other objects. |
Attribute Function | PhixFlow provides an extensive list of Attribute Functions which may be used within all expression strings. |
Audit Detail | Details of an individual audited action performed on a PhixFlow object. |
Audit Summary | A summary of all audited action performed on PhixFlow objects. Can be viewed in the System Console. |
Audited Item | PhixFlow objects that have auditing switched on to allow for any changes in the system to be tracked. |
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 Stream. |
PhixFlow Database | The database that stores the PhixFlow schema and all processed data |
Chart | A Chart displays data in table form, or in one of a number of graphs styles. |
Comparator | Refers to the comparator types that can be used in a filter, e.g. greater than, starts with. |
Collector | A generic term for a Glossary / Index#fileCollector, a Glossary / Index#databaseCollector, or an Glossary / Index#httpCollector. |
Context Menu | A context menu appears above each Glossary / Index#modelElement when the user hovers over it in a model view. This menu shows all of the actions that can be performed on that element. |
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. |
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 sets, 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 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 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 set. In this way, whenever a file fails to process the user can simply rollback the stream sets associated with that file rather than rolling back all of the stream sets 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 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 (or a chain of stream sets if there are several streams in the model) and will flag the file processed, the stream sets generated and any associated output files with the cycle number 1. When the last stream in the model has finished producing its stream set 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 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 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. |
Dashboard | A dashboard 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. |
Data Grid | A Data Grid is a particular type of view which displays the data in a table format. |
Database Collector | Used to gather information from a external database, defined as a PhixFlow Datasource. It holds the SQL that will be sent to the datasource to retrieve data. |
Database Driver | The driver used to access the source database. |
Database Exporter | Used to write information from PhixFlow to external databases. |
Datasource | Defines a connection to an external database. |
Datasource Instance | Allows for multiple connections for individual database instances to be configured for a specific Glossary / Index#datasource. |
Directed Pipe | A Directed Pipe is used as a secondary input to a Merge Stream. 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. |
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. |
File Collector | Describes the structure, content, naming patterns and location of files of data to be imported into PhixFlow. |
File Collector Attribute | The data columns that a File Collector expects to be present when importing a file. |
File Exporter | Used to write information from PhixFlow to external files. |
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. |
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). |
FTP Site | A file system that is reachable via the FTP protocol. |
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. |
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. |
HTTP Collector | Collect data from an Glossary / Index#httpDatasource. |
HTTP Datasource | A 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 Glossary / Index#httpCollector , and exported to an HTTP Datasource using a Glossary / Index#httpExporter. An HTTP Datasource Instance must define at least one Glossary / Index#httpDatasourceInstance. An HTTP Datasource Instance may define multiple Glossary / Index#xmlNamespace to support Glossary / Index#xPath expressions on Glossary / Index#httpCollector . |
HTTP Datasource Instance | An HTTP Datasource Instance provide a default username, password and URL to an Glossary / Index#httpCollector or Glossary / Index#httpExporter. |
HTTP Exporter | Export data to an Glossary / Index#httpDatasource. |
Internal variables | Pre-defined variables for use in PhixFlow Expressions. |
Language | The display language of the user. |
Log File | A record of a task or action completed in PhixFlow, including any messages output and details about stream sets created. |
Log Message | Within each log list, log messages are output by the Analysis Engine as it performs analysis. |
Macro | A macro is a user-defined function that can be called from other Glossary / Index#expression. A macro can be called with parameters. These parameters are available within the body of the macro as $arg. |
Model Element | The individual objects that make up an Glossary / Index#analysisModel e.g. streams, file collectors etc. These elements are added via drag and drop controls and context menus. |
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 data. |
Period | A period is set on a Stream. This can be either a regular period, or variable. There are four possible settings:
|
Pipe | A pipe is a connector that links two elements in a PhixFlow model. |
Privilege | Privileges are used to define what actions can be performed in PhixFlow; see Privileges. |
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. |
Refresh Action | Represents an action that once completed will cause the enclosing view to be refreshed. |
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. |
Rollback | Deletes a specified set of Glossary / Index#streamSet from a Glossary / Index#stream and updates the tidemarks for that Glossary / Index#stream. |
| Rollback Task | A Rollback Task can be configured to rollback one or more streams. Users can do this by configuring Rollback Tasks in a Glossary / Index#taskPlan. |
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. |
SQL | SQL query used to retrieve data from, or SQL or PL/SQL statement used to update data in, a Glossary / Index#datasource. |
Stream | Represent a structured store of data within PhixFlow receiving data from one or more components, processing it then storing it. |
Stream Action | Defines a set of updates to the values of a Glossary / Index#streamItem. A Stream Action can be applied from a Stream View from a Glossary / Index#streamItem form. |
Stream Action Attribute | Each Stream Action Attribute defines the new value to be assigned to a single field of a Glossary / Index#streamItem. The new value is defined as an Glossary / Index#expression, which can refer to the original values of the Stream Item. When a Stream Action is applied, each attribute's expression is evaluated in turn and the result is saved back to the Stream Item. |
Stream Attribute | Define the type, precision and expressions of how each individual attribute is calculated based on the inputs to the Stream. |
Stream Function | Defines the basic Stream operation. The type of stream may be aggregate, calculate, calculate by set, cartesian or merge. |
Stream Item | Individual record in a Glossary / Index#streamSet. |
Stream Item Details | A Stream Item Details form can be opened from a Grid Glossary / Index#streamView by opening the view, selecting a Glossary / Index#streamItem then selecting Show Stream Item Details from the context menu. |
Stream Tables | Physical table in PhixFlow schema that stores the Glossary / Index#stream data. |
Stream View | Used to customise the display of data in one or more Stream Sets. |
Stream View Attribute | Glossary / Index#streamAttribute used in a Glossary / Index#streamView. Each attribute has a role that defines how the data will be displayed. |
Stream Set | A set of data items for a given period. |
System Configuration | Where all general system wide properties are configured in PhixFlow. |
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. |
Task | A Task can be set up to carry out an action or set of actions in PhixFlow. Tasks can be one of: |
Task Plan | Contains a set of Glossary / Index#task to run. |
User | Users represent the individuals working in the organisation that will be logging onto PhixFlow and performing tasks. Users are assigned to User Groups. |
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). |
User Notification Rule | Specifies the Glossary / Index#user that will be notified of the completion of a task plan based on a set of rules. |
XML Namespace | When parsing an XML response, the XPath on an Glossary / Index#httpCollector 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 Glossary / Index#httpDatasource linked to the Glossary / Index#httpCollector . |
XPath | An XPath expression on an Glossary / Index#httpCollector 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 Glossary / Index#xmlNamespace |
Please let us know if we could improve this page feedback@phixflow.com