SAP Business One v2

Provides integration with SAP Business One Service Layer over OData for query, create, update, delete, and action or function operations.

Revision History

0.0.0.2 - Initial release.
0.0.0.3 - Removed query page-size controls from templates and kept continuation paging inside the Node.
0.0.0.4 - Added Run Anywhere Cluster support.
0.0.0.11 - Improves Connection test diagnostics and provider error handling while preserving SAP property casing.

Connection

Create an SAP Business One Connection so the Node can log in to Service Layer, load live metadata, and execute the selected operation.

Property Type Description
Service Root Url String Absolute URL to the SAP Business One Service Layer v2 root.
CompanyDB String SAP Business One company database name used during login.
UserName String SAP Business One user name used during login.
Password Masked SAP Business One password used during login.

Setup Notes

  • Service Root Url must be an absolute HTTPS URL that points exactly to /b1s/v2.
  • Test the Connection after you configure it. The Connection test performs a login and then attempts a logout. When login fails, the error reports the HTTP status and the SAP error code and message. Messages that contain the configured company database, user name, or password are redacted.
  • Flowgear manages the SAP B1SESSION cookie and optional ROUTEID cookie automatically during Runtime calls.
  • When login and metadata retrieval succeed, the template picker uses live /$metadata so entity sets, keys, actions, functions, enums, complex types, and customer-specific extensions reflect the target system.
  • When live metadata is not available, static starter templates remain available for common entity operations and generic action or function calls.
  • This Node targets SAP Business One Service Layer only. Deferred surfaces such as /$batch, attachments, file flows, SQL query surfaces, view.svc, scripting, and webhooks are not exposed by this release.

Methods

This Node exposes separate methods for GET-based queries, POST-based creates, PATCH-based updates, DELETE-based deletes, and Service Layer action or function calls.

Query

Use this Method to execute one GET-based Service Layer operation selected from the template picker.

Parameter Type Description
Connection Connection SAP Business One Service Layer Connection details.
OperationId String Operation identifier from the selected template.
Options Object Route and query parameters for the selected operation.
Return Type Description
Response Array One row per returned result. See the Response Properties table below.

Response Properties

Returned rows always include the standard normalized fields below, and then merge any provider fields returned by SAP for the selected operation.

Property Type Description
status String Normalized Flowgear status value, for example, OK or ERROR.
statusMessage String Normalized status summary for the row.
errorMessage String Error message when the row represents a failure.
httpStatusCode Integer HTTP status code returned by SAP Business One Service Layer.
providerCode String SAP provider error code, when available.
providerMessage String SAP provider error message, when available.
entitySet String Resolved entity set for the operation, when one exists.
operationPath String Resolved relative operation path used for the request.
keyLiteral String Resolved OData key literal for key-based operations, when one exists.

Create

Use this Method to execute one POST-based Service Layer operation.

Parameter Type Description
Connection Connection SAP Business One Service Layer Connection details.
OperationId String Operation identifier from the selected template.
Options Object Route and query parameters for the selected operation.
Items Array Request payload supplied by the selected template. Supply one Object for a single payload, or multiple Object items when the operation expects a JSON array.
Return Type Description
Response Array One or more normalized response rows. See the Response Properties table above.

Update

Use this Method to execute one PATCH-based Service Layer operation.

Parameter Type Description
Connection Connection SAP Business One Service Layer Connection details.
OperationId String Operation identifier from the selected template.
Options Object Route and query parameters for the selected operation.
Items Array Request payload supplied by the selected template. Supply one Object for a single payload, or multiple Object items when the operation expects a JSON array.
Return Type Description
Response Array One or more normalized response rows. See the Response Properties table above.

Delete

Use this Method to execute one DELETE-based Service Layer operation.

Parameter Type Description
Connection Connection SAP Business One Service Layer Connection details.
OperationId String Operation identifier from the selected template.
Options Object Route and query parameters for the selected operation.
Return Type Description
Response Array One or more normalized response rows. See the Response Properties table above.

Invoke

Use this Method to execute one supported bound or unbound Service Layer action or function.

Parameter Type Description
Connection Connection SAP Business One Service Layer Connection details.
OperationId String Operation identifier from the selected template.
Options Object Route and query parameters for the selected action or function.
Items Array Optional request payload for actions that accept a body. Function templates typically use Options only.
Return Type Description
Response Array One or more normalized response rows. See the Response Properties table above.

Usage Notes

  • Connection testing validates both login and logout. Login failures include the HTTP status and recognized SAP diagnostic code/message, with credential-bearing diagnostics redacted. Raw login response bodies are omitted.

  • Select operations from the template picker so OperationId, Options, and Items match the current Service Layer contract.

  • Query templates omit $top. The Node unwraps OData collection responses and follows @odata.nextLink internally, so each emitted row represents one returned item.

  • Error rows report the SAP error message in errorMessage. When SAP returns an unrecognized error body, errorMessage contains the HTTP status and up to 1,024 characters of the response body.

  • If the selected operation does not accept a request body, the Node returns a normalized error row instead of sending Items.

  • Some SAP objects still reject delete operations for business-rule reasons, even when a delete template is available.

  • Static starter templates such as generic entity-set and generic action or function templates remain available when live metadata cannot be loaded.

See also