SAP Business One

​

Extra information

System documentation: https://sap.highwaytwo.com/Working_with_SAP_Business_One_Service_Layer.pdf

​

Connector package documentation

​

Table of Contents

• 1. Setting up HTTP Client SAP Business One
  • 1.1 Steps
• 2. Subscribing to entities from SAP Business One
  • 2.1 Steps
  • 2.2 General concept
• 3. Publishing entity to SAP Business One
  • 3.1 Steps
  • 3.2 General concept

​

1. Setting up HTTP Client SAP Business One

1.1 Steps

1. In the Alumio Dashboard, go to Clients > HTTPS Client. Create a new HTTP Client and select SAP B1 HTTP Client as the prototype of the HTTP Client.
2. Fill in the Username, Password, and CompanyDB name. Select the version of the REST API.
3. Save the HTTP Client for use.

​

2. Subscribing to Entities from SAP Business One

2.1 Steps

1. Go to Connections -> Incoming, create a new incoming configuration, and select SAP B1 Subscriber as the subscriber. You can select SAP B1 Subscriber, SAP B1 Subscriber (Service Layer) or SAP B1 UDO Subscriber.
2. Select the entity you want to subscribe from SAP B1. Exception for SAP B1 UDO Subscriber, you’ll need to input the endpoint into the “End Point (UDO Name)” field.
3. Add any request parameters needed to subscribe to the entity (optional), but path and query properties should exist, you can leave them as empty objects). Refer to their documentation for input query parameters.
   • https://sap.highwaytwo.com/Service%20Layer%20API%20Reference.html
   • https://sap.highwaytwo.com/Working_with_SAP_Business_One_Service_Layer.pdf
4. Optionally add a transformer to transform the request parameters into something you will request from SAP Business One.
5. Select the SAP Business One HTTP Client to use.

2.2 General Concept We follow SAP Business One documentation on building this connector, so you can easily use the connector based on SAP Business One API Reference. Entity It’s the entity you want to subscribe to from SAP Business One. Please refer to the entities from the SAP Business One API Reference page. Request Parameters You can provide these parameters based on the SAP Business One API Reference to get the needed entity. Please look at the example below on how to fill the Request Parameters field when subscribing to an entity of Pricelist(id). The endpoint in SAP Business One uses oData input, so for the endpoint/Pricelist(id), we need to provide the ID value inside the oData key as an array. Alumio will transform it into /PriceLists(100) There’s an exception for SAP B1 UDO Subscriber. You’ll need to put the Odata path into the corresponding field called “Odata Input for UDO” for this subscriber. More examples on SAP Business One Odata:

• /v1/Currencies(‘CNY’) In Alumio we input as

Input Transformer Any transformers set here will be executed after the Request Parameters are loaded. So, you can add any transformer to provide and manipulate the request parameters into anything you need, either as path parameters and/or as query parameters of an entity. HTTP Client It’s the HTTP Client configuration that you will use to access SAP Business One.

​

3. Publishing Entity to SAP Business One

3.1 Steps

1. Go to Connections -> Outgoing, create a new outgoing configuration, and select SAP B1 Publisher as the publisher.
2. Select the action you want the publisher to perform with the data.
3. Select the SAP B1 entity where the data will be published.
4. You can optionally add any oData data to the request on the key odata.
5. You can optionally add any query data to the request on the key query.
6. You can optionally add any payload data to the request on the key payload.
7. Select the HTTP Client to use.

3.2 General Concept Like the subscriber, the publisher has similar methods for using it. The difference is the payload that will be submitted by the publisher originating from the data (from routes and transformers in outgoing configuration). However, you can also add or modify the payload using the Request Transformer. Method Currently, we support Create (HTTP POST method), Update (HTTP PATCH method), and Delete (HTTP DELETE Method). Entity We support publishing to most SAP B1 endpoints. Based on the documentation, some endpoints may need one or more path parameters.
Exception for SAP B1 UDO Subscriber, you must input the endpoint into the “End Point (UDO Name)” field.

• Odata is the odata data of the URL. For example the (id).
• Query is a defined set of data attached to the end of a URL.
  Example: www.url.com?type=true&start=0
• Payload is the data contained within a request.

HTTP Client It’s the HTTP Client configuration that you will use to access SAP Business One.