Generating Reports

You can generate reports in multiple output formats, including PDF, HTML, Microsoft Word, and so on. Report features may vary depending on the report output format.

The size and complexity of a report impacts the time required to generate the report. Oracle recommends that you limit the scope of a report to the most specific part of the solution as possible, and to define the filtering criteria as narrowly as possible. For example, instead of generating one large report, generate sets of complimentary reports that describe subsets of a solution to improve report generation times.

When reports contain data from sealed projects and from unsealed projects, it may be difficult to distinguish data under active development from static data included in sealed projects. Generate reports that are specific to sealed projects separately from the reports that are specific to the active solution.

System administrators can include report generation in a continuous integration cycle by using Ant tasks. See the Design Studio System Administrator's Guide for more information.

Note:

Design Studio reports do not automatically update when changes are made to the report source data.

You can generate reports using data from projects that contain errors, but some content may fail to appear, depending on the error. For example, content defined with an invalid reference will fail to appear in a report.

To generate a report:

  1. Build the projects that contain the data to be included in the report.

    Design Studio includes the data from the last project build. To generate a report with the latest model information, perform a clean build. See "Running Clean Builds" for more information.

  2. From the Studio menu, select Generate Report.

    The Generate Report dialog box appears.

  3. Do one of the following:

    • To generate a report using a report design that is included in the Design Studio feature installation, select Select a report design from the list, and then select the report.

    • To generate a report using a report design that you have saved on a local file system, select Select a report design from a file, and then select the report.

  4. Click Next.

  5. In the Report Content area, do one of the following:

    • To generate a report by projects, select Content by project and then click Select. In the dialog box, select one or multiple projects to include and then click OK. When you select this option, all entities in the projects are included. You can refine the scope by using the Project Dependencies field.

    • To generate a report by entity, select Content by entity and then click Select. In the dialog box, select one or multiple entities to include, and then click OK. When you select this option, the scope begins from the selected entity and includes all entities related to the selected entity. You can refine the scope by using the Project Dependencies field.

  6. In the Project Dependencies field, select one of the following:

    • Include all content in referenced reports: When generating a report by project, select this option to include all content in the selected projects as well as all content in all dependent projects. When generating a report by entity, select this option to include all related entities in the selected entity project and related entities in all dependent projects.

    • Include only unsealed content in referenced reports: When generating a report by project, select this option to include all content in the selected projects as well as all content in all unsealed dependent projects. When generating a report by entity, select this option to include all related entities in the selected entity project and related entities in all unsealed dependent projects. When you select this option, no content from sealed dependent projects is included.

      Oracle recommends that you select this option.

    • Exclude content in referenced reports: When generating a report by project, select this option to include only the content in the selected projects, but no content from any dependent projects. When generating a report by entity, select this option to include only the related entities in the same project as the selected entity. When you select this option, no content from dependent projects is included .

  7. In the Output Format field, select the format in which to generate the report.

    For installed Design Studio reference reports, this list is filtered to include only output formats that support the report features and that display the report layout properly. If you are generating a report from a local file, the list is not filtered. You must select an output format that supports the features and layout design.

  8. In the Action field, indicate whether you want to view the report, save the report, or save and view the report.

    You can save reports in any available format. To view a report, you must have an installed version of an application associated with the output format type. For example, you can not view PDF files if you do not have a PDF reader installed.

  9. If you are saving the report, enter the name of the report and the location to which you want to save the report in the Save As field.

  10. Click Finish.

Related Topics

Working with Reports

Contributing Documentation to Reports