Kaizen #160: Automating ZDK CLI commands using shell scripting

Hello everyone,

Welcome back to Kaizen.  ZDK CLI's command-line nature allows you to easily incorporate it within a shell script, to achieve any custom action that you want to execute.  It allows you to execute multiple ZDK CLI commands seamlessly, enhancing productivity.

In this week's Kaizen post, we will discuss a shell script designed to automate the process of pushing locally modified metadata to our CRM environment. Before executing the push operation, ensure that the local metadata is up-to-date and conflicts (same file has been modified in both the local ZDK environment and the remote UI environment) are resolved. To achieve this, we will perform the following steps for files in conflict where manual intervention is required:

• Retrieve the latest metadata from Zoho CRM to our local environment using zdk org:pull command
• Address conflicts that may arise during the pull operation using zdk org:pull:resolve command 
• Update our local directory with the newly pulled file using zdk org:pull:update command
• Push changes from your local environment to the CRM using zdk org:push command
• Update local directory and check status of push command using zdk org:push:result command

This script automates the sequential execution of these commands.

Prerequisites

• ZDK CLI Version 1.0.2-beta

To update ZDK CLI, execute the following command in your terminal

npm install -g @zohocrm/zdk-cli

This will initiate the installation process for the latest version.

Crafting the Shell Script

 

1.Create a new shell script file zdk_automation.sh in your ZDK project's root directory.

#!/bin/bash touch stdout.txt #This script is used to automate ZDK CLI conflict resolve flow conflict_flag=false # Clear stdout.txt at the start > stdout.txt #Step 1: Initial Push Command echo "====Start of the script ====" >> stdout.txt echo "**Executing the initial zdk org:push -j" >> stdout.txt json_content=$(zdk org:push -j) echo "Output  $json_content" >> stdout.txt next_command=$(echo "$json_content" | jq -r '.next_command_sequence // empty') echo "next_command after initial push  is $next_command">> stdout.txt # Check if the JSON is valid if echo "$json_content" | jq empty 2>/dev/null; then #Step 2: Conflict Detection     message=$(echo "$json_content" | jq -r '.message')     echo "message: $message" >>stdout.txt     if [[ "$message" == *"Merge Conflicts!"* ]]; then         #Step 3: Resolving Conflicts         conflict_flag=true         # Pull changes to the local repository and store the output in a variable         echo "**Executing zdk org:pull -j" >> stdout.txt         json_content=$(zdk org:pull -j)         echo "Output  $json_content" >> stdout.txt         if echo "$json_content" | jq empty 2>/dev/null; then             message=$(echo "$json_content" | jq -r '.result')             echo "message $message" >>stdout.txt             IFS=$'\n' read -r -d '' -a filenames <<< "$message"             # Iterate over each filename and execute the resolve command             for filename in "${filenames[@]}"; do                 echo "**Executing zdk org:pull:resolve for $filename" >> stdout.txt                 # Executing zdk org:pull:resolve                  json_content=$(zdk org:pull:resolve -f "$filename" -j)                 echo "Output  $json_content" >> stdout.txt             done             echo "***Executing zdk org:pull:update" >> stdout.txt             json_content=$(zdk org:pull:update -j)             echo "Output  $json_content" >> stdout.txt         fi     fi fi #Step 4: Second Push Attempt after conflict if [ "$conflict_flag" = true ]; then # Push changes to the org and store the output in a variable again echo "***Executing: zdk org:push -j after conflict resolution" >> stdout.txt json_content=$(zdk org:push -j) echo "Output  $json_content" >> stdout.txt # Extract the line containing "next_command_sequence" from the push output next_command=$(echo "$json_content" | jq -r '.next_command_sequence') echo "Next command $next_command " >> stdout.txt fi #Step 5: Push result command # Execute the next command if it exists counter=0  # Initialize a counter if [ -n "$next_command" ]; then     while true; do     # Execute the command stored in next_command and capture the output     echo "***Executing: $next_command -j"  >> stdout.txt     output=$(eval "$next_command -j")     echo "Output $output" >>stdout.txt     # Check if the output contains "Process in progress"     if echo "$output" | grep -q "Process in progress"; then         echo "Push process in progress. Waiting for 5 seconds..."  >> stdout.txt         sleep 5  # Wait for 5 seconds     else         # If not found, break the loop and handle the output         echo "Command executed successfully or completed."  >> stdout.txt         break     fi      # Increment the counter     counter=$((counter + 1))     # Break the loop after 10 iterations     if [ "$counter" -ge 10 ]; then         echo "Maximum number of attempts(10) reached. Exiting the loop." >> stdout.txt         echo "Try executing $next_command after some time" >> stdout.txt         break     fi done fi

Explanation of the script

Step 1: Initial Push Command

• The script starts by executing the zdk org:push -j command. 
• The commands executed using -j option ensures that the output is in a machine-readable JSON format, which facilitates easier parsing and processing.
  
• The conflict_flag is set to false.

Step 2: Conflict Detection

• The script checks the output for any merge conflicts. 
• If conflicts are detected, it executes the zdk org:pull -j  command to retrieve the latest changes from the organization. The conflict_flag is set to true.
• If conflicts are not present, the script proceeds to Step 5: Executing the push:result command.

Step 3: Resolving Conflicts

• If conflicts are present, the script extracts a list of filenames associated with these conflicts. 
• It iterates through this list and executes the zdk org:pull:resolve -j command for each filename, allowing for manual resolution of conflicts as needed. 
• This opens a three-way editor in the browser where the conflicts can be resolved.

Step 4: Second Push Attempt after conflict

• Once all conflicts are resolved, the script attempts to push any changes back to Zoho CRM by executing the zdk org:push -j command. 

Step 5: Executing push:result command 

• This command should be followed by zdk org:push:result --jobid {id} command (indicated by a next_command_sequence) which displays the result of the push process with the mentioned job id and updates the local directory. 
• During this process, if the result is shown as "Process in progress", a subsequent push:result command is required. In this case, the script waits for five seconds before trying again to ensure that operations complete successfully. 
  

2.Make the script executable

chmod +x zdk_automation.sh

3.Run your script

./zdk_automation.sh & tail -f stdout.txt

Logging Actions: All actions taken by the script are logged in stdout.txt. This serves as a record for later reference and troubleshooting.

Using ZDK CLI with shell script ensures that your ZDK CLI operations are automated daily, minimizing manual intervention while effectively managing conflicts. 

For the current beta release, ZDK CLI is exclusively available for Sandbox environment and is not operational in Production environments. 

We hope you found this post useful. We will meet you next week with another interesting topic!

If you have any questions, let us know in the comment section.

Happy Exploring!

Further Reading : ZDK Documentation 

Previous Post: Kaizen #159 - Configuring Telephony Extension Widget in Zoho CRM | Kaizen Collection: Home
                 

• Topic Participants

• Mable Mary M P

  

• Sticky Posts

• Kaizen #197: Frequently Asked Questions on GraphQL APIs

  🎊 Nearing 200th Kaizen Post – We want to hear from you! Do you have any questions, suggestions, or topics you would like us to cover in future posts? Your insights and suggestions help us shape future content and make this series better for everyone.

• Kaizen #198: Using Client Script for Custom Validation in Blueprint

  Nearing 200th Kaizen Post – 1 More to the Big Two-Oh-Oh! Do you have any questions, suggestions, or topics you would like us to cover in future posts? Your insights and suggestions help us shape future content and make this series better for everyone.

• Celebrating 200 posts of Kaizen! Share your ideas for the milestone post

  Hello Developers, We launched the Kaizen series in 2019 to share helpful content to support your Zoho CRM development journey. Staying true to its spirit—Kaizen Series: Continuous Improvement for Developer Experience—we've shared everything from FAQs

• Kaizen #193: Creating different fields in Zoho CRM through API

  🎊 Nearing 200th Kaizen Post – We want to hear from you! Do you have any questions, suggestions, or topics you would like us to cover in future posts? Your insights and suggestions help us shape future content and make this series better for everyone.

• Client Script | Update - Introducing Commands in Client Script!

  Have you ever wished you could trigger Client Script from contexts other than just the supported pages and events? Have you ever wanted to leverage the advantage of Client Script at your finger tip? Discover the power of Client Script - Commands! Commands

• Recent Topics

• Is it possible to hide fields in a Subform?

  Since layout rules cannot be used with Subforms, is there another way, or is it even possible, to hide fields in a subform based on a picklist fields within said subform? For example, if the Service Provided is Internet, then I do not want to see the

• Weekly Tips :Instantly find what you need with Attachment Viewer

  Your inbox must be packed with project emails, shared notes, and scattered attachments. You are looking for one specific file—a presentation slide or maybe a media clip from a team update—but don’t want to dig through endless email threads or switch between

• Putting Watermark on Zoho Sheet

  Can this be done?

• Missing Zoho Desk integration option for form workflows

  According to the help page "Configure Zoho Desk integration in form workflows" we should be able to select Zoho Desk as an integration target but when I open the integrations list then Zoho Desk is not being listed in it. We are on the Premium plan which should already support Zoho Desk integrations.

• Gantt for 2 or more projects

  Hello, I'm trying the free version of your produtc. It is veryyy good!!!! I don't know if in the Standard plan, I can overview a Gantt Graph for 2 or more Projects Milestone. This would be very helpfull for managing teams and taking decisions about who I will assign a task to. In the paid plan Do I have this possibility? Thank you.

• Integrating a Zoho Project Gantt Chart into Reports

  Is is possible to integrate a Zoho Project Gantt Chart into a Zoho Report Dashboard. I am in the process of creating Project Status Dashboards for the projects that we track in Zoho Projects and I would like to incorporate the gantt chart within Reports.  Please let me know! Thanks

• ZOHO BOOKS - EXCESSIVELY SLOW TODAY

  Dear Zoho Books This is not the first time but it seems to be 3 times per week now that the system is extremely slow. I work on Zoho Books 95% of my day so this is very frustrating. Zoho you need to do something about this. I have had my IT guy check

• Gantt Chart - Zoho Analytics

  Are there any plans to add Gantt Charts capabilities to Zoho Analytics?

• Displaying related quotes in sales order and back

  Hi, My colleague liked to see to which sales orders, the quote has been converted. Quote shows Invoices, but not SO. Same, they would like to see the quotes in the sales order, as they can see invoices, packages, shipment, How can we achieve this ? Thank

• Tip of the Week #71–Auto-move incoming messages to the right inboxes with keywords

  We all know that customer-facing teams, especially your sales and support teams, can’t afford to miss even a single customer conversation. But sometimes, sales queries or support requests can easily get lost in a crowded inbox or even end up in the wrong

• Clearing Fields using MACROS?

  How would I go about clearing a follow-up field date from my deals? Currently I cannot set the new value as an empty box.

• Migrating a Zoho Forms form into Zoho Creator

  Hi, How can I migrate my Zoho Forms form into Zoho Creator? Thanks. Truly, Emad

• Is there any way to recall an email sent using Zoho CRM?

  If an email is sent using Zoho Mail, there is a recall option/functionality that is available to the sender. Is there any way to recall an email if it was sent using Zoho CRM? I can't seem to find that option. Any help would be appreciated.

• Quick Create needs Client Script support

  As per the title. We need client scripts to apply at a Quick Create level. We enforce logic on the form to ensure data quality, automate field values, etc. However, all this is lost when a user attempts a "Quick Create". It is disappointing because, from

• is it possible to add more than one Whatsapp Phone Number to be integrated to Zoho CRM?

  so I have successfully added one Whatsapp number like this from this User Interface it seems I can't add a new Whatsapp Number. I need to add a new Whatsapp Number so I can control the lead assignment if a chat sent to Whatsapp Phone Number 1 then assign

• Problem with reports due to "Connected" items change - Yes this IS a problem

  Now that the change has been made to use "connected" items I can no longer run the reporting I need in CRM. I should be able to start with Deals as the parent, connect down to the Account (Account_Name) on the deal as the child, then to any child items

• Introducing notifications in the vendor portal

  Imagine this: You're a recruiter working with multiple vendors on a high-volume hiring project. You’ve just updated a job description after a last-minute change from the hiring manager. One of your vendors, however, is still working off the older version

• CRM limit reached: only 2 subforms can be created

  we recently stumbled upon a limit of 2 subforms per module. while we found a workaround on this occasion, only 2 subforms can be quite limiting in an enterprise setting. @Ishwarya SG I've read about imminent increase of other components (e.

• 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

• How to update "Lead Status" to more than 100 records

  Hello Zoho CRM, How do I update "Lead Status" to more than 100 records at once? To give you a background, these leads were uploaded or Imported at once but the lead status record was incorrectly chosen. So since there was a way to quickly add records in the system no matter how many they are, we are also wondering if there is a quicker way to update these records to the correct "Lead Status". I hope our concern makes sense and that there will be a fix for it. All the best, Jonathan

• Analytics for notes created

  Is there a way I can see how many notes were created per day? Via reporting or analytics?

• No TDS Deduction

  In some of our case, where we are reselling items at the same rate we purchased. In this scenario, Indian IT Law has a provision to request customer not to deduct TDS if the transaction value is same. TDS is paid by us (intermediary reseller) before we

• Cannot update Recurring_Activity on Tasks – RRULE not accepted

  Hello, I am trying to update Tasks in Zoho CRM to make them recurring yearly, but I cannot find the correct recurrence pattern or way to update the Recurring_Activity field via API or Deluge. I have tried: Sending a string like "RRULE:FREQ=YEARLY;INTERVAL=1"

• Add image to report...

  Greetings, I send a weekly color coded report via Creator email. I would like to add the legend somewhere in the report. Header, footer where ever. I have the legend saved on Google Drive and can access it via shared link. Sure someone has wanted to add

• More controls for User Fields in CRM

  Dear All, We are here with a minor but crucial enhancement to the user fields—now set accessibility permissions to the records for user field. User field allows you to extend co-ownership of records to your peers. You can collaborate with them for certain

• Calls to accounts rather than leads or contacts?

  So..... We have a dilemma and I'm hoping someone has encountered this before and figured out a fix. We have just migrated to Zoho. It's great.....expect for how "Calls" are handled.... We are B2B. We do not use the leads module. A "Lead/Prospect" for

• Image Upload Field | Zoho Canvas

  I'm working on making a custom view for one of our team's modules. It's an image upload field (Placement Photo) that would allow our sales reps to upload a picture of the house their working on. However, I don't see that field as a opinion when building

• Power of Automation :: Automated 'Delayed & Closed' Status Update Based on Due Date

  Hello Everyone, A custom function is a software code that can be used to automate a process and this allows you to automate a notification, call a webhook, or perform logic immediately after a workflow rule is triggered. This feature helps to automate

• Lead Blueprint transition in custom list view

  Hi, Is It possible to insert the Blueprint transition label in a custom Canvas list view? I am using Lead module. I see the status, but it would be great if our users could execute the Blueprint right from the list view without having to enter the detailed

• Range names in Zoho Sheet are BROKEN!

  Hi - you've pushed an update that has broken range names. A previously working spreadsheet now returns errors because the range names are not updating the values correctly. I've shared a video with the support desk to illustrate the problem. This spreadsheet

• Has anyone integrated SMS well for Zoho Desk?

  Our company does property management and needs to be able to handle inbound sms messages which create a ticket for Zoho Desk. We then need to be able to reply back from Zoho desk which sends the user an sms message. This seems like a fairly common thing

• populate email address and name in zoho desk?

  Is it possible to populate the email address and name in the zoho desk widget? We only use it in the context of an authenticated user, so we already know the user's name and email. Thanks,

• Are there default/pre-built dashboards in Zoho Desk?

  Hi, I am looking for some pre-built dashboard templates in Zoho Desk, similar to what we can find in CRM/Projects, etc Thank you

• SAP S/4 HANA to CRM Integration - change the SAP Client ID

  Hi I am trying to push the business partners from SAP S/4 HANA to ZOHO CRM module. The SAP Client ID is 421 in my case....kindly let me know how do I specify the sap client because it's a dropdown with specific values as of now. Thanks Ravi Aswani

• Staff rules

  Hi! Do you people know what are the default staff rules when a new booking is created? We have two staff members in my team (me as the admin, and my employee). As we share the same services, I'm wondering how Zoho will pick the staff for new apointments.

• Adding branded signature to tickets reply

  Hi, i am unable to figure out how to add signatures with logo to tickets reply. please advice .

• Zoho Marketing Automation 2.0 - Landing Page function not working

  Dear Zoho Team, I am working on implementing Zoho Marketing Automation 2.0, and am now looking into the section "Lead Generation". If I open the "Landing Pages" section, I immediately get an Error code: Error: internal error occurred. Can you help me

• Zoho Mail Android app update: Manage folders

  Hello everyone! In the latest version(v2.9) of the Zoho Mail Android app update, we have brought in support for an option to manage folders. You can now create, edit, and delete folders from within the mobile app. You can also manage folders for the POP

• How to share ticket numbers across different ticket types

  I'm running an event and have three different ticket types. Add on Event + Main Event - Early bird Main Event only - Early bird Add on Event only - Early bird And Standard class - shown but not available until early bird finishes Add on Event + Main Event

• Adding Social Media Buttons to Basic Campaigns

  Hi, I'm quote new to using Zoho Campaigns and I can't work out how to add Social Media Buttons into my basic campaign? In MailChimp there's a button that brings the icons into your campaign for you. I've tried adding the social media icons as 'buttons' in Zoho but it's not looking great. Can anyone help? Thanks!

• Next Page