63.2 Registering the OpenSSO Agent

You can register the OpenSSO Agent.

Before you begin, complete the following steps:

  • Remotely register the agent so that the Agent Profile is created on the Oracle Access Management side. Use the remote registration tool on the OAM server located here:

    <Middleware_Home>/Oracle_IDM1/oam/server/rreg
    
  • Ensure that the fully-qualified domain name of the OAM server and the SAP server are updated in the hosts file on both systems.

    Always use the SAP and OAM server's fully-qualified domain name while installing or registering the agent and doing OAM configuration.

  1. Open the appropriate XML request file for editing. The request file will provide inputs for the registration.

    Request files are located inside the input folder.

  2. Modify the specific values to match your environment.
    <?xml version="1.0" encoding="UTF-8"?>
    <!-- Copyright (c) 2009, 2013, Oracle and/or its affiliates. All rights reserved. 
       NAME: OpenSSORequest.xml - Template (with all options) for OpenSSO Agent Registration Request file
       DESCRIPTION: Modify with specific values and pass file as input to the tool-->
    <OpenSSORegRequest>
        <serverAddress>http://OAMserver.example.com:7001</serverAddress>  
        <hostIdentifier>OPENSSO_HOSTID8</hostIdentifier>
        <agentName>OPENSSO_SAP8</agentName>
        <agentBaseUrl>http://SAPserver.example.com:50000</agentBaseUrl>
        <applicationDomain>OPENSSO_APPDOMAIN</applicationDomain> //Modify this.
        <autoCreatePolicy>true</autoCreatePolicy>
        <agentType>J2EE</agentType>
        <agentVersion>2.2</agentVersion> //Important: Make sure the version is 2.2.
        <agentDebugDir></agentDebugDir>
        <agentAuditDir></agentAuditDir>
        <agentAuditFileName></agentAuditFileName>
        <protectedAuthnScheme></protectedAuthnScheme>
    </OpenSSORegRequest>
    
  3. To register the agent, open a command prompt and run the following command from the bin directory in the rreg tool:
    oamreg.sh inband input/OpenSSORequest
    

    The command outputs the AMAgent.properties file, which is located in the output directory.

    Note:

    For OpenSSO agent 2.2, there is only one output file (AMAgent.properties), whereas for OpenSSO agent 3 there are two output files (OpenSSOAgentBootstrap.properties and OpenSSOAgentConfiguration.properties).

    This registration creates a footprint in the oam-config.xml file for the OAM domain, which is located here:

    <Middleware_home>/user_projects/domains/base_domain1/config/fmwconfig/oam-config.xml

    The registered agent is in an entry similar to the following:

    <Setting Name="<Agent_Name>" Type="htf:map">

    The registration process is now complete.