Workflow: Custom reports

The typical workflow for defining and running such custom reports is:

1. Create an .xml file to return the results you want. For more information, see Creating a Custom Spreadsheet Report.

   • Optionally define an Excel .xls file to format the data the way you want. In the .xml file, make sure to define the <report> tag "templatePath" attribute to point to the current .xls file).

2. Install the new report by using either of the following methods:

   • Copying the files to user\apriori\version\watchpoint-report-defs

   • Creating a .zip file from the modified .xml and .xls files and clicking

     Tools > Spreadsheet Reports > Install Spreadsheet Reports .

     Copying a new report for the first time requires restarting aPriori ; subsequent update copies do not.

3. Run the report with Reports > Spreadsheet Reports

4. Optional: You can run the custom report (or any system-defined report) from the command line. If you are running this report from the command line and never using it from the UI, you can skip the last two steps and generate the reports as described in "Running from the Command Line".

When you install your custom reports, they reside in your local aPriori user folder, such as:

• C:\Users\myUserName\aPriori\14.1\watchpoint-report-defs

• They are added to the aPriori system-defined reports in apriori_install\ext\cost-watchpoint-report\watchpoints