This page is for data modellers who are new to using PhixFlow. It provides an introduction to using the modelling window.
Opening a Modelling Window
PhixFlow opens a modelling window when you:
- add a new model.
In the repository right-click on Analysis Models and select
Add. - display an existing model.
In the repository, double-click on an analysis model's name to open its properties.
In the properties toolbar, click the
Models button to display its modelling window in the workspace.
The modelling window shows a picture of either all or part of an analysis model.
Modelling Objects
You can drag any object from the menu bar of a model view onto the modelling pane. This will create a new object of this type. See the list of object types under Using the Model Window#modelViewFormIcons.
Models are made up of modelling objects. They can include:
- data connectors, to load or export data
- the data is processed in streams
- objects are connected by pipes.
When you make changes to a model, remember to save your changes by clicking the 
Save button in the modelling window toolbar.
Model
| Field | Description |
|---|---|
| Name | Name of the model view. |
| Description | Optional: Description of the model view. |
Add new objects
You can drag any object from the menu bar of a model view onto the modelling pane. This will create a new object of this type. See the list of object types under Using the Model Window#modelViewFormIcons.
Drag on existing objects
You can drag objects that have already been created onto a model=. For example, if you want to include a stream, open the list of streams in the repository, select the stream and drag it onto the model. Similarly, objects can be added from the list of datasources, file collectors, database collectors, file exporters, database exporters and FTP sites.
When you drag an object onto an model view in this way, if this it linked (via one or more pipes) to other objects on the view, PhixFlow will draw in the links.
If an object dragged onto a model view is not from the same application as the analysis model a small application icon will be visible on the top left of the object's icon.
Modelling Window Toolbar Icons
 | The default mode for the cursor in the modelling window is select. Pressing this button sets the mode to drag. Alternatively, while in select mode, keep the Ctrl key pressed on your keyboard, and with the left mouse button pressed move the pointer. |
 | If you are in drag mode, pressing this button puts you back into select mode (the default mode when you open a new modelling window). While in select mode, keeping the left mouse button pressed and dragging over an area of the window, you can select several items in the model. Press the Alt key on your keyboard to include Pipes in the selection. |
 | Organise selected objects in a grid. |
 | Align all selected objects left. |
 | Align all selected objects right. |
 | Align all selected objects to top. |
 | Align all selected objects to bottom. |
 | Distribute all selected objects horizontally. |
 | Distribute all selected objects vertically. |
| Object Types | |
| Add a new Datasource to the Analysis Model. |
 | Add a new FTP Site to the Analysis Model. |
| Add a new HTTP Datasource to the Analysis Model. |
| Add a new Database Collector to the Analysis Model. |
 | Add a new File Collector to the Analysis Model. |
| Add a new HTTP Collector to the Analysis Model. |
 | Add a new Database Exporter to the Analysis Model. |
 | Add a new File Exporter to the Analysis Model. |
| Add a new HTTP Exporter to the Analysis Model. |
 | Add a new Stream with function Aggregate to the Analysis Model. |
 | Add a new Stream with function Calculate to the Analysis Model. |
 | Add a new Stream with function Calculate By Set to the Analysis Model. |
 | Add a new Stream with function Cartesian to the Analysis Model. |
 | Add a new Stream with function Merge to the Analysis Model. |
| Show model details |
Modelling Object Pop-Up Toolbar
In the model, hover your mouse pointer over any object to display a pop-up toolbar. The pop-up toolbar some of the same buttons that appear in the menu bar, described above. It also provides the following buttons:
| Make this object static. |
| Disable/ enable this object. |
 | Bring up a list of attributes for the object. Attributes can be selected from this list and dragged into an attribute list window for another object, so this is useful when building new objects in the model. |
 | Show the list of views configured on this object. |
 | Show the list of Stream Sets for this object. This brings up the Stream Set viewer. |
 | Bring into the model all objects in the model that are inputs to this object. |
 | Bring into the model all objects in the model that are outputs of this object. |
| Run the Analysis Engine on this object. All objects required to build the object selected will be run, but only these objects; so this may run analysis on objects that are not in the model, and analysis may not be run on some of the objects that are in the model. |
| Erase this object from the model. This object still exists in the repository, and it's data is available to any other object that refers to it. |
Modelling Object Context Menu
Right-click on a modelling object to display its context menu. This includes many of the same options as in the menu bar or the hover menu. A few addition options are also available:
- Copy Object: Create a copy of the object
- Export Object: Export a copy of the object
- Show All Predecessors: bring all objects that are used to build this object in the underlying model into the model.
- Show All Successors: bring all objects that use this object in the underlying model into the model.
- Rollback Stream: rollback data in the Stream. This brings up the Rollback form.
- Permanently Delete: permanently delete the object from the underlying model in PhixFlow. This removes the object from PhixFlow completely - only do this if you are certain that you never want to use this object again.
Modelling Window Context Menu
Right-click anywhere on the modelling window to display the context menu:
- Rollback Selected Objects: Rollback the data in the currently selected Streams
- Copy Selected Objects: Create copies of the currently selected objects
- Delete Selected Objects: Delete selected objects
- Enable Selected Objects: Enable selected objects
- Disable Selected Objects: Disable selected objects
- Switch The Static Flag On In The Selected Objects: Switch the 'static' flag on in the currently selected Streams and Pipes
- Switch The Static Flag Off In The Selected Objects: Switch the 'static' flag off in the currently selected Streams and Pipes
Moving Model Pane
If some objects are not visible on the Model Pane (i.e. are positioned outside the currently displayed area), arrows will be displayed. Arrows indicate that there are objects outside the display area and allow the user to quickly move the Model Pane and display those objects.
Keyboard support
If you are in select mode, there are keyboard commands available:
- Ctrl: Switch to drag mode (move the pointer with the left mouse button pressed) / Select multiple items (click left mouse button on items).
- Alt: Include pipes in selection.