Generating a Patient Data Report from the Command Line

You can generate a Patient Data Report by issuing the RunPDR command from the Microsoft Windows command line.

You enter the RunPDR command in the following format:

RunPDR.cmd -st study [-si study_site] [-p patient] [-bk DCI_Book] -l folder_location -u user [-pw password] [-aud] [-disc] [-debug] [-trace] [-nobm] [-o orientation] -cfg xdobookbinder_location [-test]

For example:

RunPDR.cmd -st test3 -l D:\temp -u jsmith -cfg D:\pdr\xdobookbinder.cfg

For more information, see:

• Displaying the Command Syntax
  
• Parameters for the RunPDR Command
  

Displaying the Command Syntax

To display the syntax for the command:

1. Type RunPDR on the command line.
2. Press Enter.

Parameters for the RunPDR Command

The following table describes the required and optional parameters for the RunPDR command.

Note:

When specifying a parameter that contains spaces (on a Windows command line), you must enclose the parameter in double quotes.

Parameter	Required?	Description
-st study	Yes	Runs the Patient Data Report for the specified study. The system produces a separate PDF report file for each patient.
-si study_site	No	Runs a report for all patients currently assigned to the specified study site. If you do not specify a site, the system runs the report for all patients assigned to those study sites that your user role has privileges to access. The system produces a separate PDF report file for each patient.
-p patient	No	Runs a report for the specified patient only. If you do not specify a patient, the system runs a report for all patients in the specified study and sites.
-bk DCI_Book	No	Denotes the DCI Book (casebook) to use for any CRF that was not entered against a casebook. Note that: If you do not specify this parameter and a CRF was not entered against a DCI Book, the system uses the casebook assigned to the patient. If no casebook is assigned to the patient, the system uses the default casebook for the study. If no default casebook exists for the study, the system uses the first active DCI Book, in alphabetical order, for the study.
-l folder_location	Yes	Specifies the directory where the system saves the PDF file created for each report, and the log files created during the generation of the report. In addition, the system uses this directory to write the debug information if you include the -debug parameter on the command line. The directory that you specify must already exist. If the directory does not exist, the command fails and displays an error message that the folder is invalid.
-u user	Yes	Specifies your user name for logging in to the Oracle Clinical database.
-pw password	No	Specifies your password for logging in to the Oracle Clinical database. When you use this parameter, your password is visible on the screen. If you do not use this parameter, the system prompts you for your password. Asterisks mask your password as you type it. For security reasons, Oracle recommends that you do not specify your password directly on the command line.
-aud	No	Includes change history for individual responses. In addition, if the DCI Form Settings Include Approval Information and Include Verification Information are set to Y, approval history and verification history will also be included. Note: The verification history appears only if the user generating the report has one or more of the Verify privileges (BROWSE_VERIFY, BROWSE_SDVPLAN, UPDATE_SDVPLAN, or VERIFY).
-disc	No	Includes discrepancy information in the report.
-debug	No	Leaves data in temporary tables and outputs files to the directory that you specified with the -l folder_location parameter. This data is useful when working with customer support to debug an issue. After you resolve the issue and the debug information is no longer necessary, be sure you truncate the temporary pdr_temp and pdr_superscripts tables.
-trace	No	Turns on database trace and creates a trace file during the execution of the report. Trace data is useful when debugging performance problems. The system saves the trace file in the directory specified in the init.ora file of the database. Check with your database administrator for the location.
-nobm	No	Does not create the bookmarks or a table of contents for the report.
-o orientation	No	Denotes the orientation of the pages in the cover, table of contents, ancillary data sections, and appendixes. Valid entries are: P = portrait (default) L = landscape
-test	No	Runs the report in test mode for test data. The report uses provisional DCI form versions in place of active ones when the provisional versions exist.
-cfg xdobookbinder_location	No	Location (path, excluding file name) of xdobookbinder configuration file. If executing command line PDR from a client, provide the xdobookbinder configuration file as a parameter to ensure that all fonts are correctly embedded in the PDR and similar output with similar fonts is generated when compared to the report output generated from Oracle Clinical and RDC. If you omit to provide the parameter from the command line, the PDR report output could use different fonts compared to the output generated from the application server. See Copying and Configuring the xdobookbinder.cfg File for Fully Embedding Fonts.
rdci	No	Receives the DCI ID for which PDR needs to be generated.
jid	No	Indicates the job ID for which PDR needs to be generated.
rtyp	No	Pass crfh to generate the CRF report and sdr to generate soft-deleted CRFs report.
doc	No	Indicates the document number for which PDR needs to be generated.
dci	No	Indicates DCI for which PDR needs to be generated.
rtyp	No	Pass crfr to generate CRF Report, crfh to generate CRF History, and sdr to generate soft-deleted CRFs report.