Set up the webvdme.properties file for Oracle Empirica Topics

To use Oracle Empirica Topics, set up the webvdme.properties file.

Perform these steps using the non-privileged user account on the application server.

  1. Navigate to the <INSTALL_DIR>/TopicsService/WEB-INF/classes directory, for example:

    $ cd /u01/stage/Signal_Install/TopicsService/WEB-INF/classes

  2. If this is a new installation or an upgrade from Oracle Empirica Signal 8.x, copy the template_webvdme.properties file into the same directory, and name the copy webvdme.properties, for example:

    $ cp template_webvdme.properties webvdme.properties

  3. If you are upgrading Oracle Empirica Topics from any 8.x version, copy your previous Oracle Empirica Topics webvdme.properties to the <INSTALL_DIR>/TopicsService/WEB-INF/classes directory, for example:
    $ cp /u01/stage/Signal_Install_old/TopicsService/WEB-
    INF/classes/webvdme.properties
    /u01/stage/Signal_Install/TopicsService/WEB-INF/classes/webvdme.properties
  4. Open the webvdme.properties file in a text editor.
    1. Edit the parameters according to the following table:
      Parameter Description Example

      instance.name

      Edit the instance name to match the instance name you provided for the Oracle Empirica Signal webvdme.properties file. See Set up the webvdme.properties file for Oracle Empirica Signal.

      See Set up the webvdme.properties file for Oracle Empirica Signal

      #feedback.url

      Specifies the path to Oracle Health Sciences Support.

      Add these two lines for the Feedback parameter:

      # Feedback URL

      #feedback.url=https://www.oracle.com/industries/health-sciences/support.html

      # Feedback URL

      #feedback.url=https://www.oracle.com/industries/health-sciences/support.html

    2. If you wish to configure IP Access Control List for Oracle Empirica Topics, edit the following parameters according to the table below:
      Parameter Description Example
      #IPACL_ENABLE=FALSE

      To configure Access Control List (ACL) in TopicsService, 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
  5. Save and close the webvdme.properties file.