Appboard/2.5/builder/widgets/actions/bundled actions: Difference between revisions

imported>Jason.nicholls
No edit summary
imported>Jason.nicholls
 
(9 intermediate revisions by the same user not shown)
Line 3: Line 3:
== Overview ==
== Overview ==


The ''Bundled Actions'' Action executes multiple Actions based on a single request from a User.
''Bundled Actions'' is a grouping mechanism so that multiple actions can be triggered based on the same action filter. The action filter applies to the bundle and all actions within the bundle are run when there is a match. Logically grouping actions into bundles is also useful for widgets that have a lot of actions to keep things organized.


Bundling actions together also makes it possible to reuse action configuration on multiple widgets. While this is possible there are some caveats due to actions often being widget specific, data collection specific, or similar which means the actions may not work as expected when triggered from a different widget to the original.


Because Actions are tied directly to the type of data from the event, Bundled Actions are also tied to a specific type of data.  When a Bundle is created, it is specific to a data type.  When you add another "Bundle Action" instance, it will only be available for Actions using the same type of data.


{{Warning|It is '''not''' recommended to reuse action bundles on different widgets. Instead copy the widget which will make a complete copy of the actions, including the action bundle. Ensure to edit the new widget and rename the action bundle as it will have the same name as the original which can be confusing.}}


== How To Add Actions To A Widget ==
== Configuration ==


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]].
[[File:appboard-2.5-bundled-actions.png|frame|center|example Bundled Action configuration]]


== How To Configure a Bundled Actions Action ==


Perform the following steps to configure a "Bundled Actions" Action:
Refer to [[appboard/2.5/builder/widgets/actions#Managing_Actions|Managing Actions]] for general information on adding / editing / deleting actions.


The following settings are available:


# Follow the instructions above to create the basic "Bundled Actions" Action.
* '''Select Action Bundle''': shows the currently selected bundle. Use the ''Add'' button to create a new action bundle, or the ''Edit'' button to edit the currently selected bundle.
# <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.
# Click the <b>Add</b> button to create a new Bundle and launch the <b>Bundled Actions</b> window.
# Under <b>Action Bundle Name</b>, enter the name to be displayed later for this Bundle in the AppBoard drop-down Bundle selector.
# Click <b>Add Action</b> and select an Action type to create the first Action to be provided in this Bundle.
# Configure the Action.
# Click <b>Add Action</b> and select an Action type to create the second option to be provided in this Bundle.
# Continue adding Actions until the screen contains all of the Actions to be provided in this Bundle.
# Click <b>Finish</b> to return to the <b>Widget Actions</b> panel.
# Click <b>Close</b> to exit.
# Click in the Widget and verify that AppBoard executes all of the desired Actions in the Bundle.


{{Tip|If the Data Collection associated with the widget is changed, the user will be presented with a confirmation dialog asking whether or not to upgrade the bundled actions. There is a possibility, however, that another widget is using the same bundle: upgrading the bundle will fix the actions for this widget but could nevertheless break the actions on the other widget. Upgrading a bundle that is shared with another widget using another entity will break it for that widget.}}
The screenshot above is from the ''Feature List'' widget in the Welcome content that ships with AppBoard. Most of the actions triggered by clicking a feature are grouped into bundles so this serves as a good example of how to use this feature.


{{Tip|The Bundled Actions should have at least two Actions. Otherwise, a standard Action can be used and there would be no need to use the Bundled Actions.}}
=== Editing Bundles ===


== Sample Use Case ==
Editing an action bundle is very similar to the normal widget actions editor.


Suppose you want to perform the following multiple Actions any time a User clicks a node in certain content in a Map Widget:
Use the ''Add Action'' button to add actions. Use the red <tt>X</tt> button on each action to remove the action. The main difference is that actions added into an action bundle do not have an action filter. Also make sure to set a unique '''Action Bundle Name''' to avoid confusion in systems with multiple action bundles. The screenshot below shows the bundle configuration from the same example as above.


# Drill down to another Board.
[[File:appboard-2.5-bundled-actions-editing.png|frame|center|example editing an action bundle]]
# Filter the Data Collection to only show items associated with the clicked node on the map.
# Refresh a Data Collection.
 
 
Perform the steps outlined above to create an Action Bundle similar to what is presented in the following image:
 
 
[[Image:BundledActionsConfigure.png|thumb|center|500px|Sample Configuration of Bundled Actions]]
 
 
You can now assign this same Bundled Action to any or all Widgets that use the same type of data as the Map Widget in the Actions configuration screen.  When the User clicks in the Map Widget, the bundle of Actions will be executed.  This bundle can be re-used as an Action in multiple Widgets and only needs to be configured one time.

Latest revision as of 10:06, 24 October 2014

Overview

Bundled Actions is a grouping mechanism so that multiple actions can be triggered based on the same action filter. The action filter applies to the bundle and all actions within the bundle are run when there is a match. Logically grouping actions into bundles is also useful for widgets that have a lot of actions to keep things organized.

Bundling actions together also makes it possible to reuse action configuration on multiple widgets. While this is possible there are some caveats due to actions often being widget specific, data collection specific, or similar which means the actions may not work as expected when triggered from a different widget to the original.


Template-warning.png
It is not recommended to reuse action bundles on different widgets. Instead copy the widget which will make a complete copy of the actions, including the action bundle. Ensure to edit the new widget and rename the action bundle as it will have the same name as the original which can be confusing.

Configuration

example Bundled Action configuration


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

The following settings are available:

  • Select Action Bundle: shows the currently selected bundle. Use the Add button to create a new action bundle, or the Edit button to edit the currently selected bundle.

The screenshot above is from the Feature List widget in the Welcome content that ships with AppBoard. Most of the actions triggered by clicking a feature are grouped into bundles so this serves as a good example of how to use this feature.

Editing Bundles

Editing an action bundle is very similar to the normal widget actions editor.

Use the Add Action button to add actions. Use the red X button on each action to remove the action. The main difference is that actions added into an action bundle do not have an action filter. Also make sure to set a unique Action Bundle Name to avoid confusion in systems with multiple action bundles. The screenshot below shows the bundle configuration from the same example as above.

example editing an action bundle
Retrieved from "http://ab.edge-technologies.com/docs/index.php?title=Appboard/2.5/builder/widgets/actions/bundled_actions&oldid=6789"