Last Updated: 08/17/2016Introduced in Verision: 2.0
It is possible to add a custom action to any “normal” folder, except the service catalog. (“Normal” refers to a root folder, or plain sub folder, which will be of Folder data type.) A custom action can open a folder you specify or run a previously created flow. There are two methods for adding a custom action to a folder:
(1) Using the Add Navigate as Action menu option on the folder
(2) Creating a Folder Actions and Configuration folder of type Folder to house the flows that perform the custom action.
This option is more sophisticated, in that it passes in to a flow specific information about the folder from which the action is taking place. In the example below for method #2, the action is to run a report of all the users/groups who have permission to the folder, and list what those permissions are. That would not be possible using method #1 without retrieving first the folderID. The FolderID is automatically provided when a flow is created within a Folder Actions and Configuration folder of type Folder.
Example – Method #1
The Add Navigate as Action menu option creates a custom action that can open a folder, or run a previously created flow.
To add a custom action, in the Actions menu, select Manage > Page > Add Navigate as Action
In the example, we will add a custom action to a folder that opens the Hardware Requests folder. Adding the custom action will add a button to the folder page. When the user clicks the button, the Hardware Requests folder opens.
To begin, select the folder to contain the custom action from the Folders tree. In folder view, in the upper right, click the Actions menu and select Manage > Page > Add Navigate as Action.
The Add Navigate as Action option allows us to add an open folder action. Choosing Add Flow as Action would allow us to run a flow with the click of a button from the folder.
Because we selected the Add Navigate as Action option, in the Add New User Action pop-up, in the Action Type drop-down list, the default setting is OpenFolder.
In the Action Name field, enter a name for the action, which will appear on the action button that will be added to the folder. You may specify a display type and order.
Most importantly, choose the folder to be opened when the button is clicked. Click the Folder selector.
In the Select a Folder pop-up, we’ll select the folder to open and click OK.
To save our custom action, in the Add New User Action pop-up, click Save.
Select the custom action button for Portal Branding Example .
. . . the Portal Branding Example folder opens.
Example – Method #2
This example will add an action to run a report of all users/groups and their permissions for the folder. This example assumes a report has already been created. From a Designer Folder, click on Create Configuration Extension, and select Add Entity Actions and Configuration.
In the Type Name field, type “folder” and click on the Folder [DecisionsFramework.ServiceLayer.Services.Folder.Folder] option. This is the folder type of the “normal” portal folder. Click OK.
Notice a folder is created in the Designer Folder:
Click on Entity Actions, and select Create Action. Name the flow “Report Users and Permissions” and click OK.
Add the report, and save and close the flow. Notice the action to run the report is now available on all folders of the Folder type.