Fetch a field's value

Fetch a field's value

Note:

  • This task is applicable only to Zoho Creator.

Overview

The fetch record deluge task retrieves records from a specified form, when a given criteria is met.

This page will explain how to fetch a specified field's value from the first record in the collection of records.

See this page to learn about fetching all values of a field in a collection.

Note:

  • The fetched records may appear to be sorted based on "added time" (oldest first) system field. However, there is no guarantee to this order and there is no guarantee that the order will remain constant over time. If you are particular about the sequence of the records, it is advisable to use the sort param.

Return

This task returns a specified field's value from the first record in a collection.

The returned field value can be put to further use like updating it.

Syntax

To fetch a specified field's value from the first record which meets the criteria

<variable> = <form_link_name>[<criteria>].<field_link_name>;

To fetch a specified field's value from the first record of all the records sorted in ascending order, which meet the criteria

<variable> = <form_link_name>[<criteria>].<field_link_name>sort by <field_link_name>;

To fetch a specified field's value from the first record of all the records sorted in descending order, which meet the criteria

<variable> = <form_link_name>[<criteria>].<field_link_name> sort by <field_link_name> desc;

To fetch a specified field's value from the first record of all the records in the specified range, which meet the criteria

<variable> = <form_link_name>[<criteria>].<field_link_name> range from <start_index> to <end_index>;

To fetch a specified field's value from the first record of all the records in the specified range sorted in ascending order based on a field, which meet the criteria

<variable> = <form_link_name>[<criteria>].<field_link_name>sort by <field_link_name>range from <start_index> to <end_index>;

To fetch a specified field's value from the first record of all the records in the specified range sorted in descending order based on a field, which meet the criteria

<variable> = <form_link_name>[<criteria>].<field_link_name>sort by <field_link_name> descrange from <start_index> to <end_index>;
ParameterDescription
<variable>Variable holding the specified field's value
<form_link_name>

Link name of the form from which the records will be fetched.

<criteria>

Criteria based on which the records will be fetched.

[<criteria>].<field_link_name>

Link name of the field whose value has to be retrieved.

sort by <field_link_name>

Link name of the field based on which records will be sorted.

 

range from <start_index> to <end_index>

Records falling in the specified index range will be fetched.

<start_index>

Start index of the range of records to be fetched.

Both, 0 and 1 are considered as the index number of the first record when used in <start_index> param.
If 0 is the specified start index, the last index is numbered from 0. If 1, or any number greater than 1, is the specified start index, the last index is numbered from 1.
So let's say we have records - A (index 1), B (index 2), C (index 3), D (index 4), and E (index 5). 
Range from 0 to 3 will fetch A, B, C, D
Range from 1 to 4 will fetch A, B, C, D
Range from 2 to 4 will fetch B, C, D

<end_index>

Last index of the range of records to be fetched.

Negative index values will return a runtime error.

Things to keep in mind

  • If you wish to fetch all records of the specified form, use the following script as criteria:
    [ID != 0]

    It is advisable to fetch all records only when absolutely needed. Fetching all records generates a load resulting in performance issues.
  • If you wish to use the "sort" and "range" parameters together, the "sort" parameter should be followed by the "range" parameter.
  • The Name and Address fields do not work with the sort by param.

This task can be used in the following events

When a record is Created
On LoadYes
On ValidateYes
On SuccessYes
On User inputYes
Subform on add rowYes
Subform on delete rowYes
When a record is Created or Edited
On LoadYes
On ValidateYes
On SuccessYes
On User inputYes
Subform on add rowYes
Subform on delete rowYes
When a record is Edited
On LoadYes
On ValidateYes
On SuccessYes
On User inputYes
Subform on add rowYes
Subform on delete rowYes
When a record is Deleted
On ValidateYes
On SuccessYes
Other workflow events
On a scheduled dateYes
During approval processYes
During payment processYes
In a Custom FunctionYes
In an Action item in reportYes

Example

1) The following script fetches the value of the "name" field from the record which appears at the top after the records have been sorted based on the age field.

EmployeeDetails = Employee[ID != 0 ].name sort by age;

Share this post : FacebookTwitter

Still can't find what you're looking for?

Write to us: support@zohodeluge.com