11 Setting Up File and Image Viewing

This section includes the following information on the steps required so that users can see the output files for the reports and batch jobs they have submitted:

Setting Up Reports Viewing
Setting Up Batch Job File Viewing
Setting Up Image Viewing

11.1 Setting Up Reports Viewing

To set up reports viewing:

Install the Oracle Clinical Reports Server
Setting Up Reports Directories
Making the Reports Root Directory Sharable
Assigning Directories to Users

11.1.1 Install the Oracle Clinical Reports Server

Install Oracle Clinical Reports Server; see the Oracle Clinical Installation Guide for detailed instructions.

To ensure high availability of the Reports Server, you can set up and use more than one Reports Server on a subnet and they can access each other. Job submissions can be carried out on different reports servers at runtime (based on the values of the REPORT_SERVER Local Codelist).

If you use multiple reports servers you must set up a shared file for the outputs.

To identify all Reports Servers running on a subnet and accessible, execute the following command on any Reports Server:

DB_Home/config/reports/bin/rwdiag -findAll

For example:

drive:\app\Oracle\Middleware\example_database\config\reports\bin>rwdiag -findAll

11.1.2 Setting Up Reports Directories

Report Server jobs store output files on the Report Server middle tier.

During Oracle Clinical installation you create a Reports Server root directory (see the Oracle Clinical Installation Guide for instructions). You can either use the root directory for all users' report output, or you can create a separate subdirectory for each user under the root directory. In either case, a user's access is restricted to the reports generated by that user in Oracle Clinical or RDC—regardless of whether or not there is a user-specific subdirectory.

If the Reports Server is installed on the same computer as the Oracle Clinical Front End, create the root directory on that computer. If you are using multiple Reports Servers, create a shared directory to serve as the root directory; see next section.

11.1.3 Making the Reports Root Directory Sharable

If you are using multiple Reports Servers, create a shared directory to serve as the root directory. Grant the administrator account read and write access to this directory.

To share the Reports Server root directory on Windows with the administrator account:

Use Windows Explorer to select the Reports Server root directory.
Right-click on the folder and select Properties.
Click the Sharing tab.
Select Shared This Folder, and then enter a value in the Share Name field.

Click OK to save your changes.

Tip:

The Microsoft Windows Universal Naming Convention (UNC) for any Reports Server log directory cannot exceed 35 characters.

The UNC syntax is:

\\computer\sharename\subdirectory

For example, if the computer name is oclfsrv1, and the share name is opareportout, and the report log is stored in a subdirectory user under this shared directory, then the UNC is:

\\oclfsrv1\opareportout\user

This works as long as user does not exceed eight characters. To have longer names for user, then shorten the share name.

11.1.4 Assigning Directories to Users

To allow users to view reports through Oracle Clinical and RDC, enter the full path to the root directory or user-specific subdirectory when you execute the Add User script or in the Oracle Accounts window; see "Running the Add User Script" and "Maintaining Oracle User and Group User Accounts".

If the Reports Server is installed on the same computer as the Oracle Clinical Front End, enter the full path of the for each user.
If you are using multiple Reports Servers, enter the UNC path of the shared directory for each user.

11.2 Setting Up Batch Job File Viewing

This section includes:

Setting Up Directories for PSUB
Entering Reference Codelist Values

11.2.1 Setting Up Directories for PSUB

Oracle Clinical's Parameterized Submission (PSUB) batch utility runs and schedules most Oracle Clinical jobs.

11.2.1.1 Creating a Directory for Log and Output Files and Registering it in OCL_STATE

The logs and output of the PSUB job are stored in the database and retrieved and displayed directly from a database table. Beginning in Release 5.0, FTP is no longer used.

You must create a single directory to temporarily store .log and .out files generated by PSUB before they are stored in the database, and enter the path of this directory in the PSUB_LOGS_DIR entry of the OCL_STATE local reference codelist.

The system automatically creates a subdirectory for each user the first time the user runs a PSUB job, and stores the .log and .out files in the subdirectory.

By default, the system deletes these files from the temporary directory after writing them to the database. If you prefer to keep files in the temporary directory, you can set the PSUB_DEL_FILES entry in OCL_STATE to N.

11.2.1.2 Creating Directories for Input and Output Files of Certain Job Types

Some PSUB jobs require input files and/or produce output files for which they require an additional directory.

For each job type listed in Table 11-1, "PSUB Job Types Requiring Special Directories and the Corresponding OCL_STATE Settings" below, do the following:

Create a root directory in the operating system file system for the database for each job type.
(Optional but recommended) Create a user-specific directory for each user who needs to submit jobs of that type. Oracle recommends having user-specific directories but provides the option in case you have very few users loading files and they have the same security privileges. Not creating user-specific directories may create a security issue, especially if you have multiple studies on the same database. A user could select and view a file from a study other than the one in context in the Oracle Clinical interface.

You must name the subdirectory exactly the same as the username, minus the OPS$ string, if any. The system disregards the OPS$ string when determining whether to give the user access to files in the subdirectory.
Give access to each directory only to the opapps account. Individual users do not need access and should not have access.

Table 11-1 PSUB Job Types Requiring Special Directories and the Corresponding OCL_STATE Settings

Job Type	Oracle Clinical Menu Path	OCL_STATE Settings
Randomization	From the Design menu, select Randomization, then Randomization Batch Load, then one of the following: Download Randomization Validate and Load Randomization Load a Converted Randomization Validate a loaded Randomization	RAND_ROOT RAND_USERDIRS
Load Patient Enrollment Dates	From the Design menu, select Patient Positions, then Load Enrollment Dates.	BDL_ROOT BDL_USERDIRS
Batch Data Load and Out of Study Load	From the Conduct menu, select Batch Data Load or Out of Study Load, then select Batch Load Data Files.	BDL_ROOT BDL_USERDIRS
Load Patient SDV Attributes	From Design select Patient Positions, and then select Load Patient SDV Attributes	BDL_ROOT BDL_USERDIRS
Lab Batch Data Load	From the Labs menu, select Lab Batch Data Load, then one of the following: Lab Ranges Batch Data Load Report Results of the Data Load	LAB_ROOT LAB_USERDIRS
Disconnected Replication	From the Admin menu, select Replication, then one of the following: Disc Repl Export Disc Repl Load	REPL_ROOT

Note:

Disconnected Replication does not require or support user-specific subdirectories.

11.2.2 Entering Reference Codelist Values

For each job type listed in Table 11-1, "PSUB Job Types Requiring Special Directories and the Corresponding OCL_STATE Settings", do the following:

Enter the Root Directory Path in OCL_STATE Local Reference Codelist
Enter Y or N in the USERDIRS OCL_STATE Setting

11.2.2.1 Enter the Root Directory Path in OCL_STATE Local Reference Codelist

Enter the directory's path in the matching setting (JOBTYPE_ROOT) of OCL_STATE.

11.2.2.2 Enter Y or N in the USERDIRS OCL_STATE Setting

You can choose to use a subdirectory for each user or not for input and output files for each job type. Each job type (except disconnected replication) has an OCL_STATE setting named JOBTYPE_USERDIRS. Enter Y or N.

If Y, the job looks for the input or output file specified by the user in any directory at or below JOBTYPE_ROOT/user, where user must match the database account ID of the Oracle Clinical user who submitted the job.

If the account ID of the user who submitted the job begins with OPS$, the subdirectory name must match only the user (non-OPS$) portion of the account name.

Output files, if any, cannot be written unless the user-specific subdirectory has been created by an administrator.
If N, ), the job looks for the input or output file in any directory at or below JOBTYPE_ROOT.

Note:

Other reference codelist settings control other aspects of PSUB functionality; see "Required Reference Codelist Settings for Batch Jobs".

11.3 Setting Up Image Viewing

You may need to include your company logo or medical diagrams in Patient Data Reports (PDRs) or CRFs. Beginning in Oracle Clinical 5.0, there is a single directory for images used as follows:

Oracle Clinical Reports Server looks for images for the Patient Data Report and the Layout Editor PDF Preview feature
Oracle Clinical Layout Editor also looks for images used in CRFs in the HTML Preview feature
RDC Onsite looks for images displayed in CRFs during data entry in RDC Onsite

This section includes:

Put Images in dcif_images Directory
Sharing the Images Directory
Automatic Setup During Installation
Changing the Images Directory Location

11.3.1 Put Images in dcif_images Directory

You must place all the images required for image viewing in these three features in the crfimages directory, which is created during installation by the Installer in OPA_HOME\html\rdc\dcif_images. By default OPA_HOME is opapps51.

11.3.2 Sharing the Images Directory

If the only report server that you use to generate DCI forms co-exists on the same computer with the forms server, there is no need to share the images directory and the path specification can be a simple local directory name, such as, c:\opapps51\html\rdc\dcif_images\crfimages.

If any reports server used for DCI forms generation is located on a different computer than the forms server, then:

The path specification used for the value of RDC_DCIF_IMAGES must use the UNC format.
The forms server images directory must be shared, so it can be accessed from other computers.
The domain/account_used_to_set_up_the_Reports_Server must have read/write privileges on the shared forms server directory.

For example, if, during initial installation, you reply to the Installer that there is a standalone report server, the Installer sets this the value of this key to:

\\appserver\rdc\dcif_images

and requires that you share drive:\opapps51\html\rdc with the share name "rdc".

11.3.3 Automatic Setup During Installation

The Installer automatically does the following:

Creates the dcif_images directory in OPA_HOME\html\rdc
Enters the dcif_images directory location in the rdcConfig.properties with key as crf_images_path.
Enters the crfimages alias location as the dcif_images directory's location in the opa51_httpd.conf file found in Middleware_Home/asinst_1\config\OHS\ohs1\moduleconf.
Places the properties files in the OPA_HOME/config directory.
Populates all registry variable values required for image viewing, including:
- OPA_CONFIG_FOLDER, which contains the full path of the config directory
- RDC_DCIF_IMAGES
- RDC_DCIF_IMAGES_URL
- HTML_DCIF_IMAGES_URL, which must have the same value as RDC_DCIF_IMAGES_URL

11.3.4 Changing the Images Directory Location

Oracle recommends using the default location. You can change it but you must change each thing the Installer does automatically.

Note:

The Patient Data Report template generation process fails if the report server cannot locate the path to the dcif_images directory and the image file for each each CRF that contains an image in its layout.