Collection Functions

This guide will help you with the following:

1. Clear

2. containsKey

3. containsValue

4. delete

5. deleteAll

6. deleteKey

7. deleteKeys

8. distinct

9. duplicate

10. get

11. getAsString

12. getKey

13. getLastKey

14. insert

15. insertAll

16. intersect

17. isEmpty

18. keys

19. percentile

20. size

21. sort

22. sortKey

23. toCollection

24. update

25. values

26. notContains

Clear

The clear function empties a given collection.

Syntax

<collectionVariable>.clear();

where,

Examples

productVersion=collection("Deluge":5,"CRM":2,"Mail":8);
productVersion.clear();
info productVersion;// Returns {}

containsKey

The containsKey function checks if a specified key or an index value is present in a collection. It returns true if the key or the index is present in the collection. Otherwise, it returns false.

Note: This function performs a case sensitive search.

Return Type

BOOLEAN

Syntax

To check if a key is present in a collection:

<variable>=<collectionVariable>.containsKey(<key>);

(OR)

To check if an index value is present in a collection:

<variable>=<collectionVariable>.containsKey(<index>);

where,

Examples

productVersion=collection("Creator":5,"CRM":2,"Mail":8);
info productVersion.containsKey("CRM"); // Returns true
productVersion=collection("Creator","CRM","Mail");
info productVersion.containsKey(3); // Returns false

containsValue

The containsValue function checks if a specified value is present in a collection. It returns true if the value is present in the collection. Otherwise, it returns false.

Note: This function performs a case sensitive search.

Return Type

BOOLEAN

Syntax

<variable>=<collectionVariable>.containsValue(<value>);

Examples

productVersion=collection("Creator":5,"CRM":2,"Mail":8);
info productVersion.containsValue(2);// Returns true

delete

The delete function deletes a specified element, or a specified value (along with the key) from a collection.

Syntax

To delete a value along with the key:

<collectionVariable>.delete(<value>);

(OR)

To delete an element:

<collectionVariable>.delete(<element>);

where,

Examples

products=Collection("Creator","CRM","Campaigns");
products.delete("CRM");
info products;// Returns "Creator,Campaigns"
productVersion=Collection("Creator":5,"CRM":2);
productVersion.delete(2);
info productVersion;// Returns {"Creator":5}

deleteAll

The deleteAll function deletes specified elements, or specified values (along with the keys) from a collection.

Syntax

To delete values along with the keys:

<collectionVariable>.deleteAll(<valuesList>);

(OR)

To delete elements:

<collectionVariable>.deleteAll(<elementsList>);

where,

Examples

products=collection("Creator","CRM","Campaigns");
products.deleteAll({"CRM","Campaigns"});// deletes the specified elements from the collection
productVersion=collection("Creator":5,"CRM":2);
productVersion.deleteAll({2});// deletes the specified key along with its value from the collection

deleteKey

The deleteKey function deletes an element based on a specified index, or a specified key along with its value in a collection.

Syntax

To delete a key-value pair based on the key:

<collectionVariable>.deleteKey(<key>);

(OR)

To delete an element based on its index:

<collectionVariable>.deleteKey( <elementIndex> );

where,

Examples

productVersion=collection("Creator":5,"CRM":2);
productVersion.deleteKey("CRM");// deletes the specified key along with its value
products=collection("Creator","CRM","Campaigns");
products.deleteKey(1);// deletes the element "CRM"

deleteKeys

The deleteKeys function deletes specified elements, or keys(along with their values) from a collection.

Syntax

To delete keys along with their values:

<collectionVariable>.deleteKeys(<keysList>);

(OR)

To delete elements based on index values:

<collectionVariable>.deleteKeys(<indexList>);

where,

Examples

productVersion=collection("Creator":5,"CRM":2,"Mail":8);
productVersion.deleteKeys({"CRM","Mail"});// deletes the specified keys along with their values
products=collection("Creator","CRM","Mail");
products.deleteKeys({1,2});// deletes the elements "CRM" and "Mail"

distinct

The distinct function returns the unique values (from key value pairs), or unique elements, present in a collection.

Return Type

LIST

Syntax

<variable>=<collectionVariable>.distinct();

where,

Examples

productVersion=collection("Creator":5,"CRM":2,"Mail":5);
infoproductVersion.distinct();// Returns 5, 2
products=collection("Creator","CRM","CRM");
infoproducts.distinct();// Returns "Creator", "CRM"

duplicate

The duplicate function returns the elements present in the given start index (inclusive) and end index (non inclusive). If the indices are not specified, it duplicates and returns the given collection of elements.

Return Type

LIST

Syntax

<variable>=<collectionVariable>.duplicate(<startIndex>,<endIndex>);

where,

Examples

products1=collection("Creator","CRM","Books");
info products1.duplicate(0,1);// Returns "Creator"

get

The get function retrieves values from a collection using either an index or a key.

Note: Index starts from 0.

Return Type

ANY DATA TYPE

Syntax

<variable>=<collection>.get(<indexValue>);

(OR)

<variable>=<collection>.get(<key>);

Examples

names = Collection("name10","name2","name6","name1");
first_name = names.get(0);// the value "name10" is assigned to first_name
fifth_name = names.get(4);// Throws a run-time error - "Given index 4 is greater than the list size"
names= Collection("name1":"John","name2":"Bill");
name = names.get("name1");// the value "John" is assigned to name
name = names.get("name3");// returns null

getAsString

The getAsString function fetches an element from a collection as a text value.

Return Type

TEXT

Syntax

<variable>=<collection>.getAsString(<index>);

where,

Examples

product_name=Collection();
product_name="123,456,120,120.46";
index2=product_name.getasstring(2);// The number 120 gets stored in index2 as a 'text' value

getKey

The getKey function returns the key of a specified value, or the index of a specified element, in a collection.

Return Type

Data type of the return value will depend on the data type of the key.
Returns null if the specified value is not found.
Data type is NUMBER if the index of an element is returned. Returns -1 if the specified element is not found.

Syntax

To get the key of a specified value:

<variable>=<collectionVariable>.getKey(<value>);

(OR)

To get the index value of an element:

<variable>=<collectionVariable>.getKey(<element>);

where,

Examples

productVersion=collection("Creator":5,"CRM":2,"Mail":8);
product=productVersion.getKey(5);
info product;// Returns "Creator"
products=Collection("Creator","CRM","Mail");
indexNum=products.getKey("CRM");
info indexNum;// Returns 1

getLastKey

The getLastKey function returns the key of a specified value's last occurrence, or the index of a specified element's last occurrence, in a collection.

Return Type

Data type of the return value will depend on the data type of the key.
Returns null if the specified value is not found.
Data type is NUMBER if the index of an element is returned. Returns -1 if the specified element is not found.

Syntax

To get the key of a specified value's last occurrence:

<variable>=<collectionVariable>.getLastKey(<value>);

(OR)

To get the index value of an element's last occurrence:

<variable>=<collectionVariable>.getLastKey(<element>);

where,

Examples

productVersion=collection("Creator":5,"CRM":2,"Mail":5);
info productVersion.getLastKey(5);// Returns "Mail"
products=collection("Creator","CRM","Creator");
info products.getLastKey("Creator");// Returns 2

insert

The insert function adds specified elements or key-value pairs to a collection.

Note: You cannot add key-value pairs into an index-value type collection or elements into a key-value type collection.

Syntax

To insert key-value pairs:

<collectionVariable>.insert(<key>:<value>);

(OR)

To insert elements:

<collectionVariable>.insert(<element>);

where,

Examples

products=collection("Creator","CRM","Campaigns");
products.insert("Analytics");// inserts "Analytics" to the existing collection
productVersion=collection("Creator":5);
productVersion.insert("CRM":5);// inserts the new key value pair to the existing collection

insertAll

The insertAll function adds a list of specified elements or key-value pairs to a collection.

Syntax

To insert key-value pairs:

<collectionVariable>.insertAll(<keyValueList>);

(OR)

To insert elements:

<collectionVariable>.insertAll(<elementList>);

where,

Examples

products=collection("Creator","CRM","Campaigns");
products.insertAll({"Analytics","Connect"}); // inserts "Analytics" and "Connect" to the existing collection
productVersion=collection("Creator":5);
productVersion.insertAll({"CRM":5,"Campaigns":2});// inserts the new key-value pairs to the existing collection

intersect

The intersect function returns the common elements present in two given collections.

Return Type

DECIMAL

Syntax

<variable>=<collectionVariable1>.intersect(<collectionVariable2>);

where,

Examples

products1=collection("Creator","CRM","Books");
products2=collection("Creator","CRM","Mail");
info products1.intersect(products2);// returns "Creator", "CRM"

isEmpty

The isEmpty function takes an expression as argument. It returns true if the value resolved by the expression is empty. Otherwise, it returns false.

Note: Please refer to the differences between isBlank(), isNull() and isEmpty() and how data can be validated.

Return Type

BOOLEAN

Syntax

<variable> = <expression>.isEmpty();

where,

Examples

listVar={"Projects","Mail",{"Zoho Creator","Zoho CRM"}};
info listVar.isEmpty();//returns false
collVar=Collection();
info collVar.isEmpty();//returns true
mapVar=Map({"key1":"value1","key2":"value2"});
mapVar={};
info mapVar.isEmpty();//returns true
textVar=" ";
info textVar.isEmpty();//returns false

keys

The keys function returns the keys (from key value pairs), or elements, present in a collection.

Return Type

LIST

Syntax

<variable>=<collectionVariable>.keys();

where,

Examples

productVersion=collection("Creator":5,"CRM":2,"Mail":8);
info productVersion.keys();// returns "Creator", "CRM", "Mail"
products=collection("Creator","CRM","Mail");
info products.keys();// returns "Creator", "CRM", "Mail"

percentile

The percentile function takes a numerical value 'n' as argument, and returns the nth percentile in a collection of values

Note:

This task is applicable to all services except Zoho Creator.

A percentile is a value below which a given percentage of values in a data set fall.

Return Type

NUMBER/DECIMAL

Syntax

<variable>=<collection>.percentile(<n>);

where,

Examples

Let's consider a collection of numerical values. Calculating the 50th percentile of the collection of numbers.

marks=Collection(300,455,124,926,780);
info marks.percentile(50); // returns 455

Percentile calculation:

Multiply the percentile (50 in this case)to be calculated with the number of elements (5 in this case).
Dividing the product by 100, we get 2.5 (50*5/100 = 2.5)
Rounding up the result to the nearest whole number, we get 'n' (3).
Ordering the collection in ascending order, we get {124,300,455,780,926}.
Find the n'th (3rd) value from the collection. 455 is the 50th percentile for the collection.

size

The size function returns the number of values or elements present in a collection.

Return Type

NUMBER

Syntax

<variable>=<collectionVariable>.size();

where,

Examples

productVersion=collection("Creator":5,"CRM":2,"Mail":8);
info productVersion.size(); // Returns 3
products=collection("Creator","CRM","Mail");
info products.size();// Returns 3

sort

The sort function sorts the elements, or key value pairs based on values in a collection.

Syntax

<collectionVariable>.sort(<booleanValue>);

where,

Examples

productVersion1=collection("Creator":5,"CRM":2,"Mail":8);
productVersion1.sort();// collection becomes {"CRM":2,"Creator":5,"Mail":8}
productVersion2=collection("Creator","CRM","Mail");
productVersion2.sort(false);// collection becomes {"Mail", "Creator", "CRM"}

sortKey

The sortKey function sorts the keys in a collection containing key-value pairs.

Syntax

<collectionVariable>.sortKey(<booleanValue>);

where,

Examples

productVersion=collection("Creator":5,"CRM":2,"Mail":8);
productVersion.sortKey();// Collection becomes {"CRM":2,"Creator":5,"Mail":8}

toCollection

The toCollection function takes an expression as an argument, and returns a collection.

Return Type

COLLECTION

Syntax

<variable>=<expression>.toCollection();

where,

Examples

products = "{company:Zoho, product:Deluge}";
info products.toCollection(); // Returns the collection as a key-value pair - {"product":"Creator","company":"Zoho"}
products = "{company, Zoho, product, Deluge}";
info products.toCollection(); // Returns the collection as a list - "product,Creator,company,Zoho"

update

The update function updates a specified value of a key or a specified element in a collection.

Syntax

To update the value of a key:

<collectionVariable>.update(<key>,<updateValue>);

(OR)

To update an element:

<collectionVariable>.update(<elementIndex>,<updatedValue>);

where,

Examples

products=collection("Creator","CRM","Campaigns");
products.update("2","Analytics");//replaces "Campaigns" with "Analytics"
productVersion=collection("Creator":5,"CRM":2)
productVersion.update("CRM",3);// replaces the value 2 with 3

values

The values function returns the values (from key value pairs), or elements, present in a collection.

Return Type

LIST

Syntax

<variable>=<collectionVariable>.values();

where,

Examples

productVersion=collection("Creator":5,"CRM":2,"Mail":8);
info productVersion.values(); // Returns 5, 2, 8
products=collection("Creator","CRM","Mail");
info products.values();// Returns "Creator", "CRM", "Mail"

notContains

Overview

The notContains() function takes inputValue and searchValue as arguments. It returns true if the inputValue does not contain the searchValuet. Otherwise, it returns false.

Note: This function performs a case-sensitive search.

Return Type

Boolean

Syntax

<variable> = <inputValue>.notcontains( <searchValue> );

(OR)

<variable> = notContains(<inputValue>, <searchValue> );

Examples

/*The notContains() function on TEXT input value*/
products="Zoho Creator";
boolVal=products.notContains("Creator");// returns false
/*The notContains() function performs a case-sensitive search*/
products = "Zoho Creator";
boolVal = products.notContains("CREATOR");// returns true
/*The notContains() function on LIST*/
products =List();
products.add("Creator");
products.add("CRM");
products.add("Cliq");
boolVal = products.notContains("Books");// returns true
/*The notContains() function on MAP input value*/
product_details = Map();
product_details.put("product","Creator");
product_details.put("subscription","yearly");
boolVal = product_details.notContains("price");// returns true
/*The notContains() function on index-value Collection*/
products = Collection();
products.insert("Creator");
products.insert("CRM"); boolVal = products.notContains("Cliq");// returns true
/*The notContains() function on key-value collection*/
product_details = Collection();
product_details.insert("product","Creator");
product_details.insert("subscription","yearly");
boolVal = product_details.notContains("subscription");// returns false

Zoho CRM Training Programs

Learn how to use the best tools for sales force automation and better customer engagement from Zoho's implementation specialists.

Redefine the way you work

with Zoho Workplace

Start your free trial

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.

Create, share, and deliver

beautiful slides from anywhere.

Get Started Now

Zoho Sign now offers specialized one-on-one training for both administrators and developers.

BOOK A SESSION

Zoho Workerly Home
Forums
Connect With Us:

Zoho Recruit Home
Forums
Connect With Us:

Start tracking your website metrics today

Use PageSense to understand what your visitors are looking for, how they are behaving, and where they are facing problems on your website.

Ready to improve your website's performance?

Install the PageSense code snippet on your site in a matter of minutes and start collecting in-depth data about the website visitors to grow your business.

Track and measure every business goal

Set up goals in PageSense to measure every single action performed by visitors on your website like button or link clicks, form submissions, and page engagements.

Understand the customer journey on your website

Create funnels in PageSense to quickly see which pages visitors use to enter your website, where they navigate to next, and which pages they decide to leave without converting.

Visualize your visitor's behavior with color codes

Set up heatmaps in PageSense to see where users have clicked more, how far they've scrolled, and on which parts of a page they've spent the most time using color-coded patterns in reports.

Measure customer engagement with your web forms

Use form analytics in PageSense to see how people interact with different fields in your form, whether they complete the form successfully or not, and where exactly they drop out on your form.

Record real visitor interactions on your website

Use session recordings in PageSense to watch a video of all the visitor actions performed on your website including the pages they navigate, the buttons they click, the UX issues they face, and more.

Test and optimize webpages for better conversions

Run A/B or Split URL tests in PageSense to figure out which version of your web page works best for your business and results in the best conversion rate.

Give each customer a unique website experience

Use personalization in PageSense to deliver customized versions of your website for every individual customer based on their demographics, local weather, browsing history, and more.

Grow your business through customer feedback

Run polls on your website using PageSense to understand what your customers think about your products/services and what needs improvement on your site.

Send timely updates that customers love

Use web push notifications in PageSense to schedule and notify your customers about an upcoming flash sale, product releases, promotional coupons, and a lot more that can spark conversions on your website.

Advertise your business to website visitors

Use pop-ups in PageSense to instantly grab the attention of visitors by showing attractive signup offers, coupon code discounts, or email newsletters that can eventually convert them into subscribers.

Access more advanced settings in PageSense

Use PageSense's advanced features like creating mutually exclusive groups, enabling cross-domain tracking, configuring customized project JS, and more to get deeper insights about your website.

Try easy-to-use extensions

Download the PageSense extension app available for your web browser with a few clicks and start collecting all of your required website metrics in real time.

Discover your favorite integrations with PageSense

Get a deeper look at your website's data by seamlessly integrating PageSense with a host of popular third-party apps like Google Analytics, Mixpanel, Intercom, and more.

Quick Links	Workflow Automation	Data Collection
Web Forms	Enterprise	Begin Data Collection
Interactive Forms	Workplace	Data Collection App
Offline Forms	Customer Service	Accessible Forms
Digital Forms	Marketing	Forms for Small Business
HTML Forms	Education	Zoho Forms for Enterprise
Contact Forms	E-commerce
Lead Generation Forms	Healthcare
Wordpress Forms	Customer onboarding
No Code Forms	Construction
Free Forms	Travel
Prefill Forms	Non-Profit
Intake Forms
Form Designer
Card Forms
Assign Forms
Translate Forms
Electronic Forms
Notification Emails for Forms
Holiday Forms
Form to PDF
Email Forms CRM Forms Embeddable Forms Drag and Drop form builder

Zoho Pagesense Resources

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.

New to Zoho Survey?

Access Zoho Survey

Latest Feature Updates

Explore our Pricing & Plans

Zoho Survey Resources

Android Mobile Surveys

Insurvey Blogs

Insight Blogs

Tips & Tricks

New to Zoho Social?

Manage your brands on social media

Access Zoho Social

Zoho Desk Resources

Desk Community Learning Series
Digest
Functions
Meetups
Kbase
Resources
Glossary
Desk Marketplace
MVP Corner
Word of the Day

Zoho Sheet Resources

New to Zoho Forms?

Latest Feature Updates

Explore our Pricing & Plans

Zoho Forms Resources

Secure your business

communication with Zoho Mail

Get started

Mail on the move with

Zoho Mail mobile application

Go Mobile

Stay on top of your schedule

at all times

Get started

Carry your calendar with you

Anytime, anywhere

Get started

Latest Announcements

New to Zoho Sign?

Zoho Sign Resources

Sign, Paperless!

Sign and send business documents on the go!

Get Started Now

Zoho SalesIQ Resources

New to Zoho TeamInbox?

Zoho TeamInbox Resources

Connect with us

New to Zoho ZeptoMail?

LEARN MORE

Latest Feature Updates

Zoho DataPrep Resources

New to Zoho DataPrep?

Access Zoho DataPrep

Zoho DataPrep Demo

Get a personalized demo or POC

Design. Discuss. Deliver.

Create visually engaging stories with Zoho Show.

Get Started Now

New to Zoho Workerly?

Access Zoho Workerly

New to Zoho Recruit?

Access Zoho Recruit

New to Zoho CRM?

Signup Now

Access Zoho CRM

Latest Feature Updates

New to Zoho Projects?

Access Zoho Projects

New to Zoho Sprints?

Access Zoho Sprints

You are currently viewing the help articles of Sprints 1.0. If you are a user of 2.0, please refer here.

You are currently viewing the help articles of Sprints 2.0. If you are a user of 1.0, please refer here.

New to Zoho Assist?

Access Zoho Assist

New to Bigin?

Signup Now

Access Bigin

Latest Feature Updates

Related Articles
Data Access - Collection variable
This guide will help you with the following: Overview Declaring a collection variable Aggregate functions Fetch field value from the first record Fetch values of a field from all the records in a collection Updating field value in a collection ...
Collection data type
This guide will help you with the following: Overview Types Create a collection Insert data into a collection Retrieve data from a collection Iterate through a collection List/Map vs Collection Note: Collection data type is not to be confused with a ...
Logical Functions
The guide helps you with the following: 1. Difference between isBlank(), isNull() and isEmpty() functions 2. Equals 3. isBlank 4. isEmpty 5. isNull 6. isValidObject Difference between isBlank(), isNull() and isEmpty() functions The table below lists ...
XML and JSON functions
Difference between getJson and get The major difference between getJson and get functions is the type of data on which the two functions work. The getJson function is meant to be performed on TEXT type which is in json or key-value format. The get ...
Functions
This guide helps you with the following: Create Functions Normal Functions REST API Functions Invoke Functions Edit Functions Delete Functions Rest API Functions Authentication Version 2.0 Version 1.0 Example Comparison of Version 2.0 and 1.0 ...