# Creating a custom project report [edit]

This Help topic describes how to create your own custom project report in Aptana Studio Pro.

## Introduction

In addition to generating the standard project reports included with Aptana Studio pro, you can also easily create your own custom report using a template. The instructions below describe how to set up the report template and generate your report.

## Instructions

To create a custom project report:

1. Import the sample project template from the Samples View into your Project View:
   1. Open the Samples View. (Go to Window > Show View > Other... > Aptana Views > Samples.)
   2. In the Samples View, expand Reporting and select the Sample ReportBold text folder.
   3. Click the Import sample as project... button to import this sample into your Project View as a project.
2. Edit the report template that you just imported:
   1. In your Project View, locate the project named Sample Report.
   2. Open sample_report.js in the JavaScript editor.

      This file contains the Eclipse Monkey script that generates the report. See Scripting with Eclipse Monkey for more information about Eclipes Monkey scripts. You can modify the JavaScript in this file just as you would any other JavaScript.

   3. Open sample_report.html in the HTML editor.

      This file contains the HTML that formats and displays your report.

   4. Make your modifications to the report JavaScript and/or HTML.
   5. Save your changes.

      You may need to refresh the scripting environment (click the Refresh button in the Scripts View) or re-start Aptana for the changes to take effect.

3. Generate your new report:
   1. Open the Scripts View (Window > Show View > Other... > Scripting > Scripts).
   2. In the Scripts View, expand the Reporting folder.

      Unless you renamed it, your custom report will be the one named Sample Report in this folder.

   3. In the Project View, select the project that you want to use to generate the report.
   4. In the Scripts View, double-click the Sample Report script.

Aptana Studio generates the sample report for your project and displays it as an HTML document in the Editor window.

Note: You can set up a hotkey shortcut or menu command to generate your report by adding the appropriate metadata (e.g. "KEY" or "MENU" settings) to the metadata section of the script. See Adding metadata to an Eclipse Monkey script for more information.

## Related Topics

- Generating a project report
- Upgrading to Aptana Studio Pro
- Creating a new Eclipse Monkey script
- Adding metadata to an Eclipse Monkey script

Retrieved from "http://aptana.com/docs/index.php/Creating_a_custom_project_report"

Category: AptanaHelp