- Installation and Upgrade Instructions
- Set up the Oracle Empirica Signal software
- Set up the Oracle Empirica Signal properties files (skip for upgrades from 9.0 or later)
- Set up the webvdme.properties file for Oracle Empirica Signal
Set up the webvdme.properties file for Oracle Empirica Signal
You create and edit the webvdme.properties
file to supply
important properties to the Oracle Empirica Signal software.
Before you begin, if you intend to configure the Oracle Empirica Signal software to use single sign-on (SSO) with Oracle Access Manager, refer to Set up Oracle Access Manager for configuration details.
Perform these steps using the non-privileged user account on the application server.
- If you are installing the Oracle Empirica Signal software on this server for the first time, create a directory for temporary
files created by the Oracle Empirica Signal application if it has not already been created, for example:
$ mkdir /u01/app/oracle/product/Signal/temp
- Set the permissions on the directory containing the log file to enable write access for the non-privileged user account.
- Navigate to the
<INSTALL_DIR>/Signal/WEB-INF/classes
directory, for example:$ cd /u01/stage/Signal_Install/Signal/WEB-INF/classes
- If this is a new installation, copy the
template_webvdme.properties
file into the same directory, and name the copywebvdme.properties
, for example:$ cp template_webvdme.properties webvdme.properties
- If you are upgrading from Oracle Empirica Signal 8.x, copy your previous
webvdme.properties
to the<INSTALL_DIR>/Signal/WEB-INF/classes
directory, for example:$ cp /u01/stage/Signal_Install_old/Signal/WEB- INF/classes/webvdme.properties /u01/stage/Signal_Install/Signal/WEB- INF/classes/webvdme.properties
- Using a text editor, open the
webvdme.properties
file.- Edit the parameters according to the following table:
Parameter Description Example sqlldr_connect
Specify the value
<TNS_NAME>
.sqlldr_connect=orcl
temp_dir
Specify the path to the /temp directory you created in Step 1.
temp_dir=/u01/app/oracle/product/Signal/temp
instance.name
If you plan to use one application server to host multiple instances of Oracle Empirica Signal, provide the name of the instance.
If you do not plan to use one application server to host multiple instances of Oracle Empirica Signal, leave the
instance.name
blank.instance.name
=devor
instance.name
=#topicsService.url
If you plan to use the Oracle Empirica Topics feature, uncomment the line, and replace
localhost
with your server name and replaceportNumber
with the port number.If you do not plan to use the Oracle Empirica Topics feature, uncomment the line, and set the
topicsService.url
parameter to empty.topicsService.url=https://myserver:7006/TopicsService/ws/topicsService
The example is for an SSL environment, where you configure the SSL security policy for the Oracle Empirica Topics web service. For more information, see Set up the Oracle Empirica Topics web service security policy. For a non-SSL environment, use http and the appropriate port.
topicsService.maxAttachmentSizeMB
Specify the maximum allowed size for Oracle Empirica Topics attachments in MB. The recommended value is 100 MB.
topicsService.maxAttachmentSizeMB=100
#sso.plugins
To enable SSO, uncomment the line.
sso.plugins=com.oracle.hsgbu.empirica.sso.EmpiricaSsoPlugin
#sso.EmpiricaSsoPlugin.username.header
To enable SSO, uncomment the line.
The value of the
sso.EmpiricaSsoPlugin.username.header
property depends on your OAM configuration.sso.EmpiricaSsoPlugin.username.header=OAM_REMOTE_USER
#sso.EmpiricaSsoPlugin.logoutRedirectUrl
To enable SSO, uncomment the line, and replace the sample URL with your logout URL in the form <https://ssoServer:port/oamsso/logout.jsp>
.sso.EmpiricaSsoPlugin.logoutRedirectUrl=<OAM_logout_URL>?end_url=https://myserver:7004/Signal
#help.url
To point to more current help content than what appears in the application by default, uncomment the line and replace with the url for the most recent help content.
help.url=https://docs.oracle.com/pls/topic/lookup?ctx=en/industries/health-sciences/empirica-signal/9.2.2/userguide&id
#feedback.url
Specifies the path to Oracle Health Sciences Support.
#feedback.url=https://www.oracle.com/industries/health-sciences/support.html
- If you wish to configure IP Access Control List, edit the following
parameters according to the table below:
Parameter Description Example #IPACL_ENABLE=FALSE To configure Access Control List (ACL) in the Signal application, uncomment this parameter and set the value to TRUE.
Controls whether IP Access Control Lists are enabled or disabled.
Valid Options:
TRUE -> Enable ACL Checks
FALSE -> Do not enable ACL Checks
IPACL_ENABLE=TRUE
#IPACL_ SOURCE Uncomment the parameter and set the value to SOURCE_IP.
Specifies where to obtain the source IP.
This parameter is evaluated only when IPACL_ENABLE is set to TRUE.
Valid Options:
SOURCE_IP -> Evaluate ACL based on source IP of HTTP request
HEADER -> Evaluate ACL based on the value of a header within the http request
IPACL_ SOURCE = SOURCE_IP
#IPACL_HEADER_NAME This parameter defines which HTTP header contains the IP address.
This parameter is evaluated only when IPACL_ENABLE is set to TRUE and IPACL_SOURCE is set to HEADER.
Typically, this value is FORWARED-FOR, X-FORWARED-FOR, or COOKIE
Note: This implementation does not support the COOKIE header.
IPACL_HEADER_NAME=X-FORWARED-FOR
# IPACL_HEADER_VALUE_REGEX This parameter determines how the IP address is parsed from a header value.
This parameter is evaluated only when IPACL_ENABLE is set to TRUE and IPACL_SOURCE is set to HEADER.
The default value is \b\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}\b (the first thing resembling an IP address).
#IPACL_HEADER_VALUE_REGEX=\\b\\d{1,3}\\.\\d{1,3}\\.\\d{1,3}.\\d{1,3}\\b(\\s*,\\s*\\b\\d{1,3}\\.\\d{1,3}\\.\\d{1,3}.\\d{1,3}\\b)*
# IPACL_ALLOW Add IP addresses to the IPACL_ALLOW list separated by comma.
Defines the whitelist of IP addresses able to access the application.
This parameter is both evaluated and required only when IPACL_ENABLE is set to TRUE.
The format is as follows, in Backus Normal Form notation:
<ip4-octet> ::= <0..255
<ip4-address> ::=
<ip4- octet >.<ip4- octet >.<ip4- octet >.<ip4- octet >
<ip4-range> ::= <ip4-address>-<ip4-address>
<ip4-entry > ::= <ip4-address> | <ip4-range>
<ip_acl_list > := <ip4-entry > | <ip4-entry > {, <ip4-entry >}
IPACL_ALLOW : <ip_acl_list >
Examples: IPACL_ALLOW : 192.168.1.100
IPACL_ALLOW : 192.168.1.100, 192.168.1.101
IPACL_ALLOW : 192.168.1.100-192.168.1.200
IPACL_ALLOW : 192.168.1.100-192.168.1.200, 10.1.1.20
IPACL_ALLOW =192.168.1.100-192.168.1.200, 10.1.1.20
- Save and close the file.
- Edit the parameters according to the following table:
- For an SSO environment, update the session timeout value.
- Navigate to the
<INSTALL_DIR>/Signal/WEB-INF
directory, for example:$ cd /u01/stage/Signal_Install/Signal/WEB-INF
- Using a text editor, open the
web.xml
file. - Edit the session-timeout parameter so that it is greater than the session timeout for the single sign-on setup in the organization.
- Save and close the file.
- Navigate to the