This command runs an Excel report using an Excel template file.
ksc_run_excel_report <path/to/excel/template> REPORT_ID=[RP.REPORT_SUBMISSION_ID] ksc_end_report_parameters
The path to the Excel template should point to an
xlsxmfile relative to the folder
<PPM_HOME>/conf/custom_excel_templates. Files located in the folder
<PPM_HOME>/conf/excel_templateswill also be picked if no matching file is found in the
custom_excel_templatesfolder. However, files in the folder
excel_templatesare built-in and should not be modified as they will be overwritten upon upgrade.
The second line with
REPORT_IDis also mandatory and is used to pass the report ID to the Excel report engine. It should never be omitted nor modified.
It is possible to add any number of arbitrary parameters between the first and the last line. All these parameter values will be passed to the Excel template when the report is generated. For example, to pass a parameter
TIME_PERIODwith the value “weeks”, you can use the following command steps:
ksc_run_excel_report reports/rm/ResourcesDetailsTemplate.xlsx REPORT_ID=[RP.REPORT_SUBMISSION_ID] TIME_PERIOD=weeks ksc_end_report_parameters
If you add the line
ksc_end_report_parameters, the Excel Report will be run in debug mode and the generated file will be an Excel file which includes all the objects that are passed to the template file.