Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • Add a new model: right click on Analysis Models in the repository browser and select Add Analysis Model
  • Open details for an existing model: double click on the model view in the repository browser

HELPTRUNKTODOHELPDEVTODO: open these details in the repository browser from an open model view

...

The model view pane can be opened by right-clicking on an existing model in the repository browser and selecting Display.

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 Form Icons.

Drag on existing objects

You can drag objects that have already been created onto a model view pane. For example, if you want to include a stream, open the list of streams in the repository browser, select the stream and drag it onto the pane. Similarly, objects can be added from the list of datasources, file collectors, database collectors, alarm generators, 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.

Anchor
modelViewFormIcons
modelViewFormIcons

Form Icons

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

Database Exporter Stream with function Calculate

The default mode for the cursor in the model pane 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 Analysis Model View pane). While in select mode, keeping the left mouse button pressed and dragging over an area of the pane, 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.

Image Modified

Add a new HTTP Datasource to the Analysis Model.
Image Added

Add a new Database Collector to the Analysis Model.

Add a new File Collector to the Analysis Model.

Image Modified

Add a new HTTP Collector to the Analysis Model.
Image Modified

Add a new File Database Exporter to the Analysis Model.

Image Modified

Add a new Stream with function Aggregate File Exporter to the Analysis Model.

Image Modified

Add a new HTTP Exporter to the Analysis Model.
Image Modified

Add a new Stream with function Calculate By Set Aggregate to the Analysis Model.

Image Modified

Add a new Stream with function Cartesian Calculate to the Analysis Model.

Image Modified

Add a new Stream with function Merge Calculate By Set to the Analysis Model.

Image Modified

Add a new Alarm Generator Stream with function Cartesian to the Analysis Model.

Image Modified

Add a new Pipe Stream with function Merge to the Analysis Model.

By pressing this you get a slider which allows you to zoom out from the Analysis Model View pane. This is useful if you have a complex model and want to get a high-level overview.

Open the Analysis Model View details. HELPDEVTODO - have we still got this button?

Make a copy of the model and all its contents

Export a copy of the model and all of its contents to an XML file so that it can be imported into another system (or saved as a backup)

...

In the Analysis Model View pane a hover menu is also available for any object. To get this menu, move your pointer over the object and the hover menu will appear. The hover menu provides a number of the same buttons that appear in the menu bar, described above. It also provides the following buttons:

Image Removed

Image Added

Make this object static.

Image Added/ Image Modified

Disable/ enable this object.
Image Added

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.

Image Modified

Show the list of views configured on this object.

Image Modified

Show the list of Stream Sets for this object. This brings up the Stream Set viewer.

Image Modified

Show the list of Alarms that relate to this object. This brings up the Alarm viewer.

Bring into the pane all objects in the model that are inputs to this object.

Image Modified

Bring into the pane all objects in the model that are outputs of this object.

Image Modified

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 pane, and Analysis may not be run on some of the objects that are in the pane.

Image Modified

Remove this object from the Analysis Model View pane. This does not delete the object from the underlying model in PhixFlow.

Object Context Menu

...

Right click menu

The right click menu on any object in the Analysis Model View pane a context menu will appear. Many of the options available are the same as those available from objects in a model view contains many of the same options as in the menu bar or a the hover menu, as described above. A few addition options are also available:

  • Show Models: show a list of all the models that contain this object
  • 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 pane.
  • Show All Successors: bring all objects that use this object in the underlying model into the pane.Rollback Stream/Alarms: rollback data in the Stream or Alarms generated by the Alarm Generator. 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.

Model Pane Context Menu

If you right click anywhere on the modelling pane a context menu will appear.

  • Rollback Selected Objects: Rollback the data in the currently selected Streams and Alarm Generators.
  • Copy Selected Objects: Create copies of the currently selected objects.
  • Export Selected Objects: Export 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.
  • Merge Selected Streams: Create new Merge Stream in order to merge selected Streams and configure it.

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.

See Also

Forms: Analysis Model View

An Analysis Model View shows a picture of an Analysis Model, or part of an Analysis Model.

Analysis Model Views can include Datasources, Database Collector, File Collector, Streams, Alarm Generators, Database Exporters, File Exporters and FTP Sites.

Models can be saved, or built on request.

Note that all objects that appear on Analysis Models have a context menu entry "Show Models" which will display a list of all the models that contain that object.

Form: Analysis Model Details

...

  • .

...

...

Form Icons

The form provides the standard form icons.

Form: Analysis Model View Pane

Models on request

Analysis Model Views can be created on request from any of the elements that can be shown in a model pane. For example, if you want to create an Analysis model view for a Stream, open the list of Streams, select the Stream, right click and select Show Model Predecessors. A new Analysis Model View pane will be generated with the Stream selected, and all its predecessors - that is, the Collectors, Streams, Alarm Generators and Exporters that must be run to generate this stream.

Drag on existing objects

You can drag objects that have already been created onto an Analysis Model View pane. For example, if you want to include a Stream, open the list of Streams, select the Stream and drag it onto the pane. Similarly, objects can be added from the list of Datasources, File Collectors, Database Collectors, Alarm Generators, File Exporters, Database Exporters and FTP Sites.

When you drag an object onto an Analysis 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.

Form Icons

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

Image Removed

The default mode for the cursor in the model pane 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.

Image Removed

If you are in drag mode, pressing this button puts you back into select mode (the default mode when you open a new Analysis Model View pane). While in select mode, keeping the left mouse button pressed and dragging over an area of the pane, you can select several items in the model. Press the Alt key on your keyboard to include Pipes in the selection.

Image Removed

Organise selected objects in a grid.

Image Removed

Align all selected objects left.

Image Removed

Align all selected objects right.

Image Removed

Align all selected objects to top.

Image Removed

Align all selected objects to bottom.

Image Removed

Distribute all selected objects horizontally.

Image Removed

Distribute all selected objects vertically.

Image Removed

Add a new Datasource to the Analysis Model.

Image Removed

Add a new FTP Site to the Analysis Model.

Image Removed

Add a new Database Collector to the Analysis Model.

Image Removed

Add a new File Collector to the Analysis Model.

Image Removed

Add a new Database Exporter to the Analysis Model.

Image Removed

Add a new File Exporter to the Analysis Model.

Image Removed

Add a new Stream with function Aggregate to the Analysis Model.

Image Removed

Add a new Stream with function Calculate to the Analysis Model.

Image Removed

Add a new Stream with function Calculate By Set to the Analysis Model.

Image Removed

Add a new Stream with function Cartesian to the Analysis Model.

Image Removed

Add a new Stream with function Merge to the Analysis Model.

Image Removed

Add a new Alarm Generator to the Analysis Model.

Image Removed

Add a new Pipe to the Analysis Model.

Image Removed

By pressing this you get a slider which allows you to zoom out from the Analysis Model View pane. This is useful if you have a complex model and want to get a high-level overview.

Image Removed

Open the Analysis Model View details.

Image Removed

Make a copy of the model and all its contents

Image Removed

Export a copy of the model and all of its contents to an XML file so that it can be imported into another system (or saved as a backup)

Hover Menu

In the Analysis Model View pane a hover menu is also available for any object. To get this menu, move your pointer over the object and the hover menu will appear. The hover menu provides a number of the same buttons that appear in the menu bar, described above. It also provides the following buttons:

Image Removed

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.

Image Removed

Show the list of views configured on this object.

Image Removed

Show the list of Stream Sets for this object. This brings up the Stream Set viewer.

Image Removed

Show the list of Alarms that relate to this object. This brings up the Alarm viewer.

Image Removed

Bring into the pane all objects in the model that are inputs to this object.

Image Removed

Bring into the pane all objects in the model that are outputs of this object.

Image Removed

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 pane, and Analysis may not be run on some of the objects that are in the pane.

Image Removed

Remove this object from the Analysis Model View pane. This does not delete the object from the underlying model in PhixFlow.

Object Context Menu

If you right click on any object in the Analysis Model View pane a context menu will appear. Many of the options available are the same as those available from the menu bar or a hover menu, as described above. A few addition options are also available:

  • Show Models: show a list of all the models that contain this object
  • 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 pane.
  • Show All Successors: bring all objects that use this object in the underlying model into the pane.
  • Rollback Stream/Alarms: rollback data in the Stream or Alarms generated by the Alarm Generator. This brings up the rollback 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.

Model Pane Context Menu

If you right click anywhere on the modelling pane a context menu will appear.

  • Rollback Selected Objects: Rollback the data in the currently selected Streams and Alarm Generators.
  • Copy Selected Objects: Create copies of the currently selected objects.
  • Export Selected Objects: Export 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.
  • Merge Selected Streams: Create new Merge Stream in order to merge selected Streams and configure it.

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.

See Also