This appendix describes the environment variables and registry settings that Oracle Clinical uses to condition the environment on computer servers, and to condition a user's interactive environment to point at a particular database and code environment. These variables are created as part of the Oracle Clinical installation process; most are also set to a default value. Information is provided here so that you can set them up and modify them, if necessary.
This section includes:
The Oracle Clinical server environment definition and setup system, known as opa_setup, consists of a set of scripts (on UNIX systems) or command files (on Windows systems).
The four types of setup files are:
Definition – Edit this file, if necessary, to set or change values on a system-wide or database-specific level. The Oracle Universal Installer creates the file in drive:\opapps\bin.
opa_settings – UNIX
opa_settings.bat – Windows
Initialization (login) – This file is optional, edit it to set or change values for an individual user.
.profile – UNIX platforms, Bourne/Korn shells
.cshrc – UNIX platforms, C shell
.login – UNIX platforms, C shell
login.bat – Windows
Selection – Run this file to choose a configuration from among those defined in the settings file.
opa_setup – UNIX platforms, Bourne/Korn shells
copa_setup – UNIX platforms, C shell
opa_setup.bat – Windows
Supplemental – For compatibility with previous versions of Oracle Clinical; belongs in the user's home directory on the PSUB server machine.
.oclrc – UNIX platforms
oclrc.bat – Windows
You can edit and maintain the Definition scripts for your installations. However, do not modify the Selection scripts, which call the definition script. The selection script is used in the following contexts:
When you start or stop the PSUB process for a database, you log in to the operating system as opapps. The selection script is called to set the environment to that database.
Each time a PSUB job is requested, PSUB executes the setup script to condition its environment to the correct version of the Oracle Clinical code, running against the correct database.
You may execute the selection script at the command line to define server environments for various purposes, such as connecting to a particular database or running SQL scripts under RXC_TOOLS.
Administrators are not required to create or modify users' installation scripts to enable users to submit back end jobs through the client interface. However, you must add entries to the initialization scripts of users who need to run opa_setup, SAS, or SQL*Plus from the back end command line. See "Setting Up Power Users" for details.
This section includes information about opa_settings on UNIX and Windows.
You can define values for the environment variables in opa_settings (UNIX) or in opa_settings.bat (Windows). On UNIX you can limit the scope of the environment variable setting to a single instance or to a single user. See "Defaulting, Adding, and Customizing Values" for details.
On UNIX some of these settings are in opa_setup (Korn or Bourne shell) and copa_setup (C shell).
Most of these environment variables affect job execution on back end servers.
NLS_DATE_FORMAT – National Language Support
NLS_LANG – National Language Support
RXC_BATCH_QUEUE – Batch queue for non-blocking PSUB jobs (UNIX only)
RXC_BDL_DIR – Spool directory for batch data load
RXC_DEBUG_BUFFER_SIZE – Output buffer size for executing procedures
RXC_IMMED_QUEUE – Batch queue for blocking PSUB job (UNIX only)
RXC_LOG – Location for log files
RXC_MAA_TAB_SPACE – Data extract temporary tablespace
RXC_NOW_STRING – Time when PSUB job is executed (UNIX only)
RXC_PRINTER – Default printer for Oracle Clinical
RXC_SAS_BATCH_QUEUE – Default PSUB batch queue for SAS jobs (UNIX only)
RXC_USER – Root directory for creating data extract files
TEMP – Default location for SFTP and FTP
USER_BV_JOB – Script run after batch validation (back end server)
This variable determines the format used for displaying dates and converting characters to dates. The default value is "DD-MON-RRRR". The year must be specified as RRRR.
You can modify this variable using db_env_setting records in the opa_settings file.
This variable specifies the language and character set settings used by Oracle RDBMS to read from and write to the database.
For Oracle Clinical and RDC Onsite, Oracle strongly recommends that you use the AL32UTF8 character set (the default value set during installation). However, these applications support UTF8, US7ASCII, WE8ISO8859P1, or any single byte character set.
Oracle Clinical and RDC use the NLS_LANG environment variable to control the language, territory, and character set used for database connections. The NLS_LANG variable concatenates the three components as LANGUAGE_TERRITORY.CHARSET.
You must set the CHARSET component of the NLS_LANG variable to match the character set of the database.
You must use the same character set on the database tier and the application tier. If you select US7ASCII for the database tier and AL32UTF8 or UTF8 for the application tier, Oracle Clinical stores some special characters incorrectly in the database.
For PSUB to work correctly for an AL32UTF8 character set database, the opa_settings file must have the following setting:
db_env_setting:database:NLS_LANG:american_america.AL32UTF8
The default value for this variable is:
db_env_setting:_DEFAULT_:NLS_LANG:american_america.AL32UTF8
You can modify this variable using db_env_setting records in the opa_settings file.
Note:
The default settings for all databases or the specific settings for a particular database, such as NLS_LANG, must be correct in the opa_settings file.This the batch queue for nonblocking PSUB jobs, on UNIX only.
If you want PSUB to use a batch queue other than the default for running user requests, redefine the setting for rxc_batch_queue. You can define it globally for all users, or individually by placing the command in the user's login script.
Default is a.
This is the spool directory for batch data load.
When a user requests Prepare to Completion for a given data file group, and does not specify otherwise in the submission form, any resulting reloadable data files are written to the directory specified by RXC_BDL_DIR. If there are no reloadable files, the completed files are placed in RXC_LOG.
This sets the output buffer size for executing procedures.
RXC_DEBUG_BUFFER_SIZE controls the size of the buffer space used for running a Validation or Derivation Procedure in debug mode. The installed default value is 200000; you may want to increase it to 1000000.
Batch queue for blocking PSUB jobs, on UNIX only
If you want PSUB to use a batch queue other than the default to process user requests for blocking jobs (such as default layout and generate procedure), redefine the setting for RXC_IMMED_QUEUE. It may be necessary to send blocking jobs to another batch queue so that they are not held up by other system activity, such as long-running reports.
Set this variable through db_env_setting records in the opa_settings file.
Oracle Clinical's Data Extract functionality requires a privileged Oracle user so that Oracle schemas can be created to hold Data Extract Views. The Oracle account for this purpose is RXC_MAA (Maintain Access Accounts).
RXC_MAA_TAB_SPACE specifies the name of the Oracle tablespace defined by RXC_MAA as the temporary tablespace when these schemas are created. During installation RXC_MAA_TAB_SPACE is set to TEMP1 with a size of 10Mb.
Set through db_env_setting records in the opa_settings file.
Defines the string for "now" that is used by the at command in the local language environment. This is effective only for 3GL and PL/SQL jobs submitted in immediate mode to run on UNIX back end servers. Default value is "now". To see your current "now" string, enter:
% echo $LANG
If LANG is undefined or is equal to "C", you have finished. The RXC_NOW_STRING is simply "now". Otherwise, do this:
% cd /usr/lib/nls/$LANG dumpmsg at.cat
The string for "now" is the third item in the third set of output.
Set through db_env_setting records in the opa_settings file.
This is the environment variable to which PSUB refers when the user chooses RXC_PRINTER from the list of values for printing a PSUB job. It refers to the default printer for Oracle Clinical.
This references to the default PSUB batch queue for SAS job, on UNIX only.
If you want PSUB to use a batch queue other than the default for running users' SAS requests, redefine the setting for RXC_SAS_BATCH_QUEUE, globally for all users, or individually by placing the command in the user's initialization file.
Set this variable to the full path of the database subdirectory of the sas_view directory: OPA_Home/sas_view/database_Oracle_SID. For example:
c:/home/opapps/sas_view/example_db
Set this variable to the full path of the database subdirectory of the sas_view directory: OPA_Home/sas_view/database_Oracle_SID. For example:
c:/home/opapps/sas_view/example_db
Note:
For historical reasons, two environment variables identify the same directory. Both RXC_SAS_VIEW and RXC_SAS_ROOT identify the root directory for all the input and output files associated with the Data Extract jobs that run in your installation. See Appendix B, "SAS_VIEW Directory Tree." (This is true with the exception of the .log and .out files now stored in the database).The Installer automatically populates these variables in UNIX and Windows, whether the database is local to the machine or remote.
This is the root directory for creating SAS files during data extract. For example, if RXC_USER is defined as /u01/oc, and ORACLE_SID is prod, then the data extract files go in /u01/oc/prod/… directory.
Note:
It is possible to set a different value for RXC_USER for each database, if you wish, overriding this default.When SAS is installed on a UNIX database, this environment variable must be defined when you run SAS Access against an Oracle database. The default value shipped in opa_settings is V9.
When PSUB and the SAS server are both on Windows, you must comment out the setting of SASORA in opa_settings.bat:
rem set SASORA=V9
This environment variable specifies the name and location of a user-defined script to be executed as the last step of batch validation.
For example:
USER_BV_JOB=/dir1/dir2/dir3/filename export USER_BV_JOB
The full pathname of the file must be specified.
At batch validation run time, the environment variable is evaluated and the corresponding script is submitted for execution via PSUB. The script is called with two arguments: clinical_study_id and clinical_study_version_id.
This section has information on UNIX settings.
On UNIX systems, you run the selection script, which checks the arguments you provide to define a configuration against the settings file. If the arguments are valid, the script applies the appropriate values to the corresponding environment variables in the current shell. The syntax for calling the selection script depends on whether you use the C shell or Bourne/Korn shells. For all shells, the selection script accepts at least one argument and an optional second:
| Argument | Description |
|---|---|
| database | Indicates the database to be used. This can be:
|
| code_env | Optional. An Oracle Clinical code environment designator that must refer to a code environment defined in the opa_settings file on the PSUB server. |
Note that using a - (minus) for the first argument neither updates nor creates a database context.
| Arguments Specified | Resulting Behavior | |
|---|---|---|
| database | ~ | With no code_env specified, the script sets only Oracle-level environment variables needed for applications to access database. |
| - (minus) | code_env | With no database specified, the script sets only environment variables needed for jobs to run. That is, it sets PATH to include RXC_PSUB and RXC_BIN, and defines the RXC_* environment variables. |
| database | code_env | With both database and code_env specified, the script executes both sets of commands. |
In Bourne and Korn shells:
For example:
$ p1=test $ p2=52 $ . opa_setup
In C shell:
For example:
%copa_setup test 52
The configurations are defined in the opa_settings file. The Oracle Universal Installer creates all necessary entries in this file during installation of software and creation or upgrade of databases. The most common reason to modify the opa_settings file is to customize the values set for various environment variables during execution of back end jobs. You may also need to modify the file to delete databases that are no longer available and enable the use of additional code environments against a database.
Each line in the file defines a particular type of environment information:
record_type_key:field_1[:field_2]...
Starting with an identifier of the type of information (record), the line also contains a colon (:) separator, followed by fields that contain the information for that record, each separated by colons. Table A-1, "List and Description of the Records in the opa_settings File" lists and describes each record type.
Use db_env_setting entries to define the value you want environment variables to assume during execution of back end jobs. You can add an entry for any environment variable you want to define; the definition will be in effect for any database if you set field 1 to _DEFAULT_. To limit the environment variable setting so that it affects only those jobs associated with a particular database, use the database's SID as the value for field 1.
The environment variable settings in opa_settings affect all users. To set a value for an environment variable for just one user, place a statement in that user's .oclrc script—for example, RXC_DEBUG=TRUE; export RXC_DEBUG.
If you want an environment variable setting to affect all jobs that run against a particular database, add or modify a database-specific entry in opa_settings—for example, db_env_setting:test:SQL_TRACE:TRUE.
Finally, if you want the setting to affect all jobs run against any database, add or modify a _DEFAULT_ entry for that environment variable—for example, db_env_setting:_DEFAULT_:RXC_SAS_BATCH_QUEUE:b
The last example in Table A-1, "List and Description of the Records in the opa_settings File" shows how to override a system-wide default setting with a database-specific setting.
Note:
The default settings for all databases or the specific settings for a particular database, such as NLS_LANG, must be correct in the opa_settings file.Oracle recommends that you use the defaults where possible, and add overrides only as needed. In addition, note the following constraints if you edit this file.
In the opa_settings file, there should be exactly one each of these record types:
opa_home
oratab_filespec
tnsnames_filespec
For each database instance appearing in a db_code_pair record, a value must be defined for each of the database environment settings (record type key db_env_setting). The setting may be made either through a generic _DEFAULT_ record, or through a database-specific record.
If you modify the opa_settings file, run the script ~opapps/bin/check_opa_settings.sh to check the settings file for errors. The syntax is:
check_opa_settings.sh [-nowarn] settings-file-name
The script generates an error message if it finds any duplicate record_type key values. These would cause an error if present when opa_setup is run. (In fact, opa_setup calls check_opa_settings.sh to preclude this. However, opa_setup does not check for warnings. See below).
Unless the -nowarn argument is provided, check_opa_settings.sh will also generate a warning for multiple db_code_pair entries for a single database. While multiple db_code_pair entries are not invalid, they may represent a condition you do not want to allow. For instance, if you upgrade database 'x' from 5.1 to 5.2, opa_settings would include:
db_code_pair:x:51 db_code_pair:x:52
In this case, check_opa_settings.sh warns you. Remove the line enabling the 5.1 code environment against the 5.2 database, so you don't mistakenly start up a PSUB process in that configuration.
You might want to disregard other warnings. For example, if you had a code tree for testing patches, as well as a production code tree. Then opa_settings might have:
db_code_pair:x:52 db_code_pair:x:52patchtest
You would disregard the warning check_opa_settings.sh would give, since both pairs are valid.
Table A-1 List and Description of the Records in the opa_settings File
| Record Type Key | Description | Example |
|---|---|---|
|
Location of the file oratab on the server Field 1: Fully specified path to the OPA directory |
|
|
|
Location of the file tnsnames.ora on this server. Ensure that this file has an entry for each connect string (that is, a reference to a remote database) that is required for OPA applications. The record provides information about accessing the database over the network. Field 1: Fully specified path to the file tnsnames.ora |
|
|
|
Location of Oracle Health Sciences (formerly known as Oracle Pharmaceutical Applications) products on the server. Field 1: Fully specified path to the OPA directory. |
|
|
|
Location of an available remote database, to which ORACLE_HOME should be set. Field 1: Net8 connect string of the remote database. Field 2: ORACLE_HOME value that is used while accessing the current database |
|
|
|
Location of the code for a version of an OPA application. Field 1: A code environment designator, for example, OC52 for the Oracle Clinical 5.2 code Field 2: The fully specified path to the root directory for the version of the application software |
|
|
|
Indicates that a particular code environment can be used with a particular database. Field 1: The system identifier (SID) of a local database instance, or the connect string of a remote database instance. Field 2: A code environment designator |
|
|
|
Provides either a default or database-specific setting for an environment variable. The following environment variables must have at least default settings: NLS_DATE_FORMAT NLS_LANG RXC_BATCH_QUEUE RXC_NOW_STRING SASORA These settings are assigned default values at install time. Field 1: The database SID, or connect string, if this is a database-specific setting for the environment variable; or _DEFAULT_, if this is a default setting across databases for this environment variable. Field 2: Name of an environment variable Field 3: Value to be assigned to the environment variable |
db_env_setting:_DEFAULT_:SASORA:V9 db_env_setting:TEST:SASORA:V9 |
The TNS_ADMIN environment variable is located in the .cshrc file in the opapps Home directory. It must point to the location where sqlnet.ora exists. The Installer puts sqlnet.ora in the opapps Home directory. slqnet.ora contains the path of the Oracle Wallet that contains the credentials for OCPSUB.
To set the value to the opapps Home:
.chsrc:
setenv TNS_ADMIN $HOME
During installation of the server code, the Installer creates the file opa_settings.bat, located in the opapps\bin directory. File opa_settings.bat contains the commands to set environment variables at startup and execution of the PSUB process.
Below is a list of the Oracle Clinical environment variables that must be defined in opa_settings.bat.
set NLS_DATE_FORMAT=DD-MON-RRRR
NLS_DATE_FORMAT determines the format in which client applications running on the Windows server transfer date information to and from the database. The format must specify the year as RRRR to be Year 2000 compliant.
set NLS_LANG=american_america.AL32UTF8
NLS_LANG determines which language settings Oracle uses when it reads and writes values into the database. The NLS_LANG entry in your registry for your iSuites Oracle Home must be consistent with the NLS_LANG setting in the Oracle Home and your databases.
opa_settings must have the following setting for PSUB to work correctly for a AL32UTF8 character set database. See NLS_LANG for more information.
To change or add environment variable settings active during back end job execution, edit the opa_settings.bat file with a text editor. Each line must be in the following format:
This section lists the Windows registry settings used by the Oracle Clinical application tier. It describes the settings for the each of the following:
These registry variables apply across products and are located at HKEY_LOCAL_MACHINE\SOFTWARE\ORACLE\KEY* where * is a random number assigned to the Oracle Home. Each value is set by the Installer.
Table A-2 OPA Front End Registry Variables and Example Values
| Registry Variable | Example Value | Description |
|---|---|---|
|
c:\opapps52\opa |
The path that is searched to find forms. |
|
|
FORMS_TIMEOUT |
10 |
The amount of time in elapsed minutes before the Form Services process is terminated when there is no client communication with the Form Services. To prevent the forms session's timing out due to inactivity, set the heartbeat value(defined in the formsweb.cfg file ) to less than the forms_timeout value. See article ID 549735.1 'Description List For Parameters Affect Timeout In Webforms' on My Oracle Support; see "Finding Information on My Oracle Support" for more information. |
|
OPA_CONFIG |
opa52 |
The OPA configuration name. |
|
OPA_RQM_URL |
https://server.domain:port/reports/rwservlet/showjobs?server=report_server_name |
The URL for the Reports Queue Manager. |
|
OPA_HOME |
c:\opapps52 |
The top-level OPA products directory. |
|
OPA_HOME_DIR |
c:\opapps52\opa |
The Oracle Health Sciences product directory. |
|
OPA_SERVER |
server.domain |
The full server name. |
|
OPA_PORT |
This should be set to NULL, that is, blank, to facilitate either HTTP or HTTPS operations. |
|
|
NLS_DATE_FORMAT |
DD-MON-YYYY |
The default NLS date format. |
|
NLS_LANG |
AMERICAN_AMERICA.W |
The NLS language. |
|
OPA_JARS |
f60all_jinit.jar, opaicons.jar |
The names of the OPA jar files to be downloaded to the client. This is used by the OUI to coordinate between product changes to the opa52 config section in the formsweb.cfg file. |
|
OPA_PHYSICAL_MAP |
c:\opapps52\html\repout |
The physical mapping to the repout directory. |
|
OPA_VIRTUAL_MAP |
/OPA_REPOUT/ |
The virtual mapping to the repout directory. |
|
OPA_DEV_VERSION |
60 |
The version of Developer. |
These registry variables are located on the SOFTWARE\ORACLE\KEYnumber branch of the registry. Each value is set by the Installer.
Table A-3 Oracle Clinical Front End Registry Variables and Example Values
| Registry Variable | Example Value | Description |
|---|---|---|
|
c:\opapps52\oc |
The Forms60 path that is searched to find forms |
|
|
forms60_repformat |
HTML |
|
|
forms60_userexits |
c:\opapps52\oc\f60xtb.dll; c:\oc\rxcde1.dll |
User Exits referenced from Oracle Clinical/RDC |
|
forms60_defaultfont |
MS Sans Serif 1.0 |
Oracle Clinical default font |
|
oc_home_dir |
c:\opapps52\oc |
The Oracle Clinical top level directory |
|
Arial.8 |
The default font for Oracle Clinical data entry field prompts and boilerplate text |
|
|
Arial.8 |
The default font for response fields in Oracle Clinical data entry |
|
|
f60all_jinit.jar, opaicons.jar,oclicons.jar, pharmaocjle.jar, pharmaocgle.jar, xmlcomp.jar, xmlparserv2.jar, jle2-0-3.jar |
The names of the OPA JAR files |
|
|
http://server.domain/opa52/rdc/temp |
The URL to access the xmltemp directory |
|
|
If forms and reports servers are on the same computers, the value should be c:\opapps52\html\rdc\temp If forms and reports servers are on different computers, the value should be t:\html\rdc\temp (where t:\ is mapped to OPA_HOME of the server where reports server is installed) |
The value that is passed to the report server that informs it how to access xmltemp. If the forms and reports servers are on the same computer, the value is a directory. If the forms and reports servers are on different computers, the value will be a UNC |
These registry variables are located on the SOFTWARE\ORACLE\KEYnumber branch of the registry on the application tier server where RDC is installed.
Table A-4 RDC Front End Registry Variables and Example Values
| Registry Variable | Example Value | Description |
|---|---|---|
|
c:\opapps52\rdc |
The path that is searched to find forms |
|
|
RDC_HOME_DIR |
c:\opapps52\rdc |
The location of the RDC directory |
|
\\appserver\rdc\dcif_images or c:\opapps52\html\rdc\dcif_images |
The location of the RDC directory images |
|
|
OPA_LOCALHOST |
oclw2k16.oracle.com |
If the RDC installation is used by client computers other than the application server, use the fully qualified application server name. If you plan to run the client locally on the application server computer, you can use the machine name e.g., oclw2k16. |
|
OPA_XML_LOC |
OPA_HOME/temp e.g.: c:\opapps52\temp |
This is a folder where temporary files are created at runtime and deleted at the end. This can be anywhere. During installation, this is set to its default value: OPA_HOME/temp. |
|
OPA_PJC_LISTENER_DEBUG_LEVEL |
1 |
Sets the debug level for the Pluggable Java Component (PJC). There are three options for the value:
By default, it is set to "1" during installation. |
These registry variables are located on the SOFTWARE\ORACLE\KEYnumber branch of the registry. Each value is set by the Installer.
These registry variables are located on the SOFTWARE\ORACLE\KEYnumber \HOME branch of the registry for the Reports Server installation. Each value is set by the Installer.
Table A-6 Report Server Registry Variables and Example Values
| Registry Variable | Example Value | Description |
|---|---|---|
|
REPORTS_PATH |
c:\opapps52\opa, c:\opapps52\oc, c:\winnt\fonts |
The path the system searches to find reports |
|
REPORTS_CLASSPATH |
c:\opapps52\lib\pdfappend.jar, c:\opapps52\lib\pdrgenerator.jar |
The path Reports uses to find classes |
|
NLS_DATE_FORMAT |
DD-MON-RRRR |
The date format when running reports for Oracle Clinical/RDC with the NLS option |
|
OC_RSERVER_DIR |
c:\opapps52\oc |
The Reports Server directory |
|
NLS_LANG |
american_america.AL32UTF8 |
The NLS language that is used when running Reports; supported values are: AL32UTF8, US7ASCII, WE8IS08859P1, or any single byte character set |
|
OC_PDF_REPORTS_TEMP_OC |
c:\opapps52\temp |
The temporary directory that the system uses when you run reports. |
|
OC_RPT_GRIDWIDTH |
8 |
The default grid width for the report |
|
OPA_HOME |
c:\opapps52\ |
The top level Oracle Health Sciences products directory. This is written to both the default and the specific branches of the registry. |
|
Arial.8 |
The default font for response fields in Oracle Clinical data entry |
|
|
Arial.8 |
The default font for data entry field prompts and boilerplate text. |
|
|
OC_RPT_FIELDFONT |
Arial.8 |
The font for response field data in the Patient Data Report. This variable is not created by the Installer. If you need to differentiate the field font used for the PDR from the one used for data entry, add this registry variable and set it. If not specified, the system uses the value for OC_DE_FIELDFONT. |
|
OC_RPT_TEXTFONT |
Arial.8 |
The font for CRF header field prompts, question prompts, and boilerplate text in the Patient Data Report. This variable is not created by the Installer. If you need to differentiate the text font used for the PDR from the one used for data entry, add this registry variable and set it. If not specified, the system uses the value for OC_DE_TEXTFONT. |
|
c:\opapps52\rdc\dcif_images |
The location of images that are used for DCI Forms and PDR generation. |
|
|
|
The path to the Adobe Acrobat or Reader application on the Report Server. Path must be in double-quotation marks and the "/t" must be included in the value. |
This section provides details about some registry keys. Use this information if it becomes necessary to modify the value of a registry key due to configuration or hardware changes.
In general, the values assigned to the keys are set by the Oracle Universal Installer (OUI), during the installation of various Oracle Health Sciences (formerly known as Oracle Pharmaceutical Application—OPA) components, based on answers you provide during the information-collection phase of the installation.
These registry keys are described in the following sections:
The value that is assigned to this key is based on the Oracle Health Sciences products that are installed on the computer. As each component is installed, the OUI appends product-specific values to the existing value. For example, if the Thesaurus Management System (TMS) is installed on a system where Oracle Clinical and RDC 5.1 are installed, the FORMS_PATH value would be:
c:\opapps52\opa;c:\opapps52\oc;c:\opapps52\rdc;c:\opapps52\tmsThe following table lists the path string that each component contributes to the FORMS_PATH key value.
The value that is assigned to this key is based on the OPA products that are installed on the computer. As each component is installed, the OUI appends product-specific values to the existing value.
The value that is assigned to this key is the directory on the application server that Oracle Clinical uses to write temporary files during the DCI form generation process. When the Oracle Clinical client is installed, the Oracle Universal Installer sets this value to:
drive:\opapps52\html\rdcThe Oracle Reports server also writes files to this directory during DCI form generation.
If any reports server used for this task is located on a different computer than the application server, the directory must be shared, with read/write privileges, to the domain/account on the report server; see the "Configure the Reports Server and Forms Server for DCI Form Generation" section in the Oracle Clinical Installation Guide.
For example, if during installation you specify in the Oracle Universal Installer that there is a standalone report server, the Installer sets the value of this key to:
C:\appserver_hostname\rdc\tempand requires that you share drive:\appserver_hostname\html\rdc with the share name "rdc".
If the only report server that you use to generate DCI forms is installed on the same computer as 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:\appserver_hostname\html\rdc\tempThe value that is assigned to this key must be a valid URL that points to the forms server directory to which Oracle Clinical writes temporary files during DCI form generation. When the Oracle Clinical client is installed, the OUI sets this value to:
drive:\appserver_hostnamedomain:port\html\rdc\tempThis is the same directory specified by the OPA_XMLTEMP_UNC key.
In order for the system to use this directory, it must be supported by an HTTP virtual directory that can serve files from it.
For example, if the temp directory is c:\opapps52\html\rdc\temp on myOCSever, then a virtual directory must be associated with c:\opapps52\html:
alias /opa52/ "c:\opapps52\html\"This allows a URL of http://myOCServer/opa52/rdc/temp/MYFILE.pdf to resolve and serve the file, c:\opapps52\html\rdc\temp\MYFILE.pdf.
The value that is assigned to this key must be the path specification of the directory in which image files that are referenced in DCI forms are found; see "Setting Up Image Viewing". However, the Patient Data Report generation subsystem uses its own registry variable to locate the path to the directory.
When the Oracle Clinical client is installed, the Installer sets this value to:
OPA_HOME\html\rdc\dcif_images\crfimagesIn a manner similar to OPA_XMLTEMP_UNC, the dcif_images directory specification must be one that can be resolved by any reports server that generates DCI forms.
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:\opapps52\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_imagesand requires that you share drive:\opapps52\html\rdc with the share name "rdc".
Note:
If the Patient Data Report generation process cannot locate the path to the dcif_images directory, each CRF that contains an image in its layout is not printed in the report.The value assigned to this key regulates the font size of response values that are typed in response fields and displayed in data entry windows. This registry key is set as part of the Oracle Clinical Front End installation and the Oracle Clinical Report Server installation in the SOFTWARE\ORACLE\KEYnumber branch.
The default value is Arial.8.
The value assigned to this key regulates the font size of the question prompts and boilerplate text in data entry windows. This registry key is present in:
the SOFTWARE\ORACLE\KEYnumber branch, where it is set as part of the Oracle Clinical Front End installation
the SOFTWARE\ORACLE\KEYnumber\DatabaseServer branch, where it is set as part of the Oracle Clinical Report Server installation
The default value in both locations is Arial.8. If you change the value in one location, change it in the other too.
If you want PDRs to look the same as the CRFs that are displayed in data entry windows, the value for both keys must be identical.
The value assigned to this 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".
These registry variables are located on the SOFTWARE\ORACLE\KEYnumber branch of the registry. Each value is set by the Installer.
Table A-8 Xhelp Registry Variables and Example Values
| Registry Variable | Example Value | Description |
|---|---|---|
|
opa_doc_dir |
http://server.domain/opa52 |
The URL for standard online help and documentation location |
|
opa_custom_doc_dir |
http://server.domain/opa52 |
The URL for custom online help and documentation |
|
opa_xhelp_dir |
c:\opapps\html\xhelp |
The location of the online help directories |
Many tasks in this guide require setting environment variables on the command line in UNIX or Windows. The syntax varies by the operating system and shell type, but always includes the database name and code environment.
The code environment value is two digits for the current Oracle Clinical major or minor release, without the point (.). For example, by default the code environment for Oracle Clinical 5.1 is 51 and the code environment for Oracle Clinical 5.2 is 52.
The syntax is:
For UNIX servers, C shell:
opa_setup database_name code_environment
For UNIX servers, Bourne shell:
p1 = database_name p2 = code_environment . opa_setup
For Window servers:
set p1=database_name set p2= code_environment opa_setup