Modifying Report Details
Pre-requisites:
To modify the details of an existing report through the CentraSite Command Line Interface, you must have the CentraSite Administrator role.
CentraSite provides a command tool named update Report for this purpose. The report to update is specified by the parameter -report. The property values that you want to modify must be provided by an updated configuration file.
Note: | All property values provided by the configuration file is overwritten. In case you want to retain the existing property values, you must delete the whole property entry from the configuration file. |
To modify the details of a report
Run the command update Report. The syntax is of the format: C:\SoftwareAG\CentraSite\utilities>CentraSiteCommand.cmd update Report [-url <CENTRASITE-URL>] -user <USER-ID> -password <PASSWORD> -report <REPORT> [-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. |
REPORT | Name or key of the report you want to update. If the report name contains white spaces, enclose the name with "". |
CONFIG-FILE | (Optional). Name of the configuration file which contains the report properties. |
TEMPLATE-FILE | (Optional). Name of the BIRT report design (.rptdesign) file to update. |
Examples (all in one line):
Providing report configuration file and BIRT report design file:
C:\SoftwareAG\CentraSite\utilities>CentraSiteCommand.cmd update Report -url http://localhost:53307/CentraSite/CentraSite –user Administrator –password manage –report “API Usage Report” –file c:\temp\APIUsageReportConfig.xml –template c:\temp\APIUsageReport1.rptdesign
Providing report configuration file:
C:\SoftwareAG\CentraSite\utilities>CentraSiteCommand.cmd update Report -url http://localhost:53307/CentraSite/CentraSite –user Administrator –password manage –report “API Usage Report” –file c:\temp\APIUsageReportConfig.xml
Providing BIRT report design file:
C:\SoftwareAG\CentraSite\utilities>CentraSiteCommand.cmd update Report -url http://localhost:53307/CentraSite/CentraSite –user Administrator –password manage –report “API Usage Report” –template c:\temp\APIUsageReport1.rptdesign
The response to this command could be:
Executing the command : update Report
Successfully executed the command : update Report
A sample update configuration file is shown.
The sample illustrates how you can overwrite the description of an existing report. All other property values will remain unchanged.
