Apama 10.15.0 | Building and Using Apama Dashboards | Dashboard Deployment | Generating Dashboards | Using the layout configuration forms
 
Using the layout configuration forms
These forms allow you to enter information about each section of each dashboard's layout, including the visualization object to use in that section, and how to attach the object to query variables.
For each section of each dashboard (main, create, edit, or details), the wizard includes a form with the following editable elements:
*Choose content: Select an object to appear in the current section of the layout. The current section of the layout is indicated by the check mark in the layout diagram to the left of this field.
*Variables table: Use the buttons to ensure that the Selected variables column contains those variables that you want attached to the object specified in the Choose content field.
To add variable, select the variable in the Available variables, and click Add. The variable appears in the Selected variables column.
To remove a variable, select the variable in the Selected variables column, and Click Remove.
Summary tables contain one row for each query instance, and one column for each variable that is included in the Selected variables column. A cell in a given column and row contains the value of the column's corresponding variable for the row's corresponding query instance. Summary table lists both input and output variables for queries.
Form panels contain one text-entry field for each query variable that is included in the Selected variables column. Create and Edit dashboards use entered values to initialize or update the variables.
Bar charts contain one group of bars for each numeric variable that is included in the Selected variables column. Within each group, there is one bar for each instance. The size of a given bar in a given group is proportional to the value of the group's corresponding numeric variable for the bar's corresponding instance.
Pie charts contain one slice for each instance. The size of a given slice is proportional to the value of the first included, numeric variable for the slice's corresponding instance.
Note:
The layout for pie chart and bar chart does not list any parameters for queries as queries do not have output variables.
If you select Summary Table for the Choose content field, the following elements are included:
*Table header: Enter a label for the table
*Column name: Select a variable in the Selected variables column of the query variables table. Enter the header for the selected variable's corresponding table column. Leave this field blank to use the variable name as the column header.
*Format: Select a variable in the Selected variables column of the query variables table. Enter a format string for the selected variable's corresponding table column. Specify numerical formats based on the Java format specification, or with the following shorthand:
*$ for US dollar money values
*$$ for US dollar money values with additional formatting, ( ) for non-money values, formatted similar to money
*# for positive or negative whole values
*Specify date formats based on the Java date specification.
If you select Form Panel for the Choose content field, the following element is included:
*Display name: Select a variable in the Selected variables column of the variables table. Leave the Display name field blank to use the variable name as the field label.
If you select Bar Chart or Pie Chart for the Choose content field, the following elements are included:
*Chart header: Enter a heading for the chart.
*Show legend: Select to show a legend for the chart. The legend indicates the mapping from bar or pie-slice color to value of the instance's first non-numeric variable for the bar or slice's corresponding instance.
*Filter by instance: Select to filter out all instances except the one that corresponds to the selected row in a summary table on the current dashboard. This allows the end user (the user of the generated dashboard) to select the instance to be visualized. In this case, the bar chart has only a single bar for each numeric variable, rather than a group of bars for each numeric variable.