Using the SAP Business One Integration Tool Pack v3.0+ with SAP Business One OnDemand and HANA

Introduction

The SAP Business One Integration Tool Pack provides communication between SAP Business One and BPA Platform. It consists of:

  • SAP Business One (DIAPI) Integration Agent
  • SAP Business One (DIAPI) Integration Tool
  • SAP Business One (SL) Integration Agent (v3.1 onwards)
  • SAP Business One (SL) Integration Tool (v3.1 onwards)
  • SAP Business One Event Agent (optional)
  • SAP Business One Event Tool

For a detailed description of how to use the tool pack, refer to the SAP Business One Integration Tool Pack White Paper.

This article is aimed at SAP hosting providers managing the cloud environment. It describes how to configure the SAP Business One Integration Tool Pack to connect to a SAP Business One OnDemand environment with HANA Cloud Control.

System Requirements

The SAP Business One Integration Tool Pack v3.0 requires BPA Platform (formerly “TaskCentre”) 4.6 SR1a (build 2718) or above.

The SAP Business One Integration Tool Pack v3.1 requires BPA Platform (formerly “TaskCentre”) 2018 (build 4031) or above.

Notes for the BPA Platform Installation

You can choose to install the BPA Platform server on a separate machine which is in the same domain and has access to the SAP Presentation Server, or on the Presentation Server itself.

NOTE: If your BPA Platform with SAP Business One Integration Tool Pack installation makes use of the Event Agent, you must install the BPA Platform client on the Presentation Server as a minimum — see (OPTIONAL) NOTES FOR THE EVENT AGENT INSTALLATION.

Install the tool pack onto the same machine, and any remote BPA Platform machines in use.

Notes for the Integration Agent Installation

If using the SAP Business One (DIAPI) Integration Agent , this must be installed on the same machine as the Presentation Server, alongside the SAP DI API. This machine must also have permanent internet access.

If using the SAP Business One (SL) Integration Agent, this can be installed on any Windows Server that can access the Service Layer. For ease of installation, we recommend installing the Agent local to the BPA Platform server.

For a detailed description of how to install and configure the Integration Agents, refer to the SAP Business One Integration Tool Pack White Paper.

Configuring the SAP Business One Integration Tools

The configuration required for any SAP Business One Integration tool consists of a global connection to SAP Business One, and step configuration for use in tasks.

How to use this tool in a task step is outside the scope of this article. For a detailed description of how to use the SAP Business One tool in a task, refer to the connector tool’s product help, and white paper SAP Business One Integration Tool Pack White Paper.

Adding a Global Connection

The global configuration is used to create a connection to a SAP Business One company database. You access the global configuration via the BPA Platform client: Manage > Tools > Data Connectors > SAP Business One Integration. Note that older installations may see Manage > Tools > Specialist (3rd Party) Tools > SAP Business One Integration.

Connection Tab

  • Connection Name — A unique, meaningful name for this connection.
  • Integration Agent Server — The IP address or hostname of the machine where the Integration Agent is installed.

Licence Server Tab

  • Licence Server — The IP address or hostname of the HANA Licence Server.
  • Port Number — (DIAPI Only) The default port for the License Server is 80.
  • Advanced — (SL Only) The default port for the License Server is 40000.

Database Tab (DIAPI Only)

  • Backend Server Name — The IP address or hostname of the SAP Business One instance and port number, using the following format:
    <IP_address_or_hostname>:<port_number>
    For example, HANADB:30015.
    Note that port 30015 is the default port used by HANA.
    This is case-sensitive and must match exactly.
  • Username — The username for the HANA Database Account. This user must have permission to access the relevant tenant’s company database.
  • Password — The password for the above username.
  • Backend Server Version — Use the Detect button to confirm the version rather than selecting one from the drop-down list.

Service Layer Connection Tab (SL Only)

  • Server Address — The IP address or hostname of the machine hosting the Service Layer.
  • Advanced — The default port for the connection is 50000.

Authentication Tab

  • Username — The username for BPA Platform to use to access the SAP Business One tenant. This user must have SAP super user permissions. The format for this is:
    <domain_name>\<tenant_username>
    For example, MYDOMAIN\CRM-JOE-BLOGGS.
  • Password — The password for the above username.
  • Company Database — (SL Only) The relevant company database. Note this is case-sensitive.

Company Tab (DIAPI Only)

  • Select Company — The relevant company database.

(Optional) Notes for the Event Agent Installation

The Event Agent is only required if you want SAP Business One events to be monitored for later processing.

The Event Agent must be installed on the same machine as the Presentation Server, alongside the SAP Business One Client for HANA. The Event Agent must have access to the HDBODBC or HDBODBC32 drivers on the machine. Without access, the HANA option in the BPA Platform Configurator is greyed out.

The Event Agent also requires the BPA Platform client to be installed alongside it.

Configuration for the Event Agent

The Event Agent does not require any global configuration. Instead, the connection to the HANA server is made through the BPA Platform Configurator.

A separate Event Agent is required for each company database that requires monitoring.

For more information about configuring the Event Agent, refer to the SAP Business One Integration Tool Pack White Paper.

Configuration Node

  • SAP Backend Type — HANA
  • Click Add connection

    • HANA Server — The IP address or hostname of the HANA database.
    • HANA Server Port — The default port is 30015.
    • Administrator Account — The username of a HANA administrator user account.

      This account is used to create the SBO_<company-database-name>_CODELESSPLATFORMS database table in HANA, and to modify the SBO_SP_TRANSACTIONNOTIFICATION stored procedure in the company database. <company-database-name> is the company database this Agent is monitoring. It is recommended you use the SYSTEM account details.

      This account is not used at runtime.

    • Password — The password for the above username.

Once saved, the Configurator attempts to connect to the HANA database using the credentials provided. If successful, the SBO Database drop-down is populated. Choose the relevant database this Agent is monitoring.

SBO Agent > Agent Account Node

The Event Agent creates a database table (CodelessPlatforms.SBOEventAgentCommon) to store events. The Configurator creates a default account for the Event Agent to access the SBO Database specified previously.

The configuration required for this node is optional, and can be skipped (click Next). This is only required if you want a separate, specific account to access the database. However, if the default Agent account is sufficient, see NOTES FOR THE EVENT AGENT DATABASE PERMISSIONS for extra configuration that is required.

  • User name — The HANA username for the Event Agent
  • Password — The password for the above username

SBO Agent > Registration Settings Node

All Event Agents must be registered with the BPA Platform server.

  • Server — The IP address or hostname of the BPA Platform server
  • Agent Name — A unique name for this Agent instance

Notes for the Event Agent Database Permissions

The Event Agent creates a database (SBO_<company-database-name>_CODELESSPLATFORMS) to store events. The default user permissions for the tenant’s administrator user only allow access to the tenant’s company database.

You must grant sufficient permissions to the tenant administrator account to allow access to the specified SBO Database, but also the SBO_<company-database-name>_CODELESSPLATFORMS database table in its entirety. You do this in the HANA Studio, see SAP’s guide to Object Privileges.

Article originally published 19 January 2018 — Article updated 21 May 2019
SAP Business One Integration Brochure

SAP Business One Integration Brochure

Learn how integrating SAP Business One with other business applications or web services will save your company time and money.

Download Brochure