Forms: Stream View
Stream views can be configured to customise the display of data in one or more streamsets.
Form: Stream View Details
The following fields are configured on the Advanced tab:
| Field | Description |
|---|---|
| Name | The name of the stream view. |
| Display Type | A number of chart types are available:
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). |
| 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. |
| Default Filter | Any filter on the stream can be selected as the default filter for this view. |
| Default Sort Order | If specified, the default order in which data should be displayed. See the Stream View Sort Order form. |
| 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. |
Values governing the appearance of charts are configured in the Chart Layout tab.
The following fields apply to Pivot views:
| Field | Description | ||||
|---|---|---|---|---|---|
| Pivot Column Source | The pivot column source determines how the the values that are converted to Pivot Columns are generated:
If no labels are provided, they are derived from the pivot values using the formatting options set on the Column attribute. | ||||
| Pivot Column Expr | If Pivot Column Source == Expression, this expression must return either a list of values or a list of pairs of values (the values and corresponding labels). E.g.
or
The expression can refer to any lookup pipe that is an input to the Stream being viewed. If no labels are provided, they are derived from the pivot values using the formatting options set on the Column attribute. | ||||
| Row Attributes | The row attributes will be displayed on the left of the view. | ||||
| Maximum Pivot Columns | This is the maximum number of pivot columns that can be displayed. If this is blank, the system-wide default in System Configuration is used. | ||||
Column attribute | Values in the Column Attribute are mapped to separate columns in the resulting view. The formatting options on the attribute (decimal places, date/time format) can be used to automatically generate column headers corresponding to Column Attribute values. | ||||
| Value Attribute | When the view is displayed, the value in this Value Attribute will be displayed in the column corresponding to the value in the Column Attribute. A Pivot View is not automatically grouped. To make this a grouped view, you should set the value attribute's aggregate function (e.g. to SUM). | ||||
| Label Attribute | If Pivot Column Source == View Data, this attribute provides the pivot column labels corresponding to the column values. In most cases, the number of values for the label attribute, should be exactly the same as the number of values for the column attribute. |
The following fields apply to all graphs, that is, all display types other than Grid or Pivot:
| Field | Description |
|---|---|
| Default Resolution | Set the default resolution for the generated graph. Larger values will produce a more finely grained image, and equivalently smaller fonts, sometimes useful when using graphs containing a large amount of data. Smaller values will produce a bolder, less finely grained image, sometimes useful for producing a clearer graph when there is not much data to display. |
| Minimum Value | Minimum value along the vertical axis to be displayed. This value will be lowest point on the vertical axis if any value in the data plotted falls below this value. Otherwise, the graph will be automatically sized as normal. |
| Maximum Value | Maximum value along the vertical axis to be displayed. This value will be the highest point on the vertical axis if any value in the data plotted falls above this value. Otherwise, the graph will be automatically sized as normal. |
| Fixed Scale | If fixed scale is turned on, the the maximum value and minimum value defined will always be used as the highest and lowest points on the vertical axis, regardless of the data plotted. |
| Horizontal Axis Title | The label given to the horizontal axis. |
| Vertical Axis Title | The label given to the vertical axis. |
| Include Legend | When a series is used, if this is turned on then a box listing all lines shown, along with the corresponding values, is displayed on the graph. |
| Tick label angle | The orientation of the values displayed along the horizontal axis. Select a value from the drop down menu. |
| Show Horizontal Gridlines | If this is turned on, horizontal gridlines are displayed on the chart. |
| Show Vertical Gridlines | If this is turned on, vertical gridlines are displayed on the chart. |
| Show Values on Charts | If this is turned on, then the y/data attribute values are also displayed on the chart for better clarity. |
The following fields apply only to display type: Line Chart (times series horizontal axis):
| Field | Description |
|---|---|
| Primary Axis Unit | Units for date display along the horizontal axis. Choose a value from the drop down list. Note, however, that only as many values will be displayed as can comfortably be fitted in the space available. |
| Primary Axis Format | Choose a format to display dates along the primary horizontal axis. |
| Secondary Axis Unit | Units for an optional, second date display along the horizontal axis. This might be used, for example, to create a graph where the months are shown along the primary horizontal axis (Primary Axis Unit = 'Month', Primary Axis Format = 'Jan, Feb') and the years are shown along a line below this, along the secondary horizontal axis (Secondary Axis Unit = 'Year', Secondary Axis Format = 'Four digit year'). |
| Secondary Axis Format | Choose a format to display dates along the secondary horizontal axis, if this is being used. |
The following fields apply only to dial charts:
| Field | Description |
|---|---|
| Major Tick Increment | The incremental values at which major tick marks should be shown. Do not set too low for the minimum/maximum values specified otherwise there will be too many major ticks. |
| Minor Tick Count | The number of tick marks between each major tick. |
| First Band Colour | The colour of the first segment on the three coloured arc indicating different regions of the dial. |
| Second Band Colour | The colour of the second segment on the three coloured arc indicating different regions of the dial. |
| Third Band Colour | The colour of the third segment on the three coloured arc indicating different regions of the dial. |
| First Threshold Value | The value at which the first band colour changes to the second band colour. |
| Second Threshold Value | The value at which the second band colour changes to the third band colour. |
| Dial Style | Arc or Circular. |
The following fields are configured through separate tabs on the form:
| Field | Description |
|---|---|
| View Attributes | See the Stream View Attribute Details form. |
| Menu | This tab shows the Lists and Buttons which holds Stream Actions that can be applied when Stream Item Details are accessed from this view. Lists can hold Buttons and other Lists creating multi level menu. There are three ways to add Lists and Buttons:
You can add new Lists and Button to the existing List by following the same steps. See the Action Button Details form for details of each Action Button. |
| Refresh Actions | This tab shows the list of Refresh Actions which are all the actions that, following their execution, will cause this view to be refreshed. To add a Refresh Action go to a Stream's Actions tab and drag actions into this tab. The stream does not have to be the parent of this StreamView. |
| Filters | This tab shows the list of Filters which will be available in the drop down list of filters accessible from the filter icon in the header of the StreamView. There are two ways to add a Filter to this list:
|
| User Groups | A list of user groups associated with the Stream View. |
| Description | Description of the stream view. |
Form Icons
The form provides the standard form icons.