Integration Framework Configuration

Integration Framework of SAP Business One
Settings for Development Environment
03, 2015
Objectives
At the end of this course, you will be able to:

Make the configuration and maintenance settings in order
to use the integration framework as a scenario
development environment
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
2
Integration Framework Configuration
Development Environment
After installation, the integration framework is configured for a productive
environment. To use the integration framework as a development environment,
you need to change some settings.
●
XCellerator configuration
●
Tomcat memory settings
●
Maintenance Settings
●
System Information
●
Message Log Configuration
●
Error Handling
●
User and Session Administration
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
3
Configuration Settings
Integration Framework Runtime
© 2015 SAP SE or an SAP affiliate company. All rights reserved.

Runtime web server for
integration framework is
handled by Tomcat

XCellerator is main
engine for integration
framework processes
and adapters

BizStore is a persistent
layer for viewing XML
data
5
Configuration for Development Environment - 1
xcellerator.cfg File

To use as a development environment, change Xcellerator configuration file
default parameters:
Path: ..\SAP\SAP Business One\SAP Business One Integration\
\Integration Server\Tomcat\webapps\B1iXcellerator\
\xcellerator.cfg
Development Environment
Productive Environment
full
disabled (default)
Extend as appropriate.
10 (default)
or minimum value needed *
For remote access,
set to true.
false (default)
or true, if needed *
xcl.webdav
xcl.http.sessionTimeout
xcl.http.localOnly
* These parameters affect security do not misuse them
Note: After changing xcellerator.cfg, restart the SAP Business One Integration Service.
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
6
Configuration for Development Environment - 2
xcellerator.cfg File

Other parameters in the Xcellerator configuration file that you can change for
use in a development environment:
Path: ..\SAP\SAP Business One\SAP Business One Integration\
\Integration Server\Tomcat\webapps\B1iXcellerator\
\xcellerator.cfg
Development Environment
com.sap.b1i.bizprocessor.level
com.sap.b1i.coordservice.level
com.sap.b1i.utilities.level
com.sap.b1i.dblayer.level
com.sap.b1i.xcellerator.level
Possible levels:
• SEVERE
• FINEST
• CONFIG* (debug)
*recommended
Productive Environment
SEVERE
xcl.threads
Change for multiple processors
-1 (default)
Change for multiple processors
-1 (default)
xcl.recovery
disabled*
enabled (default)
*recommended for debugging and
testing
Note: After changing xcellerator.cfg, restart the SAP Business One Integration Service.
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
7
Safe Mode Configuration
xcellerator.cfg File

You can start the integration framework in safe mode by changing the
parameter in the configuration file:
Path: ..\SAP\SAP Business One\SAP Business One Integration\
\Integration Server\Tomcat\webapps\B1iXcellerator\
\xcellerator.cfg
Safe Mode Use cases
•
•
•
Locked administrator user – see
SAP Note # 1556041
An error-prone process blocks the
integration framework, even after
restart
Integration framework will not start
due to application deployment
problems
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
Activation
•
Set xcl.safemode=true
•
Restart the integration service
Safe Mode Limitations
•
All adapters are disabled
•
User authentication is disabled
•
Access is only possible from the
local machine.
8
Configuration
Tomcat Memory

Assign more RAM to improve performance:
Path: ..\SAP\SAP Business One\SAP Business One Integration\
\Integration Server\Tomcat\bin_64 (or bin)\tomcat6w.exe
● To assign Tomcat memory:
● Open tomcat6w.exe
● Select the Java tab
● Recommended values for a 32bit system:
● Initial memory pool: 256 MB
● Maximum memory pool: 1024MB
● Recommended values for a 64bit system:
● Initial memory pool: 256MB
● Maximum memory pool: 2048MB or more,
depends on server memory, no limit defined
by Tomcat
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
9
Maintenance Settings
Maintenance
System Information
Path: Maintenance → System Info
Integration framework
information:

Version Number of
installed integration
framework

Version Information:
list of changes with
each version

Functions: available
inbound and
outbound channels,
atoms and functions
in current release
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
11
Maintenance
Development Mode and Prefix
Path: Maintenance → Cfg Dev Env.

Set the Mode to
Vendor

Enter a Development
Prefix – SAP
recommends a three
character prefix
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
12
Maintenance
Message Log Configuration -1Path: Maintenance → Cfg MsgLog
For development, enable the
message log checkboxes:

Message Log: Enable the
generation of message
logs (default is off)

Daily Deletion: Enable the
daily deletion (garbage
collection) of message logs

Indexed Access: improves
performance of accessing
message logs (default)
This configuration is optional and all options can be activated or done manually.
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
13
Maintenance
Message Log Configuration -2Path: Maintenance → Cfg MsgLog
Additional message log settings:

Blocksize: Number of
messages displayed on one
page

User Interface Refresh
Timeout: Minutes that the
message log screen
remembers the timestamps in
the filter setting

Log Level: Level of information
generated in message log:



© 2015 SAP SE or an SAP affiliate company. All rights reserved.
Infoset
Full message
Full message including binary
data
14
Maintenance
Message Log Configuration – Daily Deletion
Path: Maintenance→ Cfg MsgLog – Daily Deletion
Options for daily deletion
of logs:
© 2015 SAP SE or an SAP affiliate company. All rights reserved.

Deletion Time: hour

Backup Buffer: number
of days to exclude from
deletion

Last Deletion:
timestamp

Delete Imported
Messages: garbage
collector will delete
imported messages
15
Maintenance
Default Error Handling
Path: Maintenance → Cfg Error Handling

View the default error handling for synchronous and asynchronous
transaction processing

Error handling option for Processing phase
You can also define error
handling in the scenario package.
Choose Scenarios > Package
Design, and select the Definitions
button.
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
16
Maintenance
Error Handling – Additional Actions
Path: Maintenance → Cfg Error Handling
To set additional error actions, choose the buttons:

Overall Actions to configure a notification to be sent when a message blocks
an integration queue

Outbound Error Actions to define specific error actions for outbound phase

Garbage Collection to configure garbage collection for error information
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
17
Maintenance
Error Handling – Overall Actions
Path: Maintenance → Cfg Error Handling → Overall Actions

QBlocker alert

Choose the
Overall Actions
button to enable
a notification to
be sent when a
message blocks
an integration
queue

Choose the
Configure button
to provide the
email details
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
18
Maintenance
Error Handling – Outbound Error Actions - 1
Path: Maintenance → Cfg Error Handling → Outbound Error Actions

Option to define
specific error actions
that apply at package,
step, or outbound
channel level

Choose Outbound
Error Actions button

Choose
to define
a new error action
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
19
Maintenance
Error Handling – Outbound Error Actions - 2
Path: Maintenance → Cfg Error Handling → Outbound Error Actions
To configure the actions:
1. Select the error action
type (scenario, step,
outbound)
2. Select the event that
triggers the error action
3
5
3. Click Select Actions to
define the error actions
4. Select what should
happen if an error
occurs in the outbound
phase.
4
5. Activate the action
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
20
Summary

The integration framework provides both a development and runtime
environment. After installation, the integration framework is configured for a
productive environment

To use the integration framework as a development environment, you need
to change some configuration settings in:

The main configuration file xcellerator.cfg

Tomcat memory (optional)

The Maintenance section of the user interface for message log and
error handling
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
21
Thank You!
© 2015 SAP SE or an SAP affiliate company.
All rights reserved.
No part of this publication may be reproduced or transmitted in any form or for any purpose without the express permission of SAP SE
or an
SAP affiliate company.
SAP and other SAP products and services mentioned herein as well as their respective logos are trademarks or registered trademarks
of SAP SE
(or an SAP affiliate company) in Germany and other countries. Please see http://global12.sap.com/corporateen/legal/copyright/index.epx for additional trademark information and notices.
Some software products marketed by SAP SE and its distributors contain proprietary software components of other software vendors.
National product specifications may vary.
These materials are provided by SAP SE or an SAP affiliate company for informational purposes only, without representation or
warranty of any kind, and SAP SE or its affiliated companies shall not be liable for errors or omissions with respect to the materials. The
only warranties for SAP SE or
SAP affiliate company products and services are those that are set forth in the express warranty statements accompanying such
products and services, if any. Nothing herein should be construed as constituting an additional warranty.
In particular, SAP SE or its affiliated companies have no obligation to pursue any course of business outlined in this document or any
related presentation, or to develop or release any functionality mentioned therein. This document, or any related presentation, and SAP
SE’s or its affiliated companies’ strategy and possible future developments, products, and/or platform directions and functionality are all
subject to change and may be changed by SAP SE or its affiliated companies at any time for any reason without notice. The
information in this document is not a commitment, promise, or legal obligation to deliver any material, code, or functionality. All forwardlooking statements are subject to various risks and uncertainties that could cause actual results to differ materially from expectations.
Readers are cautioned not to place undue reliance on these forward-looking statements, which speak only as of their dates, and they
should not be relied upon in making purchasing decisions.
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
23