Adding Custom Report
Pre-requisites:
To add a new report through the CentraSite Command Line Interface, you must have the CentraSite Administrator role.
CentraSite provides a command tool named add Report for this purpose.
To add a new report
Run the command add Report. The syntax is of the format C:\SoftwareAG\CentraSite\utilities>CentraSiteCommand.cmd add Report [-url <CENTRASITE-URL>] -user <USER-ID> -password <PASSWORD> -file <CONFIG-FILE> –template <TEMPLATE-FILE>
The input parameters are:
Parameter | Description |
CENTRASITE-URL | (Optional). The URL of the CentraSite registry. For example, http://localhost:53307/CentraSite/CentraSite. |
USER-ID | The user ID of a registered CentraSite user who has the CentraSite Administrator role. For example, Administrator. |
PASSWORD | The password for the registered CentraSite user identified by the parameter USER-ID. |
CONFIG-FILE | Name of the configuration file which contains the report properties. |
TEMPLATE-FILE | Name of the BIRT report design (.rptdesign) file. |
Example (all in one line):
C:\SoftwareAG\CentraSite\utilities>CentraSiteCommand.cmd add Report -url http://localhost:53307/CentraSite/CentraSite –user Administrator –password manage –file c:\temp\APIUsageReportConfig.xml –template c:\temp\APIUsageReport.rptdesign
The response to this command could be:
Executing the command : add Report
Report API Usage Report was successfully added
Successfully executed the command : add Report
Report Configuration File
You can configure the details for new report in an XML configuration file. The configuration file ReportConfig.xml must look like the one below:
The contents of the configuration file are listed below:
Tag Name | Description |
Name | (Mandatory). Name of the report. |
Description | (Optional). The description for the report. |
Classifications | (Optional). The classification of the report, which determines whether the report is shared or nonshared. The default is nonshared. If you want to share the report with API Portal, then you mark it as a shared report. If you do not have the classification marked as shared, then the report is automatically nonshared. For multiple classifications, use a comma to separate the values. Currently, CentraSite only supports the shared classification. |
Here is a sample configuration file. The sample illustrates how you can add a new report with name API Usage Report, with description Short Description of the API Usage Report, and with the classification shared.