8 Install the Oracle Clinical Reports Server

This chapter includes:

You can choose to install a standalone Reports Server on a computer that does not have a Forms Server installation. You can also set up and use more than one Reports Server on a subnet where they can access each other. If you have any standalone Report Servers, all Forms and Report Servers must map a drive (the same drive for each server) to the shared directory on whichever server you choose; see Section 8.7, "Set Up Reports Server and Forms Server for Access and File Viewing".

If you are installing the Reports Server on the same computer as the Forms Server, you must install the Oracle Application Server technology stack and Oracle Clinical Front End before you install the Oracle Clinical Reports Server.

If you are installing a standalone Reports Server, you must first install the Oracle Application Server technology stack on the same server.

8.1 Gather Required Information

Have the following information ready to enter in the Installer screens:

  • Home Details: Enter the following:

    • Name: OPA_HOME

    • Path: c:\opapps52

  • Your Oracle Fusion Middleware home directory; for example:

    C:\Oracle\Middleware\Oracle_Home

  • Your OPA home directory; for example:

    C:\opapps52

  • WebLogic username and password

  • Report Server name

  • Report Server output directory

  • Adobe Reader location; for example:

    C:\Program Files (x86)\Adobe\Reader 11.0\Reader\AcroRd32.exe

  • If you select to store the DCIF images locally, you need the local DCIF images directory. Else, you need the location of the shared directory.

8.2 Restart the Computer

  1. Restart the computer.

8.3 Start the WebLogic FRDomain Admin Server

The WebLogic FRDomain Admin Server must be running when you install the Reports Server.

  1. At the DOS command prompt, do one of the following:

    • Go to ORACLE_HOME\user_projects\domains\FRDomain\bin and run the startWebLogic.cmd.

    • Go to C:\ProgramData\Microsoft\Windows\Start Menu\Programs\Oracle FMW 12c Domain-FRDomain - 12.2.1.2.0 and run startWeblogicAdminServer.cmd.

  2. Go to ORACLE_HOME\user_projects\domains\FRDomain\bin and run startNodeManager.cmd.

8.4 Install the Oracle Clinical Reports Server

Follow these instructions to deploy the Oracle Clinical Reports Server onto the application tier installation.

Note:

If you run Patient Data Reports from a Reports Server, install Acrobat Reader before installing the Oracle Clinical Reports Server. The Installer detects the Reader's location and automatically configures the registry.

To install the Oracle Clinical Reports Server components:

  1. Log in as a user with system administrator privileges.

  2. Navigate to the location where you downloaded and extracted the software in Section 1.6, "Download the Software".

  3. Run the following file as an administrator:

    Disk1\install\setup.exe

    The Installer opens to the Welcome screen.

    Note:

    See "Use the Silent Installer (Optional)" for instructions for running the Installer as a file with pre-entered parameter values.

    Note:

    Although there is a button for deinstalling products on the Welcome screen, Oracle does not support using the Installer to deinstall Oracle Clinical or Oracle Clinical Remote Data Capture (RDC) Onsite.

  4. Select a Product to Install: Select Oracle Clinical Report Server 5.2.0.0.x.

  5. Follow instructions on the installation screens, providing the information you have gathered in Section 8.1, "Gather Required Information".

  6. Summary: The Summary screen provides information about the global settings, languages, space requirements, and products for this installation.

    Review the installation details to verify that they are correct. To revisit earlier installation screens and make changes, click Back.

    When you are ready to continue, click Install.

  7. Install: The Installer copies the files onto the server, completes the setup and configuration tasks, and generates a log file of this installation.

    In addition, the Install screen displays the location of the log file that records the results of the installation activities for this session. Make a note of this information so you can view the log file after the installation.

  8. End of Installation: The End of Installation screen reports whether the installation was successful. Please check the install logs if any errors are displayed.

    When you have finished reviewing the installation information, click Exit.

8.4.1 Review the Installation Log File

  1. Review the generated installation log file, installActionstimestamp.log, for errors.

    This is the name of the most current log file. Earlier files have a timestamp appended to the name.

    Location: \Oracle\Inventory\logs

    For example:

    C:\Program Files\Oracle\Inventory\logs

Work with Oracle Support, if necessary, to resolve any errors.

8.5 Apply Oracle Reports Developer Patch 22334822

Note:

If you have already installed the Oracle Reports Developer Patch 22334822, ignore instructions in this section.

  1. Download the patch from My Oracle Support.

  2. To apply the patch, follow instructions in the patch release notes.

8.6 Restart the Computer

To ensure that all configuration changes are initialized:

  1. Restart the computer before you continue with the next task in the installation process.

8.7 Set Up Reports Server and Forms Server for Access and File Viewing

Perform these Reports Server file viewing tasks once for each Oracle Clinical location.

8.7.1 Create the Reports Server Root Directory

If your Oracle Clinical environment includes Forms, Reports, or standalone File Server, select a single server where you will locate your Reports Server root directory. Otherwise, you will locate the Reports Server root directory on the single computer comprising your entire Oracle Clinical installation.

  1. Create the Reports Server Root directory, making sure it is accessible by the user that started up the auto process; see Section 8.10, "Set Up Automatic Startup of Services".

    Note:

    (Optional) Either now or later you can create a separate subdirectory for each user. However, users do not require direct access to the directory, and when viewing reports and log files from the application, users can see only the files they generated.

8.7.2 Share Each Reports Server Root Directory

If your Oracle Clinical environment includes multiple servers, you must make your Report Server root directory shareable on every server (Forms Server and Reports Server). Otherwise, all of your Oracle Clinical components and your Report Server root directory reside on a single computer, and you can skip the following steps.

  1. Share the Reports Server root directory:

    1. Log on to Windows with an administrator account.

    2. Use Windows Explorer to select the Reports Server root directory.

    3. Right-click on the folder and select Properties.

    4. Click the Sharing tab.

    5. Select Shared This Folder, and then enter a value in the Share Name field.

    6. Click OK to save your changes.

  2. On each Forms and Reports Server, map a drive to the shared directory.

    • You must use the same drive letter in each server's mapping, for example 't'. This allows for a unified specification of the output directory in Oracle Clinical.

    • Even if the root directory is local to the Report Server, you must map a drive to allow for unified specification.

If you have already completed the Oracle Clinical Report Server installation and did not specify the correct Report Server root directory path, you can correct this by editing the rwserver.conf file, directly, as follows:

<folderAccess>
<read>%OPA_HOME%\oc;%OPA_HOME%\*;%REPORTS_LOG_DIR%\*</read>
<write>%OPA_HOME%\oc;%OPA_HOME%\*;%REPORTS_LOG_DIR%\*</write>
</folderAccess>

8.7.3 Provide Oracle Clinical and RDC Users Access to the Root Directory

The Report Server root directory you created in the previous steps is the directory to specify for each user in Oracle Clinical. See the Oracle Clinical Administrator's Guide on setting up user accounts, sections "Running the Add User Script" and "Maintaining Oracle User and Group User Accounts."

Provide the Oracle Clinical and RDC user access to the root directory on the Forms server. If the directory is local to the Oracle Clinical Forms server, specify the full directory path, including the user directory name, if any. Otherwise, the specification will be the mapped directory path, optionally with a user-specific subdirectory, for example: t:\<user_name>

8.7.4 Configure the Reports Server and Forms Server for DCI Form Generation

Both the Reports Server and the Oracle Clinical application server must have read/write access to the directory (\rdc\temp) on the application server used to write temporary files during the DCI form generation process.

If you have any standalone Reports Servers, they must also have access to this directory.

On the Oracle Clinical (Forms) Server:

  1. Confirm that the OUI has the specified values for the registry settings OPA_XMLTEMP_UNC and OPA_XMLTEMP_HTTP. During the installation, if you correctly indicated that there is a standalone report server, the value of the key(s) is set to:

    • OPA_XMLTEMP_UNC:

      C:\opapps52\html\rdc\temp

    • OPA_XMLTEMP_HTTP:

      https://<serverName>:port/opa52/rdc/temp

  2. To provide access to the remote Report Server, share the directory with the share name "RDC", providing read/write privileges to the domain/account on the report server.

On the Reports Server used in DCI Form Generation

  1. By default, OUI will have updated RWSERVER.conf, specifying a value of %OPA_HOME%\oc;%OPA_HOME%\*;%REPORTS_LOG_DIR%\* under folder access.

    For example:

    <folderAccess>
<read>%OPA_HOME%\oc;%OPA_HOME%\*;%REPORTS_LOG_DIR%\*</read>
<write>%OPA_HOME%\oc;%OPA_HOME%\*;%REPORTS_LOG_DIR%\*</write>
</folderAccess>

  2. Map a drive to the RDC share on the application server.

  3. Update the registry values. For example:

    • OPA_XMLTEMP_UNC:

      z:\rdc\temp

      The Z drive is mapped to \\SharedAPPSERVERNAME\OPA_HOME\html.

    • OPA_XMLTEMP_HTTP:

      https://servername(same as Z drive):port/opa52/rdc/temp

If the only report server that you use to generate DCI forms co-exists on the same computer with the application server, there is no need to share the xmltemp directory and the path specification can be a simple local directory name, such as,

C:\opa_home\html\rdc\temp

8.7.5 Configure the Reports Server to Send Output to a Printer

If you run the PDR, and you send the output directly to a printer:

  1. Set value for the RDC_PDF_PRINT_TOOL key.

    The value assigned to the RDC_PDF_PRINT_TOOL key determines the location of the Adobe Acrobat or Reader executable, which allows users to run PDF patient data reports with "PRINTER" specified as the output type. This value must be in the form:

    "<acrobat-reader_path>" /t

    Note that the double-quotation marks around the path and the "/t" switch are required. A typical example of a value is:

    "C:\Program Files\Adobe\Acrobat 6.0\Acrobat\Acrobat.exe" /t

In addition to setting this key correctly, ensure that the Adobe Acrobat or Reader application is running on the Reports Server prior to users initiating this type of report job, that is, a job that specifies the output type as "PRINTER".

8.8 Add the Reports Server to the Database Reference Codelist

For each Reports Server that you install, you must edit reference codelists in Oracle Clinical to specify the values for the Reports Server.

To set the Reports Server values:

  1. Start Oracle Clinical.

  2. Navigate to Admin, Reference Codelist, and then Local Codelist to open the Maintain Reference Codelists form.

  3. Query for REPORT_SERVER in the Name field.

  4. Complete the Short Value and Long Value fields as follows:

    • For each Short Value listed in Table 8-1, enter in the Long Value field the connection string of the Reports Server that you want to use as the default for the specified function.

    • For each additional, non-default Reports Servers, add a row to the reference codelist. Specify a unique name in the Short Value field and the connection string in the Long Value field.

      Table 8-1 REPORT_SERVER Local Reference Codelist Values

      Short Value Enter in Long Value Field

      REPORT_SERVER

      The connection string for the Reports Server you want to use as the default for Oracle Reports.

      JOB_SET_SERVER

      The connection string for the Reports Server you want to use as the default for job sets.

      PSUB_SCHEDULER

      The connection string for the Reports Server you want to use as the default for PSUB jobs.

  5. Click Save.

8.9 Test the Reports Server Installation

To test that the Reports Server can create printouts and files:

  1. Start Oracle Clinical.

  2. Navigate to Admin, Admin Reports, and then Reference Codelist. The Report Reference Codelist submission screen opens.

  3. Click the Reference Codelist Name field, and enter OCL_STATE.

  4. Print the report:

    1. Click the Job Details button.

    2. Change the Output Type to PRINTER.

    3. Examine the printer's path to see if it is correct.

    4. Click Submit Job. You receive a status prompt. Close the prompt to return to the Submission screen.

    5. Click Job Status to check the progress of your print job. Look for the printout from your printer.

  5. Print the report to file:

    1. Return to the Report Reference Codelist submission screen.

    2. Click the Reference Codelist Name field, and enter OCL_STATE.

    3. Click Job Details.

    4. Change the Output Type to FILE.

    5. Click Submit Job. The system displays a status prompt. Close the prompt to return to the Submission screen.

    6. Click Job Status.

    7. Check its status in the Execution Status field.

    8. Click View Output. The system displays a path location prompt.

    9. Click OK. The Report Server processes the file and converts it to the selected format. If successful, the file then opens in a separate window.

8.10 Set Up Automatic Startup of Services

Oracle recommends setting up the server so that the Node Manager automatically restarts services when necessary. If you are installing this on a machine with the Oracle Clinical Front End, you will have done this as part of executing Section 7.9, "Set Up Automatic Startup".

  • If this is a standalone reports server, follow the same instructions except, in script autostartfrdomainscript.py located in opa_home\config, comment out the following line:

    start ('WLS_FORMS')

  • If you are not installing TMS, also comment out the following line in script autostartopadomainscript.py located in opa_home\config:

    domainName='OPADomain' domainDir='your_middleware_home/USER_P~1/domains/OPADomain' nmConnect(userConfigFile=configfile, userKeyFile=keyfile, nmPort=port, domainName=domainName,domainDir=domainDir,nmType='ssl') nmStart('Admin Server') connect(userConfigFile=configfile, userKeyFile=keyfile) nmStart('Server.Domain_OPA_1')