Extending Entities by Adding Group Actions

Overview

Folder Entity actions are actions that can be taken upon a Folder Entity. Custom Folder Entity actions are built in Flows, and saved within a Folder for the Entity type, within a Designer Folder. Actions can be set up for a single entity, or for a group of Entities. This article sets up an action to manipulate a group of entities. The group action can be seen from a report.

Example

In this example, a group will be added to a pre-designed Folder Entity called "Travel Itinerary." This action will be called Assign Agent. Using a Form, this action will allow a user to assign a travel agent to handle a travel request, then loop through the collection of Entities and update the selected Itineraries with the assigned agent nameNo other properties of the Travel Itinerary Entity will change. The action will be for a group of Travel Itinerary Entities, however, a single Travel Itinerary Entity can be handled as well.

1. Begin in the portal by navigating to the Entity Configurations Folder for Travel Itinerary. 
2. To create the action, within the Travel Itinerary Configuration Folder, select User Actions > Create User Group Action.

   

3. In the resulting Group Action dialog, give the action Flow the name "Assign Agent".

   

4. In the Flow Designer, place a Get All step in the workspace to retrieve the list of all Accounts. 
5. This step is found in the Integration > Internal Services > Account Service category. The output from the Get All step will be used to populate the drop down list of "Agents" in a Form.

   

6. Next, add a Show Form step and select the already built Select Agent Form. 
7. This Form contains a data grid, a drop down list of Account email addresses, and an Assign Agent button. 
8. This Form is included in the downloadable example above. Save and close the Form Designer. 

   

9. In the Flow Designer with the Show Form step selected, navigate to the Properties panel. 
10. Under Inputs, select GetAll1_Output.All EmailAddress for the input of Agent Emails. 
11. For the input of Itineraries, select Entities from the Flow.  

    

12. On the "Assign Agent" outcome path, add a ForEach step to loop through the collection of Entities to perform the Selective Update step which updates the Itinerary with the assigned agent name. 
13. The Data Type for the ForEach step needs to be TravelItinerary with the Collection being Entities. 

    

14. On the Next outcome path from the ForEach step add the Selective Update TravelItinerary step. 
15. This step is found in the Steps panel, under User Defined Types > Entities > TravelItinerary. 
16. Select the Selective Update step and click Edit Input Mappings.

    

17. Connect Agents to Assigned Agents and connect Item.ID to ID. Once each of the Item attributes is mapped into their respective properties select 'Ok.'

    

18. Drag the Done outcome from the Selective Update step to the ForEach step. 
19. Then, drag the Done outcome from the ForEach step to the End step. Save and close the Flow.

Debug

1. The group action can be seen from a Report that displays travel Itineraries. Open the Report containing the Itineraries. 
2. In the upper right-hand corner, select the Multiple Selection tool. 
3. Choose two or more Travel Itineraries. This will show all available group actions. 
4. Select Assign Agent. The Form displays and an Agent is assigned.  
5. Upon refreshing, the Assigned Agent column is no longer empty.