...
| Field | Description | ||||
|---|---|---|---|---|---|
| Basic Settings | |||||
| Name | The name of the stream view. By default, a space will be included before each capital letter. For example, the name CustSpendAverage will be displayed in the column heading as Cust Spend Average. | ||||
| Display Type | A number of chart types are available:
HELPDEVTODO: no file download button on form; is this still correct anyway? If display type is a chart and the user elects to output the chart to HTML (either via a File Exporter or from a chart, PhixFlow will output the chart to HTML as a picture (.PNG). | ||||
| Default Sort Order | If specified, the default order in which data should be displayed. See the Stream View Sort Order form. | ||||
| Default Filter | Any filter on the stream can be selected as the default filter for this view. | ||||
| Default Action | The action that will be applied when users double-click on a row in a data grid. Often this is an update action - that allows users (if they have permissions to run the action) to update the record. But you can make this open a read-only detailed view of the record if that is more useful for most users. See Action. | ||||
| View Attributes | |||||
A list of attributes displayed in the view, or to build a chart. Press For each attribute, the following fields are shown: | |||||
| Order | The order in which the attributes will appear in the view. For a grid view, this is the order of columns. | ||||
| Name | The display name of the attribute in the view. By default, this is the same as the name of the attribute in the underlying stream. Remember that if you are applying an Aggregate Function to the attribute, it is often useful to reflect that in the display name. For example: you are going to display the average monthly spend for each customer, by applying the aggregate function Average to the attribute | ||||
| Stream Function | You can specify an Aggregate Function on this attribute. As soon as you have specified a single aggregate attribute in your view, any other fields will be either aggregate attributes - if you also specify an aggregate function for them - or used as grouping attributes. | ||||
| Decimal PlacesRole | This field willsetting only showshows if the underlying stream attribute has type Float. The number of decimal places to display. | Date/Time Formatview is a chart, i.e. not a data grid. This is the role that the field has in generating the chart. HELPDEVTODO: are there fairly generic descriptions for roles that are worth putting in, or is it only worth describing these in context for each chart type? | |||
| Decimal Places | This field will only show if the underlying stream attribute has type Date or Datetime. Float. The number of decimal places to display. | ||||
| Date/Time Format | This field will only show if the underlying stream attribute has type Date or Datetime. See toString for a description of display formats. | ||||
| Hidden | HELPDEVTODO: not shown for charts, should it be? If not, put in Grid Settings section Whether the field is shown on the view. Sometimes you need to include fields in views so that they can be used in filters and Actions, but displaying them would make the view cluttered. Make the field hidden. | ||||
| Stream Attribute Details | |||||
Name | The name of the underlying stream attribute. | ||||
| Type | The type of the underlying stream attribute. This cannot be edited here. It must be edited in the Stream. | ||||
| Grid Settings | |||||
| Excel Template | An excel template can be linked to the view to specify the format the chart data should be exported in. The location that excel templates must be saved to is specified in the System Configuration. | ||||
| Number of Periods | Number of processing periods from the stream to display on the chart. If a full set of data is generated in each period, then this will be 1. If the data is spread across processing periods in the stream - for example, each processing period only contains new data for that day, but we want to plot data across a number of days - then this number must be high enough to include all data of interest to show on a chart. | ||||
| Background Filter | Any filter on the stream can be selected as the background filter for this view. When the user opens this view the background filter is applied first and any other filter applied to the view (either specifically created/selected by the user or automatically applied as the default filter described above) acts in addition to the background filter. | ||||
| All Users Can View Data | If checked, this specifies that all users can view this stream view by default (provided they have the basic privilege to view stream views). If this field is not checked, then access to the stream view is controlled by dropping user groups onto the stream's "User Groups" tab. | ||||
| Default Width | The default width of the Stream View. If empty, the View's width will be set to the system default value. | ||||
| Default Height | The default height of the Stream View. If empty, the View's height will be set to the system default value. | ||||
| Form View | Check box to determine if this view is to be used as a Form View. When a user is entering or updating data using a form view, you can use the internal variable _form to use a value already entered in the form in the filter on a selection view. That is, the values that appear in a drop down list will be governed by values they have entered so far in the form. See selection view attributes for details of using selection views to create drop down lists.These settings are only available for view attributes for grid views | ||||
| Grid Default Width (pixels) | Set the default width of the column for this attribute. PhixFlow will create the grid with default column widths - you only need to specify a value in this field if the width you want is different from this default. | ||||
| Label | An optional label for the resulting column header. If left blank, this is the Name of the stream view attribute. The label gives you more options for setting the column header - for example, control over the white space in the column heading - but you can also make this an expression. For example, to that the column contains transactions for the currently logged in user, you could use:
For user
To use an expression in this field, tick the box Label is Expression | ||||
| Label is Expression | Tick this box if you want to set the Label using an expression. | ||||
| Changes Row Colour | If ticked, the row colour changes whenever the value in this field changes. | ||||
| Alignment | Set the alignment of values in this column to:
| ||||
| Formatting Rules | |||||
A list of the formatting rules that apply to this field in the view. For each formatting rule, set the following fields: | |||||
| Rule Expression | |||||
| Style | Select a style from the drop-down list, or create a new style. | ||||
| Order | The order in which the formatting rules are applied. | ||||
| Enabled | |||||
| Stop if True | |||||
| Excel Template | An excel template can be linked to the view to specify the format the chart data should be exported in. The location that excel templates must be saved to is specified in the System Configuration. | ||||
| Number of Periods | Number of processing periods from the stream to display on the chart. If a full set of data is generated in each period, then this will be 1. If the data is spread across processing periods in the stream - for example, each processing period only contains new data for that day, but we want to plot data across a number of days - then this number must be high enough to include all data of interest to show on a chart. | ||||
| Background Filter | Any filter on the stream can be selected as the background filter for this view. When the user opens this view the background filter is applied first and any other filter applied to the view (either specifically created/selected by the user or automatically applied as the default filter described above) acts in addition to the background filter. | ||||
| All Users Can View Data | If checked, this specifies that all users can view this stream view by default (provided they have the basic privilege to view stream views). If this field is not checked, then access to the stream view is controlled by dropping user groups onto the stream's "User Groups" tab. | ||||
| Default Width | The default width of the Stream View. If empty, the View's width will be set to the system default value. | ||||
| Default Height | The default height of the Stream View. If empty, the View's height will be set to the system default value. | ||||
| Form View | Check box to determine if this view is to be used as a Form View. When a user is entering or updating data using a form view, you can use the internal variable _form to use a value already entered in the form in the filter on a selection view. That is, the values that appear in a drop down list will be governed by values they have entered so far in the form. See selection view attributes for details of using selection views to create drop down lists. | ||||
HELPDEVTODO not yet in form Height On Form (pixels) | This only applies on Form views: sets the height of the form field for this attribute. PhixFlow will create the form field with a default height - you only need to specify a value in this field if the height you want is different from this default. | ||||
HELPDEVTODO not yet in form Width On Form (pixels) | This only applies on Form views: sets the width of the form field for this attribute. PhixFlow will create the form field with a default width - you only need to specify a value in this field if the width you want is different from this default. | ||||
HELPDEVTODO not yet in form Multiline on Form | This tick box will only be shown when configuring a view attribute on a Form view. If ticked, users can press the Enter key to create multiple lines in this field, or copy multi-line text into this field. | ||||
Values governing the appearance of charts are configured in the Chart Layout tab.
...