Using the SAP Business One Integration Tool Pack v3.0 with SAP Business One OnDemand and Microsoft SQL Server

Introduction

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

  • SAP Business One Integration Agent
  • SAP Business One Integration Tool
  • 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.

System Requirements

The SAP Business One Integration tool pack requires BPA Platform (formerly TaskCentre) 4.6 SR1a (build 2718) or above.

Notes for the BPA Platform Installation

You must designate an OnDemand machine within the SAP Business One environment where BPA Platform is installed on.

Install the SAP Business One Integration tool pack on this machine also, and on any other remote BPA Platforms in use.

Notes for the Integration Agent Installation

The Integration Agent must be installed on the same machine as the SAP DI API. This machine must also have permanent internet access.

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

Configuring the SAP Business One Integration Tool

The configuration required for 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 SAP Licence Server.
  • Port Number — The default port for the licence server is 30000.

Database Tab

  • Backend Server Name — The IP address or hostname of the SAP Business One instance. This is case-sensitive and must match exactly.
  • Username — The username for the above server. Note that this username must have system administrator rights. Typically, this is the sa account.
  • 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.
    TIP: If you encounter problems detecting the server version, check the Backend Server Name is correct and is the same location of where the Integration Agent is installed. Additionally, you can disable IPv6 on the machine’s network adaptor.

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 Tab

  • Select Company — The relevant OnDemand environment.

(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 machine where the Event Agent is installed on must have the BPA Platform client installed (at least). This is because the Event Agent uses the BPA Platform Configurator rather than any global configuration settings to connect to SAP Business One.

It is recommended you install the Event Agent on the same machine as the one hosting the SAP Business One company databases. Should you want to install a remote Event Agent, separate from the company databases, our knowledge base article, How to Install a Remote SAP Business One Event Agent (v3.0) guides you through this.

Notes for the Event Agent Database Permissions

The Event Agent creates a database (CodelessPlatforms.SBOEventAgentCommon) to store events. The default user permissions for the tenant’s super user only allow access to the tenant’s company database.

You must grant sufficient permissions to the tenant super user account to allow access to the specified SBO Database, but also the CodelessPlatforms.SBOEventAgentCommon database. You do this as follows:

  1. Connect to the database engine where CodelessPlatforms.SBOEventAgentCommon is stored, using the SQL Server Management Studio.
  2. Expand the Object Explorer tree structure until CodelessPlatforms.SBOEventAgentCommon > Security > Users is visible.
  3. Right-click on Users and select New User.
  4. From the General page, configure the following:
    1. User type — SQL user with login
    2. User name — The database name, that is, CodelessPlatforms.SBOEventAgentCommon
    3. Login name — Click the ellipses. Enter the same database name into the Enter the object names to select box. Click Check Names. From the Matching objects list, select the object matching the format:
      [##SAPB1-DB-<username>-<tenant_name>##]
      where:
      username is the User name entered previously
      tenant_name is the SAP Business One tenant
      For example, [##SAPB1-DB-CodelessPlatforms.SBOEventAgentCommon-MYCRM##].

      NOTE: There may be an object using the same format as above, but ending in RO## rather than just ##. Do not select this one.
    4. Default schema — Leave this blank.
  5. Go to the Membership page.
    1. Select db_owner.
  6. Click OK to save and exit the dialog.
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