younifyd
Menu

Connectors

SAP Business ByDesign

Manage customers and sales orders in SAP Business ByDesign via tenant-configured custom OData services, with a generic-request escape hatch. Covers Basic auth, the CSRF handshake, request fields, and response access paths.

On this page

Connecting SAP Business ByDesign

Every action needs a SAP Business ByDesign connection holding your tenant URL, HTTP Basic Auth username and password, and the names of the custom OData services your tenant exposes for the Customer and SalesOrder business objects (created in the tenant's OData Services work center). Requests go to <tenant-url>/sap/byd/odata/cust/v1.

ByDesign's OData services use Basic Auth for reads; writes additionally require an SAP CSRF token + session cookie, obtained via a priming X-CSRF-Token: Fetch request. The connector does this handshake automatically for the create actions and for write-method Generic Requests.

Request customization (all actions)

  • Forward All Headers — forward headers from the workflow's incoming request (off by default).
  • Additional Headers — key/value pairs; override forwarded headers of the same name.
  • Query Parameters — key/value pairs appended to the URL (OData $select, $expand, $filter, …).

Reading the response

Every action's result is at {{<stepReference>.response...}} (see Step Reference): {{<stepReference>.response.status}}, {{<stepReference>.response.statusText}}, {{<stepReference>.response.headers.<name>}}, and {{<stepReference>.response.data.<field>}} for the body. OData v2's d envelope is unwrapped by the connector, so a "Get Customer" step (reference getCustomer) resolves fields directly at {{getCustomer.response.data.Name}}.

Because the Customer and SalesOrder services are custom-built per tenant, the exact field set beyond the commonly-present ones below depends on your tenant's service definition. A non-2xx response does not fail the step — it's returned with the real status code and SAP's error body under {{<stepReference>.response.data}}. A network failure is returned as a synthetic 503, any other error as a synthetic 500; a missing CSRF token surfaces as a 500 with "Failed to obtain a CSRF token".

Create Customer

Create a customer (POST /<customerServiceName>/CustomerCollection, with CSRF handshake).

Configuring it

Request body fields:

  • Name (name) — required, sent as Name.
  • Email (email) — sent as Email.
  • Phone (phone) — sent as PhoneNumber.
  • Additional Data (JSON) (additionalData) — a JSON object string merged into the payload as-is; field names depend on your tenant's Customer service (e.g. {"CustomerID": "1000123"}). Invalid JSON fails the step.

Reading the response

{{createCustomer.response.data.InternalID}} (used to fetch the customer later), {{createCustomer.response.data.Name}}.

Get Customer

Retrieve a customer by internal ID (GET /<customerServiceName>/CustomerCollection('{internalId}')).

Configuring it

  • Internal ID (internalId) — required; single quotes are escaped for the OData key.

Reading the response

{{getCustomer.response.data.Name}}, {{getCustomer.response.data.Email}}, {{getCustomer.response.data.PhoneNumber}}, plus any tenant-specific fields.

Create Sales Order

Create a sales order (POST /<salesOrderServiceName>/SalesOrderCollection, with CSRF handshake).

Configuring it

Request body fields:

  • Customer Internal ID (customerId) — required, sent nested as BuyerParty.InternalID.
  • Line Items (JSON) (lineItems) — required, a JSON array string. Each entry becomes an Item row: productIdProductID, quantityQuantity. Example: [{"productId":"P1","quantity":5}].
  • Additional Data (JSON) (additionalData) — merged into the SalesOrder payload as-is (e.g. {"Note": "Priority"}).

Reading the response

{{createSalesOrder.response.data.InternalID}} (used to fetch the order later), {{createSalesOrder.response.data.ID}}, {{createSalesOrder.response.data.BuyerParty.InternalID}}.

Get Sales Order

Retrieve a sales order by internal ID (GET /<salesOrderServiceName>/SalesOrderCollection('{internalId}')).

Configuring it

  • Internal ID (internalId) — required; single quotes are escaped for the OData key.

Reading the response

{{getSalesOrder.response.data.ID}}, {{getSalesOrder.response.data.BuyerParty.InternalID}}, {{getSalesOrder.response.data.Item}}.

Generic Request

Call any custom OData service/entity not covered above.

Configuring it

  • Path (path) — required, relative to /sap/byd/odata/cust/v1, e.g. /khcustomer/CustomerCollection or /khsalesorder/SalesOrderCollection('...'). The target service must already be activated in the tenant.
  • HTTP Method (method) — required, one of GET, POST, PUT, PATCH, DELETE. Defaults to GET. For write methods the connector primes a CSRF token against the service named by the first path segment.
  • Request Body (JSON) (body) — for write methods.

Reading the response

{{genericRequest.response.data.<field>}}. A collection query returns {{genericRequest.response.data.results}} (OData v2 classic JSON).

Example

Path /khcustomer/CustomerCollection?$filter=Name eq 'Acme', Method GET.

Also applies here

Step Name

What it's for

Every step in a workflow gets a name — either one you set or a default based on the connector and action (e.g. "Get Order Details", "Send Welcome Email"). It's shown throughout the UI and in your execution history, and it's also the source for the step's Reference — a camelCase identifier auto-generated from the name (e.g. "Get Order Details" → getOrderDetails) — which is what you actually use in {{...}} expressions to read this step's output from later steps. See Step Reference.

Rules

  • Must be at least 2 characters, and 50 characters or fewer.
  • Must be unique within the workflow — reusing a name that's already taken will be rejected, with a suggested alternative (e.g. "Get Order Details 2").
  • Can't be empty.

Tips

  • Prefer a descriptive, human-readable name over a generic one — "Get Order Details" is easier to work with later than "HTTP Request 2", especially once a workflow has a dozen steps.
  • Renaming a step updates every reference to it elsewhere in the workflow automatically.

Step Reference

Syntax

Any input field can reference earlier data using {{expression}}. The expression is evaluated as JSONata — so simple dot-paths and more advanced queries (filters, functions) both work.

Referencing a step's output

Use the step's Reference — a camelCase identifier auto-generated from its Name (e.g. "Get Order Details" → getOrderDetails), shown read-only wherever the step's fields are configured — followed by the field path. Elsewhere in these docs this general pattern is written as {{<stepReference>.field.path}}:

{{getOrderDetails.response.data.id}}
{{getOrderDetails.response.status}}

The raw display name won't work here even though it's what you see in the UI — {{Get Order Details.response.data.id}} isn't valid, since a bare name containing spaces isn't a single JSONata identifier. Always use the camelCase Reference.

You can also reference steps by position instead of by reference:

{{steps[0].response.data.id}}

Referencing trigger data

{{trigger.headers.authorization}}
{{trigger.body.customerId}}
{{trigger.query.page}}
{{trigger.params.orderId}}
{{trigger.method}}
{{trigger.path}}

Referencing workflow variables

{{variables.myVariable}}

See Variables for the full list of variable types and more examples, including connection-type variables.

Referencing runtime variables

A separate, mutable namespace written by the Variable connector while a run is in progress — not the same as the workflow-level variables above:

{{runtimeVariables.myVariable}}

Notes

  • If an expression can't be resolved (a typo in a step name, a field that doesn't exist), it resolves to an empty string rather than failing the workflow — check your execution history if a value comes through blank.
  • Object values are automatically JSON-stringified when interpolated into a string field.

Execution Settings

Fire-and-forget

When enabled, the workflow doesn't wait for this step to complete before moving to the next one. Use it for steps whose result nothing downstream depends on — logging, analytics, notifications — so they don't add latency to the steps that matter.

Continue on error

When enabled, a failure in this step doesn't stop the workflow — execution continues to the next step. The failure is still recorded in the execution history; this just controls whether it's fatal.

Combine the two for steps that are genuinely optional to the outcome: fire-and-forget so they don't add latency, continue-on-error so a failure in them (e.g. an analytics endpoint being briefly down) doesn't take down an otherwise-successful workflow run.

Caching

What it does

When enabled, a step's result is cached for a configurable TTL (time-to-live, in seconds). If the step runs again with the same effective cache key before the TTL expires, the cached result is returned instead of re-running the step.

Configuring it

  • Enabled — turn caching on or off for this step.
  • TTL — how long (in seconds) a cached result stays valid.
  • Cache key template — an expression (supporting the same {{...}} step reference syntax used elsewhere) that determines what counts as "the same call". By default this is based on the step's resolved input; a custom template lets you cache more narrowly or broadly than that.

When to use it

Good candidates are steps that call something slow or rate-limited but return the same answer for the same input within a short window — a lookup against a rarely-changing external system, for example. Skip it for steps whose result must always be fresh (anything involving live inventory, pricing, or payment state).

Locking

What it does

When enabled, only one execution of this step (for a given lock key) can run at a time. If a second execution tries to run the same step while a lock is held, it waits until the lock is released or the hold period elapses.

Configuring it

  • Enabled — turn locking on or off for this step.
  • Lock key — an expression (supporting the same {{...}} step reference syntax used elsewhere) that determines what counts as "the same resource". By default the lock is scoped to the step itself; a custom key lets you lock per-customer, per-order, or any other identifier that needs serialized access.
  • Period — how long (in seconds) the lock is held before it's automatically released, in case an execution doesn't complete normally.

When to use it

Use it whenever concurrent executions could race on the same resource — e.g. two workflow runs both trying to update the same order's status at once. A lock key scoped to the order id ensures only one of them proceeds at a time.