Appboard/2.5/builder/widgets/actions/switch to a board: Difference between revisions

imported>Jason.nicholls
No edit summary
imported>Jason.nicholls
 
(7 intermediate revisions by the same user not shown)
Line 5: Line 5:
''Switch to a Board'' is the main navigation mechanism in AppBoard other than the Stacks available to the user. Typically this action is used in conjunction with other actions to either drill-down in context to show another dashboard with additional information, or cross-navigate to another board in context.
''Switch to a Board'' is the main navigation mechanism in AppBoard other than the Stacks available to the user. Typically this action is used in conjunction with other actions to either drill-down in context to show another dashboard with additional information, or cross-navigate to another board in context.


For example, a top level dashboard may show a summary of application health. By clicking a particular application this can trigger a ''Switch to a Board'' action, along with some other filtering actions, to present another application specific dashboard showing more details about the selected application.
For example, a top level dashboard may show a summary of application health. By clicking a particular application this can trigger a ''Switch to a Board'' action, along with some other SSF or CSF filtering actions, to present another application specific dashboard showing more details about the selected application.
 


{{Note|The ''Switch to a Board'' action will only work if the target board is part of a stack provisioned to the role of the logged in user.}}
{{Note|The ''Switch to a Board'' action will only work if the target board is part of a stack provisioned to the role of the logged in user.}}
Line 11: Line 12:
== Configuration ==
== Configuration ==


[[File:appboard-2.4-switch-to-a-board.png]]
[[File:appboard-2.4-switch-to-a-board.png|frame|center|example Switch to a Board configuration]]
 
== How to add an Action to a Widget ==
 
For instructions on adding an Action to a Widget, see the general instructions in [[appboard/2.5/builder/widgets/actions#How_To_Create_an_Action_in_a_Widget|How To Create an Action in a Widget]].
 
 
== How To Configure a Switch To A Board Action ==
Perform the following steps to configure the "Switch To A Board" Action for a Widget:
 
# Follow the instructions above to create the Action in the <b>Widget Actions</b> panel.
# <b>Name</b>: Enter a name for this Action.  For convenience, a default name is provided.  The Name is not used anywhere else in AppBoard, and only displayed on this configuration page.
# <b>On selection of</b>:
## Select "any" or "specific" for the type of data selection by the User that will trigger the Action. When selecting "specific", perform the following additional steps:
### Click the <b>Filter</b> button. The <b>Filter Editor</b> is displayed.
### Click <b>Add Rule</b> to create one or more rules that indicate what data should trigger the Action, when selected.
### Click <b>Close</b> to save the Filter settings.
## Select the Data Source name. When the Widget is run, selection of data in this Data Source will trigger the Action.
# Enter the following information on the <b>Actions</b> configuration panel in the Widget Wizard:
## <b>Board</b>: Select the name of the Board to switch to.
##* For convenience, an <b>Add Board</b> button is provided if you need to create the Board that will be switched to.
##* Note: It may appear that some Boards are not listed in the drop-down selector.  Boards are filtered based on their defined context and the object selected when triggering the switch to board action.
## <b>Use Context Label Field</b>: Check the box if a context label should be used, and if so, select the field to use for the context label.
### The context type cannot be changed after the board is created. The context type gives the Board the option to present data collected from associations based of the context type. This gives the Widgets on the Board extra Data Collections to use that are automatically derived from the data that was used to switch to the target Board.
### The context label is taken from a field on the piece of data that was clicked to trigger this "Switch To Board" Action, and is shown after the Board label in the bread crumb at the top of the Board.
 
 
== Sample Use Case ==
 
 
The following diagram summarizes the generic concept of drilling down for more information on a specific element:
 
[[Image:DrillDownExample.png|thumb|center|500px|Drill-down Generic Example]]
 
 
The original data grid shows a simple summary of events, grouped by country of origin.  Observe that when the user clicks anywhere in the row for Brazil, this triggers an action that launches a new pie chart data visualization.  The pie chart is configured to specifically show a break out of the events, by severity, for the selected country (Brazil).  You could further create an action on the pie chart that would launch another widget when a segment of the pie chart is clicked.
 
 
{{Note|Clicking anywhere in a row triggers the same action.  The column that is clicked does not affect how the resulting Widget will be displayed.}}
 
 
===Types of Drill-downs===
 
There are several ways to configure switching to a Board, depending on the type of experience you are providing to the end-user.  These include the following:
 
# Record Details window
# Launching a Board with a (Client-side) filtered Data Collection
# Launching a Board using a (Server-side) Association
 
 
These types of drill-downs are detailed in the sections below.
 
 
===Drill-Down to a Record Details window===
 
The Record Details window is a standard action that is automatically supported for any Widget.  The following is an example of a Record Details window display in AppBoard:
 
[[Image:RecordDetailsExample.jpg|thumb|center|500px|Record Details Example]]
 
In the above example, the user clicked on "Adams" in a county list table.  The table was configured with an Action to launch the Record Details window.  The window displayed lists all of the raw data elements in the original data file for the Adams county row in the file.
 
In addition, note that the Record Details window indicates that there is an Association between this record and another Data Source that is currently being utilized in the Widget display.




===Drill-Down to a Board with a Filtered Data Collection===
Refer to [[appboard/2.5/builder/widgets/actions#Managing_Actions|Managing Actions]] for general information on adding / editing / deleting actions.


Although the Record Details window can provide insight into the raw data, in most cases you will want to drill-down to other Widgets containing data that is collected in a way that is meaningful to the user.  In this case, the Action you define on a Widget must tell AppBoard the name of the new Widget and/or Board to be launched, as well as define the collection of data to be provided to that new Widget.
The following settings are available:


One method to drill-down to a Widget with information associated to a selected item is by applying a client-side filter. For more information about this approach, see [[appboard/2.5/builder/widgets/actions/apply_a_filter_to_a_data_collection|Filtering Collections Action]].
* '''Board''': a drop-down selection that selects the target board. If the target board doesn't exist yet you can use the ''Add Board'' button for convenience to create a new child-board.
* '''Use Context Label Field''': Enabling this, and selecting a field from the data collection, will add the value of the field based on the row selected by the user to the child-board title in the board breadcrumb trail. So for example:
:* no context label: <tt>Child Board</tt>
:* with context label: <tt>Child Board: ''Field Value''</tt>

Latest revision as of 17:53, 10 September 2014

Overview

Switch to a Board is the main navigation mechanism in AppBoard other than the Stacks available to the user. Typically this action is used in conjunction with other actions to either drill-down in context to show another dashboard with additional information, or cross-navigate to another board in context.

For example, a top level dashboard may show a summary of application health. By clicking a particular application this can trigger a Switch to a Board action, along with some other SSF or CSF filtering actions, to present another application specific dashboard showing more details about the selected application.


Template-note.png
The Switch to a Board action will only work if the target board is part of a stack provisioned to the role of the logged in user.

Configuration

example Switch to a Board configuration


Refer to Managing Actions for general information on adding / editing / deleting actions.

The following settings are available:

  • Board: a drop-down selection that selects the target board. If the target board doesn't exist yet you can use the Add Board button for convenience to create a new child-board.
  • Use Context Label Field: Enabling this, and selecting a field from the data collection, will add the value of the field based on the row selected by the user to the child-board title in the board breadcrumb trail. So for example:
  • no context label: Child Board
  • with context label: Child Board: Field Value
Retrieved from "http://ab.edge-technologies.com/docs/index.php?title=Appboard/2.5/builder/widgets/actions/switch_to_a_board&oldid=6819"