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

imported>Jason.nicholls
imported>Mike.berman
No edit summary
Line 85: Line 85:
|-
|-
|}
|}


== How To Create an Action in a Widget ==
== How To Create an Action in a Widget ==
Line 92: Line 93:
# Log in to AppBoard Builder as an administrator.
# Log in to AppBoard Builder as an administrator.
# Go to the Actions panel in the Widget Wizard:
# Go to the Actions panel in the Widget Wizard:
## Method 1: Using the quick launch icon
## In the <b>Builder Modes</b> panel, select <b>Builder</b> and locate the appropriate Widget in which you will create the Action.
### In the <b>Builder Modes</b> panel, select <b>Builder</b> 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.
### Click the lightning bolt icon in the header bar of the Widget to display the Actions panel for that Widget.
# Click <b>Add Action</b>
## Method 2: Edit the Widget configuration
# Select the appropriate Action. See the table above for a brief summary of each Action.
### In the <b>Builder Modes</b> panel, select <b>Widgets</b>.
### Locate the name of the Widget in which you will create the Action.
### Click to highlight the Widget.
### Click <b>Edit</b> to launch the Widget Wizard.
### Click <b>Next</b> until the Actions panel is displayed.
# Click <b>Add Event Action</b>
# 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.
# Configure the Action. Each Action will have different elements that are required.
# Click <b>Finish</b> to save the changes to the Action and the Widget.
# Click <b>Close</b> to save the changes to the Action and the Widget.

Revision as of 15:10, 4 September 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:


On Mouse Click

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.


On Mouse Hover

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. In the Builder Modes panel, select Builder and locate 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.
  3. Click Add Action
  4. Select the appropriate Action. See the table above for a brief summary of each Action.
  5. Configure the Action. Each Action will have different elements that are required.
  6. Click Close to save the changes to the Action and the Widget.