API Developer Guide
How can we help?
Full Site Search

Retrieving HTML, PDF, Excel, Mail Merge and Custom Print Report of a record

For example, if you have an URL to the record as follows

https://www.ragic.com/demo/sales/1/41

1. Printer Friendly

You can retrieve an HTML printer friendly version like this, by adding a .xhtml to the end:

https://www.ragic.com/demo/sales/1/41.xhtml

2. PDF or Excel Version

You can add a .pdf for a PDF version, .xlsx for an Excel version:

https://www.ragic.com/demo/sales/1/41.pdf
https://www.ragic.com/demo/sales/1/41.xlsx

3. Mail Merge

You can retrieve a Mail Merge of a record, by adding .custom? and a Mail Merge CID to specify which template (which is 1 for the mail merge template used in this case):

https://www.ragic.com/demo/sales/1/41.custom?cid=1

To obtain the cid of a mail merge, you can manually download a mail merge from the Ragic user interface first, and pay attention to the cid parameter in the download url.

https://www.ragic.com/demo/sales/1/41.custom?rn=41&cid=1

4. Custom Print Report

You can retrieve a Custom Print Report of a record by appending .carbone? to the URL, along with the following parameters (joined with &).

https://www.ragic.com/demo/sales/1/41.carbone?fileFormat=pdf&ragicCustomPrintTemplateId=1&fileNameRefDomainId=1001000

(1) File format syntax: fileFormat="file format" (e.g., pdf, png, docx).

Example: fileFormat=pdf

(2) Custom template ID syntax: ragicCustomPrintTemplateId="Template ID".

Example: ragicCustomPrintTemplateId=1

To obtain the "Template ID", first manually click the button to download the Custom Print Report.

Note: You cannot obtain the "Template ID" by clicking Download report from the gear icon next to the report name on the settings page.

After clicking the download button, you can find the Template ID parameter in the download URL displayed in the browser’s address bar.

https://www.ragic.com/demo/sales/1/41.carbone?fileFormat=pdf&fileNameRefDomainId=-1&ragicCustomPrintTemplateId=2

(3) File name referenced field syntax (Optional):fileNameRefDomainId="Field ID".

Example: fileNameRefDomainId=1001000

Share your feedback with Ragic

What would you like to tell us?(required, multi select)

Please provide detailed explanations for the selected items above:

Screenshots to help us better understand your feedback:

Thank you for your valuable feedback!

Start Ragic for free

Sign up with Google

Terms of Service | Privacy Policy