Report Configuration File
You can configure the new report details in an XML configuration file. The configuration file ReportConfig.xml should look like the one below:
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE properties SYSTEM "http://java.sun.com/dtd/properties.dtd">
<properties version="1.0">
<entry key="com.centrasite.scheduledreport.Name"></entry>
<entry key="com.centrasite.scheduledreport.Description"></entry>
<entry key="com.centrasite.scheduledreport.Classifications"></entry>
</properties>
The contents of the configuration file are listed below:
Tag Name | Description |
com.centrasite.report.Name | (Mandatory) The name of the report. |
com.centrasite.report.Description | (Optional) Description for the report. |
com.centrasite.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".
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE properties SYSTEM "http://java.sun.com/dtd/properties.dtd">
<properties version="1.0">
<entry key="com.centrasite.report.Name">API Usage Report</entry>
<entry key="com.centrasite.report.Description">Short Description of the
API Usage Report</entry>
<entry key="com.centrasite.report.Classifications">shared</entry>
</properties>