Trace Messages

Trace messages provide information about adapter activities.

Trace messages are logged to the console where you starts the runtime adapter, and to a log file. They can also be redirected to the TIBCO Hawk Display application, or sent to other applications by using the TIBCO Rendezvous transport.

A trace message includes the following fields:

Field Description
Timestamp Timestamp of occurrence.

For example, 2014 Feb 22 20:14:51:718 GMT -8.

Adapter Identifier Name of the adapter that writes the trace message.

This is a combination of the adapter acronym and adapter configuration name. For example, the application identifier, AER3.pulisher1, identifies a TIBCO ActiveMatrix Adapter for SAP (TIBCO Business Studio) service named as publisher1.

Role

Trace message level.

Trace messages are grouped into the following levels:
  • Info

    Indicates normal adapter operation. No action is necessary. A trace message tagged with info indicates that a significant processing step was reached and has been logged for the tracking or auditing purpose. Only an Info messages before a tracking identifier are considered as a significant step.

  • Warn

    Indicates that an abnormal condition is found. Processing continues, but special attention from an administrator is good practice.

  • Error

    Indicates that an unrecoverable error occurs. Depending on the error severity, the adapter decides wether to continue with the next operation or stop altogether.

  • Debug

    Indicates trace messages defined by developers. In normal operating conditions, debug messages cannot be displayed.

When configuring the adapter, you can define whether trace messages of a role can be logged or not. For example, you can decide not to log trace messages of the info role to increase performance.
Category Category of trace messages.
Trace messages can be grouped into the following categories:
  • Adapter

    The adapter is processing an event.

  • Application

    The adapter is interacting with a SAP system.

  • Configuration

    The adapter is reading configuration information.

  • Database

    The adapter is interacting with a database.

  • Schema

    The adapter is retrieving metadata from a SAP system.

  • Palette

    The adapter is interacting with the palette.

  • Publication

    The Publication Service service is reporting this trace message.

  • Request-Response Invocation

    The Request-Response Invocation Service service is reporting this trace message.

  • Request-Response

    The Request-Response Service service is reporting this trace message.

  • Shutdown

    The adapter is shutting down.

  • Startup

    The adapter is starting.

  • Subscription

    The Subscription Service service is reporting this trace message.

  • Connection

    This is an application connection related trace message.

  • System

    This category is not linked to any specific event process. The trace message can be related to a Windows Service related message, memory allocation, file system error, and so on.

  • TibRvComm

    The adapter is communicating with TIBCO Rendezvous.

  • XML

    The adapter is parsing XML documents.

Status Code Unique code for the message and description.

Status codes are identified by an unique number and description. If a trace message includes an error or warn role, the status code includes a resolution.

Tracking Identifier Unique identifier that is “stamped” on each message by the originating adapter.

The tracking identifier remains in effect from the beginning of a message to its completion as it is exchanged by TIBCO applications. If the adapter is the termination point of the message, the tracking identifier is not displayed in the trace message. You cannot modify the tracking identifier format or configure what information to be displayed.

Application Information Application specific information added to the tracking info to trace the message back to its source.

Set initially by the originating adapter and carried forward. It is augmented by each intermediate component.

Example of Trace Messages

The following trace messages are displayed during a session where the adapter receives a message from a SAP system:
2014 Jan 24 10:46:10:486 GMT 5 SAPAdapter.SALESORDER-OUT Info [Adapter] AER3-000082 Successful initialization of Adapter 
2014 Jan 24 10:47:18:644 GMT 5 SAPAdapter.SALESORDER-OUT Info [Adapter] AER3-000114 Received invocation request for BAPI_SALESORDER_CREATEFROMDAT1 from SAP R/3 System tracking=#-0Y--C--DX1ALUbc--4zzzw-TEzzw#

The first trace message indicates that the adapter has been started. The fields in this trace message are:

  • Timestamp: 2014 Jan 24 10:46:10:486 GMT 5

    Indicates when the adapter has been started.

  • Adapter Identifier: SAPAdapter.SALESORDER-OUT

    Indicates that the trace message is about the activity of

  • Role: Info

    Indicates that the trace message is informational, that means the activity is normal for the adapter.

  • Category: Adapter

    Indicates that the category of this trace message is Adapter.

  • Status code: AER3-000082 Successful initialization of Adapter

    Indicates that the adapter has been started successfully.

The second trace message indicates the adapter received a message from the SAP system. The tracking identifier, #-0Y--C--DX1ALUbc--4zzzw-TEzzw#, uniquely identifies this trace message.