Report types
Create custom report types to meet your business needs.
Overview of report types
A report type defines the following for reports of the report type:
-
What categories the reports belong to.
-
What fields are displayed on the report submission page, and how they are constructed and validated.
-
Who can access and submit the reports, including any required licenses or access grants.
-
Who can modify the report type.
-
What commands are executed when the reports are submitted.
Supported report formats
Custom report types are classified by output format as follows:
Report group | Description |
---|---|
JSP report |
HTML format, convertible to PDF. For details, see Convert JSP reports to web reports. Configure a report type with the ksc_run_jsp_report special command. For details, see Report types and ksc_run_jsp_report. Convert JSP reports to web reports
You can convert JSP reports to web reports by replacing the ksc_run_jsp_report command with the ksc_run_web_report command in the report type. This lets you convert JSP reports to PDF format. It is helpful when you want to attach a completed report to email notifications. |
Web report |
Flexible format: HTML, PDF, PPTX, and XLSX. Configure a report type with the ksc_run_web_report special command. For details, see Report types and ksc_run_web_report. |
Excel report |
XLSX format. Configure a report type with the ksc_run_excel_report special command. For details, see Excel reports. |
Word report |
DOCX format. Configure a report type with the ksc_run_word_report special command. For details, see PowerPoint and Word reports. |
PowerPoint report |
PPTX format. Configure a report type with the ksc_run_powerpoint_report special command. For details, see PowerPoint and Word reports. |
Create and configure a report type
Follow the steps below to create and configure a report type.
To create a new or to edit an existing report type:
-
Log on to PPM.
-
Click the Administration button from the masthead.
-
From the Administration menu, select Workbench > Open Workbench on Desktop.
-
From the shortcut bar of the workbench, select Configuration > Report Types.
-
To create a new report type, click New Report Type.
To edit a report type, select the target report type.
-
Provide the following general information for the report type:
Field Name Description Report Type Name Provide a unique name for the report type.
Type any alphanumeric string.
Caution: Do not change the name of the Baseline Comparison report. Doing so disables the Compare Baselines button on the View Baselines page (accessible from the Project Overview page).
Description Provide a brief description for the report type.
Type any alphanumeric string.
Requires License Select the required product license to access and run this report. If no specific license is required, select Any.
Enabled Select Yes to enable the report type or No to disable the report type. Report Category Select one or more categories that this report type belongs to.
-
Configure the following for the request type:
- Click OK.
To copy a report type
-
From the Report Type window, select the report type to copy.
-
Click Copy.
The Copy Report Type window opens.
-
Provide a name for Report Type Name.
-
Click Copy .
The Question window opens.
-
Click Yes if you want to make modifications. Otherwise, click No.
If you click Yes, the Report Type: <Report> window opens.
-
Make necessary changes to the report type.
-
Click OK to save your changes.
See also: