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

• Zoho Sign: need to leave document pending for up to a year, or maybe there's a better way?

  I have zoho one, maybe there's a better way to do this with another service than sending a zoho sign template from zoho crm. At the end of the day this requirement is due to regulations, no matter how dumb it may seem. I'm just looking for a way of getting

• 'Add Tax To Amount' not reflected in Invoice

  Hi Zoho Support, I'm experiencing an issue with tax calculation display in my invoice template. Despite having "Add tax to amount" box checked in the template settings, the Amount column is not showing the tax-inclusive total for line items. Current behaviour:

• To Do: shareable task links without login

  Hi! I’m using Zoho Mail and ToDo in my daily work, and I’ve run into one limitation that’s a real blocker for me. Right now, to share tasks with managers or directors, they need to have a Zoho account and be added to a group. In practice, many of them

• Separate Items & Services

  Hi, please separate items and services into different categories. Thank you

• Unable to edit or delete email address

  I signed up for free Zoho today. I usually am pretty good at understanding and configuring things like this, but your interface baffles me, and your online help is cryptic to say the least. I have spent hours just trying to set up a couple of email accounts in Zoho before pointing my domain MX records to Zoho. I solved some other issues on my own, but I can't figure out this latest problem: I have created two email addresses in Zoho. Let's call the first one myname@mydomain.com and the second one

• Mastering Zia Match Scores | Let's Talk Recruit

  Feeling overwhelmed by hundreds of resumes for every job? You’re not alone! Welcome back to Let’s Talk Recruit, where we break down Zoho Recruit’s features and hiring best practices into simple, actionable insights for recruiters. Imagine having an assistant

• We are unable to process your request now. Please try again after sometime or contact support@zohoaccounts.com

  I cannot sign up and return the error of we are unable to process your request now. Please try again after sometime or contact support@zohoaccounts.com

• Multi-currency - What's cooking ?

  Hi,       We have been doing this feature for sometime and we would like to give you some glimpses of it.  Working with Multi Currency :        Multicurrency support gives you the ability to handle business transactions in multiple currencies. You can define a base currency for your organization and add more currencies with exchange rates based on the base currency.  Setup :        From the setup page, you can manage all the currencies supported by your organization.       Currencies page        

• Integrating Chatbot with Zoho Creator Application

  Is it possible to integrate a chatbot with a Zoho Creator application?

• How to reduce programmatically the image uploaded by user?

  I need a function that will automatically reduce the pixel dimension to 800 x 600 pixels / 180 resolution or (approx. 1.37MB) of image uploaded by user from digital camera, for example, 2271 x 1704 pixels /180 resolution or approx. 11.1MB. After the user selected the image, the function will able to detect if pixels is above 800x600, process the photo (crop/ reduce) and resume upload. Need help...  

• Dark mode for Zoho Creator / Zoho CRM Code editor

  Hi Team, Is there any plans for Dark mode in Zoho creator / Zoho Crm code editor and development pages in pipeline?

• Is there a way to make a button scroll down?

  Looking to have a button on a landing page scroll down to another section on the page. Any recomendations outside of coding?

• Collective-booking event not added to all staff calendars

  We assign two staff to certain events. When the client books this event, it adds it to one staff calendar (the 'organiser') but not the other. How can I ensure all staff assigned to a collective booking get the event in their calendar? (A side note: it

• ZOHO Android Client

  Hi, I installed the Android app, but it had an issue, so I reinstalled it. I was able to add multiple accounts, but now when I add the next account, it just duplicates the one I already have and will not even allow me to enter the info for another account.

• I'd like to suggest a feature enhancement for SalesIQ that would greatly improve the user experience across different channels.

  Hello Zoho Team, Current Limitation: When I enable the pre-chat form under Brands > Flow Controls to collect the visitor’s name and email, it gets applied globally across all channels, including WhatsApp, Messenger, and Instagram. This doesn't quite align

• Enhance Barcode/QR Code scanner with bulk scanning or continuously scanning

  Dear Zoho Creator, As we all know, after each scan, the scanning frame closes. Imagine having 100 items; we would need to tap 100 times and wait roughly 1 second each time for the scanning frame to reopen on mobile web. It's not just about wasting time;

• Managing Rental Sales in Zoho Inventory

  I am aware that Zoho Inventory is not yet set up to handle rental sales and invoicing. Is anyone using it for rentals anyway? I'd like to hear about how others have found work arounds to manage inventory of rental equipment, rental payments, etc. Th

• Megamenu

  Finally! Megamenu's are now available in Zoho-Sites, after waiting for it and requesting it for years! BUT ... why am I asked to upgrade in order to use a megamenu? First: Zoho promised to always provide premium versions and options for all included Zoho-applications

• Zoho Flow to Creator 3001 Respoonse

  I have updated my Flows with the new V2 connection to Zoho Creator, but now some Flows do not work. They take in data from a Webhook and are supposed to create a record in Creator, however creator returns a 3001 message along with a failure, but I cannot

• File Upload to Work Drive While Adding Records in Zoho Creator Application

  Hi I am trying to set a file attachment field in zoho creator form, to enable the user to upload a scanned document from their local pc. The file should be uploaded to zoho workdrive and not to the default zoho creator storage. The file link should be

• Why not possible to generate?

  Using this https://desk.zoho.com/DeskAPIDocument#TicketCount#TicketCount_Getticketcountbyfield on my ZML script url :"https://desk.zoho.com/api/v1/ticketsCountByFieldValues?departmentId=XXXXXXXXXXX&accountId!=XXXXXXXXX&customField1=cf_country_1:XXXXXX&field=overDue"

• email

  Hi My crm email is not working, can you check, I have zoho one account.

• Need option to see Mass Emails & Cadences in Gmail Outbox OR a dedicated Zoho Outbox

  Hi everyone, Right now, when we send 1:1 emails from gmail (with gmail API connected to Zoho CRM), those emails appear both in gmail's sent folder and in Zoho CRM. That works well. But when we send Mass Emails or Cadence emails form Zoho CRM, they are

• I can't found API for Sales Receipts

  Hello May you please help me to find an API document for Sales Receipts to get data and retrive a custom fields like Invoice and credit notes Regards

• Kaizen #205 - Answering Your Questions | Managing Picklists and Enabling History Tracking via Zoho CRM APIs

  Hello everyone! Welcome back to another post in our Kaizen series. In this post, we will look at how you can manage picklist fields in Zoho CRM using APIs. This topic was raised as feedback to Kaizen #200, so we are taking it up here with more details.

• Multiple Vendor SKUs

  One of the big concerns we have with ZOHO Inventory is lack of Vendor Skus like many other inventory software packages offer. Being able to have multiple vendor skus for the same product would be HUGE! It would populate the appropriate vendor Sku for

• Internally created tickets

  Hi there When tickets are created internally on-behalf of customers - there is nothing to show that the ticket was created by an internal agent. This means, that it's easy for our agents to confuse tickets which were created by internal team members and

• Automatically change website passwords

  Hi everyone, We just switched to a Professional package to also use the "Automatically change website passwords" function. But I cannot find anything about it, how to use it, anywhere. Does anyone know how I can use this function? Best, Caspar

• Change Invoice Prices for an Effective Date

  Hi, It would be a really good feature to be able to change the prices on invoices/recurring invoices from an effective date in the event of price increases. For instance, I am in the process of increasing prices that will be effective from a specific

• "Other Current Asset" accounts as "Paid Through" accounts in Expense

  It would be incredibly useful to be able to assign accounts of type Other Current Asset as Paid Through accounts in Expense. Currently, Other Current Liability are permitted as Paid Through Accounts. This makes sense, as Credit Cards are current liabilities.

• Multi column open text questions that allows respondents to add rows for additional information

  I need to create a question that has 2 columns with open text, but I also need to allow respondents to click a "+" button, or something similar, so that they can add additional information if they choose to. I've tried using the Multiple Textboxes type

• Bot Filtering & Apple Mail Privacy Protection Compliance in Zoho Campaigns

  Dear Campaigns Users, The wait is over! We’re excited to announce that the enhanced bot filtering feature is now live in Zoho Campaigns. This update brings greater accuracy to your email campaign reports by distinguishing real user engagement from automated

• Découvrons les détails qui simplifient vos journées de travail avec Trident

  Nous nous installons dans des routines efficaces et rodées avec le temps. Chaque matin, nous ouvrons nos e-mails, passons aux messages, consultons notre agenda, puis attaquons nos tâches. Ce processus nous semble maîtrisé, mais est-il réellement optimisé

• Issue with Purchase Rate Showing as “0” After Importing Items List

  Dear Zoho Books Support Team, Good day. I’m reaching out regarding an issue I’m facing while importing my items list into Zoho Books. Despite mapping all fields correctly and including the purchase price for each product in my Excel file, the Purchase

• API for Task Entity in Zoho Books

  I’m working on automating task creation in Zoho Books via a custom button in the Bills Module. The goal is to create a task in the Tasks Module and assign it to the Finance Team, so they can track progress efficiently. While reviewing Zoho Books documentation,

• create invoice in zoho books from the zoho forms

  Is there a native way to have create invoice in zoho books, when zoho form is completed?

• Email undelivered

  GOod Day I am always receiving an uncategorized-bounce to my email. I am not sure why this is happening.

• Add inventory_valuation_method to items endpooints

  To ensure consistent item creation it would be helpful to have the inventory_valuation_method (FIFO vs WAC) be able to be set at item creation or as an update (consistent with current behavior where it is not allowed for items with existing transactions)

• Use Zoho to send sales receipts for Gocardless transactions

  I've been using gocardless for years and have d/d mandates set up on there. Each week we get bulk payments from customer d/d's. However, we need to send sales receipts to these customers. So I know I can sync mandates into Zoho, and then I can set up

• Zoho - Gocardless sales receipts

  I've been using gocardless for years and have d/d mandates set up on there. Each week we get bulk payments from customer d/d's. However, we need to send sales receipts to these customers. So I know I can sync mandates into Zoho, and then I can set up

• Next Page