Enable the Logging for the AI and for the Target Server Component

This topic explains the steps you need to perform to generate detailed logging, to capture requests from AI to Gateway to the Siebel server component and task:

  1. Set SMC Logging = Information

    Log into SMC > Profiles > Application Interface > select the application profile being used > Logging section > set everything to INFORMATION level.

    INFORMATION level is sufficient for capturing the details. If desired, it is also possible to set these to DEBUG level as well.

    Note: Both Information or Debug level will work fine.
  2. Edit the <AI>\applicationcontainer_external\webapps\siebel\WEB-INF\log4j2-siebel.properties set to ALL for the CommonLogger.

    <logger name="CommonLogger" level="ALL" additivity="false">
    <AppenderRef ref="CommonLogger"/>
    </logger>
  3. Edit the <AI>\applicationcontainer_external\conf\server.xml bottom AccessLogValve section to have more descriptive information/labels for the log entry output.

    Note: Please refer to the Tomcat documentation for additional information on the flags within the AccessLogValve: https://tomcat.apache.org/tomcat-9.0-doc/config/valve.html
    Flag and Pattern Tomcat Loggings Flags
    Description and Usage

    %{begin:yyyy-MM-dd HH:mm:ss.SSS}t

    Request start time(formatted with label "Begin Time:" and yyyy-MM-dd HH:mm:ss.SSS)

    %{end:yyyy-MM-dd HH:mm:ss.SSS}t

    Response finish time (formatted with label "End Time:" and yyyy-MM-dd HH:mm:ss.SSS)

    %r

    First line of the request (method and request URI)

    %F

    Time taken to commit the response, in milliseconds

    %s

    HTTP status code of the response with prefix label 'http'

    %{Content-Length}i

    Write value of incoming header with name Content-Length

    %b

    Bytes sent, excluding HTTP headers, or '-' if zero

    %{SOAPACTION}i

    Write value of incoming header with name SOAPACTION

    Note: Adding the extra strings/labels such as PROCESSING TIME, HTTPS, MS, BYTES will help when reviewing the logs, provides more description to what the numerical values represent and easier when parsing/searching for patterns in the log file.
  4. Restart the AI container service after making the above changes.

  5. Set logging on the target Siebel server component.

    For instance the EAI OM component for inbound interfaces such as Inbound Web Services, Inbound REST, etc.

    1. Set all events on the EAI OM component to log level = 5 (preferred, in order to generate the maximum detail possible).

    2. Set the OM component parameter Enable Business Service Argument Tracing = TRUE"

      This will generate the Inbound_*.dmp file with the incoming soap payload data and SessionToken string, which then can be used to match back to the EAI OM task log file by matching the ending file's TaskId value.

    3. Restart the EAI OM component afterwards as changing the Enable Business Service Argument Tracing parameter requires a component restart.