Overview: Hot-Deploying Custom Reports
Users with DESIGN REPORTS permission can create and “hot-deploy” custom reports to the PowerSteering application. These users, referred to as “report designers” in this manual, create and deploy custom reports by: (1) uploading report templates and graphics files on the Assets page; (2) mapping template fixed parameters to PowerSteering strings on the Configuration page; (3) adding a new report to the Report Listing page; (4) configuring the report on the Report Filters page (users with CREATE PUBLIC REPORTS permission who have saved a custom report to a new location can also configure certain report details).
Hot-Deploying Custom Reports
Note: Report templates are XML files that use the jrxml schema, so in order to configure custom reports, the .jrxml files must already be created as explained in the Report Designer’s Guide.
For more information about designing reports, see the Report Designer’s Guide document, found under Help > Downloads.
Overview: The Report Listing page
To access custom reporting features, choose Browse | Public Reports to display the Report Listing page, which presents a table that lists all reports currently defined for the context. There are also links/controls for the report designer to perform the following tasks:
•Add a report to or delete a report from the table. See Adding a new report on the Report Listing page
•Select the Assets page link to manage report assets (templates, subreports, and images). You can upload new assets, update existing assets, or download a file to your local hard drive for modification. See Managing templates and images on the Report Assets page
•Select the Configuration page link to map template fixed parameters to PowerSteering strings. See Report Configuration.
•Select a report link in the table to display a context menu which allow you to:
-Run or view the report (Web, PDF, Excel, and/or RTF formats, depending on template);
-Save a copy of an existing report to a new name or location;
-Edit the report details, schedule, and filters; see Configuring a new report on the Report Details page.
•View the profile of the person who last modified the report.
•Select the Public or Private link to redisplay the page showing just those reports.
•Browse and edit folders.
The Report Design Process
To hot-deploy new or updated custom reports, the report designer uses the Report Assets, Report Configuration, and Report Details pages:
1.Upload report templates and images as explained in Managing templates and images on the Report Assets page. Assets are the building blocks you use to create reports.
2.Map template fixed parameter names to strings as explained in Report Configuration.
3.Add a report stub as explained in Adding a new report on the Report Listing page.
4.Select the link for the report stub (“New Report” by default) and edit the report details and schedule as explained in Configuring a new report on the Report Details page.
Note: Links to the Configuration and Assets pages appear at the top of every custom reporting page if you have the proper permissions.
Managing Templates and Images on the Report Assets Page
Report templates, subreports, and images are collectively referred to as report “assets.” To manage these assets, navigate first to Browse | Public Reports, then select the Assets tab at the top of the page.
The Report Assets page lists the assets that have already been uploaded. Because the available assets can be numerous, there are several Filters to assist you in viewing/managing them:
•Name: Use this filter to display assets whose name contains All of, Any of, or Exactly the string you enter into the Name field.
•Source: Use this filter to display only those assets that were uploaded specifically for your context or only those that are built-in to the system.
•Modified by: Use this filter to display assets that were modified by a specific PowerSteering user. Applies only to uploaded assets.
After setting one or more filters, click the Search button to apply them. Click the Reset button to remove your filters and see the complete list of assets.
Templates and subreports are XML files using the jrxml schema, created with a jrxml authoring tool such as iReport. Supported image formats are gif and jpeg.
The report designer can manage assets in the following ways:
•Upload report assets
•Update an asset
•Delete an asset
•Download an asset to your local drive
Upload report assets
Uploading report assets establishes a repository of building blocks used to configure and “hot-deploy” custom reports to the PowerSteering application. Uploaded assets are listed in a table, showing the file name and file type (template or image). Both the file name and type are automatically determined from the uploaded file and cannot be changed. For the report designer, the table also contains controls for uploading a new version of an asset and for deleting assets.
To upload a new report template, subreport, or image
1.Select the Assets link at the top of the page.
2.Select Add New to display the Add New Asset dialog.
3.Enter the name of the file to upload or select Browse to search for the file.
4.Click Upload. A new row for the file is added to the Assets table.
Update an asset
When new versions of a report template, subreport or image become available, you should replace the version currently in use with the new version.
To update an existing report template, subreport, or image
1.Locate the asset in the table.
2.Enter the name of the updated file or select Browse to search for the file.
3.Select Upload. The new file replaces the old file (there is no version control).
Delete an asset
If an asset is no longer required, it can be deleted from the list of available assets. To delete an asset, select it’s checkbox and click Delete.
Note: The Delete checkbox is disabled for assets that are installed with the product and the Upload New Version column for these assets displays the text “Read-Only.”
Download an asset to your local drive
The ability to download an asset is provided so that you can modify an existing template with a jrxml authoring tool, rather than creating a similar report from scratch. (For information on using JasperSoft's iReport to edit jrxml template files, refer to the Report Designer’s Guide.) Each of the templates, subreports, and images listed in the Asset Name column are links. To download an asset to your local drive, select its link and choose a “Save To” location in the browser’s file download dialog.
When a user clicks the PowerPoint icon on a project’s summary page, PowerSteering compiles a summary of the work item in PowerPoint. The template for the PowerPoint summary is stored and managed as an Asset - the default template is called PSGenericPPTTemplate.ppt with the type "PowerPoint Template". If you wish to create a custom template you will need to download this file, modify it, then upload it as a new asset.
Report templates use their own unique parameter names to reference database fields. In order for the report engine to be able to retrieve the data required for the report, you need to map each fixed parameter name that appears in a custom report template to a PowerSteering string used in a report. This mapping makes it possible to reuse reports on different contexts that use different names for the same string. For example, you might map a report template fixed parameter called netBenefitsMetricItem to the string “Net Benefits” in one context, but to the string “Total Project Savings” in a different context.
Note: The mappings shown on the Report Configuration page are for the entire system, i.e. for all templates. If two templates happen to use the same name for a fixed parameter, that name can be mapped to just one string. If you notice that a mapping already exists for one of the fixed parameters in your template, it means that the name has been used by another template designer.
To map a template fixed parameter
1.Select the Configuration link at the top of the page.
2.In the Add New panel:
1.In the Name field, enter the fixed parameter name as it appears in the report template (i.e., without the prefix). For example, enter “netBenefitsMetricItem” in the Name field if the fixed parameter appears in the template as “fixedString.netBenefitsMetricItem.”
2.In the Value field, enter the string to associate with this fixed parameter, for example, “Net Benefits”.
3.Click Add New. The values you entered are added to the “Name in Report Template” column and the “Value in PowerSteering” column.
To modify a mapping, update the names directly in the columns “Name in Report Template” or “Value in PowerSteering” and click Save Changes.
To delete a mapping, select its checkbox from the list and click Delete.
To sort the list by name or value, click on the column header.
Adding a New Report on the Report Listing Page
Once report templates have been uploaded as described in Upload report assets, and template fixed parameter names have been mapped to PowerSteering strings as described in Report Configuration, the next step to hot-deploying a custom report is to add the report to the table on the Report Listing page. This just creates a stub for the report, which must then be configured by editing report details and schedule.
1.Select the Public Reports or Private Reports link at the top of the page.
2.Open the folder where the new report should be added.
3.Click Add New. A report link with the default name “New Report” is added to the Report List. Note that the name appears in red, indicating that the report details and schedule need to be specified.
You can also save a copy of an existing report to a new name or location.
Configuring a New Report on the Report Details Page
After a new report has been added to the Report List page, it can be configured by:
•Editing report details
•Editing report schedule
Both of these configuration tasks are accomplished on the Report Details page. To display this page for a report:
1.Select the report’s link on the Report Listing page.
2.In the context menu, select the Edit Details & Schedule link.
For users with DEFAULT USER or DESIGN REPORTS permission, all controls on the page are enabled. Users with CREATE PUBLIC REPORTS permission cannot change the details or schedule of a report they do not own, and the Template selection control is disabled for all reports.
Editing report details
1.Update the report Name. The Name cannot contain either the "&" or "/" characters.
2.Select the report Template from the drop-down list.
3.Select “Default” from the Data Source drop-down list. Reports you design should always use the Default data source, which uses SQL to access the database views. (The other options listed are custom java data sources reserved by PowerSteering.)
4.Select the Location to which this report should be saved:
-My Reports saves this report to My Reports on home page (accessible only to you).
-Public Folders saves the report to a the specified folder (accessible to other PowerSteering users).
5.Specify the Default Action that will be presented to users when they want to run this report:
-Run on demand: For fast-running reports, select this option to rerun this report using live data.
-Retrieve from last run: For long-running reports, select this option to retrieve the last run version of this report.
6.Optionally, enter any Notes (i.e. information or instructions) you deem relevant to the report.
Editing report schedule
1.Select a Frequency from the drop-down list, which determines how often PowerSteering generates reports from this definition: Never, Daily, Weekly, Monthly, Yearly. (If you choose Never, the report must be run manually.)
2.For any Frequencies except Never, configure a Start Date and End Date.
-Start Date: The configuration options depend on the Frequency selected: Daily, Weekly, Monthly, or Yearly. For example, if you choose Weekly, you can also set weekly intervals, such as every two or three weeks, and the days of the week on which the report runs.
-End Date: Reports can be set to end on an absolute calendar date, or after a specified number of runs.
3.Optionally, specify who receives copies of this report as an E-mail attachment: enter their E-mail addresses, the format of the attachments (Web, PDF, Excel, or RTF, depending on the template), and an accompanying message.