Siebel Reports Administration Guide > Parameterized Reports > Creating Parameterized Reports >

Using Siebel Tools to Create Parameterized Reports

This section describes how to create and customize reports in Siebel Tools.

To create and customize parameterized reports in Siebel Tools

  1. Create a business component object Revenue Report Parameters.

    Specify the properties of this business component as follows:

    Class and Name properties are required:

    Class = CSSBCVReportParameters.

    Name = Revenue Report Parameters. It is recommended that the business component be named to recognize that it forms the basis for the parameter applet for a specific report.

    Accept the default properties for all other properties of this business component, and any other business component created for a custom parameterized report.

  2. Create the picklists to be used with the field object.

    In the Object Explorer select the Pick List object type and create picklists with the following properties:

    Picklist = Revenue Report By PickList; Revenue Report Show PickList; Revenue Report then PickList

    Business Component = PickList Generic for all picklists

  3. Expand the business component in the Object Explorer and select Field. Create as many fields as the number of parameters in the report. The fields can be created as entry fields or picklists. For entry fields, the creation and association of picklists to business component fields can be skipped.

    There are three parameters in the Revenue Analysis Detail report that allow filtering data at three levels. Therefore, create three fields with the following properties:

    Name and picklist properties are required:

    Name: By In Revenue; Show In Revenue; Then In Revenue.

    PickList: Revenue Report By PickList; Revenue Report Show PickList; Revenue Report Then PickList.

  4. Create an applet for the business component. The applet is the pop-up window that appears as the second or third screen when requesting a parameterized report.

    Set the applet properties as follows:

    Class: CSSSWEFrameReportParam. This class contains the logic for translating the selected parameters into the ROV file in Actuate.

    HTML Popup Dimension: 200 x 200. This is the default size of the pop-up window, but this can be changed depending on the number of parameters.

    Title: Revenue Parameter Applet. Set this property appropriately to represent the parameter applet for a custom parameterized report.

    Business Component: Revenue Report Parameters. This is the name of the business component created for parameter applet in Step 1.

  5. Create an applet Web template to associate with the parameter applet.
    1. Highlighting the applet created in Step 4, expand the Applet object in the Object Explorer.
    2. Select Applet Web Template object and add two applet Web templates with the following required properties:

      Type: Edit. This property specifies the mode in which this applet is rendered at run-time. Type should always be set to Edit since users need to select or enter values for parameters at run-time.

      Web Template: Applet Popup Form. You may select any other Web template that has the desired layout for the parameter pop-up window.

  6. Create the necessary controls for the Parameter pop-up window. These controls include labels, text, parameter fields, and standard controls. The properties for the controls for Revenue Parameter Applet are shown below:

    For standard controls:

    Name: Submit Button; CancelButton. This property can be set to any meaningful name, but it is recommended that they indicate the function of the control.

    Method Invoked: Submit; CloseApplet. This property is required for standard controls and should be left blank for all other controls.

    HTML Type: MiniButton for both of the controls. This property should be set appropriately depending on the type of control. For example, set this value to FieldLabel for the label controls ByLabel, ReportLabel, ShowLabel, and ThenLabel.

    For parameter field controls:

    Name: ByInRevenue; ShowInRevenue; ThenInRevenue. This property can be set to any meaningful name, but it is recommended that the name indicate the function of the control. In Control User Prop, make Name equal to SHOWNONE, where the value equals FALSE. This means that for the dropdown field shown on the UI, a blank entry is not allowed. This avoids the situation where a user clicks enter without selecting a valid value from the dropdown list.

    HTML Type: Field, for all three parameter field controls.

    Field: By In Revenue; Show In Revenue; Then In Revenue. Recall that these are the fields created in Step 2. This property should be left blank for all other controls.

  7. Create a report object to associate with the parameter applet. Set the Parameter Applet property of this report object to the name of the applet previously created.
  8. Include the report object created in Step 7 in the views that should display this report.
  9. Create the Actuate ROL file using Tools > Utilities > Generate Actuate Report.

The configuration in Tools is complete. The next steps involve creating the design in Actuate for the parameterized report.

Siebel Reports Administration Guide