Versions Compared

Version Old Version 40 New Version Current
Changes made by

Fiona Sargeant

Zoe Baldwin

Saved on

Key

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

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

Image RemovedImage Added


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

Table of Contents
maxLevel3
indent12px
stylenone

Task


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

task

Header bar is the grey bar at the

bottom

top of the PhixFlow

Window

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,

stream

views and

dashboardsOpen

screens, that are open in the workspace.

Right Side

Insert excerpt
_user_options
_user_options
nopaneltrue

 Details

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

dashboards

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

stream

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

.Administration Menu AnchorAdminMenuAdminMenuThe  Insert excerpt_administration_administrationnopaneltrue menu is on the right of the grey task bar at the bottom of the PhixFlow window.
Tip

The options that are available in the Administration menu depend upon your privileges. Administrators configure privileges in roles; see Managing User Groups and Privileges.

The menu has the following options:

Option

Description

Online Support

Opens a browser window into PhixFlow's online support desk. Your designated support contacts will have login details.

Send Feedback Email

Opens a new email window.

About PhixFlow

Shows general information about PhixFlow, in particular the current version that you are using

.

Insert excerpt
_help
_
helpnopaneltrueOpens this online
help
system. Insert excerpt_admin_import_admin_importnopaneltrue

Import applications or packages previously exported from another PhixFlow instance.  Import Configuration

Insert excerpt_admin_import_stream_admin_import_streamnopaneltrue

Import stream data previously exported from another PhixFlow instance.

Insert excerpt_admin_export_admin_exportnopaneltrue

Export everything. Export Pane

excerpt-include_admin_export_open
_admin_export_open
nopaneltrue
Open
a window where you can select the applications or packages that you want to export. Insert excerpt_admin_stream_open_admin_stream_opennopaneltrue

Open a  window where you can select the stream data that you want to export.

Move to property page and make sure the links are there

Property Tab Toolbar AnchorformIconsformIcons

When you open the property tab for a model or one of its modelling objects, the tab has a toolbar at the top. 

Insert excerpt_finish_finishnopaneltrue

Save the current properties and close the tab.

Insert excerpt_save_savenopaneltrue

Save the current properties and keep the tab open.

Insert excerpt_back_backnopaneltrue

Toggle between the current property tab and one that was previously open.

Insert excerpt_forward_forwardnopaneltrue Insert excerpt_repository_repositorynopaneltrue

Find in Explorer. This icon will bring the repository browser tab to the front and will close all nodes except those leading to this object.  You may need to scroll the explorer to see the selected object.

Insert excerpt_help_helpnopaneltrue

Context sensitive help.

Insert excerpt_toolbar_squashed_toolbar_squashednopaneltrue

If there is insufficient space on the header bar then some buttons are moved into this drop-down menu. The following options are always on the drop-down menu:

Insert excerpt_delete_deletenopaneltrue Delete the current object. Delete is:

permanent as there is no "undo" option

everywhere, so if the object is used by other models, it is also deleted there.

Insert excerpt_close_closenopaneltrue Close the current property tab. You can also use the X on the tab itself. Image Removed

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.

Each property tab can contain a number of sections.  Each section has a header represented by a green bar with a small arrow before the section label which can be clicked to collapse and open the section. 

Image Removed

Some sections contain fields whereas other sections can contain grids.  Sections which contain grids may have a number of icons on them to allow you to add and delete records, see a more detailed grid with more columns or refresh the current grid.

Insert excerpt_add_addnopaneltrue

Create and insert a new item into the list.

Insert excerpt_detailed_list_detailed_listnopaneltrue

Open up a grid showing more details about each item.

Insert excerpt_delete_deletenopaneltrue

Delete the selected item or items.

Insert excerpt_refresh_refreshnopaneltrue

Refresh the list (e.g. if the list has been updated on another computer by another user).

Insert excerpt_add_addnopaneltrue

Create and insert a new item into the list.

Context
the PhixFlow Help Overview page in a browser window.


All objects have context menus associated with them which are accessed by right-clicking the mouse button. One key context menu item

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

context menu entry "

popup option Show Models

"

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

Grid

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

explorer

. The second type of grid shows a data

e

record.

g. Stream Items.

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

Image Removed

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.

Image Removed

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

Insert excerpt
_excel_export
_excel_export
nopaneltrue

Export the data being shown to an Excel spreadsheet

. However, please note that when viewing Stream Data, pressing this button causes an option form to open which amongst other things allows you to choose to export the data to Excel, CSV or HTML. Note also that this will export all data implied by the Filter

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

Stream

View that is used to specify the properties for the Chart.

Image Removed

Insert excerpt
_delete
_delete
nopaneltrue

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

Image Removed

Insert excerpt
_refresh
_refresh
nopaneltrue

Refresh the contents of the current grid.

Image Removed

Insert excerpt
_help
_help
nopaneltrue

Open the help page for the grid.

Image Removed

Insert excerpt
_paging_show
_paging_show
nopaneltrue

Show or hide the paging bar

Stream Views Pop-Up

When you drag

stream

attributes onto a layout, such as a

dashboard

screen or form, PhixFlow prompts how to display the data.

Icon

Type

Description

Image Modified

Grid

Display the data laid out in a table.

Image Modified

Line Chart

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

Image Modified

Barcharts

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

Image Modified

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

Image Modified

Pie Chart

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

Image Modified

Form

Layout the

stream

attributes as a form

Most PhixFlow objects have an optional description field

.

PhixFlow will display this description as you hover over the item whether the item is on a list or on a model pane. We highly recommend that you provide descriptions for all your objects to help document your work for both yourself and colleagues.

Repository Context Menu

Dashboard Context Menu