Registering the Webgate with the Oracle Access Manager server

After you have installed the OHS Webgate, you use the remote registration (RREG) tool to register the OHS Webgate with the OAM server.

1. Obtain the RREG tarball (rreg.tar.gz) from the Oracle Access Manager server.
2. Extract the file to the OHS server.
3. Modify the script rreg/bin/oamreg.bat or oamreg.sh.

   Correct the OAM_REG_HOME and JAVA_HOME environment variables.

   OAM_REG_HOME should point to the extracted rreg directory created in the previous step.

   You may not need to change JAVA_HOME if it's already set in your environment.

4. In the input directory, create an input file for the RREG tool. The file can include the list of resources secured by this Webgate.

   You can omit this list if the application domain already exists.

   Here is an example of an input file where the resources have not been set up for the application domain and host in Oracle Access Manager:

   <?xml version="1.0" encoding="UTF-8"?>
   
   <OAM11GRegRequest>
   
   <serverAddress>http://oamserver.us.mycompany.com:7001</serverAddress>
   <hostIdentifier>myserver-1234</hostIdentifier>
   <agentName>myserver-1234-webgate</agentName>
   <applicationDomain>Information Discovery Studio</applicationDomain>
   <protectedResourcesList>
     <resource>/eid</resource>
     <resource>/eid/.../*</resource>
   </protectedResourcesList>
   <publicResourcesList>
     <resource>/public/index.html</resource>
   </publicResourcesList>
   <excludedResourcesList>
     <resource>/excluded/index.html</resource>
   </excludedResourcesList>
   
   </OAM11GRegRequest>

   In this example, the resources have already been set up in Oracle Access Manager:

   <?xml version="1.0" encoding="UTF-8"?>
   
   <OAM11GRegRequest>
   
   <serverAddress>http://oamserver.us.mycompany.com:7001</serverAddress>
   <hostIdentifier>myserver-1234</hostIdentifier>
   <agentName>myserver-1234-webgate</agentName>
   <applicationDomain>Information Discovery Studio</applicationDomain>
   
   </OAM11GRegRequest>

   In the input file, the parameter values are:

   Parameter Name	Description
   serverAddress	The full address (http://host:port) of the Oracle Access Manager administrative server. The port is usually 7001.
   hostIdentifier	The host identifier string for your host. If you already created a host identifier in the Oracle Access Manager console, use its name here.
   agentName	A unique name for the new Webgate agent. Make sure it doesn't conflict with any existing agents in the application domain.
   applicationDomain	A new or existing application domain to add this agent into. Each application domain may have multiple agents. An application domain associates multiple agents with the same authentication and authorization policies.

5. Run the tool:

   ./bin/oamreg.sh inband input/inputFileName 

   or

   .\bin\oamreg.bat inband input\inputFileName

   For example:

   bin\oamreg.bat inband
   			 input\my-webgate-input.xml 

   When the process is complete, you'll see the following message:

   Inband registration process completed successfully! Output artifacts are created in the output folder.

6. Copy the generated output files from the output directory to the OHS instance config directory (under webgate/config/).
7. Restart the OHS instance.
8. Test your application URL via OHS.

   It should forward you to the SSO login form.

   Check the OAM console to confirm that the Webgate is installed and has the correct settings.