Custom Links and Buttons in Zoho Vertical Studio | Vertical Studio Help Guide

Custom Links and Buttons

Custom Links and Buttons are powerful customization features provided by Zoho Vertical Studio that allow developers to enhance the functionality and user experience of your application. Both these features allow you to add functionalities tailored to your specific requirements.

For example, imagine an application built for the real estate industry. In this solution, you want to add an option to send a pre-filled contract to a client. With a Custom Button, you can add a Send Contract option to your Deals module. When clicked, it triggers a custom function, generates a contract using the deal's details, and emails it to the client in seconds. Similarly, a Custom Link could redirect users to a Google Maps view of a property location directly from the record details.

Custom links enable easy access to third-party applications and URLs directly from the application, enhancing productivity with a single click. For instance, using a custom link in the Contacts module for the URL https://x.com/${Leads.Twitter}, the users can directly go to the contact's twitter profile in a single click. Similarly, a Locate Map link can be added to locate addresses via your preferred mapping applications, beyond Google Maps integration.

Refer to our Custom Links help guide to learn more details.

In the Developer Console, you can find Links and Buttons under the Components section in the left panel. Navigate to the Links & Buttons tab and click on Create New Link to start configuring a custom link for your selected application.
Packaged Custom Links are created in the developer console and deployed to subscriber organizations during signup or through upgrades. Any new Custom Link that is created in the developer console will be included in the next version of the application.

To know more about packaging, please refer to our guide on Components Packaging in Zoho Vertical Studio.

The following table explains the upgrade behavior of an existing packaged Custom Link already deployed in the subscriber's organization.

Property
Upgrade Type
Modify Access
Name
Upgradable
Developer Only
Link Module
Upgradable
Developer Only
URL
Upgradable
Developer Only
Description
Upgradable
Developer Only
Permissions
Non-upgradable
Developer and Subscriber Editable

Notes
Note 
Subscribers cannot delete a packaged custom link. 

Changes and Impacts  

When a Custom Link is added/modified, published, and deployed as an upgrade to the subscribers' accounts, it will have the following impact on the subscribers' accounts.

  1. Add Link : The new Link will be available in the Subscriber orgs.

  2. Delete Link : If a link is deleted from the Developer Console, upon upgrading, the link will be deleted from the subscriber account too.

Warning

Caution! 


Deleting a custom link is a destructive change. It can have lasting effects on your subscriber configurations. Please consider the consequences carefully before proceeding, and move forward only if necessary.

Custom Buttons 

Custom Buttons are interactive elements that trigger specific actions, such as executing Deluge scripts, invoking a widget or invoking a URL. These buttons can be added to record details, list views, edit page, or create/clone records page in a module.

Check our Custom Buttons help guide for more details. 

In the Developer Console, you can find Links and Buttons under the Components section in the left panel. Navigate to the Links & Buttons tab and click on Create New Button to start configuring a custom button for your selected application.

The following table lists the availability of the Custom Buttons feature in Vertical Studio in detail.


Custom Button feature
Availability in Developer Console
Availability in Subscriber Orgs

Custom Button in List View

  • Mass action menu

  • Individual records

  • Utility Menu

Available
Available

Custom Button in Records

  • Create/Clone page

  • Edit

  • View 

Available
Available
Custom Button in Related List
Not Available
Available
Custom Button in Wizards
Not Available
Available

Button Actions

  • Writng Function

  • Invoke a URL

  • Invoke a widget

Available
Available

Button Actions

  • Function from gallery

  • Function from existing actions

  • Open a Web Tab

Not Available
Available

Packaged Custom Buttons

Packaged Custom Links are created in the developer console and deployed to subscriber organizations during signup or through upgrades. Any new Custom Link that is created in the developer console will be included in the next version of the application.

To know more about packaging, please refer to our guide on Components Packaging in Zoho Vertical Studio.

The following table explains the upgrade behavior of an existing packaged Custom Link already deployed in the subscriber's organization.

Property
Upgrade Type
Modify Access
Name
Upgradable
Developer Only
Button Placement
Non-Upgradable
Non-Editable
Action
Upgradable
Developer Only
Description
Upgradable
Developer Only
Permissions
Non-Upgradable
Developer and Subscriber Editable

Notes
Note 
Subscribers cannot delete a packaged button. 

Changes and Impacts  

When a Custom Button is added/modified, published, and deployed as an upgrade to the subscribers' accounts, it will have the following impact on the subscribers' accounts.

  1. Add Button : The new Button will be available in the Subscriber orgs.

  2. Delete Button : If a button is deleted from the Developer Console, upon upgrading, the button will be deleted from the subscriber account too.

Warning

Caution! 


Deleting a Button is a destructive change. It can have lasting effects on your subscriber configurations. Please consider the consequences carefully before proceeding, and only move forward if absolutely necessary.