Functionality based URLs

Functionality based URLs

Overview

In the topic Zoho Creator URL Patterns we learned about the default URLs to access a Zoho Creator application and its forms, reports and pages. In this topic, we will learn about the functionality based URLs to set default values for form fields, edit individual records by passing record-ID in the URL, set criteria for and print reports and pages.

All URL formats will use the following:

<base_url>the base URL of your Creator account
For example, its app.zohocreator.com if your account belongs to Zoho's US DC, and is app.zohocreator.eu if it belongs to Zoho's EU DC.
<account_owner_name> is the username of owner of the Creator account in which the application exists
<app_link_name>is the link name of the Zoho Creator application

<form_link_name>
<report_link_name>
<page_link_name>

is the link Name of the component - form, report, or page, respectively

Permalink of Forms, Reports and Pages

You can also access the components (forms, reports and pages) in your Zoho Creator application using their permalinks. As the word suggests, a permalink is a permanent link; it refers to the URL of a particular webpage (a form, report or page, here). 

The format of permalinks of your app's components are as given below:

Permalink of forms 
https://<base_url>/<account_owner_name>/<app_link_name>/form-perma/<form_link_name>

Examplehttps://app.zohocreator.com/sampleapps/employee-manager/form-perma/Basic_Information 

You may embed your form in your website, blog, etc. by using the below given format,

<iframe height='500px' width='100%' frameborder='0' allowTransparency='true' scrolling='auto' src='https://<base_url>/<account_owner_name>/<app_link_name>/form-embed/<form_link_name>'></iframe>
Permalink of reports  
https://<base_url>/<account_owner_name>/<app_link_name>/report-perma/<report_link_name>

Examplehttps://app.zohocreator.com/sampleapps/employees/report-perma/All_Employees 

You may embed your report in your website, blog, etc. by using the below given format,

<iframe height='500px' width='100%' frameborder='0' allowTransparency='true' scrolling='auto' src='https://<base_url>/<account_owner_name>/<app_link_name>/report-embed/<report_link_name>'></iframe>
Permalink of pages 
https://<base_url>/<account_owner_name>/<app_link_name>/page-perma/<page_link_name>

Examplehttps://app.zohocreator.com/sampleapps/employees/page-perma/Complete_Employee_details

You may embed your page in your website, blog, etc. by using the below given format,

<iframe height='500px' width='100%' frameborder='0' allowTransparency='true' scrolling='auto' src='https://<base_url>/<account_owner_name>/<app_link_name>/page-embed/<page_link_name>'></iframe>
Note:

Functionality based URLs for Forms

To set default values for Form Fields

The default values for Form Fields can be set by passing additional parameters in the Form's URL. For example, to automatically load a value for the Field Employee ID in the Employee Manager Application, the default value is passed as query string (Employee_ID=1234) in the Form's URL, where Employee_ID is the Deluge script name of the Field in the Employee Form.

The Form's URL with query string will be in the below formats:

  1. Accessing within the Application:
    https://app.zohocreator.com/zchelp/employee-manager/#Form:Employee?Employee_ID=1234
  2. Accessing via its permalink:
    https://app.zohocreator.com/zchelp/employee-manager/form-perma/Employee?Employee_ID=1234
  3. Accessing a Form, which is embedded in another webpage:
    https://app.zohocreator.com/zchelp/employee-manager/form-embed/Employee?Employee_ID=1234

For the multi select and checkbox fields, there can be the need to set multiple values. For this, the values must be comma-separated in the URL. For example, if the values "Manager" and "Programmer" are to be set for the field Roles in the Employee Form, the URL will be: https://creator.zoho.com/zchelp/employee-manager/#Form:Employee?Roles=Manager,Programmer

Note: The values that are passed as querystring in the URL will be set when the user accesses the form, i.e., On Load of the form.

To load Form without Field focus

You may note that when you access your form in your Zoho Creator application, the focus gets set on the first Field of the Form, i.e., the cursor appears on the first Field of the Form.

Assume that you have a website or blog, in which you have embedded your form. When your webpage is accessed, this default auto-focus behavior will scroll your webpage to where your form is placed. This may hinder a user's experience as the content present above the embedded form gets skipped. To handle this, Zoho Creator provides the zc_Focus parameter.

Value for zc_Focus Intended behavior
true
false

To edit individual records by passing record-ID in the URL

The URL to view and edit individual records using their record-ID is given below. This will display the Zoho Creator Form in Edit mode.

https://<base_url>/<account_owner_name>/<app_link_name>/#Form:<form_link_name>?recLinkID=<record_ID>&viewLinkName=<view_link_name>

Refer to the topic Editing Records via Record ID for more information.

Functionality based URLs for Reports

To filter the data displayed by a Report

You can filter the data displayed by a report by setting the filter criteria as querystring in its URL. Filtering using multiple criteria is supported — use an ampersand character (&) to separate two field-value pairs. Below are examples of filtering the Employee Manager application's Employee View report. This report's URL:
https://app.zohocreator.com/zchelp/employee-manager/#Report:Employee_View

URL format for filtering a report based on the EQUALS operator

https://<base_url>/<account_owner_name>/<app_link_name>/#Report:<report_link_name>?<FieldName1>=<value1>&<FieldName2>=<value2>

where, FieldName1 and FieldName2 are the link names of the fields in the form

Examples:

Note: Here, the date 13-May-2019 is according to the date format set in this Employee Manager application's Settings. The date value that you add as querystring in your report's URL must match the date format set in your application.

URL format for filtering a report based on the STARTS WITH operator

https://<base_url>/<account_owner_name>/<app_link_name>/#Report:<report_link_name>?<FieldName1>=<value1>&<FieldName1_op>=<constant>

where,

Fieldname1is the link name of the Field in your Form
Fieldname1_opis the parameter that links the Fields and Operators
constantis the value that refers to the operator that will act on the respective fields. Refer to this table to view the list of all Operators and their Constants.

Examples:

URL format for filtering a report based on the CONTAINS operator

https://<base_url>/<account_owner_name>/<app_link_name>/#Report:<report_link_name>?<FieldName1>=<value1>&<FieldName1_op>=<constant>

For example, the URL to have this report display only those employee records where the employee is in some administrative role, is as follows. In this application, Role is a checkbox field and 26 is the constant that identifies the CONTAINS operator.
https://app.zohocreator.com/zchelp/employee-manager/#Report:Employee_View?Roles=Admin&Roles_op=26

URL format for filtering a report based on the BETWEEN operator

https://<base_url>/<account_owner_name>/<app_link_name>/#Report:<report_link_name>?<FieldName1>=<StartingValue>;<EndingValue>&<FieldName1_op>=<constant>

where, StartingValue and EndingValue can be a number, decimal value, or date

Example: The URL to have this report display only those employee records where the date of joining is between 10-Sep-2019 and 30-Mar-2020, is as follows. The Date of Joining field in this application is of type date and 58 is the constant that identifies the BETWEEN operator.
https://app.zohocreator.com/zchelp/employee-manager/#Report:Employee_View?Date_of_Joining=10-Sep-2019;30-Mar-2020&Date_of_Joining_op=58

URL format for filtering a report based on other date/date-time specific operators

Note: Refer to the table below for the list of constants that denote the operators

List of Operators and their Constants

OperatorConstant
EQUAL18
NOT_EQUAL19
LESS_THAN20
GREATER_THAN21
LESS_EQUAL22
GREATER_EQUAL23
STARTS_WITH24
ENDS_WITH25
CONTAINS26
NOT_CONTAINS27
LIKE28
EMPTY29
NOT_EMPTY30
YESTERDAY31
TODAY32
TOMORROW33
LAST_7_DAYS34
LAST_30_DAYS35
LAST_60_DAYS36
LAST_90_DAYS37
LAST_120_DAYS38
NEXT_7_DAYS39
NEXT_30_DAYS40
NEXT_60_DAYS41
NEXT_90_DAYS42
NEXT_120_DAYS43
LAST_MONTH44
THIS_MONTH45
NEXT_MONTH46
CURR_PREV_MONTH47
CURR_NEXT_MONTH48
TRUE49
FALSE50
LAST_YEAR51
CURRENT_YEAR52
NEXT_YEAR53
PREVIOUS_2_YEAR54
NEXT_2_YEAR55
CURRENT_PREVIOUS_YEAR56
CURRENT_NEXT_YEAR57
BETWEEN58
THIS_WEEK59
LAST_WEEK60
NEXT_WEEK61
CURRENT_PREVIOUS_WEEK62
CURRENT_NEXT_WEEK63
LAST_N_DAYS64
NEXT_N_DAYS65
LAST_N_WEEK66
NEXT_N_WEEK67
LAST_N_MONTH68
NEXT_N_MONTH69
LAST_N_YEAR70
NEXT_N_YEAR71
IN72

To print a Report

https://<base_url>/<account_owner_name>/<app_link_name>/print/<report_link_name>

Examplehttps://app.zohocreator.com/zchelp/employee-manager/print/Employee_View

To print a Report with criteria

Functionality based URLs for Pages

Pages can also accept URL parameters. You may access the below given URL as an example (parameter emp is being passed a value).

https://app.zohocreator.com/sampleapps/employees/#Page:Complete_Employee_details?emp=support@zohocreator.com

To print a Page with parameter

The URL format to print a Page with parameter is given below,

https://<base_url>/<account_owner_name>/<app_link_name>/print/<page name>?<paramName>=<paramValue>

where,

paramNameis the name of the parameter defined in the Page
paramValueis the value passed to the parameter that is defined in the Page

Example: The URL to print a Page named "TestHTML" with paramName "dept" and paramValue as "Engineering" is given below. Here, the paramName "dept" is the name of the parameter defined in the Page to fetch records with the specified paramValue.
https://app.zohocreator.com/zchelp/employee-manager/print/TestHTML?dept=Engineering

To convert Page to PDF

https://<base_url>/export/<account_owner_name>/<app_link_name>/pdf/<page_link_name>?<param1>=<value>&<param2>=<value>
Note: Creator 5 accounts must include isc5page=true as querystring in this URL

For example https://app.zohocreator.com/export/sampleapps/customer-support/pdf/More_Details_Html_View?ticketID=104
where ticketID is the name of the parameter defined in the Page

You can add the following parameters to customize certain aspects of the output PDF:

ParameterValuesDefault valuePurpose
zc_FileName(as required)The page's display name

To set the name of the output PDF file. For example:
https://app.zohocreator.com/export/sampleapps/customer-support/pdf/Most_Recent_Solution?zc_FileName=DownloadReport

zc_PdfOrientation

portrait, landscapeportrait

To set the orientation in which the page's contents will be exported. For example:
https://app.zohocreator.com/export/sampleapps/customer-support/pdf/Most_Recent_Solution?zc_PdfOrientation=landscape

zc_PdfSizeLetter, A4, Legal, ExecutiveLetter

To set the page size of the output PDF file. For example:
https://app.zohocreator.com/export/sampleapps/customer-support/pdf/Most_Recent_Solution?zc_PdfSize=A4

Limitations

  1. Div embedded Forms/Reports inside Pages is not supported as already discussed in this Forum post. (This will be done only after we provide #include support, i.e., server-side include directive in Deluge. Users will have to change to the new implementation once done to enable PDF output). Refer to our limitations page for more details.
  2. Any authenticated content like images/CSS that requires your current credential will not be supported, i.e., any link/embedding in the Page to be converted into PDF, should be public content.
  3. Any CSS/images and other links to be rendered have to be specified in full path. For example, /images/xyz.jpg will not be properly rendered.
Note: Refer to this page to learn how to control the visibility of the PDF export option for your pages.

Share this post : FacebookTwitter

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

Write to us: support@zohocreator.com