Configuring SAP Business One-Related Components on the SAP Business One Server for SAP ECC Integration

Configuring SAP Business One-Related Components on the SAP Business One Server for SAP ECC Integration

SAP Business One Event Sender and SAP Business One DI Proxy are components that enable communication between SAP Business One and the integration framework for SAP Business One as well as with SAP ECC.

The following options are possible:

  1. In the subsidiary, you have installed SAP Business One with the integration framework of SAP Business One. Use the SAP Integration Framework 2.0 to install SAP Business One Event Sender and SAP Business One DI Proxy on the SAP Business One server.
    1. Refer to the Setting up SAP Business One Event Sender section to configure SAP Business One Event Sender.
    2. Check the default setup of SAP Business One DI Proxy and adjust it as needed.
  1. If you have installed SAP Business One together with the integration framework of SAP Business One, you have also installed SAP Business One Event Sender and SAP Business One DI Proxy. 
    1. Check whether the SAP Business One Event Sender setup also covers events you want to send to SAP Integration Framework 2.0. 
    2. Check the default setup of SAP Business One DI Proxy and adjust it as needed.

Setting Up SAP Business One Event Sender

SAP Business One writes events about new data, changes and deletions to the SEVT table. Based on filter definitions, the event sender accesses the table, picks up data and hands over the events to SAP Integration Framework 2.0 for further processing. 

The installation program installs the event sender on the SAP Business One server and automatically sets it up. The following section describes the settings. Usually you would not have to change any settings. The event sender setup is available as an external tool and as part of the integration framework. Note that the inbuilt function only works, if the event sender is installed on the same machine as the integration framework.


NOTE

Call the event sender setup only in the following cases:

    1. You must change the password for database access.
    2. You have changed the B1iadmin password (runtime user).
    3. You have moved to another SQL server.
    4. You want to include or exclude some objects to reduce the message load.
    5. You want to exclude users.

Procedure

  1. To call the event sender setup, select Start → All Programs → Integration Framework for SAP Business One → SAP Business One Event Sender Setup.
  2. In Step 1/5 in the Choose a Database Type field, you can select your SAP Business One database type.
  3. In the DB Connection Settings section, you can set the following:

  1. In the DB Server Name field, enter the computer name or IP address of the machine, where the database of the SAP Business One server is installed. Do not use localhost.

Caution

In SAP Integration Framework 2.0 installation this setting must be identical to the value in the b1Server field.

If the values are not identical, they appear in the Filtered section.

  1. In the Port field, enter the port number of the database server, where the SAP Business One server is installed.
  2. In the Setup DB Account and Password fields, the installation has set the database user name and password for database access during setup. 

This user must have access rights to create tables and store procedures.

  1. In the Running DB Account and Password fields the installation has set the database user name and password for database access during runtime. 

This user must have access rights to the event log and event lock tables.

  1. If you want to use the Microsoft Windows authentication mechanism to connect to the database, select the Trusted Connection option.

If you select this option, you do not have to specify the Setup DB Account, Running DB Account and Password fields.

  1. In Step 2/5 the following settings are available in the Monitor Settings section.
    1. In the Idle Time (millisecond) field, you can change the time period the event sender waits until it polls events from SAP Business One. The default is 3000 milliseconds. 
    2. In the Batch Count field, you can set the number of events the event sender polls each time. The default is 10.
  1. In Step 3/5 you have available general settings for SAP Integration Framework 2.0.

The installation program sets the Sending Method to Direct by default.

    1. If you select the Direct method, the event sender directly sends events to a dedicated server address. 
    2. If you select the Distribute method, the event sender sends all events to the local server address and the event dispatcher takes over the task of distributing the events to other systems. Before selecting this method, make sure that you have configured the event subscriber.
  1. In the General Integration Framework Settings you can configure the following:
    1. In the Protocol Type field, select the protocol for the connection between the event sender and the integration framework. To enable https, make settings in the Tomcat administration.
    2. In the Authentication field, always use the Basic option. This is the default.
    3. In the Framework Server Host field, enter the name or IP address of your integration framework.
    4. In the Framework Server Port field, enter the port number of your integration framework.
    5. If you work in a network with a proxy, in the Proxy Host field enter the name or IP address of your network proxy.
    6. If you work in a network with a proxy, in the Proxy Port field enter the port number of your network proxy.
    7. In the User Name field, enter the user name for accessing the integration framework. The default is B1iadmin.
    8. In the Password field, enter the password for accessing the integration framework.
    9. To test the connection, choose the Test Connection button.
  1. In Step 4/5 choose the company databases.

The setup program displays the company databases in your SAP Business One system. For each company database, you can set up the following:

  1. To define for which SAP Business One objects the event sender sends events, chose the Event Filter button.
  1. In the Include List B1 Object(s) field, enter the object identifier of the SAP Business One object or objects. Separate entries by comma. 

If you enter, for example 22,17, the event sender sends events for purchase orders and orders to the integration framework. 

If you leave the field empty, the event sender sends events for all SAP Business One objects to the integration framework.

  1. In the Exclude List B1 Object(s) field, enter the object identifier of the SAP Business One object or objects. Separate entries by comma. 

If you enter for example 85 the event sender excludes events for special prices for groups. 

If you leave the field empty, the event sender sends events for all SAP Business One objects to the integration framework.

Note

Use either the Include B1 Object(s) or the Exclude List B1 Object(s) function. Do not use the functions together.

3.In the Exclude List B1 User field, enter SAP Business One users for which the event sender does not send events to the integration framework. Enter the SAP Business One user name, not the user code. Separate entries by comma.
  1. If you want the company database to create events based on indirect journal entries, select the Create Complete Journal Entry Events checkbox. Standard SAP Business One processing does not create events for indirect journal entries.
  1. To define the receiver of events, choose the Default Inbound button. You have the following options:
  1. Default Inbound

This is the default. The event sender hands over events to B1iP. The event dispatcher hands over the events to the event subscriber that distributes the events to the target application or applications.

  1. SAP Integration Framework 2.0

This option is available for SAP Integration Framework 2.0 to be backwards compatible. 

If you select this option, choose the Receiver button and enter the B1i application URI. To test the connection, choose the Test connection button.

  1. OTR (Other)

If you select this option, choose the Receiver button and enter the B1i application URI. To test the connection, choose the Test connection button.

  1. To test the connection to the receiver of SAP Business One events, choose the Receiver and then the Test Connection button.
  1. Step 5/5 gives you a summary of the event sender settings.
  2. To save the settings, choose the Finish button.
  3. Restart the Event Sender service.

Result

The setup program stores the settings in the datasource.properties and eventsenderconfig.properties configuration files.

Setting Up SAP Business One DI Proxy

SAP Business One DI Proxy is the SAP Business One-related component for SAP Integration Framework 2.0 that enables data exchange with SAP Business One using the DI API.

Recommendation

Install and run SAP Business One DI Proxy on the SAP Business One server. This is the prerequisite for smooth and high-performing communication using the DI API. Note that the component is not available on Linux.

Procedure

To set up the SAP Business One DI Proxy service, no additional steps are necessary.

You can maintain the following parameters to influence the behavior of your DI Proxy service. 

Access the diproxyserver.properties file on the server where you have installed the DI Proxy service. The path is …SAP\SAP Business One Integration\DIProxy.

If you change any settings, restart the SAP Business One DI Proxy Service.

Property

Description

RMI_PORT

The parameter is obsolete.

HTTPS_PORT

DI Proxy TCP port for HTTPS.

MAXDIERRORS

If this property exists and has a value greater than 0, the value defines the number of DI errors that may occur before the DI Proxy restarts. The default is 50. 

RESTARTPERIOD

If this property exists and has a value greater than 0, the value determines the time in minutes after which the DI Proxy restarts. The default is 60. 

ORPHANED

This property defines the value in minutes after which the system defines a pending and not yet completed DI transaction as orphaned. The DI Proxy removes the transaction from the internal transaction list. If this property does not exist or does not have a positive value, the default is 10. If it exists, the default is 30. 

MAXACCESSES

Upper limit of granted simultaneous pending accesses to adapter (0 = no limit).

MAXCONNECTIONS

Upper limit of DI connections kept open at the same time (0 = no limit).

Note that maximum granted simultaneous accesses is adjusted to not exceed maximum granted connections.

SINGLECOMPANY

If property available and set to 'false', overlapping or parallel processing requests for a transaction or transaction sequence to one company database are allowed.

If not available or set to 'true', only one transaction or transaction sequence can be pending at a time. Additional transactions are rejected.

JCOPATH

If this property exists and is not empty, it defines the path the DI Proxy uses to search for the JCO installation. In this case the system ignores any value coming from B1iP requested by an adapter. 

If the property does not exist, the system uses any value coming from B1iP requested by an adapter. In this case the setting is probably not definite. 

SAP recommends setting the JCo path in the diproxyserver.properties file.

If you want to change a JCo path that someone has already maintained and that the system has used for connection, you can apply this change only after you have restarted the SAP Business One DI Proxy Service. 

Use / or \\ instead of \ as a separator in the JCOPATH value. Use for example C:\\Program Files\\SAP\\SAP Business One DI API\\JCO\\LIB

JCOVERSION

If this property exists and is not empty, it defines the version the DI Proxy uses to search for the JCo installation. 

restartAttemptDelay

As of DI Proxy version 30002211, you can overlay the default for a restart delay (500 milliseconds). 

Provide a value in milliseconds.

The parameter is not part of the default diproxyserver.properties file. If you want to use it, add it manually.

restartAttemptCap

As of DI Proxy version 30002211, you can overlay the default number of restart attempts (10).

The parameter is not part of the default diproxyserver.properties file. If you want to use it, add it manually.


Next Step: Configuration in SAP Integration Framework 2.0 to connect SAP Business One for SAP ECC integration