routeFormToQueue Step

Learn to easily route form submissions to a queue, enabling more efficient workflow.

Last published at: June 16th, 2023

Description:

Route a form task to a selected queue. The users with View privilege can view the tasks from the queue and assign the tasks to themselves or other user. The queue admin may also assign the tasks as needed.

Inputs

  • name - form control name
  • selectQueue – select queue to rout the task to
  • taskDesc – task description
  • formDefinition – select form definition to route
  • formInstanceID –Variable/global holds the form instance id
  • taskDetailDescription – task detail description
  • hideReadOnlyFields– set forms fields hidden or ready only
  • hideReadOnlySubForms– set sub forms fields hidden or ready only
  • taskPriority – task priority (low, medium, high, normal, urgent) 
  • queuePriority – queue priority (low, medium, high, normal, urgent)
  • expireType - task expire type
  • daysToComplete – days to complete
  • includeWeekends - include weekends
 

 

Returns

  • True – step executed successfully
  • False – step failed to execute 
 

 

Usage:

To use this step, a queue must be configured in FlowWright Application. Navigate to Create - select Queue Management menu option. The page renders with all queues if configured previously. Select Action → Create menu option and provide a queue name to create as shown in the image below.   

Select the queue from the table and click on Security - Permissions menu option. The manage queue permissions page is rendered. Search and add application role and/or users. Click on Save Permissions button to confirm the permissions. In the example shown below, the Reviewer app role (users) have View permissions on the Task Queues. The user access privileges may be modified as necessary. 

 

Example:

Let’s build and execute the RouteFormToQueueDef example and assign a task to the queue.               

  • Create a new definition called “RouteFormToQueueDef”
  • Select the definition and click the “design” button
  • Drag a “RouteFormToQueue” step from the toolbox
  • Connect the dots between the start and RouteFormToQueue step
  • Click on the “RouteFormToQueue” step to configure its properties as shown on the below graphic. Provide a name to the form control. Select the queue from the dropdown list. Provide a task description. Select the form definition to route to queue from the dropdown list. Provide a variable/global reference to store the form instance ID on submission.
  • Click on the “RouteFormToQueue” step to configure its properties as shown on the below graphic. Provide a task detail description. Configure form fields to show/hide when rendered during run time. Configure subForm fields to show/hide when rendered during run time.  Select task priority from the list (low, medium, high, normal, urgent). Select task expire type (days, hours, months, minutes). Provide the task completion duration value. Select include weekends if desired. Save the configuration.
  • Save the workflow definition, create a workflow instance and execute. The step should route the form task  to the queue as configured. 
  • Navigate to Run - Process Instance - select the process instance and click View → Render menu option.
  • On Render Instance page select Items - Queues menu option to view the tasks assigned to the queue.  
  • Navigate to Create - Queue Management page to view the # of items in the queue.
  • Navigate to Engage - Task - Queue Assignment page and select the queue from the dropdown list. This queue shall be visible to application role (users) as configured before. 
  • Here, the users may select the task from the queue and assign to themselves or other user. 
  • Click OK to confirm the queue assignment. 
  • Refresh the process instance page. The task from the queue is now assigned to the user as selected. 
  • Navigate to Engage - Tasks page to view the task by the process instance assigned to the user as selected.
  • To view all the tasks assigned from the queue, the application role (users) navigates to Engage - Task - My Queue page and selects the queue from the dropdown list as shown below.  
  • To unassign the OPEN task from self, the user selects Actions - UnAssign menu option and the selected task is routed back to the queue.