IBM BPM, V8.0.1, All platforms > Programming IBM BPM > Business objects programming

Configure logging properties for business objects

Use the administrative console to enable logging and to select the required log specification, level of detail, and output format of the log. Business objects provide different log specifications for different functionality areas, and selecting the appropriate level of logging helps isolate and troubleshoot the problems in that area.

You can change the log configuration statically or dynamically. Static configuration takes effect when you start or restart the application server. Dynamic, or runtime, configuration changes are applied immediately.

To enable logging and set the output properties for a log, use the following procedure.


Procedure

  1. In the navigation pane of the administrative console, click Servers > Server Types > WebSphere application servers.

  2. Click the name of the server that you want to work with.
  3. Under Troubleshooting, click Loging and tracing.
  4. Under Troubleshooting, click Logging and tracing.
  5. Click Change log detail levels.
  6. Change the trace settings by clicking Change log detail levels.

  7. Specify when you want the change to take effect:

    • For a static change to the configuration, click the Configuration tab.

    • For a dynamic change to the configuration, click the Runtime tab.

  8. Expand the list, and then click the names of the public packages (described in Table 1) whose logging level you want to modify.

    Logging specification descriptions
    Logging specification Usage
    BOChangeSummary Enable this log specification in the following circumstances:

    • When changes are not logged in a business graph even though you have change summary enabled

    • You are using the BOChangeSummary API

    BOCopy Enable this log specification if you are using the BOCopy API in a business application and you notice that the copied object does not match the original object.
    BOCore Enable this log specification for any issues related to initialization of Business Object framework, loading of Business Object services, or schema loading.
    BODataObject Enable this log specification if you use the BODataObject API to access data object aspects of a business object (such as the change summary, event summary, and business graph).

    Also enable this log specification when you are using the BOLAZY parsing mode and you find issues related to retrieving, modifying, or unsetting the data on the business object.

    BOEquality Enable this log specification if you find issues when using the BOEquality API to determine if two business objects are equal.
    BOFactory Enable this log specification if you find issues when creating business objects using the BOFactory API.
    BOImpl Enable this log specification for issues related to other Business Object framework implementation classes.
    BOInstanceValidator Enable this log specification for issues related to business object instance validation.
    BOType Enable this log specification for issues that arise when using the BOType API to create types.
    BOTypeMetadata Enable this log specification for issues related to transforming an annotation string to a data object (or vice-versa) using the BOTypeMetadata API.
    BOXMLSerializer or BOXMLSerializerXMLTrace Enable these log specifications for any issues related to serialization or deserialization of business objects. Enabling BOXMLSerializerXMLTrace will print the XML document being read or written in the log file.
    For any other issues, enable the BOCore log specification.

    You can enable multiple log details for issues spanning multiple areas.

  9. Expand Message and Trace Levels, and then select the logging level (as described in Table 2).

    Logging levels
    Logging Level Description
    Fatal The task cannot continue or the component cannot function.
    Severe The task cannot continue, but the component can still function. This logging level also includes conditions that indicate an impending fatal error (that is, situations that strongly suggest that resources are on the verge of being depleted).
    Warning A potential error has occurred or a severe error is impending. This logging level also includes conditions that indicate a progressive failure (for example, the potential leaking of resources).
    Audit A significant event has occurred that affects the server state or resources.
    Info The task is running. This logging level includes general information outlining the overall progress of a task.
    Config The status of a configuration is reported or a configuration change has occurred.
    Detail The subtask is running. This logging level includes general information detailing the progress of a subtask.
    All Superset of all the logging levels.

  10. Click Apply.

  11. Click OK.


Results


What to do next

To have static configuration changes take effect, stop and then restart the process server.

Business objects programming


Related concepts:
Business objects


Related information:

Configure the business object parsing mode of modules and libraries