Run a report using a report definition file

If you are a superuser, you can create a report definition file from a valid All Cases Summary report. You can copy the content of the Input File page into a text file and save the file using the extension .in. You can then place the file in the input folder of the application server in order to be processed by the Oracle Empirica Signal application. The input folder is located in the path defined by temp_dir in webvdme.properties.

The input file (report definition file) contains the following information.

Line in the Report Definition File Description

#datetime

Date and time of creation of the report definition file. The comments are preceded by #.

ACTION=CREATE REPORT

Represents the type of batch file. Reports appear as CREATE REPORT. Data mining runs appear as CREATE RUN.

Description

Description of the report definition used with Create Definition File.

Name

Name of the report definition used with Create Definition File.

Owner

Owner of the report definition used with Create Definition File.

Project_id

Project ID of the report definition used with Create Definition File. The Report Batch Runs page relies on the project ID.

Type

0

Report.classname

com.lincolntechnologies.webvdme.reports.batch.RunAllCasesReportProc

Report.configuration

Configuration on which the report runs. If the configuration does not exist when the batch report is run, an error message displays:

Configuration named ‘<configuration name>' does not exist

Report.name

Name of the report definition used with Create Definition File. The same name will appear in the Definition column of Report Output.

Note:

For consistency in report outputs that rely on a report definition coming from another instance, the report.name should match the value of Name\="All Drug Summary Report" in XML.

Report.output_name

Name entered on the Create Definition File page. This name is used as Output in the Report Output table.

Report.output_description

Description entered on the Create Definition File page. This description is used as Description in the Report Output table.

Report.project_id

ID of an existing project selected on the source server. It can be used as a filter on the Report Batch Runs page.

If the file is to be used on an instance other than the one on which it was created, it is unlikely that the ID is on the receiving server. Omit or assign 0.

Report.reportid

Report ID of the report definition used with Create Definition File. This line should be removed in order to force use of the XML referenced by report.reportxml, especially if the file is to be used on an instance other than the one on which it was created.

Report.reportxml

XML of the report definition used with Create Definition File.

Line in the Report Definition File Description

report.Project\ Name

If the specified project name exists on the server on which report is ultimately run, the report output is placed in that project. Else, the report output is assigned to project with ID matching report.project_id.

report.Alias\ Names

Report Output Alias. If the Report Output Alias exists, it is updated with Report.output_name. If the Report Output Alias does not exist, it is created and assigned the specified value.