How to Add Custom Fields to DevExpress Reports
Overview
This tutorial explains how to add your own custom fields to DevExpress reports, such as certificates, invoices, or Statements of Attainment. Adding custom fields allows you to include extra information that isn’t part of the standard template, helping you tailor the report to your organisation’s needs.
By the end of this tutorial, you’ll understand where custom fields can be added in the DevExpress template editor and how they can help you personalise your reports. This overview is designed to give you a clear picture of what’s possible before you move on to the step-by-step process.
IMPORTANT: Before you can add a custom field to DevExpress reports, make sure you’ve already created your custom fields. Please refer to this tutorial for comprehensive steps on how to create custom fields: How to Use Custom Fields.
Step Tutorial
1. From the Dashboard, head to Administration → Templates → Documents.
2. Locate the document template (Invoice, Certificate, or SOA) where you want the custom fields to appear. You may use the search bar to locate it easily. Click the kebab icon beside it, then select Edit Report.
Refer to this image for steps 1 and 2.
3. A new tab will open in your browser; this is the editor where you can add the custom fields.
4. Drag the Label field (A icon) onto the editing page. This will allow you to type in the internal reference ID of the custom field you want to add.
5. Once it has been added to the editing page, click the field to view its properties. From the Properties tab (right panel), under the Text field, enter the internal reference ID of the custom field. Please note that you must add curly brackets before the internal reference ID (e.g. {CF0001}).
NOTE: The Internal Reference ID can be found here:
6. Repeat the process until you have added all the custom fields you want to include. Once you’re done, click the hamburger icon, then select Save.
7. Try issuing the document you edited to a student and check if the custom field you added is reflected. For example, here’s our generated template:
These are the steps for how to add custom fields to DevExpress reports.
Congratulations on completing this tutorial. We hope this has been helpful to you and your organisation. For any questions or concerns regarding this function, please reach out to the contact support via email.