Appboard/old/actions/switch to a board

Revision as of 15:32, 17 July 2014 by imported>Jason.nicholls (→‎Drill-Down to a Board with a Filtered Data Collection)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

The "Switch To A Board" Action drills down the AppBoard display to show a different Board. This Action is typically used when a User wishes to see more granular details related to an item on a Top-Level Board. By clicking on a specific data element, that element's value often drives the filtering of the data in the subsequent Board. For example, you may have a Table Widget showing a list of trouble tickets. You may want to configure a drill-down action on that Table Widget. When you click the row for a particular ticket, you may want to see a Child Board with additional details about that trouble ticket.


How to add an Action to a Widget

For instructions on adding an Action to a Widget, see the general instructions in How To Create an Action in a Widget.

How To Configure a Switch To A Board Action

  1. Follow the instructions above to create the basic "Switch To A Board" Action.
  2. Enter the following information on the Actions configuration panel in the Widget Wizard:
    1. Name: The label for this Action. A default label is automatically provided.
    2. On selection of:
      1. Select "any" or "specific" for the type of data selection by the User that will trigger the Action. If you select "specific", you must do the following:
        1. Click the Filter button. The Filter Editor is displayed.
        2. Click Add Rule to create one or more rules that indicate what data should trigger the Action, when selected.
        3. Click Finish to save the Filter settings.
      2. Select the Data Source name. When the Widget is run, selection of data in this Data Source will trigger the Action.
    3. Board: Select the name of the Board to switch to.
      • For convenience, an Add Board 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.
    4. Use Context Label Field: Check the box if a context label should be used, and if so, select the field to use for the context label.
      1. 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.
      2. 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:

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.


Template-note.png
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:

  1. Record Details window
  2. Launching a Board with a (Client-side) filtered Data Collection
  3. Launching a Board using a (Server-side) Association
  4. Using a property of a Widget to drive a server-side query

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:

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

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.

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 Filtering Collections Action.

Drill-Down to a Board Using an Association

Another method to drill-down to a Widget with information associated to a selected item is by using Associations. For more information about this approach, see AppBoard Associations.

Drill-Down Using a Server-side Query

A property of a Widget can be used to apply a server-side query and drill-down to another component. For more details on this technique, see the article on AppBoard Server-side Queries.