Appboard/old/actions: Difference between revisions
imported>Cmace m (minor changes) |
imported>Cmace (copied from internal) |
||
Line 1: | Line 1: | ||
[[image:BoardFlow.png]] | [[image:BoardFlow.png]] | ||
In addition to just visualizing data, Widgets allow you to configure "Actions". For example, you can contextually [[ | In addition to just visualizing data, Widgets allow you to configure "Actions". For example, you can contextually [[Action_Apply_a_Filter_to_a_Data_Collection|Filter]] one widget based on a selection in another, or you can [[Action_Switch_To_A_Board|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're actually clicking on the piece of data that's 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. | ||
Line 9: | Line 9: | ||
== AppBoard Actions == | == AppBoard Actions == | ||
AppBoard provides | AppBoard provides Actions that can be triggered either by Mouse Click or Mouse Hover. The following Actions are available: | ||
'''Mouse Click''' | |||
{| class="wikitable" border="1" style="background-color:#eeeeee;" | {| class="wikitable" border="1" style="background-color:#eeeeee;" | ||
|+ align="bottom" style="color:#e76700;" |''AppBoard Actions'' | |+ align="bottom" style="color:#e76700;" |''AppBoard Mouse Click Actions'' | ||
|- | |- | ||
| width=300 | <center><b>Name of Action</b></center> | | width=300 | <center><b>Name of Action</b></center> | ||
| <center><b>Description</b></center> | | <center><b>Description</b></center> | ||
|- | |- | ||
| [[ | | [[Action_Do_Nothing|Do Nothing]] | ||
| | | Do not perform any Actions. | ||
|- | |||
| [[Action_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]] | |||
| Apply a Server Side Filter to a Data Collection. | |||
|- | |- | ||
| [[ | | [[Action_Bundled_Actions|Bundled Actions]] | ||
| | | Implement multiple Actions as a result of a single User request. | ||
|- | |- | ||
| [[ | | [[Action_Change_Diagram_Context|Change Diagram Context]] | ||
| | | Change a Diagrammer Widget to use a specified Diagram Model. | ||
|- | |- | ||
| [[ | | [[Action_Focus_on_Widget|Focus on Widget]] | ||
| | | Change the focus of the application to a specific Widget. | ||
|- | |- | ||
| [[ | | [[Action_Launch_a_URL|Launch URL]] | ||
| | | Load and display a pre-configured piece of web content. | ||
|- | |- | ||
| [[Action_Refresh_a_Data_Collection|Refresh a Data Collection]] | | [[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]] | ||
| | | Set the selected item in a Widget based on an event or selection in another Widget. | ||
|- | |||
| [[Action_Show_Actions_Menu|Show Actions Menu]] | |||
| Provide a list of Actions for the User to choose from. | |||
|- | |||
| [[Action_Show_Data_Tip|Show Data Tip]] | |||
| Display a pop-up that lists selected fields and values for a record. | |||
|- | |||
| [[Action_Show_Record_Details_Window|Show Record Details Window]] | |||
| Display a window that lists every field and value for a selected record. | |||
|- | |- | ||
| [[ | | [[Action_Switch_To_A_Board|Switch to a Board]] | ||
| | | Drill down the display to show a different Board. | ||
|- | |- | ||
| [[ | | [[Action_Write_Static_Value|Write Static Value]] | ||
| | | Write a value for a specific field back to the data on the AppBoard server. | ||
|- | |||
|} | |||
'''Mouse Hover''' | |||
{| class="wikitable" border="1" style="background-color:#eeeeee;" | |||
|+ align="bottom" style="color:#e76700;" |''AppBoard Mouse Hover Actions'' | |||
|- | |- | ||
| | | width=300 | <center><b>Name of Action</b></center> | ||
| | | <center><b>Description</b></center> | ||
|- | |- | ||
| [[ | | [[Action_Set_Widget_Selection|Set Widget Selection]] | ||
| | | Set the selected item in a Widget based on an event or selection in another Widget. | ||
|- | |- | ||
| [[ | | [[Action_Show_Data_Tip|Show Data Tip]] | ||
| | | Display a pop-up that lists selected fields and values for a record. | ||
|- | |- | ||
|} | |} | ||
Revision as of 13:28, 12 March 2013
In addition to just 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're actually clicking on the piece of data that's 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
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. |
Switch to a Board | Drill down the display to show a different Board. |
Write Static Value | Write a value for a specific field back to the data on the AppBoard server. |
Mouse Hover
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:
- Log in to AppBoard Builder as an administrator.
- Go to the Actions panel in the Widget Wizard:
- Method 1: Using the quick launch icon
- In the Builder Modes panel, select Builder and navigate to the appropriate Widget in which you will create the Action.
- Click the lightning bolt icon in the header bar of the Widget to display the Actions panel for that Widget.
- Method 2: Edit the Widget configuration
- In the Builder Modes panel, select Widgets.
- Locate the name of the Widget in which you will create the Action.
- Click to highlight the Widget.
- Click Edit to launch the Widget Wizard.
- Click Next until the Actions panel is displayed.
- Method 1: Using the quick launch icon
- Click Add Event Action
- Select the appropriate Action. See the section above for a brief summary of each Action.
- Configure the Action. Each Action will have different elements that are required.
- Click Finish to save the changes to the Action and the Widget.