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.
Access your files securely from anywhere
Zoho Developer Community
New to Zoho LandingPage?
Zoho LandingPage Resources
New to Zoho Survey?
New to Zoho CRM Plus?
Deliver unforgettable customer experiences
New to Zoho CRM Plus?
Deliver unforgettable customer experiences
New to Zoho Marketing Plus?
Everything you need to run your marketing
New to Zoho Marketing Plus?
Everything you need to run your marketing
New to Bigin?
Topic Participants
Mable Mary M P
Sticky Posts
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! CommandsKaizen #165 : How to call Zoho CRM APIs using Client Script
Welcome back to another exciting Client Script post! In this post, we will discuss one of the most frequently asked questions: How do you call Zoho CRM APIs from Client Scripts? In this kaizen post, 1. Ways to make calls to Zoho CRM APIs using ClientKaizen#162 : Add Tags and Open Pre-filled Email Drafts via Client Scripts
Hello everyone! Welcome to another informative Kaizen post. In this post, let us see how to accomplish the following using Client Script. 1. How to auto-tag a record based on field update? 2. How to Open a pre-filled email draft This post will provideExtension Pointers - JS SDK series #4: Managing data from a widget using ZOHO.CRM.HTTP
Handling and managing the data between two applications is a major factor for an efficient business. There are a variety of ways to handle data between Zoho CRM and other third-party applications. You can use deluge CRM tasks, create connectors, use APIKaizen #152 - Client Script Support for the new Canvas Record Forms
Hello everyone! Have you ever wanted to trigger actions on click of a canvas button, icon, or text mandatory forms in Create/Edit and Clone Pages? Have you ever wanted to control how elements behave on the new Canvas Record Forms? This can be achieved
New to Zoho TeamInbox?
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
Design. Discuss. Deliver.
Zoho Show Resources
Get Started. Write Away!
Writer is a powerful online word processor, designed for collaborative work.
Zoho CRM コンテンツ
-
オンラインヘルプ
-
Webセミナー
-
機能活用動画
-
よくある質問
-
Ebook
-
-
Zoho Campaigns
- Zoho サービスのWebセミナー
その他のサービス コンテンツ
Nederlandse Hulpbronnen
ご検討中の方
Recent Topics
booking link that expires
I have a suggestion that is crucial. When i send booking URL to clients they keep the link and they book appointment whenever they want multiple times. You should give us the Booking URL feature. We should be able to send it and the user can use it onlyPrint record summary to pdf page breaks
Hello. I created a record summary and would like to export to pdf. Rich text fields or photos can get printed on 2 pages cutting them in half. Is there a way to add page breaks? Thanks.The email address you have entered belongs to a different deployment/region.
Hi, I am trying to create the user - mprust@crombiecomputers.co.uk but keep getting the message below - The email address you have entered belongs to a different deployment/region. Please contact support@zohoaccounts.com for assistance. Look forwardPre-fill TO and CC fields for Email Templates
This would be a game changer to be able to set either specific email addresses or merge fields based on deal role titles into email templates. Please pass this along to *hopefully* add to future features of Zoho CRM.Leads and Deals Issue
Hi! Is Zoho having trouble today? I've been experiencing issues today. When I move a deal to closed/won, it previously would require a closing date but today the screen just went blur and the closing date did not pop up. And then under leads, I was tryingHow do I hide all leads from Standard users in my CRM ZOHO
I want to configure my crm zoho in such a way that standard users will only see leads owned or assigned to them. How do I go about doing this? I have tried all i could, but nothing...can anyone help me?How to Implement Time-Based Filters in Zoho Workflows?
Hi everyone, I’m looking for a workaround to implement time-based filters in Zoho workflows. Specifically, I need a workflow to trigger only within certain hours (e.g., between 10:00 AM and 8:00 PM, Sunday to Friday). Currently, Zoho workflows executeis there a better way to routinely export my project timesheets?
Hi there, I am somewhat happy with how Zoho books handles time. One thing that is missing is more user driven control over my data. I have a workflow where I constantly need to give customers feeds of work done. So I pick a project, and would ideallyPortal Default View
Hello! My company is about roll out portals for some users, but we were wondering if it was possible to set the Record Detail Page View to default to a custom view that we made. That way the information they need would be streamlined and easier to see.Does zoho rest api support token exchange from microsoft entra id token
i want to get access token from the Microsoft user token in rest api. so it is possible to exchange microsoft user access token to zoho's access token or auth token ( token should be user specific not super admin).Important: DKIM verification needed for unauthenticated email domains
Hi all, This post is to inform users who are currently using unauthenticated email domains as their sender email for their notifications. We have mandated DKIM verification for all domains used as sender email addresses for the outgoing emails by 01-Feb-2025Zoho Sign Product updates - H2 2024
Hello! We have almost come to the end of 2024! Here's a list of features and enhancements that went live in the later half of the year. NOM 151 certification Witness signing Formula, conditional, and custom fields Zoho Sign's extension for Bigin by ZohoCustom Status for Purchase Orders
Currently Zoho books has functionality to create custom statuses for Sales Orders. Can this be extended to include custom status for purchase orders as well? It was a great decision to add this functionality to sales orders. Our use case is for trackingRemove Address from credit card payment
I would like to remove the need to add address when paying by credit card. I only want the customer to have to add their credit card details.New Built In QR/Barcode Generator Print Settings
I'm trying out the new QR/Barcode generator field in Creator. I would think most people will want to print these, like I do. I am not seeing any way to control the height or width of the barcode for printing (inside the print/pdf template builder). TheMy Zoho mail has been blocked for suspicious activity. cannot unblock it! need urgent help!
Hi, I was accessing my email on an airplane which for some reason resulted in my mail being blocked. I have managed to unblock my incoming however outgoing is still blocked. I have contacted all your support emails but it still says contact support when I try to unblock outgoing emails. Its now been over 8 days with the same issue which is really serious as I'm not able to send several business emails during this period. I have followed all your steps to unblock this and contacted your support 5Copy Widget to another Dashboard
I can see the option to clone a widget to the same dashboard but is it possible to copy it to another dashboard?Error while importing products Purchase Price: Value in the field does not match with the data type supported by us.
I am trying to import items into zoho inventory using an excel spreadsheet. I keep getting this error Purchase Price: Value in the field does not match with the data type supported by us. no matter how i format the cells this comes up and will not importQuotes Module - import data
Hello Zoho, is it possible to import Quotes records? I was trying and i have no results. Raport shows no data imported. Could you help me please how to do it?Year-End Wrap: Disconnect now; Reconnect later with Offline Mode
🎄Happy Holidays🎄 Let's say you are travelling home to spend the holiday season with your loved ones. Before you even board the train, you check your phone only to find your inbox rapidly filling with urgent emails that need your attention. There’s noResource booking functionality questions
I'm exploring the resource booking functionality in Zoho Bookings for my organisation's needs. I have a few questions about the available Zoho Bookings functionalities. Is it possible to force all users to sign up for an account before they book a resource?How to create a Field with answers as Yes, No> Further if no is selected a new field to be visible to give details
Dear All, I am creating a feedback form in HR Letter. The question is were you satisfied with the work allotted. Expected answer to this is Yes, No. Further if the response is no, then a field to be give to fill more details as to why no was selected.Modify the way a phone number is shown in footer on ZOHO Booking Page
The default display of the phone number field in the footer is not customer friendly - See image below. We would like it to use the accepted standards of phone number display: +61 (0)2 88545440, or allow us to choose. At the moment ZOHO Booking sets howZoho Bookings Multilingual ?
Hello, Not sure if there is a way to do it currently, but it would be very helpful if Zoho bookings allowed multilingual translations so we could have our booking pages and notifications setup in multiple languages. Thanks,Allow customers to choose meeting venue and meeting duration on booking page
My business primarily involves one-to-one meetings with my clients. Given the hybrid-work world we now find ourselves in, these meetings can take several forms (which I think of as the meeting "venue"): In-person Zoom Phone call I currently handle theseTwo way sync Zoho Mail and Bookings
Hi, I know it’s possible to view Bookings appointments in Zoho Mail, but is there a way to see my Zoho Mail meetings in the Bookings calendar?Modifying iframe data of Zoho booking iframe
Hello, I have integrated a Zoho Bookings embedded iframe into my website. Currently, I am pre-filling the booking form with default values as part of our process flow. However, I want to ensure that if an input field is already populated with a defaultSending my emails to Spam Folder
I am loosing my business because of this issue, many of my customers are receiving their email in the spam sometimes no one checks themWhy can't I sync my Zoho Mail tasks and notes with my mobile device, and is there a way to fix this issue?
I'm having trouble syncing my Zoho Mail tasks and notes with my mobile device. Despite following the usual steps, the tasks and notes don't appear on my phone. Is there a way to fix this issue? Regards, Adamjes, Tekskills India Pvt Limited, India.Re: constant rejected email form and to my account
Hi, have had several rejection when I sent an email to Zoho account as well as other people have sent emails to my as your health Centre they have account and all aspects have been ejected. i wonder why the email are rejecting to and from. If you seeHow do I redeem credits?
How do I redeem credits that are shown in billing section?Cannot add IMAP account to "new" Outlook
Hi, I am attempting to add an IMAP account to my copy of the "new" Outlook on my desktop computer. I have tried using the default password when MFA was disabled and an app password when MFA was enabled. But neither attempt worked. My Windows 11 OS numberUpdate Zoho Flow on Sprint Work Item Status Change
Hello, I've contacted Zoho One support but have been unable to help in a timely manner, so I'm asking the community. I want to start using sprints, but I'm having an issue. I need to post updates to Slack when a Work Item has a status change. My understandingCreate Dashboard using data/tables from different workspaces
Is it possible do create a Dashboard using different tables that are part of different Workspaces?Este domínio já está associado a esta conta
quando digitei meu domínio recebi essa mensagem que meu domínio estava associado a uma conta que eu nem faço idéia de quem seja. Como que faço pra resolver isso?Storage addon failed to upgrade
Hi, I am trying to purchase addon storage, but i am getting upgrade failed error Sorry! We are unable to process your information. Please try again after some time. If the problem occurs again, please visit our Contact Us page to reach out to the appropriateno puedo recibir correos
Hola, en la cuenta de la empresa desde hace unos tres días dejamos de recibir correos y no hemos realizado ningun cambio de configuracion, requerimos asistencia urgente por favorNO PUEDO RECIBIR CORREOS EN MI CUENTA ZOHO MAIL
LO QUE SI PUEDO HACER ES ENVIAR CORREOS PERO NO PUEDO RECIBIR CORREOS. Y LA CONFIGUIRACION DE MI DNS YA ESTA CORRECTA Y APUNTAN A ZOHO PERO AUN ASI NO PUEDO RECIBIR NECESITO AYUDA URGENTE YA QUE EN MEXICO NO HAY FORMA DE COMUNICARNOS VIA TELEFONIA CONSend email is not authenticated
Hi, I’m getting an error in Gmail, when receiving an email from my account in zoho, my email is already authenticated in my domain, and I don't know why I keep receiving this message... also testing in outlook, the message goes directly to "junk".Using Queries with dynamic parameters in Kiosk Studio
Hi, I'm pretty new when it comes to developing within Zoho (I'm really a .NET developer), as it was just added to my responsibilities. For a new feature in the CRM, I'm trying to develop a Kiosk function to show a list of records (retrieved by the newNext Page