Siebel Reports Administration Guide > Creating a Simple List Report > Example—Creating a Simple List Report >
Creating a Report Design in Actuate e.Report Designer Professional
A report design file defines the layout and behavior for one report. In this exercise, a new report design is created from scratch, using library components.
To create a report design file in Actuate e.Report Designer Professional
- Open Actuate e.Report Designer Professional.
- Choose File > New. In the Create New Report window, select Blank Report and click OK.
A blank design report appears.
- Delete the components Report and SimplePageList in the Content and PageList sections of the blank report.
For removal of Report and SimplePageList components, it is recommended that the components be deleted using the Project Browser:
- Navigate to View > Project Browser > Symbols.
- Delete the following components under the class NewReportApp Subclass Of AcReport:
- Close the Project Browser.
- Choose Tools > Library Organizer.
The Include Library window appears.
- Before adding the libraries remove the two existing sample libraries (erd_sample_library.rol and sample_sfdata_library.rol) and click More.
- Click Browse and navigate to \Siebdev\RPTSRC\LIB (or equivalent), choose sssiebel.rol, and click Open.
- Repeat this step for the files sscustom.rol, Testrept.rol, and sssiebel.bas.
NOTE: If the Testrept.rol library file is not in the folder named in Step b, navigate to \Siebdev\RPTSRC\ENU\LIB (or the equivalent on your system).
- Click OK to close the Include Library window when all the files are added.
- Click OK to close the Library Organizer.
The files sssiebel.rol and sscustom.rol are required libraries for all Siebel standard and custom reports. Testrept.rol is the data supply ROL file that you generated from Siebel Tools; it will define the way data is transferred to the new report.
Components from afc.rol (and or components from the Actuate e.Report Designer Professional toolbar) and sssiebel.rol should not be used by report developers for designing Siebel-Actuate reports. When developing Siebel application reports, only use the sscustom.rol library.
- Right-click on the top-level object (default name NewReportApp) and select Rename.
The Rename window appears.
- Double-click the Testrept (top level) icon in the structure tree.
- In the Component Editor window, click Class.
- Change the Super Class value from AcReport to ssReport.
This is an important step. Siebel reports must inherit from ssReport (the Siebel standard report) instead of directly from AcReportSection (Actuate report). ssReport is provided in sscustom.rol and inherits from baseReport from sssiebel.rol.
NOTE: You cannot perform this step until you have included the sssiebel.rol library.
Two components are automatically added to the report when you change the report's class: a report section (ssRpt) and a pagelist section (ssPageList).
- While still in the Component Editor for the Testrept (top level) icon, click Properties.
- Save the report design by choosing File > Save. Name the report Testrept.rod and specify a location where you want the report to be saved; for example:
Remember to save the design file periodically as you work.
- Make sure that the Show Empty Slots option in View > Options is checked.
You may want to deselect this option at a later time if you find the display of empty slots in the structure tree and layout pane distracting. For now, the empty slots must be visible because components will be dragged onto them from the sscustom library.
- Expand the top-level report component.
- Right-click the report section child component in the structure tree (ssRpt) and select Slot Information. The Single Structure Reference window appears.
- Verify name is set to ssRpt.
- Click Subclass and click Close. The report section child component will now be named ssRpt1. You must subclass each component you introduce into the report if you plan on modifying the component. Otherwise, the system will not allow your changes.
- Right-click the report section component (ssRpt1) and click Rename. Change the name to ssReportOpportunity.
It is good design practice to employ naming conventions for components in your reports and to give them meaningful names. The ssReport prefix indicates that this is a report section based on the ssReport library component. The Opportunity suffix identifies this as the master report section in which opportunity records are displayed.
- Click the Library Browser button and choose Testrept.rol in the dialog box.
The Library Browser window opens, displaying the contents of Testrept.rol, which is the data supply library you generated in Siebel Tools.
- Click the Library Browser button and open the sscustom.rol library. From the Library Browser window, drag and drop the ssFrm component onto the Content slot.
NOTE: When developing Siebel application reports, only use the sscustom.rol library. The use of Actuate components is not supported when modifying or developing reports.
This creates a frame that defines what appears in each report row. The frame is a child of the report section component.
- Right-click the new frame (ssFrm) and select Slot Information. On the Single Structure Reference window, click Subclass. Click Close.
- Right-click the same frame and select Rename. Rename it ssFrmOpportunityContent. Close the Library Browser window.
- Drag and drop the datastream component (ssOpportunityQuery) from the Library Browser window onto the DataStream slot in the Design Editor. Close the Library Browser window.
The datastream component is now a child of the report section component. The datastream defines the way data is supplied to generate report rows. Each data record generates one report row in the parent report section.
When making changes in Siebel Tools for a report originally designed in Actuate e.Report Designer Professional and regenerating an ROL file, be aware of the following:
- Make sure that the ROD file that uses the ROL file is not open in Actuate e.Report Designer Professional.
- If any report fields are deleted, make sure to remove the fields from your Actuate report as well.
- Changes made to the ROL file are valid only for that instance of the ROL file. The changes will need to be entered again. However, if the changes are locally subclassed, they are safely stored in the ROD file.