How to Create Custom SapphireOne Reports

Overview of Custom SapphireOne Report Creation

This simplified overview outlines the process of creating a new custom SapphireOne report, either from a blank template or by using a pre-defined template as a starting point. Further articles within this Report Procedures category will provide more detailed guidance.

Creating a New Custom SapphireOne Report

  1. Enter the paper stock dimensions in points (e.g. 842 by 595 for portrait or 595 by 842 for landscape A4 stock).
  2. Specify the desired margins.
  3. Enter the report script, which typically begins with SR_PreLoad.
  4. Add and configure the objects that comprise the report. Refer to previous articles in this Report Procedures category for detailed guidance.
  5. Click the Setup button. SapphireOne will open the print dialogue for the workstation being utilised. Ensure the correct orientation (portrait or landscape) is selected and configure any other necessary settings. Save or print to retain these settings for subsequent print runs. Previewing a PDF is the most economical approach.
  6. Save the report. SapphireOne will prompt you to save or discard before exiting. Alternatively, open the File menu on the toolbar and select Save to disk. In the following dialogue, assign a unique name to your document. The saved template will have an .xml extension.

Pre-Defined Custom SapphireOne Reports in the Installer

The installer includes several reports. Instead of starting with a blank template, we recommend choosing a report similar to your desired outcome and customising it. While the layouts of reports may differ, most standard report details are consistent across companies.

You can adjust the layout while preserving the pre-defined object links to the data in your data file.

Make sure not to overwrite the pre-defined template. Open the File menu on the toolbar and select Save to disk. In the following dialogue, assign a unique name to your document.

Special Function Scripts

Occasionally, highly specific scripts may be required to achieve a desired outcome, and these will generally need to be entered by one of our programmers as a support request. Upcoming articles will provide examples of scripts taken from various reports.

You can review our Blog and YouTube channel for additional information and resources on SapphireOne ERP, CRM and Business Accounting software.

Was this helpful?