↓ Skip to main content
  1. Posts/

IBM Sterling B2B Integrator: A Quick Architecture Overview

·1184 words·6 mins· loading · loading ·
Newton Rocha
Author
Newton Rocha
Senior IT professional with 15+ years specializing in Linux systems administration, Bash scripting, and enterprise integration using IBM Sterling technologies (File Gateway, B2B Integrator, Connect:Direct). I write about real production incidents, MFT/middleware tips, infrastructure automation, and how I’m applying AI to IT operations.
Table of Contents
sterling-b2bi-architecture - This article is part of a series.
Part 1: This Article

Sterling B2B Integrator admin console home page
The admin console home page — where every session starts

What is IBM B2Bi
#

IBM Sterling B2B Integrator does one job: move files between your business and your trading partners — banks, suppliers, logistics providers, whoever needs EDI documents, flat files, or XML exchanged reliably and traceably — and know exactly what happened to every file at every step. That’s it. Everything else exists to support that one job.

IBM’s own overview puts it plainly: B2Bi is built to manage “the technical and human dynamics of business-to-business partner relationships” (IBM Documentation). In practice, “technical and human dynamics” means the software has to be forgiving of partners who send malformed files, change their connection details without warning, and occasionally vanish for a week over the holidays — while your audit trail still needs to hold up.

IBM B2Bi Components
#

Memorizing a components list never worked, but tracing one file end to end did. For scale, here’s the full admin menu tree — everything below is one branch of it:

Full administration menu tree in the Sterling B2B Integrator admin console
The complete admin menu — Business Processes, Trading Partner, Deployment, EBICS, and Operations

Perimeter Server
#

A partner connection doesn’t hit the core engine directly. It lands on a Perimeter Server sitting out in the DMZ, which handles the actual protocol handshake (SFTP, AS2, HTTP) and forwards traffic inward over a secure channel. Most intro material skips this entirely, which is a shame, because it’s the whole reason you can expose partner-facing endpoints without ever putting your core engine anywhere near the public internet. If you’ve ever wondered why a Sterling deployment diagram has boxes sitting outside the firewall, this is why — and it deserves its own post later in this series: Part 6 covers exactly how that DMZ box talks to the core engine.

Adapters
#

From there, an Adapter picks it up. Adapters are narrow by design — SFTP, AS2, Connect:Direct, HTTP/S, JDBC, and a few dozen others — and each one does exactly one thing: receive or send a file over its specific protocol, then hand it to a Business Process.

List of configured adapters in the Sterling B2B Integrator admin console, including AS2, FTP, SMTP, Command Line, HTTP Server, JDBC, and Kafka adapters
A real adapter list — this is what ’narrow by design’ looks like in practice

Business Process
#

That handoff is where things get interesting. A Business Process is a workflow — modeled visually in the Graphical Process Modeler, stored underneath as BPML (Business Process Markup Language) — that strings together steps: validate this, map that, encrypt this, route it, page someone if it fails. Practically everything meaningful in B2Bi happens inside a Business Process. It’s the closest thing the platform has to a heart.

Business Process Manager list in the Sterling B2B Integrator admin console, showing 807 processes including ACHDeenvelope, ACHEnvelope, and various AFTRoute processes
807 Business Processes in one environment — and that’s a modest one

Services
#

Inside that process, Services do the internal work — mapping, validation, extraction, compression, custom logic — while Adapters keep handling the outside world. A Business Process, stripped down, is mostly just Adapter and Service calls in sequence, with branches for when things go wrong (and in production, something always eventually goes wrong).

Select a Service Type tree in the Sterling B2B Integrator admin console, showing categories like B2B Protocols, EDI, Translation, Transport, and Web Extensions
Services are organized into categories like this — EDI, Translation, and Transport cover most of what a Business Process actually does

Map
#

Somewhere in that sequence, a Map usually runs. Partners almost never send data in the shape you actually need — EDI to XML, flat file to JSON, whatever the downstream system expects — and that translation happens in the Map Editor, which is deep enough to deserve its own post later in this series. I’m not exaggerating when I say some of the gnarliest bugs I’ve chased started as “the map did something weird with a null field.”

List of translation maps in the Sterling B2B Integrator admin console, showing hundreds of maps including ACH and EDI transaction translations
A real maps library — this environment alone has close to a thousand of them

Mailbox
#

The file usually lands in a Mailbox — a secure, permissioned drop box inside B2Bi. This is where I see the most confusion, even among people who’ve used Sterling for years: File Gateway is not a separate product competing with B2Bi. It’s a purpose-built UI and routing layer sitting on top of B2Bi’s mailbox and adapter machinery, built specifically so partner file exchange can be managed without anyone having to touch BPML directly (IBM’s File Gateway overview is worth reading if this is new to you).

Mailboxes list in the Sterling B2B Integrator admin console, showing the Root Mailbox, Dead Letter Mailbox, EDI Inbound/Outbound Collection and Extraction mailboxes, and per-partner mailboxes
A typical mailbox tree — shared EDI collection points plus one mailbox per trading partner

Database
#

And underneath all of it sits the Database — every Business Process’s state, every document’s tracking history, the full audit trail. Easy to take for granted until your first real outage, when document tracking data becomes the only honest record of what actually happened to a file. I’ve reconstructed more than one incident timeline purely from that table.

Database Usage dashboard in the Sterling B2B Integrator admin console, showing database capacity, business processes waiting to be archived, indexed, or purged, and environment pool usage
The Database Usage dashboard — capacity, backlog, and connection pool health in one place

For production environments that can’t tolerate downtime, B2Bi also supports multi-node Clustering — worth knowing it exists, not something you need on day one.

Topology design
#

Here’s the architecture as one picture:

flowchart TB
    subgraph Partners["Trading Partners"]
        P1["Partner A"]
        P2["Partner B"]
    end

    subgraph DMZ["DMZ"]
        PS["Perimeter Server"]
    end

    subgraph Core["B2B Integrator Core"]
        AD["Adapters
SFTP / AS2 / Connect:Direct / HTTP"] BP["Business Processes
(BPML Engine)"] SV["Services
Mapping / Validation / Routing"] MB["Mailboxes"] FG["File Gateway
(UI layer over Mailboxes)"] end DB[("Database
Document Tracking & State")] P1 --> PS P2 --> PS PS --> AD AD --> BP BP --> SV SV --> MB FG -.manages.-> MB BP <--> DB MB <--> DB

And here’s the same idea as a timeline, since a static diagram doesn’t quite capture that this all happens as a sequence of discrete handoffs — useful when you’re trying to figure out which log to check first:

sequenceDiagram
    participant Partner
    participant PS as Perimeter Server
    participant AD as Adapter
    participant BP as Business Process
    participant MB as Mailbox
    participant DB as Database

    Partner->>PS: Connect (SFTP/AS2/HTTP)
    PS->>AD: Forward file over secure channel
    AD->>BP: Trigger Business Process
    BP->>BP: Run Services (map, validate, route)
    BP->>DB: Log document tracking state
    BP->>MB: Deliver file
    MB->>DB: Record delivery status
    Note over Partner,DB: Every arrow above is a point
where the file can fail — and a place
document tracking will show you why

That note at the bottom is really the point of this whole post: once you can picture the file’s actual path, troubleshooting stops being guesswork. You just walk the diagram backward from where the file stopped.

Sources
#

I’d rather link you to IBM’s own documentation than paraphrase it badly, so here’s what I drew on for this post — all official IBM Documentation pages, worth bookmarking regardless of whether you read this series:

Everything else in this post — the framing, the “which log to check first” advice, the war stories — comes from actually running this stuff in production for the last several years, not from a manual.

What’s next
#

Next up in this series: Adapters vs. Services — the distinction that trips up almost everyone in their first few weeks with Sterling, and the one that actually matters most when you’re troubleshooting at 2am.

sterling-b2bi-architecture - This article is part of a series.
Part 1: This Article