Rodger's Helpful Deluge Scripts #3 - Automatically attach files to CRM records when a file is added to Workdrive

Rodger's Helpful Deluge Scripts #3 - Automatically attach files to CRM records when a file is added to Workdrive

Hi Everyone,

I'm hoping this one will be really helpful for a lot of people. One thing that's missing from Zoho is a tighter integration between Workdrive and CRM. Whilst an update is in the works as far as I'm aware, file management can still be a needlessly complicated problem. And while there are apps out there that help with this, they often don't work with custom modules, or in the way you want.

Wouldn't it be great if you could just drag and drop your files into a workdrive folder and they all get renamed and appear on your CRM record without any effort from you? In this post, I will show you how to automatically create folders in workdrive AND LINK THEM TO THE CRM RECORD so that when a new file is added to the folder, it's automatically attached to the CRM record.

This is the basic process:
  1. CRM record is created
  2. Workdrive folder is created
  3. A Data Bind is created between the CRM Record and the Workdrive Folder
  4. When a new file is added to the Workdrive Folder, a function is triggered that attaches the file to the CRm Record.
When the file is attached to the CRM Record, we can take this opportunity to do whatever we want to aid in file management. In one of our organisations we accomplish the following in one of our business processes:

If the new file is a csv, the data is parsed and added to a subform on the recocrd
If the new file is a PDF, it is renamed with a specific format
If the new file contains a specific string of text, we know it's a thumbnail image, so it's uploaded to the record image
...

You get the idea of what we can do, so let's get into it.

Step 1: Create a CRM Function to receive the Data
First we need to create a function in CRM to receive a webhook, essentially a packed of data sent from Workdrive to CRM.

Head over to your functions in CRM and create a new Standalone function. Give it a name and description if you want.



We're going to create an argument called crmAPIRequest (spelled exactly like that, this is case sensitive) and se tthe argument type as string



Now save that and save the function, we don't need anything in there yet. In your function menu, click on the elipses (the 3 dots) and select REST API

 

Turn on "API Key" and the system will generate a url for you. Copy and save that URL as we will need it for Step 2. This finishes Step 1.

Step 2: Create an app in Workdrive
Firstly, we need to create an "App" in Workdrive. This will monitor your folder for specific events and send a webhook when that event is triggered, i.e new file created.

In Workdrive, head to the Admin Console --> Apps --> + New Custom App



Give your app a name that's descriptive and informative and paste your client ID. (There's insructions in the opo-up window about how to get your client ID)

When you have created your Custom App, go into it and head over to "Webhooks" and click "+ Create New Webhook"




Give your webhook a name and description if you please. The endpoint URL will be the url of your function that you created in step 1. This tells the app where to send the packed of data.

Next we select the event that will trigger the webhook. In this case, we want it to trigger when a file is uploaded.



Finally we want to specify the folder to monitor. This will be the parent folder that all your new folders will sit under. When you're done, click "Create Webhook"

Step 3: Setup the Data bind

A data bind links 2 records together with their unique ids. To do this we need a field on your CRM Record to store the Wokdrive Folder ID. Make this a single line field. If you don't know how to do this, then this  guide is not for you.

So that stores the Workdrive folder ID, but what stores the CRM record ID? The answer is a Data Template. In you Workdrive Admin Console, head over to Data Templates and create a data template. Add a single line text field to your data template. This will store the CRM Record ID



Step 4: Create folders in Workdrive with Deluge function.

Now that we have set this up, we need to create folders and associate store the respective IDs. This will be done on record creation.

Use the following code snipped to create your folder

  2. // Create folder
  3. header = Map();
  4. header.put("Accept","application/vnd.api+json");
  5. data = Map();
  6. data_param1 = Map();
  7. att_param1 = Map();
  8. att_param1.put("name",<Folder Name>);
  9. att_param1.put("parent_id",<Parent Folder ID>);
  10. data_param1.put("attributes",att_param1);
  11. data_param1.put("type","files");
  12. data.put("data",data_param1);
  13. createFolder = invokeurl
  14. [
  15. url :"https://www.zohoapis.com.au/workdrive/api/v1/files"
  16. type :POST
  17. parameters:toString(data)
  18. headers:header
  19. connection: <Your Workdrive Connection>
  20. ];
  21. info createFolder;
  22. // m_record.put("Folder_Id",createFolder.get("data").get("id")); - Put the created folder ID into the map for your CRM record
  23. // Associate Data Template
  24. header = Map();
  25. header.put("Accept","application/vnd.api+json");
  26. data = Map();
  27. data_param1 = Map();
  28. att_param1 = Map();
  29. att_param1.put("resource_id",createFolder.get("data").get("id"));
  30. att_param1.put("data_template_id","s1a2u5f693092015d4edc876d9043efcf9bcd-73963000001705001"); // 
  31. innerattr_param = List();
  32. innerattr_param_map1 = Map();
  33. innerattr_param_map1.put("custom_field_id",<Custom Field ID>);
  34. innerattr_param_map1.put("value",<CRM Record ID>));
  35. innerattr_param.add(innerattr_param_map1);
  36. att_param1.put("custom_data",innerattr_param);
  37. data_param1.put("attributes",att_param1);
  38. data_param1.put("type","custommetadata");
  39. data.put("data",data_param1);
  40. associateDataTemplate = invokeurl
  41. [
  42. url :"https://www.zohoapis.com.au/workdrive/api/v1/custommetadata"
  43. type :POST
  44. parameters:data.toString()
  45. headers:header
  46. connection: <Your Workdrive Connection>
  47. ];
  48. info associateDataTemplate;

Note: Use the following documentation to get the ID of your Data Template Field needed for line 33 above Zoho WorkDrive API Documentation

Then update your CRM record with the ID of the workdrive folder you created.

Generally, we don't attach this folder to the CRM Record, all we want to see in the CRM record are the files within the folder, not the folder itself.

Step 5: Set-up CRM Function to receive Webhook and attach file to CRM Record

Now we need to go back to your CRM Function which you setup in Step 1 and we're going to add some code:

  2. crmAPIRequest = crmAPIRequest.get("body");
  3. getFolderMetadata = invokeurl
  4. [
  5. url :"https://www.zohoapis.com.au/workdrive/api/v1/files/" + crmAPIRequest.get("data").get(0).get("resource_info").get("parent_id") + "/custommetadata"
  6. type :GET
  7. headers:{"Accept":"application/vnd.api+json"}
  8. connection: <Your Workdrive Connection>
  9. ];
  10. info getFolderMetadata.get("data").get(0).get("attributes").get("custom_data").get(0).get("value");
  11. recordId = getFolderMetadata.get("data").get(0).get("attributes").get("custom_data").get(0).get("value"); // Gets the Data out of the Data Template - This is the CRM Record ID
  12. r_record = zoho.crm.getRecordById(<Module>,recordId); //Get your CRm Record
  13. fileID = crmAPIRequest.get("data").get(0).get("resource_info").get("resource_id");
  14. m_map = Map();
  15. // Attach new file to CRM Record
  16. //
  17. l_attachments = list();
  18. data = Map();
  19. data.put("$link_url","https://workdrive.zoho.com.au/file/" + fileID);
  20. data.put("File_Name",<Your File Name>);
  21. if(!data.isEmpty())
  22. {
  23. data.put("$resource_id",recordId);
  24. data.put("$type","teamdrive");
  25. l_attachments.add(data);
  26. payload = "attachments=" + zoho.encryption.urlEncode({"data":l_attachments});
  27. attachFile = invokeurl
  28. [
  29. url :"https://www.zohoapis.com.au/crm/v2/<Module>/" + recordId + "/Attachments"
  30. type :POST
  31. parameters:payload
  32. connection: <Your CRM Connection>
  33. content-type:"application/x-www-form-urlencoded"
  34. ];
  35. info attachFile;
  36. // Rename File in Work Drive
  37. data = Map();
  38. data_param1 = Map();
  39. att_param1 = Map();
  40. att_param1.put("name",<Your File Name>);
  41. data_param1.put("attributes",att_param1);
  42. data_param1.put("type","files");
  43. data.put("data",data_param1);
  44. renameFile = invokeurl
  45. [
  46. url :"https://www.zohoapis.com.au/workdrive/api/v1/files/" + fileID
  47. type :PATCH
  48. parameters:data.toString()
  49. headers:{"Accept":"application/vnd.api+json"}
  50. connection: <Your Workdrive Connection>
  51. ];
  52. info renameFile;
  53. }
  54. if(!m_map.isempty())
  55. {
  56. info zoho.crm.updateRecord(<Module>,recordId,m_proof);
  57. }
  58. return "";

So how does the above code work?

Firstly, we get the body of the Webhook, this has all the data we really want.
Next we get the file metadata, this will contain the data in teh Data Template, which of course is the CRM Record ID.
Now that we have the CRM Record ID from the file Metadata, we can fetch the CRM Record. Contained within the Webhook is also the File ID in Workdrive, so this gives us all the information we need to attach the file to your CRM Record and rename the file in Workdrive.

Within this function you can now do whatever you want with the file or anything else. Let's say you want to send an email when a specific file is  uploaded, you can do that here. Or if you want to send a notification via Cliq to someone when a file is uploaded, do that here. You can code specific filename syntaxes so that all your files are perfectly name all the time, the limits are endless.

This is far more advanced than most deluge functions posted on here, so see how you go, play around and have fun. If you have any questions, I'll try to respond as soon as possible.

    Access your files securely from anywhere








                            Zoho Developer Community



                                Bootcamp
                                Community
                                Pricing
                                Webinars
                                What's New
                                Integrations
                                Contact Support
                                Contact Sales
                                  Zoho Survey Resources
                                    Features
                                    Survey Templates
                                    Integrations
                                    Community
                                    iOS Mobile Surveys
                                    Pricing
                                    Android Mobile Surveys
                                    Insurvey Blogs
                                    Insight Blogs
                                    Tips & Tricks





                                                Latest Feature Updates

                                                  • Desk Community Learning Series


                                                  • Digest


                                                  • Functions


                                                  • Meetups


                                                  • Kbase


                                                  • Resources


                                                  • Glossary


                                                  • Desk Marketplace


                                                  • MVP Corner


                                                  • Word of the Day


                                                  • Ask the Experts




                                                      Zoho SalesIQ Resources


                                                            Manage your brands on social media
                                                            Access Zoho Social

                                                              Zoho Pagesense Resources


                                                                  Zoho TeamInbox Resources

                                                                    Zoho DataPrep Resources


                                                                      Zoho CRM Plus Resources

                                                                        Zoho Books Resources


                                                                          Zoho Subscriptions Resources

                                                                            Zoho Projects Resources


                                                                              Zoho Sprints Resources


                                                                                Qntrl Resources


                                                                                  Zoho Creator Resources



                                                                                      Zoho CRM Resources

                                                                                      • CRM Community Learning Series

                                                                                        CRM Community Learning Series


                                                                                      • Kaizen

                                                                                        Kaizen

                                                                                      • Functions

                                                                                        Functions

                                                                                      • Meetups

                                                                                        Meetups

                                                                                      • Kbase

                                                                                        Kbase

                                                                                      • Resources

                                                                                        Resources

                                                                                      • Digest

                                                                                        Digest

                                                                                      • CRM Marketplace

                                                                                        CRM Marketplace

                                                                                      • MVP Corner

                                                                                        MVP Corner









                                                                                          Design. Discuss. Deliver.

                                                                                          Create visually engaging stories with Zoho Show.

                                                                                          Get Started Now


                                                                                            Zoho Show Resources

                                                                                              Zoho Writer

                                                                                              Get Started. Write Away!

                                                                                              Writer is a powerful online word processor, designed for collaborative work.

                                                                                                Zoho CRM コンテンツ



                                                                                                  Nederlandse Hulpbronnen


                                                                                                      ご検討中の方




                                                                                                              • Recent Topics

                                                                                                              • Optimising CRM-Projects workflows to manage requests, using Forms as an intermediary

                                                                                                                Is it possible to create a workflow between three apps with traceability between them all? We send information from Zoho CRM Deals over to Zoho Projects for project management and execution. We have used a lookup of sorts to create tasks in the past,

                                                                                                              • Conditional fields when converting a Lead and creating a Deal

                                                                                                                Hi, On my Deal page I have a field which has a rule against it. Depending on the value entered, depends on which further fields are displayed. When I convert a Lead and select for a Deal to be created as well, all fields are shown, regardless of the value

                                                                                                              • ATE Session on Payment Gateways: Our experts are live now. Post your questions now!

                                                                                                                Hello everyone, Our experts are all excited to answer all your questions related to payment workflows. Please feel free to join this session and learn more about this topic. If you have a query at anytime, please post them here.

                                                                                                              • Upload data deleted all Zoho form data that we manage

                                                                                                                Good morning. Let me introduce myself, I'm Iky from Indonesia. I'm experiencing an error or problem using Zoho Forms. I manage Zoho Forms, but I previously encountered an error when I misclicked the delete button in the upload format. It apparently deleted

                                                                                                              • ZOHO FORMにURL表示ができない

                                                                                                                初心者です。 ZOHO FORM で宿泊者名簿を作っています。 ゲストが、URLをクリックするとStripeで支払いができるようにURLを表示をしたいのですが、 上手くできません。 やり方が分かる方、ぜひ教えてください。

                                                                                                              • Custom module - change from autonumber to name

                                                                                                                I fear I know the answer to this already, but thought I'd ask the question. I created a custom module and instead of having a name as being the primary field, I changed it to an auto-number. I didn't realise that all searches would only show this reference.

                                                                                                              • No Automatic Spacing on the Notebook App?

                                                                                                                When I'm adding to notes on the app, I have to add spaces between words myself, rather than it automatically doing it. All my other apps add spacing, so it must be something with Zoho. Is there a setting I need to change, or something else I can do so

                                                                                                              • Holidays - Cannot Enter Two Holidays on Same Day

                                                                                                                I have a fairly common setup, where part-time employees receive 1/2 day's pay on a holiday and full-time employees receive a full day's pay. Historically, I've been able to accommodate this by entering two separate holidays, one that covers full-time

                                                                                                              • Zoho Bookings and Survey Integration through Flow

                                                                                                                I am trying to set up flows where once an appointment is marked as completed in Zoho Bookings, the applicable survey form would be sent to the customer. Problem is, I cannot customise flows wherein if Consultation A is completed, Survey Form A would be

                                                                                                              • Campaigns set up and execution assistance

                                                                                                                Hello Community, Can someone recommend a professional who can assist with the completion of my set up and deployment of Campaigns? Looking for a person or company that is not going to ask for big dollars up-front without a guarantee of performance to

                                                                                                              • Card Location in Zobot

                                                                                                                Hello, when using the “Location” card in a codeless builder Zobot, the behavior in WhatsApp is inconsistent. When asking the user to share their location, they can type a message, which will return the message “Sorry, the entered location is invalid.

                                                                                                              • Zobot with Plugs

                                                                                                                Hello, I am having a problem with Zobot using Plugs. Here is my current flow: When I run the flow, I should immediately see the messages from the initial cards (Send Message cards), then after running the plug, and finally, see the messages after the

                                                                                                              • Kaizen #223 - File Manager in CRM Widget Using ZRC Methods

                                                                                                                Hello, CRM Wizards! Here is what we are improving this week with Kaizen. we will explore the new ZRC (Zoho Request Client) introduced in Widget SDK v1.5, and learn how to use it to build a Related List Widget that integrates with Zoho WorkDrive. It helps

                                                                                                              • Remove Powered by Zoho at the footer

                                                                                                                Hi, I've read two past tickets regarding this but it seems that the instructions given are outdated. I assume the layout keeps on changing, which makes it frustrating for me to search high and low. Please let me know how exactly do I do this now? Th

                                                                                                              • Error AS101 when adding new email alias

                                                                                                                Hi, I am trying to add apple@(mydomain).com The error AS101 is shown while I try to add the alias.

                                                                                                              • No Need To Fix Something That Is Working

                                                                                                                Zoho Books is a great financial tool which helps businesses to become more efficient and productive with day-to-day operations. As such, every change, upgrade, improvement needs to be carefully thought before implemented in the software and I'm sure Zoho

                                                                                                              • Creating a task, i can not work out how to get ID for What_Id

                                                                                                                hi From Module A function I map Module B record reference membershipid (ours). I need Module B Zoho ID to create the related to on task. All examples i've seen start with the Zoho ID. void automation.LTM_Assign_Dispute_Task(String membershipid) { try

                                                                                                              • Using email "importance" as workflow-criteria

                                                                                                                I'd like to set up a workflow that triggers if an incoming email has been flagged as "high importance" but I'm not seeing any way to do that. Hopefully I'm just missing something obvious...?

                                                                                                              • This domain is not allowed to add. Please contact support-as@zohocorp.com for further details

                                                                                                                I am trying to setup the free version of Zoho Mail. When I tried to add my domain, theselfreunion.com I got the error message that is the subject of this Topic. I've read your other community forum topics, and this is NOT a free domain. So what is the

                                                                                                              • What is Resolution Time in Business Hours

                                                                                                                HI, What is the formula used to find the total time spent by an agent on a particular ticket? How is Resolution Time in Business Hours calculated in Zohodesk? As we need to find out the time spent on the ticket's solution by an agent we seek your assistance

                                                                                                              • Check & Unchecked Task Segregation in Export

                                                                                                                It must have a feature to represent checked and unchecked tasks as [ ] and [✅] respectively when exporting it to Arratai or WhatsApp ; as Keep Notes by Google contains…

                                                                                                              • WorkDrive Download Issue

                                                                                                                My client has been sending me files via WorkDrive, which generally has worked fine. Recently files won't download at all. If you try and individually select and download a file, a popup will appear in the bottom right saying it's preparing and then it

                                                                                                              • Feature Request: Add Tax ID Display on Event Tickets

                                                                                                                Hello Backstage Team, I’ve had several clients bring up an issue regarding tax compliance when creating events. For tax purposes, they are required to show their Tax ID on the event tickets. Currently, this isn’t an option, so they have to manually generate

                                                                                                              • Resolution Time Report

                                                                                                                From data to decisions: A deep dive into ticketing system reports What are time-based reports? Time-based reports are valuable tools that help us understand how well things are going by breaking down key metrics over specific periods. By tracking, measuring,

                                                                                                              • Support Custom Background in Zoho Cliq Video Calls and Meetings

                                                                                                                Hello Zoho Cliq Team, We hope you are doing well. We would like to request an enhancement to the video background capabilities in Zoho Cliq, specifically the ability to upload and use custom backgrounds. Current Limitation At present, Zoho Cliq allows

                                                                                                              • Add RTL (Right-to-Left) Text Direction Button in Zoho Cliq

                                                                                                                Greetings Zoho Team, We would like to request the addition of an RTL (Right-to-Left) text direction button in Zoho Cliq, similar to what is already available in other Zoho apps like Zoho Desk. Currently, while using Zoho Cliq with the English interface,

                                                                                                              • Enable Backgrounds and Video Filters for 1:1 Cliq Calls Across All Zoho Entry

                                                                                                                Hello Zoho Cliq Team, We hope you are doing well. We would like to request an enhancement related specifically to 1:1 video calls in Zoho Cliq. Current Behavior Zoho Cliq currently provides background and video filter options in the following scenarios:

                                                                                                              • Proposal: Actionable API Error Messages to Reduce Support Ticket Volume

                                                                                                                I've encountered a long-standing frustration with how Zoho Creator's API communicates errors to developers, and I'm hoping the Zoho team can address this in a future update. This issue has persisted for over 9 years based on community discussions, and

                                                                                                              • Zoho Flow: Stripe a Zoho Marketing Automation

                                                                                                                Hola! Quiero hacer un flujo con Zoho Flow, para que cuando se haga un pago en Stripe, añada el lead en Zoho Marketing Automation. Lo he configurado, configurando el disparador como "Payment created" y mapeando el campo de Stripe "Receipt email address".

                                                                                                              • Not able to delete a QC nor able to revert or create a cycle of manufacturing for QC failed Jobs

                                                                                                                Not able to delete a QC nor able to revert or create a cycle of manufacturing for QC failed Jobs

                                                                                                              • Need Customer Item Inward Module along with QC

                                                                                                                Need Customer Item Inward Module along with QC 1. Using Transfer Orders hit the item balance sheet 2. Items without inventory it becomes difficult for tracking purpose. 3. Custom Modules become tedious to capture multiple items, item subforms are not

                                                                                                              • LESS_THAN_MIN_OCCURANCE - code 2945

                                                                                                                Hi I'm trying to post a customer record to creator API and getting this error message. So cryptic. Can someone please help? Thanks Varun

                                                                                                              • Zoho email

                                                                                                                I need a list of email addresses of all contacts on my zoho

                                                                                                              • Shift-Centric View for Assigning and Managing Shifts in Zoho People

                                                                                                                Hello Zoho People Product Team, Greetings and hope you are doing well. This feature request is related to Zoho People - please don't move it to zoho one! We would like to submit a feature request regarding the shift assignment and management view in Zoho

                                                                                                              • Zoho Sheet for Desktop

                                                                                                                Does Zoho plans to develop a Desktop version of Sheet that installs on the computer like was done with Writer?

                                                                                                              • Introducing parent-child ticketing in Zoho Desk [Early access]

                                                                                                                Hello Zoho Desk users! We have introduced the parent-child ticketing system to help customer service teams ensure efficient resolution of issues involving multiple, related tickets. You can now combine repetitive and interconnected tickets into parent-child

                                                                                                              • cant upload images in signature- urgent help needed. ta!

                                                                                                                HI, I have been trying to insert the company logo in the signature. i have tried it several times since yesterday, the longest I waited was 1 hour and 12 minutes for the pop up window to upload a 180 KB .jpg file. what am i doing wrong.. an urgent reply

                                                                                                              • Add Ticket button in Home view

                                                                                                                When I go to the My Tickets or the Knowledge Base view in our Help Centre, the Add Ticket button is available, but not in the Home view. I would really like for it to be displayed in the Home view as well. Is this possible? Thanks.

                                                                                                              • Problem using Zoho Desk API

                                                                                                                Goodmorning, I am trying to use the Zoho Desk API to create a dashboard in Grafana, but I am having a problem. Following the instructions in the API documentation, I created the API Console application (server-based application). Then I created the string

                                                                                                              • Add zoho calendar to google calendar

                                                                                                                Hi I keep seeing instructions on how to sync Zoho CRM calendar with google calendar but no instructions on how to view Zoho calendar in my google calendar.

                                                                                                              • Next Page