Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Insert excerpt
_Banners
_Banners
nameproperties
nopaneltrue

Anchor
pageStart
pageStart

The following notes provide useful information on general interaction features of the client application that are used in many of the PhixFlow screens.

Double clicking

Double clicking items on a list (and elsewhere) generally opens the object definition form however for Stream Views, Dashboards, and Analysis Models PhixFlow will open the object representation e.g. the Chart implied by the Stream View. To open definition forms for these objects you need to use the "Edit" option on the context menu.

Selecting Items

Clicking an item "selects" it (the item will be highlighted) and any previously selected items will be deselected. To select multiple items, press the Control key at the same time as you click the item. This will add the new item to the list of selected items. Note that if the item clicked is already selected, it will be removed from the selection list. If you want to select a continuous list of items, select the first item on the list and then select the last item while holding down the Shift key.

Note that there are several places in PhixFlow where operations can be carried out on multiple selected items, for example object deletion.

Drag and Drop

The user can drag and drop the majority of object items within PhixFlow. The outcome of each drag/drop operation is dependent upon the context and is explained on help for each form however here are a few general tips:

  • Objects can only be dragged/dropped between compatible forms i.e. only if it makes sense for the object to be dropped onto the target location.
  • Many forms support drag/drop for multiple selected items.
  • Items can be reordered by dragging and dropping on ordered lists i.e. lists where the order of the items is important e.g. the list of Stream Attributes for a Stream. Note that the list should be ordered in the (default) ordered state.
  • On Analysis Model panes, single or multiple objects can be dragged off the modelling pane and onto another object by selecting the objects you want to drag and then holding down the Shift key and dragging the item(s). If the Shift key is not held down, the selected objects are just moved on the modelling pane.
  • Stream Views can be dragged onto Dashboards to create your own layout.

Multiple object windows - undocking and  re-docking

These concepts are explained in a little more detail below, but to start watch this short video:

View file
nameundock and dock windows.wmv
height250

Undocking - creating floating windows

It is often useful to create a stand-alone window, outside of the main repository browser. To do this, simply select the tab of the object you want to pull out, and drag it to somewhere on the PhixFlow background. A new floating window will appear.

Re-docking windows

If you open a new repository browser for an object, but want to re-dock it in the main repository browser area:

  • hold the shift key down
  • drag the banner of the window over the banner of the main repository browser

The window will now re-dock.

Deleting Items

PhixFlow will always ask for confirmation that you really do want to delete an item or selected list of items before actually deleting it. Note that you will not be able to delete an item that is referenced by other objects within PhixFlow (an message box will appear indicating the number and types of referencing items).

...

This page is for PhixFlow data modellers and application developers. It describes the different menu and toolbar options available in the PhixFlow interface.

Image Added


Panel
borderColor#7da054
titleColorwhite
titleBGColor#7da054
borderStylesolid
titleSections on this page

Table of Contents
maxLevel3
indent12px
stylenone


Filter by label (Content by label)
showLabelsfalse
showSpacefalse
sorttitle
titleMore PhixFlow Menus
cqllabel = "menu" and space = currentSpace ( ) and type = "page"

Filter by label (Content by label)
showLabelsfalse
showSpacefalse
sorttitle
titleMore PhixFlow Toolbars
cqllabel = "toolbar" and space = currentSpace ( ) and type = "page"


There are several places where you can switch how PhixFlow displays list items. 

  • Insert excerpt
    _show_list
    _show_list
    nopaneltrue
  • Insert excerpt
    _show_card
    _show_card
    nopaneltrue

You can also set your preference for the application menu in User Details.

Most PhixFlow objects have an optional description field. PhixFlow will display this description as you hover over the object in a list or on a model. We recommend that you provide descriptions for all your objects to help document your work for both yourself and colleagues.

The Header bar is the grey bar at the top of the PhixFlow window.

Option

Description

Left Side

Running Actions: n

Information about the number of actions that are currently running.

Dismiss Notifications

Only available when there are open notifications. Close any green or blue notification messages that are open.

Show/Hide Windows Bar

Toggle between showing or hiding the windows bar. This bar displays icons for all the items, such as models, views and screens, that are open in the workspace.

Right Side

Insert excerpt
_user_options
_user_options
nopaneltrue

Open user options menu, which includes access to the User Details window.

Insert excerpt
_logout
_logout
nopaneltrue

Logout of PhixFlow. Returns PhixFlow to the startup screen so that you must log back in to resume work.

Insert excerpt
_console
_console
nopaneltrue

Show the System Console. This displays currently running tasks and log messages from PhixFlow processes.

Insert excerpt
_download_area
_download_area
nopaneltrue

Show the download area. This displays files created by an export process that are ready to download; see Using the Download Area.

Insert excerpt
_palette
_palette
nopaneltrue

Open the Changing or Creating a Palette tab on the right. You can drag preconfigured layout components from the palette into screens.

Insert excerpt
_repository
_repository
nopaneltrue

Open Using the Repository. This shows all of the available items in your PhixFlow instance.

Insert excerpt
_administration
_administration
nopaneltrue

Select options related to importing or exporting applications, packages or table data. Also contact PhixFlow for support. See Administration menu, below.

Insert excerpt
_app_mode
_app_mode
nopaneltrue

Insert excerpt
_design_mode
_design_mode
nopaneltrue

The icon indicates the view or mode you are currently using.

In 

Insert excerpt
_design_mode
_design_mode
nopaneltrue
 you can create data analysis models and design applications. In
Insert excerpt
_app_mode
_app_mode
nopaneltrue
 you can run your application. Click the icon to switch between the views.

Insert excerpt
_help
_help
nopaneltrue
Open the PhixFlow Help Overview page in a browser window.



Right-click any object to open its popup menu. One key popup option is Permanently Delete which is always the last item on the list (to help ensure it is not pressed accidentally)! 

Note that all objects that appear on Analysis Models have a

...

popup option Show Models

...

which will display a list of all the models that contain that object.

Forms

Forms within windows all have the usual minimise, maximise, restore and close icons. Note that you can find a link to all forms (including minimised forms) on the Form Bar which appears when the mouse is near the bottom edge of the screen.

Double clicking the form header region is a fast way to toggle between maximised and restored states.

...

Image Removed

...

Save any changes and close the form. Note that an error message will pop up if there are any problems and the form will remain open with each problem field flagged with Image Removed. Note that if you hover over this icon, the error message relating to that field will appear.

...

Image Removed

...

Save any changes but keep the form open. Again any errors will be reported.

...

Image Removed

...

Shows a full Audit trail for all changes to this object i.e. who changed it, when and what they changed.

...

Image Removed

...

Print the form details. On the majority of forms this will launch a browser window with the object formatted for printing.

...

Image Removed

...

Back - go back to the previous object

...

Image Removed

...

Image Removed

...

Image Removed

...

Open the help page for the form.

Note that the Audit trail is a useful way of reversing changes made by mistake as each audit entry shows both the new and old values. In the case of text fields, simply copy the old value and paste it into the form field.

Object Lists

Many forms include lists of objects that are associated with the object edited by that form. E.g. the list of stream attributes belonging to a stream.

Object lists have the following buttons:

...

Image Removed

...

Refresh the object list.

...

Image Removed

...

Add a child object to the object being edited. E.g. add a stream attribute to a stream.

...

Image Removed

...

Drop down list

...

...

There are two types of grid display. The first are simply lists of the configuration objects but showing more details than the repository

...

. The second type of grid shows a data

...

record.

...

The operations on configuration object grids are all very similar (e.g. add, delete, refresh etc.) however data grids will have additional operations which are all described on the help page for that object.

The following general features of grids are worth noting:

The items on grids are paged which means that PhixFlow fetches a batch of data at a time to populate the grid. The grid footer bar indicates which items are being shown, how many items there are in total and the page size. The user can page forwards and backwards using Image Modified and Image Modified. Note that the user can also change the page size (the number of rows brought back from the PhixFlow Database). Please note that with very large datasets it will be more efficient to filter the the data rather than page through it!

Columns can be ordered by clicking the column header. Each click reverses the order direction. Please note that only the items currently paged in the display are ordered.

...

The following functional icons are common to many grids:

...

Anchor
gridIcons
gridIcons

Insert excerpt
_filter
_filter
namefilter
nopaneltrue

Select an existing (or predefined) Filter or create, delete and modify Filters. This causes the grid to refresh and display only those entries which match the selected Filter.

...

Insert excerpt
_sort_order
_sort_order
nopaneltrue

Select an existing (or predefined) multi-column Sort Order or create, delete and modify Sort Orders. Note that data is ordered across all records which are implied by the Filter, not just the current page of data.

...

Image Removed

...

Pressing this icon toggles the display of additional icons for the form.

...

Insert excerpt
_excel_export
_excel_export
nopaneltrue

Export the data being shown to an Excel spreadsheet

...

or CSV file.

Note

For views, this option opens the Download CSV or Excel Data window. If the data is filtered, all data selected by the filter will be exported, not just the current paged result.

When viewing data in a Chart, an Excel template can be configured on the

...

View that is used to specify the

...

properties for the Chart.

...

Insert excerpt
_delete
_delete
nopaneltrue

Delete the currently selected items. A form will appear to confirm that you wish to proceed.

...

Insert excerpt
_refresh
_refresh
nopaneltrue

Refresh the contents of the current grid.

...

Insert excerpt
_help
_help
nopaneltrue

Open the help page for the grid.

...

Tooltip Descriptions

...

Insert excerpt
_paging_show
_paging_show
nopaneltrue

Show or hide the paging bar

When you drag attributes onto a layout, such as a screen or form, PhixFlow prompts how to display the data.

Icon

Type

Description

Image Added

Grid

Display the data laid out in a table.

Image Added

Line Chart

Plot a line or lines to represent quantities against a horizontal axis of categories. 

Image Added

Barcharts

Plot a quantity as a set of bars aligned vertically against a set of categories along the horizontal axis.

Image Added

Plot a quantity as a set of bars aligned horizontally against a set of categories along the vertical axis.

Image Added

Pie Chart

Plot a quantity as a pie chart, grouped by a category.

Image Added

Form

Layout the attributes as a form.