Export and print URLs for individual records | Zoho Creator Help

Export and print URLs for individual records

Notes
This help page is for users in Creator 6. If you are in the older version (Creator 5), click here. Know your Creator version.
What does this page cover
This page explains about the pre-defined URL formats using which users can print and export the detailed view of a report's record.

1. Overview

Zoho Creator supports URLs to print and export a report's individual records. When the URL is accessed, the record's will be printed/downloaded. These actions can be performed in both unpublished and published reports by using different URL formats.
To export or print records, the URLs can either be accessed directly in the browser or be included in customized actions within the application using the following methods:
  1. Write openURL Deluge task in workflows and functions using the target URL as input
  2. Configure open URL action in page elements using the target URL
  3. Use Redirect to URL action in workflows to navigate to target URL
Notes
Note: To make printed or exported records more attractive and insightful, customize and assign a record template in the Print & PDF tab under Report Properties.
  1. If no record template is set, records will be printed using the default detailed view layout, which can be customized using the canvas builder or record templates.
  2. To export a record as a PDF either using the Export button or pdf export URL, a record template must be configured in the Print & PDF tab.
  3. If both a record template and a detailed view layout are configured, the printed record will follow the template selected in the Print & PDF tab.

1.1 URL formats

1. Reports Accessed from within an Application (Unpublished Reports)
  1. Print
    https://creatorapp.zoho.com/<org_namespace>/<app_link_name>/record-print/<report_link_name>/<record_ID>/
  1. Export as PDF
    https://creatorapp.zoho.com/<org_namespace>/<app_link_name>/record-pdf/<report_link_name>/<record_ID>/<file_name>
  1. Print
    https://creatorapp.zohopublic.com/<org_namespace>/<app_link_name>/record-print/<report_link_name>/<record_ID>/<private_key>/
  2. Export as PDF
    https://creatorapp.zohopublic.com/<org_namespace>/<app_link_name>/record-pdf/<report_link_name>/<record_ID>/<file_name>/<private_key>/
where,
Placeholder
Explanation
<org_namespace>
Link name of the organization in which the application holding the target report has been created.

Retrieve the link name using the :
  1. Creator report's URL - https://creatorapp.zoho.com/<org_namespace>/<app_link_name>/#Report:<report_link_name>
  2. Deluge script with the system variable zoho.adminuser
<app_link_name>
Link name of the application from which the record is to be printed/exported.

Retrieve the link name using the:
  1. Creator report's URL - https://creatorapp.zoho.com/<org_namespace>/<app_link_name>/#Report:<report_link_name>
  2. Deluge script with the system variable zoho.appname
<report_link_name>
Link name of the report whose record is to be printed/exported. 

<record_ID>
Record ID of the record that needs to be printed/exported. To retrieve this, add the ID field while configuring fields for web in a report. The record ID will then be displayed along each record in the live mode of the application.
<file_name>
The name in which the record needs to be downloaded. Provide any appropriate name of your choice with a maximum of 100 characters.
Notes
Note: This is optional when a record is exported from an unpublished report. By default, file name will be the name of the report.

<private_key>
(Applicable only for published reports)
The set of alphanumeric characters following the report link name in the permalink. It is the last path of the URL which is obtained after publishing the report.

Retrieve private_key using the Creator report's permalink:

"Kf96ZkqG85MBOHMbQsQKCdGPygrRZAhZjGebZjJ" is the private_key.

1.2 See how it works


1.3 Use case

1. Export Record as PDF using openURL task in successful form submission Workflow - In an Order Management application, say a customer enters details, such as address, contact email, and more, in a form Create Order. Upon submission, they need a downloaded copy of the acknowledgement for future reference. To achieve this, a Successful form submission workflow is configured. A Deluge script for openUrl task is written that instructs the specified export URL to be accessed. This workflow downloads the order acknowledgement for the customer.

2. Print Record when a Page Element is Clicked On - Say you've built a Course Planner application that helps students track their online educational course. From the Student Dashboard, the students can print the course schedule by clicking a Download Schedule button. This can be achieved by configuring an open URL action for the button (page element). The print URL mentioned in this action will be accessed on click of the page element in the live mode. It prints the specified course's schedule that is stored as a record in a Course Schedule form.

  1. openURL task
  2. open URL action
  3. Understanding report publish
  4. Download the detailed view of a record as PDF

What's next
Previous
What's next
Explore our URL Patterns help pages to play-around urls and get the best outcomes.
Previous