Oracle Cloud Infrastructure Documentation

Configure Automatic Injection in APM Agent for Siebel

To use APM to monitor real time user sessions (browser interactions) in Siebel, you need to configure automatic injection in the APM Java agent.

After the APM Java agent is deployed on the Siebel server, enable the automatic browser injection by doing the following:

  1. Open the AgentConfig.properties file.

  2. Look for the following existing parameters: com.oracle.apm.agent.rum.enable.injection, com.oracle.apm.agent.public.data.key and com.oracle.apm.agent.rum.service.name which are commented out in the file. (The parameters have a # sign or hashtag at the beginning of the line).

    Uncomment the above parameters and update their values and save the file.

    The file looks like the following: 
    com.oracle.apm.agent.rum.enable.injection=true
com.oracle.apm.agent.public.data.key=<Public_Data_Key> 
com.oracle.apm.agent.rum.service.name=<Siebel_APM_Browser>
    • The value of the <Public_Data_Key> can be obtained from the APM Domain details page. For information, see Obtain Data Upload Endpoint and Data Keys.
    • The value of the <Siebel_APM_Browser> is the service name value that you specify for your Siebel APM Browser Agent. For example: SIEBEL_UI.

  3. Capture the username in plain text for the Siebel sessions.

    The Siebel integration with APM captures the username by default as a hash. This minimizes the exposure of person identifiable information, while still allowing reporting on retention and unique users.

    In some environments, there is a need to report the plain value instead. This can be accomplished by changing the BrowserAgent template to include the following line:

    window.apmrum.trackPlainUserId=true;

    The BrowserAgentTemplate.txt file after this change looks something like the following: 

    <script type="application/javascript">
window.apmrum = (window.apmrum || {});
window.apmrum.serviceName='@@SERVICE_NAME@@';
window.apmrum.webApplication='@@WEB_APPLICATION@@';
window.apmrum.ociDataUploadEndpoint='@@UPLOAD_ENDPOINT@@';
window.apmrum.OracleAPMPublicDataKey='@@PUBLIC_KEY@@';
window.apmrum.username='@@USER_NAME@@';
window.apmrum.trackPlainUserId=true;
</script>
<script type="application/javascript" crossorigin="anonymous" src="@@UPLOAD_ENDPOINT@@/static/jslib/apmrum.min.js"></script>