Appboard/2.4/builder/widgets/actions: Difference between revisions

imported>Mike.berman
No edit summary
imported>Mike.berman
No edit summary
Line 21: Line 21:
| <center><b>Description</b></center>
| <center><b>Description</b></center>
|-
|-
| [[action_do_nothing|Do Nothing]]
| [[appboard/2.4/builder/action_do_nothing|Do Nothing]]
| Do not perform any Actions.
| Do not perform any Actions.
|-
|-
| [[action_apply_a_filter_to_a_data_collection|Apply a Filter to a Data Collection]]
| [[appboard/2.4/builder/action_apply_a_filter_to_a_data_collection|Apply a Filter to a Data Collection]]
| Apply a Filter to a Data Collection.
| Apply a Filter to a Data Collection.
|-
|-
| [[action_apply_a_server_side_filter_to_a_data_collection|Apply a Server Side Filter to a Data Collection]]
| [[appboard/2.4/builder/action_apply_a_server_side_filter_to_a_data_collection|Apply a Server Side Filter to a Data Collection]]
| Apply a Server Side Filter to a Data Collection.
| Apply a Server Side Filter to a Data Collection.
|-
|-
| [[action_bundled_actions|Bundled Actions]]
| [[appboard/2.4/builder/action_bundled_actions|Bundled Actions]]
| Implement multiple Actions as a result of a single User request.  
| Implement multiple Actions as a result of a single User request.  
|-
|-
| [[action_change_diagram_context|Change Diagram Context]]
| [[appboard/2.4/builder/action_change_diagram_context|Change Diagram Context]]
| Change a Diagrammer Widget to use a specified Diagram Model.  
| Change a Diagrammer Widget to use a specified Diagram Model.  
|-
|-
| [[action_focus_on_widget|Focus on Widget]]
| [[appboard/2.4/builder/action_focus_on_widget|Focus on Widget]]
| Change the focus of the application to a specific Widget.  
| Change the focus of the application to a specific Widget.  
|-
|-
| [[action_launch_url|Launch URL]]
| [[appboard/2.4/builder/action_launch_url|Launch URL]]
| Load and display a pre-configured piece of web content.
| Load and display a pre-configured piece of web content.
|-
|-
| [[action_refresh_a_data_collection|Refresh a Data Collection]]
| [[appboard/2.4/builder/action_refresh_a_data_collection|Refresh a Data Collection]]
| Update a Data Collection to the latest data in the server cache.
| Update a Data Collection to the latest data in the server cache.
|-
|-
| [[action_set_widget_selection|Set Widget Selection]]
| [[appboard/2.4/builder/action_set_widget_selection|Set Widget Selection]]
| Set the selected item in a Widget based on an event or selection in another Widget.
| Set the selected item in a Widget based on an event or selection in another Widget.
|-
|-
| [[action_show_actions_menu|Show Actions Menu]]
| [[appboard/2.4/builder/action_show_actions_menu|Show Actions Menu]]
| Provide a list of Actions for the User to choose from.
| Provide a list of Actions for the User to choose from.
|-
|-
| [[action_show_data_tip|Show Data Tip]]
| [[appboard/2.4/builder/action_show_data_tip|Show Data Tip]]
| Display a pop-up that lists selected fields and values for a record.
| Display a pop-up that lists selected fields and values for a record.
|-
|-
| [[action_show_record_details_window|Show Record Details Window]]
| [[appboard/2.4/builder/action_show_record_details_window|Show Record Details Window]]
| Display a window that lists every field and value for a selected record.
| Display a window that lists every field and value for a selected record.
|-
|-
| [[action_show_widget|Show Record Details Window]]
| [[appboard/2.4/builder/action_show_widget|Show Record Details Window]]
| Display a window that lists every field and value for a selected record.
| Display a window that lists every field and value for a selected record.
|-
|-
| [[action_switch_to_a_Board|Switch to a Board]]
| [[appboard/2.4/builder/action_switch_to_a_Board|Switch to a Board]]
| Drill down the display to show a different Board.
| Drill down the display to show a different Board.
|-
|-
| [[action_topology_drill_down|Show Record Details Window]]
| [[appboard/2.4/builder/action_topology_drill_down|Show Record Details Window]]
| Display a window that lists every field and value for a selected record.
| Display a window that lists every field and value for a selected record.
|-
|-
| [[action_write_static_value|Write Static Value]]
| [[appboard/2.4/builder/action_write_static_value|Write Static Value]]
| Write a value for a specific field back to the data on the AppBoard server.   
| Write a value for a specific field back to the data on the AppBoard server.   
|-  
|-  
Line 80: Line 80:
| <center><b>Description</b></center>
| <center><b>Description</b></center>
|-
|-
| [[action_set_widget_selection|Set Widget Selection]]
| [[appboard/2.4/builder/action_set_widget_selection|Set Widget Selection]]
| Set the selected item in a Widget based on an event or selection in another Widget.
| Set the selected item in a Widget based on an event or selection in another Widget.
|-
|-
| [[action_show_data_tip|Show Data Tip]]
| [[appboard/2.4/builder/action_show_data_tip|Show Data Tip]]
| Display a pop-up that lists selected fields and values for a record.
| Display a pop-up that lists selected fields and values for a record.
|-
|-

Revision as of 19:47, 19 August 2013

BoardFlow.png

In addition to visualizing data, Widgets allow you to configure "Actions". For example, you can contextually Filter one widget based on a selection in another, or you can Drill Down into a child board that shows details based on an item selected in the parent. The key is knowing that when you click on a Widget, you are actually clicking on the piece of data that is being represented by the Widget. Actions allow you to use this piece of data as context to alter client or server side filters for any Data Collection inside AppBoard. This flexibility allows for extremely powerful interactions.


This section lists the Actions that you can configure in a Widget, with links to additional information on the individual Actions.


AppBoard Actions

AppBoard provides Actions that can be triggered either by Mouse Click or Mouse Hover. The following Actions are available:


Mouse Click

AppBoard Mouse Click Actions
Name of Action
Description
Do Nothing Do not perform any Actions.
Apply a Filter to a Data Collection Apply a Filter to a Data Collection.
Apply a Server Side Filter to a Data Collection Apply a Server Side Filter to a Data Collection.
Bundled Actions Implement multiple Actions as a result of a single User request.
Change Diagram Context Change a Diagrammer Widget to use a specified Diagram Model.
Focus on Widget Change the focus of the application to a specific Widget.
Launch URL Load and display a pre-configured piece of web content.
Refresh a Data Collection Update a Data Collection to the latest data in the server cache.
Set Widget Selection Set the selected item in a Widget based on an event or selection in another Widget.
Show Actions Menu Provide a list of Actions for the User to choose from.
Show Data Tip Display a pop-up that lists selected fields and values for a record.
Show Record Details Window Display a window that lists every field and value for a selected record.
Show Record Details Window Display a window that lists every field and value for a selected record.
Switch to a Board Drill down the display to show a different Board.
Show Record Details Window Display a window that lists every field and value for a selected record.
Write Static Value Write a value for a specific field back to the data on the AppBoard server.


Mouse Hover

AppBoard Mouse Hover Actions
Name of Action
Description
Set Widget Selection Set the selected item in a Widget based on an event or selection in another Widget.
Show Data Tip Display a pop-up that lists selected fields and values for a record.


How To Create an Action in a Widget

Perform the following steps to configure an Action in a Widget:

  1. Log in to AppBoard Builder as an administrator.
  2. Go to the Actions panel in the Widget Wizard:
    1. Method 1: Using the quick launch icon
      1. In the Builder Modes panel, select Builder and navigate to the appropriate Widget in which you will create the Action.
      2. Click the lightning bolt icon in the header bar of the Widget to display the Actions panel for that Widget.
    2. Method 2: Edit the Widget configuration
      1. In the Builder Modes panel, select Widgets.
      2. Locate the name of the Widget in which you will create the Action.
      3. Click to highlight the Widget.
      4. Click Edit to launch the Widget Wizard.
      5. Click Next until the Actions panel is displayed.
  3. Click Add Event Action
  4. Select the appropriate Action. See the section above for a brief summary of each Action.
  5. Configure the Action. Each Action will have different elements that are required.
  6. Click Finish to save the changes to the Action and the Widget.


Template-tip.png
In some cases, when you click on an item with no Action defined, AppBoard will provide the message: "No data action has been defined. Would you like to define one now?". You can click "Yes" to launch the Actions panel in the Widget Wizard. For example, clicking on a pin in a map with no action defined will trigger this message.