Getting Started With SAP Business One Service Layer


First published on: 11/09/2023/5:05 pm

 

SAP Business One Service Layer Connector can be broken down into 2 elements; the Standard Service Layer API which allows REST Based calls to the Service Layer API and an additional element called the Saltbox Query Extension, which enhances the connector to enable SQL based Query execution and also that of the Saltbox Messages Service, which allows Saltbox to poll SAP for CRUD operations of SAP Business One Objects.

 

Standard Service Layer

 

The SAP Business One Server hosts the Service Layer API, this is true of both SAP Business One HANA and SAP Business One SQL Server Editions.

 

The Service Layer API is usually available on your Local Area Network from the address https://YOURSAPSERVERNAME:50000/b1s/v1. However, to expose this API to the outside world where it is accessible by Saltbox will at a minimum involve port forwarding of your external or public IP Address to the internal SAP Business One Server. However, Vision33 highly recommends using a reverse proxy setup to mask the address being accessed. If you are using SAP Business One Cloud Hosted by Vision33, we will take care of this setup for you. However, if you are an On-Premise user of SAP Business One, this will need to be done by your IT Team or IT Services Partner. If you are hosted by another 3rd party, they will need to advise on the best practices to set this up.

 

Usually, once the setup of a reverse proxy is complete, you will be able to access the Service Layer using an address like https://YOURNAME.MYDOMAIN.COM.  You may or may not need the port and or /b1s/v1 added to the address dependent on the reverse proxy setup.

 

Authentication

 

To authenticate on Service Layer you will need 3 pieces of information: the Company Database Name, a User ID and Password.

 

To complete the setup, in Saltbox, go to the Connectors Repository, find the SAP Business One (Service Layer) Connector and install the latest version (Engine needs to be stopped)

 

 

Now you can go to your Project Settings, scroll to the bottom to add a new Connection Configuration (Ensure Project Engine is Running).

 

 

Enter a connection name and description, the connection URL to your Service Layer installation, the Company Database Name and the username and password, set the HANA Extension to false for the time being and click Test (engine needs to be running to test). If all is correct, you should receive a Test Connection Successful message.

 

 


Saltbox Query Extension Deployment

 

The Saltbox Query Extension allows the additonal Saltbox connector actions to execute queries on the SAP Business One Database, any action that suggests it uses a query in Saltbox will not work unless this element is deployed.

 

To deploy the Saltbox Query Extension, you will need to download this Zip file.

 

 

 

Previous

Next


  

Last modified: 03/25/2025/12:46 pm