Page parameters | Zoho Creator Help

Understand passing parameters to a page


Note: Page parameters are now improvized as page variablesAll your existing page parameters have been moved to the Page Variables and Script  tab at the top-right of the page builder.  In this tab, you can continue to use these parameters as variables, create new page variables, and continue to pass values to them similar to page parameters. Additionally, you can configure custom logic in your page scripts to modify and manipulate these variables.

Parameters are named values that are appended to your page URL as a query string. Page parameters are used to pass values to pages, similar to how we pass arguments to functions. They can pass data across the pages of applications in your Creator account. For example, displaying the employee details working in a selected department, displaying order details based on order ID and so on.

Using parameters

The page elements where parameters can be used are listed below:

  • Panels
    • Display : The display aspect of text and button in a panel can be configured to display the required data.  Learn how
    • Action : The action aspect of text, image and button in a panel can be configured to display the required data.  Learn how
    • Image : The images in a panel can be configured to display the required data.  Learn how
  • Chart : You can set a filter (criteria) or use ZML attributes to filter the data based on the parameter value.  Learn how
  • Gauge : You can set a filter (criteria) or use ZML attributes to filter the data based on the parameter value.  Learn how
  • Search : The search element can be configured to display the search results (page or report) based on the page parameter.  Learn how
  • Form : You can set the value of the fields in a form to display the data based on the page parameter.  Learn how
  • Report : You can set a filter (criteria) or use ZML attributes to filter the data based on the parameter value.  Learn how
  • Snippets : You can display data inside HTML and ZML snippets based on the parameter value.  Learn how
  • Button :
    • Display : The display aspect of a button in a panel can be configured to display the required data.  Learn how
    • Action : The action aspect of a button in a panel can be configured to display the required data.  Learn how
    • Image : The images in a panel can be configured to display the required data.  Learn how

Things to know

  • You can use page parameters to set  dynamic values  while loading a page.
  • Parameters and their values are placed in the  query string  portion of the URL that follows a question mark. They are comprised of a key and a value pair, separated by an equal sign. For example,
    https://<domain>/<account_owner_name>/<appLinkName>/#<pageLinkName>?param1=<value>

    Here,  param1  is the page parameter and its value follows the equal sign. This URL format allows the data to be retained on browser refresh and reload. 

  • Pages can be filtered using  multiple parameters . The ampersand ( & ) character is used to separate the parameter-value pairs. For example,
    https://<domain>/<account_owner_name>/<appLinkName>/#<pageLinkName>?param1=<value>&param2=<value>

Naming parameters

  • Parameter names are  case-sensitive .
  • You can name parameters using letters (English), numbers, and the underscore character (_).
  • A parameter name must start with a letter. String, number (including record ID), date, and Boolean values can be passed as page parameter values.
  • By default, the maximum number of characters allowed in a parameter name is 100.

Example

Imagine you've created an application called  Order Management . In this application, you have designed a parameterized page titled  Track your Order  that displays the order details upon entering the respective  tracking ID  (record ID). In addition to a page parameter named  tracking_id , this page has the following components:

  • An  embedded stateless form  containing a single line field named  Enter your tracking ID  in which users enter their tracking IDs. Upon form submission, it'll load the same page but with the page parameter (tracking_id) appended to the page URL in the format :
    pageParam=singleLineFieldInput 
  • HTML snippet  that is configured to display the order details in the form of a table based on the input tracking ID.

Creating the parameterized page

parameterized page  is the page that has application-level parameters to hold the input (in the form of parameter values) and render the required data on the same page. For example, you have designed a parameterized page titled  Track your Order  and added a parameter named  tracking_id . Here, the parameter values are record IDs, which are unique values for each record (order summary). Upon entering the record ID, the order details are displayed in the same page. You can create a page by following the steps in  this  page and specify the page name as  Track your Orders

Adding a parameter to your page

  1. Edit your app.
  2. Navigate to the  Design  tab and open the  page builder .
  3. Click the  Gear  icon near the top-right corner of the page builder. The  Page properties  pane will appear.
  4. Click  Add Paramete r under  Parameter  section. 
  5. Type the parameter name as  tracking_id  and click  Add .

  6. Close the  Page properties  pane.

Embedding a stateless form in your page

  1. Edit your app.
  2. Navigate to the  Design  tab and open the  page builder .
  3. Select  Form  from the palette on the left and choose the stateless form named  Order Tracking .
  4. Click and drag the form under  Embed as Form  option to embed the form into the page.

  5. Click the  Configure  option in the toolbar at the top-center of the page builder. The  Form Embed Configuration  pane will slide in from the right
  6. Under the  Field values  tab, click  Configure values . Specify the value as  tracking_id  (page parameter) beside the  Enter your tracking ID  field.

  7. Click  Done  at the top-right to save the configuration.

Adding a HTML snippet to your page

  1. Edit your app.
  2. Navigate to the  Design  tab and open the  page builder .
  3. In the page builder, click  Snippets  on the left, then drag and drop the  HTML Snippet  on to the required position on your page. The  HTML Snippet  editor will appear.

  4. Add the required HTML (to create a table that displays the order details), CSS, and Deluge code. Below image shows a reference code to filter and display record details using record ID in the HTML snippet.

  5. Click  Save  and close the editor.
  6. Access the live  Track Your Order  page and enter your tracking ID. 
  7. Click  Track  to display the order details. The below gif shows how the order details are displayed based on the  tracking_id  parameter:


    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 CRM Training
      Redefine the way you work
      with Zoho Workplace

        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 CRM Training

          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










                                    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.




                                        Manage your brands on social media

                                          Zoho Desk Resources

                                          • Desk Community Learning Series


                                          • Digest


                                          • Functions


                                          • Meetups


                                          • Kbase


                                          • Resources


                                          • Glossary


                                          • Desk Marketplace


                                          • MVP Corner


                                          • Word of the Day


                                            Zoho Marketing Automation

                                              Zoho Sheet Resources

                                               

                                                  Zoho Forms Resources


                                                    Secure your business
                                                    communication with Zoho Mail


                                                    Mail on the move with
                                                    Zoho Mail mobile application

                                                      Stay on top of your schedule
                                                      at all times


                                                      Carry your calendar with you
                                                      Anytime, anywhere




                                                            Zoho Sign Resources

                                                              Sign, Paperless!

                                                              Sign and send business documents on the go!

                                                              Get Started Now




                                                                      Zoho TeamInbox Resources



                                                                              Zoho DataPrep Resources



                                                                                Zoho DataPrep Demo

                                                                                Get a personalized demo or POC

                                                                                REGISTER NOW


                                                                                  Design. Discuss. Deliver.

                                                                                  Create visually engaging stories with Zoho Show.

                                                                                  Get Started Now









                                                                                                      • Related Articles

                                                                                                      • Configure parameters for page elements

                                                                                                        Note: Page parameters are now improvized as page variables! All your existing page parameters have been moved to the Page Variables and Script tab at the top-right of the page builder. In this tab, you can continue to use these parameters as ...
                                                                                                      • Understand Page Builder

                                                                                                        1. What Does this Page Cover? Learn about the page builder and how you can customize your page and its elements according to your business needs. 2. Availability Pages can be created in all plans of Creator. Only the super admin, admins, and ...
                                                                                                      • Add and manage parameters

                                                                                                        Note: Page parameters are now improvized as page variables! All your existing page parameters have been moved to the Page Variables and Script tab at the top-right of the page builder. In this tab, you can continue to use these parameters as ...
                                                                                                      • Understand ZML snippet

                                                                                                        Snippets are stand-alone, re-usable code pieces that can add additional functionality. ZML or Zoho Markup Language is a simple markup language used to create pages in your Zoho Creator Appliction. Using ZML, you can build various elements of your ...
                                                                                                      • Understand publishing a page

                                                                                                        This help page is for users in Creator 6. If you are in the older version (Creator 5), click here. Know your Creator version. All components in your Creator applications are subject to access control. In other words, only users you've permitted are ...
                                                                                                        Wherever you are is as good as
                                                                                                        your workplace

                                                                                                          Resources

                                                                                                          Videos

                                                                                                          Watch comprehensive videos on features and other important topics that will help you master Zoho CRM.



                                                                                                          eBooks

                                                                                                          Download free eBooks and access a range of topics to get deeper insight on successfully using Zoho CRM.



                                                                                                          Webinars

                                                                                                          Sign up for our webinars and learn the Zoho CRM basics, from customization to sales force automation and more.



                                                                                                          CRM Tips

                                                                                                          Make the most of Zoho CRM with these useful tips.



                                                                                                            Zoho Show Resources