Skip to main content

Connections

A connection is an external system that Xchange knows: its address, its sign-in and what Xchange knows about the structure of its data. Every route carries exactly one.

The SAP Business One in which Xchange works is automatically the other side of every route — no connection is needed for it.

Two connection types​

TypeWhat it connects
RESTAny system that can be addressed over HTTP — an online shop, a logistics provider's portal, a marketplace.
SAP Business OneAnother company database, e.g. that of a sister company. Xchange addresses it through the Service Layer.

In the example: "Webshop Cambira" is a REST connection, "Cambira Austria" an SAP Business One connection to the company database of the Austrian sister company.

The type is chosen when creating the connection and is fixed after that. If a system is to be connected through a different type, create a new connection.

The sign-in​

Xchange signs in to the external system on every fetch and every transfer. The UI offers three forms for it:

FormWhat is stored
No authenticationnothing — for systems that respond without a sign-in
OAuth 2.0token endpoint, client ID and a client secret
Service Layer logincompany database, user name and a password

Which forms are available depends on the connection type. A REST connection offers No authentication and OAuth 2.0. An SAP Business One connection knows only the Service Layer login and shows its fields right away.

Client secret and password are stored encrypted and stay hidden afterwards. The UI only says whether credentials are stored; they can be replaced at any time.

What differs between REST and SAP Business One​

A REST connection shows more sections than an SAP Business One connection. That is because of what the connected system brings along itself:

  • Field structure. SAP Business One discloses its fields on its own; you only fetch them. For REST, you enter where the system provides its field structure — this entry is optional.
  • Batch fetch. Only for REST. There you tell Xchange where in the system's response the records are, how it pages onward and how it reads only the changes. SAP Business One always responds in the same structure, which Xchange already knows.

The field structure​

The field structure is what Xchange knows about the fields of the external system: which exist, what they are called, what kind they are.

It is optional and a great help. If it is stored, the mapping offers the system's fields for selection when you set up a route, and the validation reports a target field that is missing there. Without a field structure, you enter the field names yourself.

For a REST connection, you specify the address at which the system provides its field structure and the format it comes in.

Fetching the field structure and the connection test are two separate verdicts. Each has its own result and its own point in time. A connection whose connection was tested just now can still carry an outdated field structure, and vice versa.

When two connections mean the same target​

Xchange points it out when a connection points to the same target as an existing one, and names it. The case is allowed nonetheless: there are reasons for it, e.g. two separate accesses to the same system with different permissions.

What the notice saves you from is the other case — the same address twice, by mistake. Then credentials are maintained twice, and a change has to be carried over in two places.

When Xchange blocks a connection​

If the external system rejects the stored credentials during ongoing operation — on a fetch or a transfer of a route — Xchange blocks the connection. From this moment on, all routes that use it stand still — including those whose schedule comes due.

You see this in two places: in the list of connections, it shows Blocked, and on the connection itself a notice appears that says what happened and what lifts the block — storing new credentials and testing the connection.

The same happens if Xchange can no longer decrypt the stored credentials. The way out is the same.

What is halted by hand is always the route. It is paused and resumed there — see Execution.

What is decided elsewhere​

  • Which data flows is defined by the route that uses it — see Routes.
  • When something runs is defined by the route's trigger — see Triggering.
  • Which field goes to which is defined by the mapping — see Mapping.

See also​