Logging

The batch client provides several levels of logging through result and trace files. Result files contain details of the commands you enter in the command window and their execution status, error, or warning messages. Trace files contain a detail stack trace that is useful for debugging purposes.

The batch client uses Oracle Diagnostics Logging (ODL) for logging. All of the configuration parameters are stored in logger.xml in the conf directory. For example, EPM_ORACLE_INSTANCE\products\Foundation\BPMA\EPMABatchClient\output.

The following excerpt shows an example of a logger.xml file.

<logging_configuration>
    <log_handlers>
        <log_handler name="traceFile" class="oracle.core.ojdl.logging.ODLHandlerFactory">
        <property name="path" value="${user.dir}/output/EPMABatchClientTrace.log"/>
        <property name="maxFileSize" value="1000000"/>
        <property name="maxLogSize" value="5000000"/>
        <property name="useSourceClassAndMethod" value="true"/>
        <property name="encoding" value="UTF-8"/>
    </log_handler>
     <log_handler name="console"
                        level="ALL"
                        class="java.util.logging.ConsoleHandler"
                        formatter="com.hyperion.bpma.logger.GenericFormatter"/>
     <log_handler name="resultsFile"
                        class="com.hyperion.bpma.logger.GenericFileHandler"
                        formatter="com.hyperion.bpma.logger.GenericFormatter"
                        level="ALL"/>
    </log_handlers>
     <loggers>
        <logger name="BatchClient.trace" level="ALL" useParentHandlers="false">
            <handler name="traceFile"/>
        </logger>
         <logger name="BatchClient.console" level="INFO" useParentHandlers="false">
            <handler name="console"/>
        </logger>
         <logger name="BatchClient.results" level="INFO" useParentHandlers="false">
            <handler name="resultsFile"/>
        </logger>
    </loggers>
</logging_configuration>

To help you determine if the command was successful, the associated JobID and the JobID URL is logged for the following commands:

Note:

You have the option to use standard Formatters available in Java 1.6. For example, you can use java.util.logging.SimpleFormatter instead of com.hyperion.bpma.logger.GenericFormatter.