Creating custom report script

With our upcoming release scheduled for Q1 2026, we will upgrade our reporting engine from DevExpress version 21.1.4 to 24.2.7. This upgrade brings improvements, but also changes to the scripting API that may cause your existing custom scripts to stop working if not updated.

📌 What you need to do

To ensure your scripts continue to function correctly:

• Review your custom report scripts.

• Refer to the DevExpress API Reference to update property and method usage where needed. For example:

FieldByName is no longer valid. Use GetFieldByName, which now returns a PivotGridFieldBase instance.

• XRPivotGridField is now XRPivotGridFieldBase.

• Script references like PivotTableStatusPriorityCounts.Fields.FieldByName should be updated to PivotTableStatusPriorityCounts.Fields.GetFieldByName.

🗂 References:

DevExpress API – XRPivotGridFieldCollection

🗂 Devexpress changelog:

https://supportcenter.devexpress.com/versionhistory

🆘 Need Assistance?

If you have troubles updating your report scripts, you will have an option to submit a support ticket, and the aqua team will help you adjust your custom scripts.

We’re here to support you during the transition!

📅 What’s coming next? We’ll keep you informed ahead of time of any changes

Scripting plays a key role in extending the functionality of aqua reports. It allows you to extend the capabilities of the report beyond just using the data contained within aqua. Scripting gives you the ability to enrich the report by extracting data from external sources such as databases or files. You also have the flexibility to save copies of the report to specific network drives and control which items are excluded from printing during each event band iteration.

To run a script on a particular event, you need to add a script function to the element's event. You can do this by linking a script method to the Behaviour/Scripts property. This property lists all the events that the selected element will trigger. These can be different for different element types.

Script linking view

To change to the scripts view, click on . Here, you can add some functionality to your report:

script view

Example: Apply different colour to areas

The appearance can be modified with the event “OnPrintPage”

The appearance doesn't necessarily have to be changed by the script. They can also be changed using formatting rules.

For users in a SaaS environment: Please note that the report script can only be managed from the desktop client.

The information on how to enable scripting mode for the On-Premise customers can be found in this article.