Set up the webvdme.properties file for Oracle Empirica Topics REST service

To use Oracle Empirica Topics REST service, 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>/TopicsServiceR/WEB-INF/classes directory, for example:

   $ cd /u01/stage/Signal_Install/TopicsServiceR/WEB-INF/classes/webvdme.properties

2. If this is a new installation, 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 REST Service from a previous version, copy your previous Oracle Empirica Topics REST Service webvdme.properties to the <INSTALL_DIR>/TopicsServiceR/WEB-INF/classes directory, for example:

   $ cp /u01/stage/Signal_Install_old/TopicsServiceR/WEB-
   INF/classes/webvdme.properties
   /u01/stage/Signal_Install/TopicsServiceR/WEB-INF/classes/webvdme.properties
   

4. If you are using OAuth 2.0 authentication (recommended), open the webvdme.properties file in a text editor.
5. Edit the parameters according to the following table:

   Parameter	Description	Example
   topicsService.identityProviderurl	The URL of the OAuth 2.0 identity provider.	topicsService.identityProviderurl=https://idcs-xxxxxxxxxxxx.identity.oraclecloud.com
   topicsService.sub	The client ID of the OAuth application.	topicsService.sub=xxyyy-abcd-1111-2222-ax01233
   topicsService.aud	The intended audience for the OAuth 2.0 token.	The client ID or the audience value specified in the OAuth 2.0 application configuration :(topicsService.aud=https://idcs-xxxxxxxxxxxx.identity.oraclecloud.com) or a custom audience.
   topicsService.scope (optional)	You can define a custom scope in the identity provider to generate tokens. If you already created a custom scope in the Authorization Server for token generation, make sure to use the same value here. If you don’t have any custom scope, you can either leave this field empty or comment it out.	topicsService.scope=<custom scope> If no scope then this can be commented. #topicsService.scope=

6. Save and close the webvdme.properties file.