Step 1: Copy the report you plan to modify

The first step is to make a copy of the report you plan to customize.

To set up a custom report:

  1. Log on to the District or Intermediate Organization view.
  2. Select Tools > Reports.
  3. Click the report you want to modify. Its detail page appears.
  4. Highlight the text in the Report ID field (such as SYS-STD-021) and press CTRL-C.
  5. Select Options > Copy.
  6. Type the number of copies you want to create (1) and click OK. The following page appears.

  1. Enter information in the fields:

  2. Field

    Description

    Name

    Type a name that distinguishes the modified report from the original.

    Report ID

    Press CTRL-V to paste the Report ID from the original report (such as SYS-STD-021) and replace the first three letters with a district/school code (such as PPS-STD-021).

    Parent Report > Name

    (Available only in the Intermediate Organizationview)

    Click Search icon. to select the District-level report definition that you want to customize for your district. The XML format definition of the parent report you select will automatically be copied and applied to the customized report.

    Note: You can only customize reports that your district administrator has allowed to be overridden. You cannot modify certain fields of a parent report, including its Java source and weight.

    Category

    Click this drop-down to select the appropriate category for the report.

    Menu group

    Type the name of the Reports sub-menu the report will appear in. For example, Student Labels.

    Note: A submenu requires that at least two reports are assigned to it.

    Sequence Number

    Type a number to indicate the report's placement on the Reports menu.

    Weight

    Type a number to indicate the report’s priority when running multiple reports simultaneously.

    Report engine version

    The report engine version determines which version of iReport must be used to modify the report:

    • Report engine version 1.0.2: iReport version 2.0.4
    • Report engine version 3.0.1: iReport version 3.00

    Format definition

    Do one of the following:

    • Click Edit icon. to edit the report format in XMLClosed eXtensible Markup Language.
    • Click Upload icon. to upload an XML report format.
    • For an existing report, click Download icon. to download the XML report format.
    Note: You will not edit the report definition from here. Editing will be done in iReport.

    Source code

    (Available only in the District view)

    Do one of the following:

    • Click Edit icon. to edit the report's Java source.
    • Click Upload icon. to upload the report's Java source.
    • For an existing report, click Download icon. to download the report's Java source.

    If this is a published report, see Edit the Report's Java Source.

    Input definition

    (Available only in the District view)

    Do one of the following:

    • Click Edit icon. to edit the report's input definition.
    • Click Upload icon. to upload the report's input definition.
    • For an existing report, click Download icon. to download the report's input definition.

    Custom format

    Select this checkbox to indicate the report format has been customized.

    Note: If you modify the default version of a report rather than making a copy, you must select this checkbox or your customizations might be overwritten during an upgrade.

    Custom Java source

    (Available only in the District view)

    Select this checkbox to indicate the report's Java source has been customized.

    Note: If you modify the default version of a report rather than making a copy, you must select this checkbox or your customizations might be overwritten during an upgrade.

    Custom input definition

    (Available only in the District view)

    Select this checkbox to indicate the report's input definition has been customized.

    Note: If you modify the default version of a report rather than making a copy, you must select this checkbox or your customizations might be overwritten during an upgrade.

    Extended Dictionary > Name

    (Available only in the District view)

    The original report’s extended dictionary should be the same for the modified report. Generally, this field will be blank.

    Comment

    Type a description of the modifications you are making to the report, for documentation purposes.

    Schedulable

    Select this checkbox to permit this report to be run on a schedule.

    Allow override

    (Available only in the District view)

    Select this checkbox to permit this report to be customized at the Intermediate Organization level.
  1. If logged on to the District view, you can add external sources (sources of re-usable code) that will be used by the report. To do so:
    • Beneath the External sources table, click Add. The Tool Selection pop-up appears.
    • Select a tool type from the Select a tool type drop-down. The pick list refreshes to display all tools of this type currently defined in the system as owned by the organization whose view you are logged on to.
    • Select the tool(s) you want to use as external sources of code for the report.
    • Click OK.
  1. Click Save.
  2. To define the locations, including NavID and views, at which users can run the report from the Reports menu, click the Navigation sub-tab.

  1. To add a new location at which users can run the report from the Reports menu:
  1. To change the views at which users can run the report from the Reports menu:
    • Click the NavID.
    • Select or deselect the checkboxes for the views to be changed.
    • Click OK.
    • Click Save.
  1. To delete a location at which users can run the report from the Reports menu:
    • Select the checkbox for the NavID.
    • Click Delete.
    • Click Save.
  1. To define which districts, intermediate organizations, or schools have the ability to run the report from the Reports menu, click the School sub-tab. By default, all the educational units owned by the organization whose view you are logged on to have this ability.
  1. To give or deny specified units the ability to run the report in the Reports menu:
    • Click the Visibility type drop-down, and do one of the following:
      • To deny a unit the ability to run the report in the Reports menu: Select Exclude.
      • To give a unit the ability to run the report in the Reports menu: Select Include.
    • Click Add.
    • Click the Owner type drop-down, and select the type of unit to which you want to give or deny the ability to run the report from the Reports menu. The pick list refreshes to display all units of that type currently defined in the system as owned by the organization whose view you are logged on to.
    • Select the district(s), intermediate organization(s), or school(s) you want from the pick list.
    • Click OK.
    • Click Save.
  1. To define which user roles can run the report from the Reports menu, click the Roles sub-tab.
  2. To give or deny specified user roles the ability to run the report from the Reports menu:
    • Click the Role visibility type drop-down, and do one of the following:
      • To deny a specific user role the ability to run the report from the Reports menu: Select Exclude.
      • To give a specific user role the ability to run the report from the Reports menu: Select Include.
    • Click Multi-Add...
    • Select the desired user role(s) from the User Role Pick List.
    • Click OK.
    • Click Save.
  1. To customize the publication of the report, click the Publish sub-tab.
  2. Customize the default subject and message, if desired, and click Save.
  3. Confirm the report is listed on the intended Reports menu.
  • For example, if you added a report to the Reports menu from the Student List:  
    • Log on to the School view.
    • Click the Student tab.
    • Click the Reports menu.
    • Check the Reports menu in each view defined on the Navigation sub-tab. Some reports are designed to run only in a particular view.