Skip to main content

System Status

System Status is the screen that says whether Xchange is working — and in case of a halt, what the cause is and where it can be resolved. Why halts exist and what one means for your work is described under System status and license.

If a notice strip brought you here, Operating state names the reason, and the tables there name the button that resolves each reason. How to narrow down a standstill step by step is described in It ran for months and stopped yesterday.

Permissions​

The screen follows the System permission:

Level on SystemWhat you can do
NoneThe System Status menu item is missing.
Read onlyView all five sections, query the license again with Check now and open the Update history.
FullIn addition, trigger the actions: update the database, finalize a structural change, re-check, repair the event filter, reset the system, fetch the field structure.

An action has two conditions: you have Full on System, and the current state permits it. If a button is missing, it is due to one of the two — the sections below say for each one when it appears.

In the example: M. Brandt has Full and takes care of operations. A. Vogt has None; the menu item is missing for her.

The System Status screen with an operational system, a valid license and an up-to-date database.

Layout​

SectionContent
Operating statewhether Xchange is processing, and in case of a halt the reason
Licenselicense status and license details
Databasestate of the Xchange structures, update and history
Field structurewhen Xchange last fetched the fields from SAP Business One
Version informationversions of the service and the UI

Operating state​

The first section carries a state name and a sentence that explains it.

StateMeaning
OperationalAll processing functions are active.
Processing StoppedXchange has stopped itself and is waiting for an action. The sentence names the reason.
Database Change DetectedThe database is a different one than the one this installation was connected to.
Binding InterruptedThe binding of this installation to the database was started and cannot be continued.
MaintenanceXchange is setting itself up or updating itself.
UpdatingThe database update is running.
UnreachableThe UI cannot reach the Xchange service.

The last three are temporary, and you wait: the first two pass into another state on their own, Unreachable concerns only the connection to the service.

Reasons with a button on this screen​

With Processing Stopped, the sentence names the reason and then what needs to be done. For these reasons the action is on this screen.

The database is not at the expected state. The button is Update database in the Database section; the way is described in Run a database update.

Sentence on the screenWhat is behind it
The database is not at the expected state. Update the database to resume processing.The structure is older than this Xchange version — or an expected structure is missing.
Updating the database failed. Start the update again to resume processing.An update run ended with an error; the cause is in the Update history.
Updating the database did not complete. Start the update again to resume processing.An update run was interrupted.
A database procedure does not match this version. Update the database to resume processing.A procedure in the database is out of date.
The SAP Business One permissions do not match this version. Update the database to resume processing.The permissions created by Xchange are out of date.

The Service Layer does not know the changed structure. For all three reasons the SAP Business One Service Layer is restarted first, outside Xchange:

Sentence on the screenAfterwards
The database structure has changed.Finalize structural change in the Database section
The Service Layer does not recognise structure that exists in the database.Re-check in the Database section
The Service Layer does not know the current state of the Xchange tables.nothing — Xchange resumes its startup on its own

The event filters are out of date.

The event filters are out of date and need to be repaired. Until then, Xchange does not process any changes from SAP Business One.

The Repair event filter button is in the Operating state section. It rebuilds the filters. If that fails because a route points to something that is missing in the target's field structure, the message names the route — and where a single field is the cause, that field as well. Then you fix the error in the route's event filter; where it is is shown in Routes — Automation. With the next successful activation the error is fixed.

The remaining reasons​

If it stays at Processing Stopped without one of these buttons appearing, the next step lies outside this UI — and the sentence names it. Depending on the reason, it means restarting the Xchange service, bringing it to the version that matches the database, or checking the permissions of the technical user in SAP Business One. Where the cause lies in the environment, for example with an unreachable SAP System Landscape Directory, it refers you to your administrator.

Reset system​

In the states Database Change Detected and Binding Interrupted the Reset system button appears. Have the credentials of all connections ready beforehand — resetting deletes them. What else the button deletes, what stays and what needs to be done afterwards is described under Retention and reset — Reset system.

What is possible during a halt​

A halt locks selectively. Xchange distinguishes three things — reading the configuration, changing the configuration, executing jobs — and a state releases each one individually.

StateReadingChangingExecuting
Operationalyesyesyes
Processing Stopped, event filteryesyesno
Processing Stopped, database affectedyesnono
Processing Stopped, remaining reasonsnonono
Database Change Detected / Binding Interruptedyesnono
Maintenance, Updatingnonono

The event filter is the only halt in which you can continue to configure — the repair can itself be a configuration change. With a detected database change, reading stays open so that you see what you are resetting before you do it.

License​

The second section shows the license status and the information behind it.

StatusMeaning for your work
ValidEverything is released.
Grace periodThe license portal is unreachable. Runs continue to start until the period ends; the notice names the remaining days.
Not checked yetNew runs are blocked until the first check is through.
Expired, Invalid, Not verifiable, UnknownNew runs are blocked.

Only Valid and Grace period let a run start. If no run can be started on Execution, check the license here.

Further rows: Customer system, Environment (Test or Productive), Database, Valid until, Last check and Last successful check. On a test license the notice also says how long it is valid. If a test version of the service or the UI runs on a productive license, a notice at the top of every screen points this out. The Check now button queries the status again immediately.

Database​

The third section describes the state of the structures that Xchange creates itself — two states:

RowWhat it describes
Configuration structureThe structures in SAP Business One in which the configuration is stored
Runtime structureThe structures in which Xchange handles its jobs

Each row carries its own version, e.g. v12. If it deviates, it reads v11 (expected v12). If the structure was created but its setup was never finalized, it reads not finalized yet (target v12).

The status is shown once beside the heading and applies to the section as a whole; which row lags behind is shown by its version.

StatusMeaning
Up to dateThe state matches this Xchange version.
Update requiredThe state is older than this version, or something is missing.
Restart pendingThe structure was changed and is waiting for completion.
FaultyAn operation on the structure failed.
Database newer than expectedThe state is newer than this Xchange version.
UnknownThe state cannot be determined.
ButtonWhen it appears
Update databasealmost always — except while Xchange is working on the database (Maintenance, Updating) and as long as Finalize structural change is due. It is highlighted only when an update is pending.
Finalize structural changeafter a structural change, with the sentence The database structure has changed.
Re-checkwith the sentence The Service Layer does not recognise structure that exists in the database.
Update historyalways, also with Read only

The Update database dialog only looks first. It determines the scope before anything happens. If there is nothing to do, it reads The database is at the expected state. No changes are required. — this is also how you check, with Operational, whether the database matches the version. If something is pending, a table shows the scope:

RowAnswer
Version transitionthe state before and after, e.g. v11 to v12; only with a version change
Structures are created, Field values are added, Procedures are renewed, Permissions are renewedno, or the names of what it affects
Data is restructured, Structures are removedyes or no
Service Layer restart afterwardsexpected to be required or not expected to be required

Update starts the run. If the database cannot be updated from here, the reason appears instead of the table, and Update is missing. What to do then is described in Run a database update.

Update history​

The Update history button opens the list of all operations on the database, with the columns Operation, Version, Status, Triggered by and Time.

OperationWhat happened
Initial setupXchange created its structures for the first time.
ReconciliationMissing structures were added.
UpdateA version transition was carried out.

The status of a row is Completed, Failed or Awaiting restart. The Time is the completion of the operation; with Awaiting restart its start is shown there. If no operation is recorded, it reads No updates recorded yet.

A failed row names its cause. An info icon then appears at the end of the row; clicking it shows in one sentence what happened and what needs to be done — e.g. "The Service Layer was not reachable. Try again once it is reachable." Below it is an Error ID; give it when you contact support. An operation that fails as early as the start of Xchange also appears here as a failed row.

The update history with completed operations on the database.

Field structure​

Xchange remembers which fields exist in SAP Business One — that is the basis for every mapping and every event filter. The section shows Last fetched and, with Full, the Fetch field structure button.

Fetching is necessary after fields have been created in SAP Business One. For Xchange to see them, the Service Layer must have been restarted after they were created. If fetching reports Field structure unchanged although fields were created, that is the likely reason — fetch again after the restart.

Version information​

The last section is display only: Last service start, Service version and UI version. Last service start appears once the service has reported it.

Service version and UI version can differ — they are two parts that are shipped separately. When you make an inquiry, include both numbers. If the service or the UI is a test version, the marker Test version appears next to its number.

See also​