- 02 Dec 2020
- 4 Minutes to read
- Print
- DarkLight
Adding a Folder Actions Bar and a Folder Actions Button to a Page
- Updated on 02 Dec 2020
- 4 Minutes to read
- Print
- DarkLight
Overview
An Actions Bar contains buttons that, when clicked, perform an action or open a menu. An Actions Bar can be configured with primary and secondary actions. When a user clicks a Folder Action button, a pop-up displays that are associated with a specific task performed in the folder. To add an Actions Bar to a page, create a page or edit an existing one. Report View Action Bar is used for displaying user actions on a dashboard. In the Page Designer, in the Toolbox panel, drag an Actions Bar component to the workspace, and configure the properties of the Actions Bar and its buttons in the properties panel. The same procedure is conducted to add the Folder action element to a Page. Both Elements can be used to filter actions, but the method of configuration is different.
Example
In this example, the following will be covered:
- Add a Folder Actions component and an Actions Bar component to a page.
- Edit the Actions Bar to have a minimum number of primary and secondary actions.
- The Report View Action Bar to display Entity Actions on a page.
- Configure Action Filter properties.
- View the new components by previewing the page.
Setting up the Page
First, access the Folder View, navigate to a Designer folder. At the bottom of the view, in the Action Bar panel,
click Manage > Page > Add Page.
An Add Page/Dashboard window will be displayed and will provide a few options for setting up a page. The following options are 'Edit', 'Create', 'Pick'. The 'Create' Action was used for this example.
This will display a Create New Page pop-up. Provide the page a name and click 'Ok'. This will lead to the Page designer view.
In the Page Elements panel, enter "actions" in the search field and press the Enter key.
Drag a Folder Actions component to the workspace and resize it.
Drag an Actions Bar component to the workspace.
Next, set the properties for the two components.
Folder Action Configuration
Folder Actions are used to filter out a list of actions matching a specific menu or text. To configure a Folder action element, select the Folder Actions element. To add button text to this component, in the Properties panel, in the Folder Actions Settings section, enter text in the Search Action Text field.
In the following example, the action contains the text "Manage" that was searched. This resulted in having all the actions with the term "Manage" listed in the Folder Actions on the Page.
For Folder Actions, there are two Search Types that can be used."Contains" search type, will filter to one search criteria. "Match" search type gives the option "Search for more", which can filter based on multiple criteria. In addition, there is an option to hide the Folder Action element when there are no actions that match the criteria. This can be done by checking the, "Hide When No Actions" box.
Action Bar Configuration
Action Bar can also be used to filter actions. With Action Bar there is more flexibility with the number of actions that can be displayed. In contrast, Folder actions will display the number of actions that match the criteria. To configure an Action Bar, select the Actions Bar component in the workspace. In the Properties panel, set the minimum number of primary and secondary actions.
Report View Actions Bar
This page components allows users to display Entity Actions. These actions can be default or custom right-click action that were created in a data structures configuration folder. To configure this component, there needs to be:
- Drag a Report Viewer on the page.
- Map the Report Viewer Name is typed into the ReportViewActionbar 'Actions Source'
- Verify the Report Viewer is displaying data.
Action Filters
By default, the action bar will have the default actions. Default Actions include "Return to", "Dependencies", "Add Category", "Manage Category", "All Category". To add customized actions to the action bar check of the "Filters Action" option in the Properties panel, under Display Info section. Select "Add New". This will display an Add Action Filter dialog.
There are a few properties that need to be configured for customized actions.
Under the Common Properties section, there are the following fields: Category and Action Name.
Fields | Description |
---|---|
Catagory | Actions can be added to categories. This component will add a drop-down feature to the action bar that will contain the actions set to this category. |
Action Name | This is the name of the action you want to add to the action bar. This name is the original name that the action has. |
Under the View section, there is an option to override the displayed information on the action that is being configured. This action provides the flexibility to customize the order the actions will be displayed on the action bar, formatting, and naming conventions.
Fields | Description |
---|---|
Display Type | This drop-down has the following options: "Keep Original", "Primary", "Secondary". "Primary" will set the action to blue color. "Secondary" will set the Action to grey. "Keep Original" will set the Action to the Display Type it was set to when it was first created. |
Sort Index | This property is used to set the order the actions will be displayed on the action bar. |
Action Name | This property is the customized name that will be displayed on the action bar. |
Show in Catagory | This option will display the Action in the drop-down feature on the action bar for the selected category. After selecting this checkbox, a category name field will be required. |
For the drop-down to appear, more than one action must be placed in the category.
"Show in Category" option will only work for User Actions that have not been set to a Category when they were created.
Page View
Save the page and close the Page Designer.
To view the new page, in Folder View, click the Page name link under the address bar.
The new page opens. It contains the Folder Actions component and the Actions Bar.