Versions Compared

Version Old Version 28 New Version Current
Changes made by

Fiona Sargeant (Unlicensed)

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.

AnchorpageStartpageStart

Image Removed

Image Added


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

Table of Contents
maxLevel3
indent12px
stylenone

Repository Context Menu

In the repository browser, you can right-click on an item to display its context menu.

Categories/Collections

"items"

modelling objects

layout components

OptionDescription Insert excerpt_add_addnopaneltrueCreates a new item of the selected type. Insert excerpt_list_show_list_shownopaneltrueOpens a new window listing all the items with the selected. The window includes information about the key properties for each item.Display
icon depends on item typeA model, dashboard, layout or area opens in the workspace. 
A palette opens in a pop-up. Insert excerpt_model_show_model_shownopaneltrueOpens a new window listing all the models that contain the item.EnableThe icon depends on the item


Insert excerpt_template_copy_template_copynopaneltruefor layout components you can copy an existing component and save it as a layout template. Insert excerpt_edit_editnopaneltrue

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_
where_used
  • list
    _show_
where_used
  • list
    nopaneltrue
Insert excerpt_delete_deletenopaneltrue- deletes the item from the repository and from all the items that contain it. Check where the item is used first using
  • Insert excerpt
    _show_
where_used
  • card
    _show_
where_used
  • card
    nopaneltrue
Insert excerpt_remove_removenopaneltrue  from container  

Set Audit Required

options for privileges, to set whether or not PhixFlow records these actions in the audit logSet Audit Not Required Insert excerpt_stream_sets_show_stream_sets_shownopaneltrue Insert excerpt_stream_view_chart_stream_view_chartnopaneltrue: opens a new window  listing the steam data. Insert excerpt_run_analysis_run_analysisnopaneltrue

User Menu

On the top right of the PhixFlow screen is the  Insert excerpt_user_usernopaneltrue menu, which has the following options:OptionDescription Insert excerpt_user_details_user_detailsnopaneltrue

Opens a User Details Form allowing the user to change their own account settings (including their password).

Online SupportOpens a browser window into PhixFlow's online support desk. Your designated support contacts will have login details.Send Feedback EmailOpens a new email window.About PhixFlowShows general information about PhixFlow, in particular the current version that you are using. Insert excerpt_help_helpnopaneltrueOpens this online help system

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

Returns

Logout of PhixFlow. Returns PhixFlow to the startup screen so that

the user

you must log back in to resume work

.Status Bar AnchorTaskBarTaskBarThe status bar is at the bottom of the PhixFlow window. On the left the number of currently running actions is shown. There is also the button to show/hide the windows bar. If there are any notifications on screen, they can all be dismissed in one go by clicking 'Dismiss notifications'

.

This will dismiss the green notification pop ups but not red error/failure messages.On the right are icons which can be used to access different features:

Insert excerpt
_

palette

console
_

palette

console
nopaneltrue

Open the palette panel on the right. You can drag preconfigured layout components from the palette into dashboards.
Image Removed

Show the System Console. This

shows

displays currently running tasks and log messages from

processes run in PhixFlow.
Image Removed
Open Using the Repository. This shows all of the available objects in your PhixFlow instance.
Image Removed
Administration Menu. Options to Import Configuration, Export Full Configuration or Open Export Pane

PhixFlow processes.

Insert excerpt
_

design

download_

mode

area
_

design

download_

mode

area
nopaneltrue

Insert excerpt_app_mode_app_modenopaneltrueThe icon indicates which mode you are currently running. Click it to switch between App Mode and Design Mode.Windows Bar  AnchorformBarformBarThe Windows bar appears in the bottom of the screen if '
Show
Windows Bar' is selected from the footer bar. The Windows bar contains links to all open windows (both open and minimised). Click on a link to restore the window (if needed) and bring the window to the front of the screen. Each window link also has a context menu which allows you to close it directly.On the bottom right of the PhixFlow screen is the  Insert excerpt_administration_administrationnopaneltrue menu, which has the following options:OptionDescription Insert excerpt_admin_import_admin_importnopaneltrueImport Insert excerpt_admin_import_stream_admin_import_streamnopaneltrueImport stream data Insert excerpt_admin_export_admin_exportnopaneltrueExport Insert excerpt_admin_export_open_admin_export_opennopaneltrueOpens a window with export options Insert excerpt_admin_stream_open_admin_stream_opennopaneltrueOpens  window with stream export options
Tip

Whether or not these options are visible in the menu depends on your privileges. Administrators configure privileges in roles; see Managing User Groups and Privileges.

Administrators can configure whether or not these options are visible to users via the associated role privileges; see Managing User Groups and Privileges

Property Tab Toolbar AnchorformIconsformIconsWhen you open the property tab for a model or one of its modelling objects, the tab has a toolbar at the top. 
the download area. This displays files created by an export process that are ready to download; see Using the Download Area.

Insert excerpt
_

finish

palette
_

finish Insert excerpt_forward_forwardnopaneltrue

palette
nopaneltrue

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.

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

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

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

Insert excerpt
_

help

administration
_

help

administration
nopaneltrue

Context sensitive help

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

Insert excerpt
_

toolbar

app_

squashed

mode
_

toolbar

app_

squashed

mode
nopaneltrue

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_delete_delete

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.

Property Section Toolbars

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_addnopaneltrueCreate and insert a new item into the list.

design_mode
_design_mode
nopaneltrue

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

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

In 

Insert excerpt
_

detailed

design_

list

mode
_

detailed

design_

list

mode
nopaneltrue

Open up a grid showing more details about each item.

 you can create data analysis models and design applications. In

Insert excerpt
_

delete_deletenopaneltrue

Delete the selected item or items.

Insert excerpt_refresh_refresh

app_mode
_app_mode
nopaneltrue

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

 you can run your application. Click the icon to switch between the views.

Insert excerpt
_
add
help
_
add
help
nopaneltrue
Create and insert a new item into the list
Open the PhixFlow Help Overview page in a browser window.


ToolbarContext
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

Dashboard Stream Views Pop-Up

When you drag

stream

attributes onto

dashboard

a layout, such as a 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

.