You are on page 1of 13

Log Configuration for

SEEBURGER Adapters
- How-To Guide SEEBURGER AG

Platform: SAP Process Integration


Release: 7.1x / 7.3x

Log Configuration for SEEBURGER Adapters

SEEBURGER AG

How-To Guide

Inhalt
SYMBOL

DESCRIPTION

OVERVIEW

Trace Formatter

Log Destination

Category

Location

Severity

CONFIGURATION

Allow multiple trace files

Creating a Trace Formatter

Creating a Log Destination and assigning a Trace Formatter

Creating a Category and assigning a Destination

Creating a Location and assigning a Destination

10

Adjusting the runtime Severity

12

Seite 2/13

2013-03-20

Log Configuration for SEEBURGER Adapters

SEEBURGER AG

How-To Guide

Icons
Symbol

Description
Caution
Warning
Note
Recommendation
Requirements
Information
Example
Code

Seite 3/13

2013-03-20

Log Configuration for SEEBURGER Adapters

SEEBURGER AG

How-To Guide

Overview
Trace Formatter
The Trace Formatter defines the layout of a trace file. You can configure the format of e.g. date, time,
application name, thread name etc. in the trace file.

Log Destination
Log Destinations are representing the physical trace files on the file system.
A Log Destination specifies file name, file path, maximum file size and number of created files.
Also a Trace Formatter has to be assigned to the Log Destination, to get a readable trace file.

Category
A Category groups several Software Components to a logical unit. This unit can be assigned to any
Destination. The trace level of a log file can be predefined in the SAP Config Tool and adjusted during
runtime using the NetWeaverAdministrator (NWA).

Location
Locations are describing specific Java packages. Like Categories Locations can be assigned to any
Destination. The trace level of a log file can be predefined in the SAP Config Tool and adjusted during
runtime using the NetWeaverAdministrator (NWA).

Severity
Severity defines the trace level.
Severity
ALL

Value
0

DEBUG

100

PATH

200

INFO

300

WARNING

400

Details
The lowest severity.
Controller with such a severity logs all the messages,
regardless of their severity.
Messages with severity ALL are logged only by
controllers with the same severity. All other controllers
suppress those messages.
For debugging purposes, with extensive and low level
information.
For tracing the execution flow. It is used, for example,
in the context of entering and leaving a method, looping
and branching operations.
Informational text, mostly for echoing what is
performed.
Announces that the application can recover from an
anomaly and fulfill the required task. However, it needs
attention from developer/operator.

Seite 4/13

2013-03-20

Log Configuration for SEEBURGER Adapters

SEEBURGER AG

How-To Guide
ERROR

500

FATAL

600

NONE

701

Announces that the application can recover from error.


However, it cannot fulfill the required task due to the
error.
Announces that the application cannot recover from
error. The severe situation causes a fatal termination.
the highest severity.
Log controllers with severity NONE logged only the
messages with the same severity.
Messages with that severity are logged by all the log
controllers, regardless of their severity.

Configuration
Allow multiple trace files
Open the SAP Config Tool and navigate to Template > Managers > LogManager.

Set the parameter ForceSingleTraceFile to NO to allow multiple trace files. Save the changes.

Seite 5/13

2013-03-20

Log Configuration for SEEBURGER Adapters

SEEBURGER AG

How-To Guide
To allow generation of trace files for SEEBURGER adapters the Location seeburger.com must be
added to the parameter SingleTraceFile_UnrestrictedLocations. Multiple Values for this parameter
have to be separated by semicolon ;.

Creating a Trace Formatter


To create a Trace Formatter navigate to Template > Log configuration > Formatter in the SAP Config
Tool.

Select an existing Entry and click > New to create a new one. Enter a Name for the new Trace
Formatter (e.g. seeburger-readable). Choose TraceFormatter as Type and use the following Pattern:
Code:
%26d %150l [%t] # %s # %m

Seite 6/13

2013-03-20

Log Configuration for SEEBURGER Adapters

SEEBURGER AG

How-To Guide

Save the changes, close the Config Tool and restart the J2EE server! If you are asked to save again
while closing the Config Tool click No!
Caution:
Due to a bug in the Config Tool of PI 7.1x the changes wont be saved if you dont proceed as
described above. Also the changes will be rejected if the Trace Formatter is reopened.

Creating a Log Destination and assigning a Trace Formatter


To create a Log Destination navigate to Template > Log configuration > Destinations in the SAP
Config Tool.

Select an existing Entry and click > New to create a new one. Enter a Name and a Pattern (the table
below shows some naming recommendations).

Seite 7/13

2013-03-20

Log Configuration for SEEBURGER Adapters

SEEBURGER AG

How-To Guide

Recommendation:
General
General

Naming recommendation
seeburger-locationreadable-log
Naming recommendation
seeburger-as2-readablelog
seeburger-ftp-readable-log

Adapter
AS2
FTP
Splitter

Zip

seeburger-splitterreadable-log
Naming recommendation
seeburgerattachment_renamereadable-log
seeburger-attribmapperreadable-log
seeburger-dsig-readablelog
seeburger-filestorereadable-log
seeburger-splitter_modulereadable-log
seeburger-secunetreadable-log
seeburger-zip-readable-log

Converter
BIC Runtime

Naming recommendation
seeburger-bic-readable-log

BIC Adapter

seeburger-bic_adapterreadable-log
seeburger-classifierreadable-log
seeburger-seefunctionsreadable-log

Module
AttachmentRename

AttribMapper
DSig
Filestore
Message Splitter
Secunet

BIC Classifier
SeeFunctions

Log Destination Pattern


./log/seeburger/adapter/seeburger-locationreadable.trc
Log Destination Pattern
./log/seeburger/adapter/seeburger-as2readable.trc
./log/seeburger/adapter/seeburger-ftpreadable.trc
./log/seeburger/adapter/seeburger-splitterreadable.trc
Log Destination Pattern
./log/seeburger/modules/seeburgerattachment_remane-readable.trc
./log/seeburger/modules/seeburger-attribmapperreadable.trc
./log/seeburger/modules/seeburger-dsigreadable.trc
./log/seeburger/modules/seeburger-filestorereadable.trc
./log/seeburger/modules/seeburger-splitterreadable.trc
./log/seeburger/modules/seeburger-secunetreadable.trc
./log/seeburger/modules/seeburger-zipreadable.trc
Log Destination Pattern
./log/seeburger/converter/seeburger-bicreadable.trc
./log/seeburger/converter/seeburger-bic_adapterreadable.trc
./log/seeburger/converter/seeburger-classifierreadable.trc
./log/seeburger/converter/seeburgerseefunctions-readable.trc

Select FileLog for Type and All for Severity (can be changed via NWA during runtime). Enter the
values for Count (number of trace files) and Limit (file size).
Recommendation:
Count: 5
Limit:

10485760 Byte (10 MB)

Select the TraceFormatter created in chapter Creating a Trace Formatter.

Seite 8/13

2013-03-20

Log Configuration for SEEBURGER Adapters

SEEBURGER AG

How-To Guide

Creating a Category and assigning a Destination


To create a Category navigate to Template > Log configuration > Categories in the SAP Config Tool.

Select an existing Entry and click > New to create a new one. Enter a Name (the table below shows
some naming recommendations).
Recommendation:
Adapter
AS2
FTP

Category Name
\Applications\ExchangeInfrastructure\AdapterFramework\ThirdPartyRoot\SEEBUR
GER\AS2
\Applications\ExchangeInfrastructure\AdapterFramework\ThirdPartyRoot\SEEBUR
GER\FTP

Seite 9/13

2013-03-20

Log Configuration for SEEBURGER Adapters

SEEBURGER AG

How-To Guide
Module
AttachmentRena
me
AttribMapper
DSig
Filestore
Message Splitter
Secunet
Zip
Converter
SeeFunctions

Category Name
\Applications\ExchangeInfrastructure\AdapterFramework\ThirdPartyRoot\SEEBUR
GER\MODULE-ATTACHMENTRENAME
\Applications\ExchangeInfrastructure\AdapterFramework\ThirdPartyRoot\SEEBUR
GER\MODULE-ATTRIBMAPPER
\Applications\ExchangeInfrastructure\AdapterFramework\ThirdPartyRoot\SEEBUR
GER\MODULE-DSIG
\Applications\ExchangeInfrastructure\AdapterFramework\ThirdPartyRoot\SEEBUR
GER\MODULE-FILESTORE
\Applications\ExchangeInfrastructure\AdapterFramework\ThirdPartyRoot\SEEBUR
GER\MODULE-MESSAGESPLITTER
\Applications\ExchangeInfrastructure\AdapterFramework\ThirdPartyRoot\SEEBUR
GER\MODULE-SECUNET
\Applications\ExchangeInfrastructure\AdapterFramework\ThirdPartyRoot\SEEBUR
GER\MODULE-ZIP
Category Name
\Applications\ExchangeInfrastructure\AdapterFramework\ThirdPartyRoot\SEEBUR
GER\FUNCTIONS

Select All for Severity (can be changed via NWA during runtime). Assign a Destination by clicking >
Add. Save the changes.
Note:
The J2EE server must be restarted once, after all Categories and Locations are created.

Creating a Location and assigning a Destination


To create a Location navigate to Template > Log configuration > Locations in the SAP Config Tool.

Seite 10/13

2013-03-20

Log Configuration for SEEBURGER Adapters

SEEBURGER AG

How-To Guide

Select an existing Entry and click > New to create a new one. Enter a Name (the table below shows
some naming recommendations).
Recommendation:
General
General
Adapter
Splitter
Converter
BIC
Runtime
BIC
Adapter
BIC
Classifier

Location Name
com.seeburger
Location Name
com.seeburger.xi.messagesplitter.adapter
Location Name
com.seeburger.jucon
com.seeburger.bicxiadapter
com.seeburger.bicxiadapter.module.classifier

Select All for Severity (can be changed via NWA during runtime) Assign a Destination by clicking >
Add. Save the changes.

Seite 11/13

2013-03-20

Log Configuration for SEEBURGER Adapters

SEEBURGER AG

How-To Guide

Note:
The J2EE server must be restarted once, after all Categories and Locations are created.

Adjusting the runtime Severity


The trace level of Categories and Locations can be changed during runtime using the NetWeaver
Administrator (NWA).
Open the NetWeaver Administrator (http://<server>:<port>/nwa) and navigate to Configuration
Management > Infrastructure > Log Configuration
To change the severity of a Category, select Show > Logging Categories and navigate to Applications
> ExchangeInfrastructure > AdapterFramework > ThirdPartyRoot > SEEBURGER. Set the Severity to
an applicable level.
Recommendation:
For productive systems it is recommended to set Info as highest level.
Save the changes > Save Configuration.

Seite 12/13

2013-03-20

Log Configuration for SEEBURGER Adapters

SEEBURGER AG

How-To Guide

To change the severity of a Location select Show > Logging Categories. Set the Severity to an
applicable level.
Recommendation:
For productive systems it is recommended to set Info as highest level.
Save the changes > Save Configuration.

Information:
For further information please refer to SAP Help - Log Configuration

Seite 13/13

2013-03-20