Org Settings - Variables
Variables in Vertical Studio
Permission Categories
Read/Write: A variable with this permission is visible in the subscriber's organization, allowing them to view and modify its value. However, any changes to the values of the variable in the developer console cannot be deployed as an upgrade and will not reflect in the subscriber’s organization. However, the changes will reflect on new sign-ups. Refer to this Components and Packaging document to learn more packaged behavior.
Read Only: A Read Only variable is visible but cannot be modified in the subscriber’s organization, and its value does not change upon upgrades from the developer console.
Hidden: The Hidden variable is visible in the Developer Console for developers to manage, but it remains hidden for the end users within the subscriber's organization. Any changes to the values of the variable in the developer console can not be upgraded to the subscriber's account. However, the changes will reflect on new sign-ups. Refer to this Components and Packaging document to learn more packaged behavior.
System: A System variable is visible in the Developer Console for developers to manage and remains hidden for the end users in the subscriber's organization. Changes made to the variable value in the developer console are reflected to the subscriber's account during upgrade.
- In the subscriber's org, the value of variables can be updated via API for all the categories except for the System variable.
- Hidden and System Variables cannot be used as merge fields in other components.
Read/Write and Read-Only variables can be associated as merge fields in the following components:
Tasks
Webtabs
Custom Buttons
Custom Links
Mail Merge Templates
Webhooks
Custom Funtions
Email Templates
Creating Record in Workflow Rules
On change Script
In the Developer Console, we support the use of a 'Change Script' to manage developer-created processes when a variable's value is updated in a Subscriber Organization. A change script is a Deluge function that uses both the old and new variable values as parameters. This allows developers to update the relevant processes with the new variable value effortlessly without any disruptions.
To facilitate this, a pre-defined object variable called 'variableMap' is used within the 'Field Value - On Change' action. This object allows the developer to obtain the old and new values of a custom variable. To implement this, navigate to the Field Value-On Change tab in the desired variable and click on Write Script to create your change script.
<oldvalue> = input.variableMap.get("oldvalue"); <newvalue> = input.variableMap.get("newvalue"); |
Packaged Variables
Packaged Variables are created in the developer console and deployed to subscriber organizations during signup or through upgrades. Any new Variable 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.
Property | Upgrade Type | Modify Access |
Variable Name | Upgradable | Developer Only |
API Name | Non-upgradable | Non-Editable |
Description | Upgradable | Developer Only |
Data Type | Non-upgradable | Non-Editable |
Permission | Upgradable | Developer Only |
Grouped Under | Non-upgradable | Non-Editable |
Changes and Impacts
1. Adding a New Variable
2. Editing a Variable
Changes to the 'Description' and 'Variable Name' properties will not affect anything. However, changes to a variable's 'Permission' property will directly impact its visibility and the level of access users have for modifying the variable. It depends on the permission category (Read/Write, Read Only, Hidden, System) outlined above.
3. Deleting a Variable
Access your files securely from anywhere
Zoho CRM Training Programs
Learn how to use the best tools for sales force automation and better customer engagement from Zoho's implementation specialists.
Zoho DataPrep Personalized Demo
If you'd like a personalized walk-through of our data preparation tool, please request a demo and we'll be happy to show you how to get the best out of Zoho DataPrep.
- Zoho Workerly Home
- Forums
- Connect With Us:
- Zoho Recruit Home
- Forums
- Connect With Us:
Create. Review. Publish.
You are currently viewing the help pages of Qntrl’s earlier version. Click here to view our latest version—Qntrl 3.0's help articles.
Zoho Sheet Resources
Zoho Forms Resources
Zoho Sign Resources
Sign, Paperless!
Zoho TeamInbox Resources
Design. Discuss. Deliver.
Related Articles
Components and Packaging in Zoho Vertical Studio
Components are fundamental building blocks of Vertical Studio applications, comprising functionalities, configurations, and customizations. These components, such as fields, modules, blueprints, widgets, and templates, work together to create a ...Functions
Functions are custom scripts in Vertical Studio that help address complex business requirements in your application. They are written using Deluge (Data Enriched Language for the Universal Grid Environment). The Deluge scripts can be used for a wide ...Company Settings - An Overview
In Vertical Studio, you can define the default organization information for your application. The details specified in the developer console are applied as default settings for all new sign-ups. The settings allows you to: Define a fiscal year Set ...Subforms
Subforms help you to include additional data tables within a primary module record in your vertical application. They are used to manage and display multiple related data entries associated with a single record, providing a structured way to organize ...Managing List Views
A List View is grouping of records based on a defined set of criteria in your application. They are beneficial for displaying customer specific data according to your business requirements. Vertical Studio provides a set of pre-defined standard list ...