Automation#19:Auto-Close Tickets Upon Task Completion

Hello Everyone!

We’re excited to bring you another custom function this week. In this edition, we’ll show you how to automatically close tickets when all associated tasks are marked as completed.

Let’s see how ZylkaPure, a leading water filter company, benefits from this functionality. ZylkaPure specializes in installing and servicing water filters for homes and offices. When a customer books a service, a ticket is created, and the specific tasks required for the service are added to it. As service engineers carry out the necessary work, they update the status of each task. Once all tasks are marked as completed, the system automatically closes the ticket, ensuring a streamlined process and reducing manual follow-ups.

Implementing this custom function in your portal can automate ticket closure and simplify your workflow. Follow these steps to set up the automation in your system.

Prerequisites

1. Create a connection

      1.1 Go to Setup and choose Connections under Developer Space.
      1.2 Click Create Connection.
      1.3 Select Zoho OAuth under Default Connection.
      1.4 Give the connection name as closeticketbytask.
      1.5 Under Scope, choose the below scope values:

Desk.activities.READ

Desk.activities.tasks.READ

Desk.tickets.UPDATE

1.6 Click Create and Connect.
1.7 Click Connect and click Accept.
Connection is created successfully.

Create a Workflow Rule

1. Go to Setup, choose Workflows under Automation.

2. Under Workflows, click Rules >> Create Rule.

In the Basic Information section,

3. Select Tasks from the drop-down menu under Module.

4. Enter a Rule Name and Description for the rule.

5. If you want to activate the rule right away, select the Active checkbox. Else, create the rule and activate it later.

6. Click Next.

In the Execute on section, follow these steps:

7. Select Field Update and select the field Status to execute this rule every time the task status is updated.

8. Click Next.

In the Criteria section

9. Specify the criteria as Status is Completed, AND Completed Time is not empty.

10. In the Actions section, click the + icon and select New next to Custom Functions.

11. Enter a Name and Description for the custom function.

12. In the script window, insert the Custom Function given below:

// ----<<<< User Inputs >>>>----
// --- Replace ".com" with appropriate domain based on your DC
deskURL = "https://desk.zoho.in";
// --- Enter a status name to indicate the 'completed' status of a task ---
taskCompletedStatusName = "Completed";
taskCanceledStatusName = "Canceled";
// --- Enter the name of the custom status to be updated in the Ticket after the completion of all the associated Tasks ---
statusNameToUpdateInTicket = "Closed";
// ----<<<< Initial Configs >>>>----
logs = Map();
logs.insert("taskId":taskId,"associatedTicketId":associatedTicketId);
tasksListToProcess = List();
shallUpdateTicketStatus = false;
//---------------------------
try
{
// ---- Check to find the Task and Ticket association ----
isTicketAssociatedWithThisTask = !isNull(associatedTicketId) && !isEmpty(associatedTicketId);
if(isTicketAssociatedWithThisTask)
{
// --- Get the list of all tasks associated with this ticket ---
getTasksListApiParam = Map();
getTasksListApiParam.insert("from":0,"limit":100,"isSpam":false,"sortBy":"createdTime");
logs.insert("getTasksListApiParam":getTasksListApiParam);
getTasksListApiResponse = invokeurl
[
url :deskURL + "/api/v1/tickets/" + associatedTicketId + "/tasks"
type :GET
parameters:getTasksListApiParam
headers:{"Content-Type":"application/json"}
connection:"closeticketbytask"
];
logs.insert("getTasksListApiResponse":getTasksListApiResponse);
isValidToProcess_getTasksListApiResponse = !isNull(getTasksListApiResponse) && !isEmpty(getTasksListApiResponse) && getTasksListApiResponse.size() > 0 && getTasksListApiResponse.containsKey("data");
logs.insert("isValidToProcess_getTasksListApiResponse":isValidToProcess_getTasksListApiResponse);
if(isValidToProcess_getTasksListApiResponse)
{
tasksListToProcess = getTasksListApiResponse.get("data");
}
}
logs.insert("isTicketAssociatedWithThisTask":isTicketAssociatedWithThisTask,"tasksListToProcess_size":tasksListToProcess.size());
if(tasksListToProcess.size() > 0)
{
// --- Check to ensure that all tasks are completed or not ---
for each currentTaskDetail in tasksListToProcess
{
currentTaskStatusName = currentTaskDetail.get("status");
currentTaskCompletedTime = currentTaskDetail.get("completedTime");
if((currentTaskStatusName == taskCompletedStatusName || currentTaskStatusName == taskCanceledStatusName) && !isNull(currentTaskCompletedTime))
{
shallUpdateTicketStatus = true;
}
else
{
logs.insert("notCompletedTaskId":currentTaskDetail.get("id"));
shallUpdateTicketStatus = false;
break;
}
}
}
logs.insert("shallUpdateTicketStatus":shallUpdateTicketStatus);
if(shallUpdateTicketStatus)
{
// --- Update status field to the associated ticket ---
ticketUpdateApiParam = Map();
ticketUpdateApiParam.insert("status":statusNameToUpdateInTicket);
logs.insert("ticketUpdateApiParam":ticketUpdateApiParam);
ticketUpdateApiResponse = invokeurl
[
url :deskURL + "/api/v1/tickets/" + associatedTicketId
type :PATCH
parameters:ticketUpdateApiParam.toString()
headers:{"Content-Type":"application/json"}
connection:"closeticketbytask"
];
logs.insert("ticketUpdateApiResponse":ticketUpdateApiResponse);
}
}
catch (errorInfo)
{
logs.insert("errorInfo":errorInfo);
}
info "logs: \n" + logs;
if(logs.containKey("errorInfo"))
{
ths "Error happen in the CF execution";
}

NOTE

a. In Line 3, Replace ".com" with appropriate domain extension based on your Data Center.

In case you have a custom name for the task status or ticket status, you can make suitable changes in the following lines:

b. Line 7 ==> Enter a status name to indicate the 'completed' status of a task

c. Line 9 ==> Enter the name of the status you want to be updated in the Ticket after the completion of all the associated Tasks

13. Click Edit Arguments and include the argument mapping as below:

13.1 In the Name field, type taskId and from the Value drop-down list, select Task Id under Task Section.

13.2 In the Name field, type associatedTicketId, and from the Value drop-down list, select Ticket Id under Task Section.

14. Click Save to save the custom function.
15. Click Save again to save the workflow.

We trust this solution will streamline your workflow! Stay tuned for more fresh insights and tips to help you make the most of Zoho Desk and optimize your experience.

Zoho Desk Resources

Desk Community Learning Series
Digest
Functions
Meetups
Kbase
Resources
Glossary
Desk Marketplace
MVP Corner
Word of the Day

Topic Participants
Lydia | Zoho Desk

Sticky Posts
Zoho Desk Virtual Meetup: US Central, October 5 - 7, 2021
After the interactive Virtual Meetups in the other regions, we are starting with the US Central and Midwest regions from October 5 to October 7, 2021. The dates for other regions will be announced soon. At this event, we will explore the topics which
Register for Zoho Desk Beta Community
With the start of the year, we have decided to take a small step in making the life of our customers a little easier. We now have easy access to all our upcoming features and a faster way to request for beta access. We open betas for some of our features
Ask the Experts 10: A 5-hour online Q&A on Zoho Desk Best Practices
Welcome to Zoho Desk's Ask the Experts session! This is a monthly discussion on our forums; wherein a panel of experts will take on questions specific to topics related to Zoho Desk. The panel will be available for a 5-hour period and will answer any questions posted here. Let's begin the year learning some best practices from our experts. In this month's ATE we are opening the floor to questions on how to use Zoho Desk the best way. If you have a business use case but not sure if Workflow is
Share your Zoho Desk story with us!
Tell us how you use Zoho Desk for your business and inspire others with your story. Be it a simple workflow rule that helps you navigate complex processes or a macro that saves your team a lot of time; share it here and help the community learn and grow with shared knowledge.
Ask the Experts 7: A 5-hour online Q&A on Telephony and Call Module
Welcome to Ask the Experts session! This is a monthly discussion in forums; each session, a panel of experts will take questions on specific topics related to Zoho Desk. The panel will be available for a 5-hour period and answer any questions posted here. In this month's Ask the Experts, we will take questions on everything related to Telephony and the Call Module in Zoho Desk. We will discuss the following aspects: Integration with different Telephony vendors Routing calls to agents Converting