Skip to main content

Configuration Snapshots

The Configuration Snapshots screen shows what is in operation, what is being built and what was once in operation. From here you validate, activate, discard, restore, export and import.

What a configuration snapshot is and why editing and activating are two different things is covered under Configuration Snapshots.

Permissions​

This screen follows two permissions:

PermissionWhat it decides
Configuration, level Read only or higherwhether the Configuration Snapshots menu item is there at all
Activation, level Fullwhether Validate, Activate, Discard, Import and Restore are there

The Activation permission has only the levels Full and None.

Export, Export Draft and Compare are available to everyone who can see the page.

In the example: A. Vogt has Configuration and sees the page with all sections; in the Draft section, only Compare and Export Draft are shown. M. Brandt also has Activation and additionally sees Validate, Activate and Discard.

The Configuration Snapshots screen with active version 7, the validated draft version 8, whose check found nothing, and the archive below.

Layout​

Four sections, one below the other:

SectionContent
Active Configurationthe snapshot in use
Draftthe snapshot being built, with its validation result
Parked draftsdrafts that were parked when the system was reset — only there if any exist
Archived configurationsall earlier active snapshots

In addition, at the top right, above all four, the Import button.

Active Configuration​

FieldContent
Versionthe number of the snapshot
Activatedwhen it became active
Activated Bywho activated it, with the user code from SAP Business One

If there is no active configuration yet — a freshly set up system — the section reads No active configuration.

Export writes this snapshot to a file. Without an active snapshot, it answers with No active configuration to export.

Draft​

Next to the heading is the status of the draft:

StatusWhat it says
Not Validatednot validated yet
Validatedlast validated without errors
Contains Errorsthe validation found errors
Validation Outdatedwork has continued since the validation

Below it, the same three details as above, only with Created and Created By instead of Activated. Without a draft, the section reads No draft available, and the buttons are missing.

ButtonWhat it does
Validatevalidates the draft and writes the result as a checklist below the fields
Activatemakes the draft the active configuration; asks for confirmation first
Compareopens the comparison between the draft and the active configuration
Export Draftwrites the draft to a file
Discarddeletes the draft permanently; asks for confirmation first

Activating requires a successful validation. The button is available anyway — clicking it on a draft that has not been validated answers with Draft must be validated successfully first.

Compare is there only when both exist — the comparison needs a draft and an active configuration.

If Validate, Activate or Discard fails, the message appears in red below the fields and says what to do — e.g. The Service Layer is currently unavailable. Please try again shortly. Below it, you can expand Technical details; they are meant for support.

The checklist​

After validating, the checklist appears below the fields: everything the validation found in the draft, in one list. Above it, a line counts the entries, for example 2 entries — 0 resolved, 2 open, and next to it is Work through checklist. If the validation found nothing, it reads The check found nothing.

Each entry has two lines: where it sits, and what needs fixing there. The location line names the type and name of the object, followed, separated by a dot, by the area within it — e.g. Value Table "Zahlungsarten Webshop" · Entries, and below it Entries 3 and 5: "Source value" is used more than once. An entry concerning a step, a mapping row or a trigger carries the name of its route. Unnamed appears where the object has no name, and Entire configuration for an entry that concerns the draft as a whole.

The icon in front of the entry says whether it holds you up. A red entry is an error: as long as one remains, activating stays blocked. An orange one is a warning — it allows activating, but is worth a look.

The order is fixed: first the connections, then the routes in the order of their list, then the value tables, and last whatever concerns the whole draft. Entries on the same object stand together. Within a value table, the entries on its rows follow the order of the table as it stands now; an entry on a row that has since been removed appears as Removed entry: … after them.

Clicking an entry takes you to its place — into the route, the step, the mapping row or the value table concerned. Work through checklist takes you through all entries in turn. Back on this screen, the entry you are currently at is highlighted.

The entries stay in place while you fix them. On the right of the entry is what has happened since the validation:

  • Resolved — the finding no longer applies to the current value, or the row it was on has been removed.
  • Changed — check again — the object has been edited since the validation, but the finding is still open. Whether it persists is decided by the next validation.

An entry without a mark is open and unchanged. The line above the list counts the resolved ones too (2 entries — 1 resolved, 1 open).

When an object has been deleted since the validation, its entries are resolved. They stay in place, carry Resolved and name the object as Removed connection "…", Removed route "…" or Removed value table "…". A click leads nowhere, and while working through the list Previous and Next skip them; the position still counts them. When every entry belongs to a deleted object, Work through checklist reports "No findings to work through".

If the list for a validation is not available, the strip This draft was checked, but its list of findings is no longer available. Check the draft again to see it. appears there, with Check again. If work continues on the draft after the validation, the status reads Validation Outdated — you then need to validate again before activating.

Even while editing, the messages in the footer of a route, connection or value table show what is open on that one object. Validate takes the whole draft, and only its result clears the way for activation.

The bar for working through the list​

On a connection and a value table, the footer carries a bar of its own while you work through the list. A route does not show it.

ElementEffect
Previous / Nextgoes to the previous or next entry of the checklist
1 of 2which entry you are at; if something has happened to it since the validation, the mark follows, e.g. 1 of 2 · Resolved
Next finding in … / Previous finding in …appears when the step leads into another object, and names it beforehand — e.g. Next finding in Route "Artikel Webshop"
The cross (Stop working through checklist)hides the bar; the checklist stays

If you open another object in between, the bar pauses. It then reads Working through checklist paused · 1 of 2, and instead of Previous and Next it shows Resume: with the object of the current entry, e.g. Resume: Value Table "Zahlungsarten Webshop". The button takes you back to that entry.

Parked drafts​

This section is only there if a parked draft exists. It arises when the system is reset while a draft is open; the strip inside it explains this.

ColumnContent
Version, Created, Created Byas for the draft

Clicking a row opens the comparison — with the open draft, otherwise with the active configuration. Unlike in the archive, every row can be opened here.

Each row has Restore and Discard. Restoring requires a free draft slot — there is only one. If it is occupied, the message says so.

Archived configurations​

ColumnContent
Versionthe number
Activatedwhen this snapshot became active
Activated Bywho activated it, with the user code from SAP Business One

The newest are at the top, 20 at a time; the rest loads on click. If the system is still on its first snapshot, the section shows No configuration snapshots have been archived yet.

Clicking a row opens the comparison with this version's predecessor and thus shows what changed when it was activated. The predecessor is the next lower version still in the archive — that can be further down than one number, because retention clears old snapshots from the bottom. If the archive holds versions 12, 9 and 7, clicking 12 compares with 9. The oldest row has no predecessor left and therefore cannot be opened.

Restore makes the version the active one again. The button appears on only a single row: the highest archived version below the active one. All other rows are for viewing and comparing. In the example, that is version 6; versions 1 to 5 have no button.

The confirmation says what happens: Version 6 becomes the active configuration snapshot again. The currently active snapshot is archived. If there is a draft, it additionally says that it is preserved and can still be activated.

A validation result for the draft disappears in the process. It was determined against the snapshot that was active a moment ago. Validate the draft once more before activating.

If restoring fails, a red strip appears below the table, usually The earlier version could not be restored. Below it, you can expand Technical details.

The comparison​

The comparison is a screen of its own; in the menu it belongs to Configuration Snapshots and can be reached from here via Compare or via an archive row. You go back via the path Configuration Versions › Comparison above the heading.

The comparison of version 7 and version 8 with the one changed row of the Zahlungsarten value table.

The heading is also the selection: Compare [Version 7 (active)] to [Version 8 (draft)]. Both fields can be changed, also by typing the number — with a long archive, that is the quicker way. The left field offers only versions below the right one and vice versa.

The entries of the selection carry their role: (active), (draft) and (parked draft) after the number. An archived version appears as a bare number, e.g. Version 6.

On the right of the title bar are three badges — Added, Changed, Removed — plus two icons whose tooltips read Expand all and Collapse all; they appear as soon as a box can be expanded. The badges at the top count objects, that is, routes, connections and value tables. The badge of a changed object counts fields: Changed: 3 means three differing fields, including those of its steps, triggers and enrichments.

The content is grouped by type — Routes, Connections, Value Tables. Within the routes, it is organized by connection, as in the route list; routes without a connection appear under Without connection.

Each object has a box with its name and its badge. For Added and Removed, the badge already says everything; for Changed, the box can be expanded and shows a table:

ColumnContent
(no heading)the field or section, indented by depth
left versionthe value there
right versionthe value there

The fields appear in the order of the editor. At the end, Other settings collects the fields that have no input of their own in the editor.

Empty values appear as —. Conditions appear as a readable sentence — equals, contains, starts with. Added and dropped rows carry their badge next to the label.

In front of a value that can be read from a field or entered as a fixed value is the same icon as in the editor — the tooltip says Field reference or Constant value. If the order in a list has changed, a separate row Order changed shows this. It shows the entries on the left and right in their respective order — a rearrangement thus concerns the order alone.

The comparison is view-only. Changes are made in the editor.

Two strips can appear above the comparison:

  • The compared configuration has changed. Someone worked on the draft or activated while the comparison was open. Refresh comparison fetches the new state; until then, the display stays with the old one.
  • One of the compared versions no longer exists. The draft was discarded or an earlier snapshot was restored. The comparison stays readable, but describes a past state.

If there is no difference, it reads No differences — the two configuration snapshots match.

Importing a configuration​

Import at the top right opens a dialog in two steps. The whole way from the export in one system to the active snapshot in the other is described in Bring a configuration into the production system.

Step 1: File and method​

At the top is the note that the export leaves out credentials and that they must be entered again after the import.

If a draft already exists, it is named, and you choose the method:

MethodWhat it does
Replacethe existing draft is replaced by the content of the file
Mergethe content of the file is merged into the existing draft

Below that is the field Select export file (.json). As soon as the file has been read, its header data appears:

DetailContent
Exported Withthe version of Xchange that wrote the file, e.g. "Xchange 1.1.0"; "—" if the file does not carry it
Exported Atwhen it was created
Source Systemwhere it comes from
Routes, Connections, Value Tableshow many of each type it contains

If the file does not fit, the message says why — not a valid export format, too large, not readable, a newer version of Xchange, unknown fields, incomplete or damaged. For everything that goes back to a newer installation, the message says what to do: update this installation and import again. If the file carries its version, the message names both versions.

If the file contains a row twice, the dialog rejects it before you decide anything. The message names where the row appears twice — in a value table, or in the mapping or the acknowledgment of a route — e.g. The value table "Zahlungsarten Webshop" in the file contains a row twice. It ends with Export the configuration again and import the new file.

Two further messages appear only on Next and name the object concerned first:

  • Content cannot be read — "Artikel Webshop": the content of "Data filter" in the file cannot be read. Correct the file, then import it again. The message names the part of the object that cannot be read, here the Data filter. If the part cannot be determined, it reads content in the file cannot be read.
  • A condition of the additional data compares two fields — "…": a condition of the additional data compares a field with another field — this is no longer supported. Compare the field with a value or placeholder in the exporting system, export again, then import the new file.

Next takes you to the second step.

Step 2: Decide object by object​

At the top are three numbers: New, Conflict, Identical. If all objects are identical, the strip says All objects in this file are identical to the active configuration. There is nothing to import.

Below that are the objects in the file:

ColumnContent
Namethe object
Change TypeNew, Conflict or Identical
Decisionwhat should happen to it

The decision depends on the change type: for New, between Import and Skip; for Conflict, between Overwrite and Skip. Identical objects stay as they are and are hidden; Show identical objects brings them in.

An info icon next to the change type opens the notes on this object. It appears in two cases:

  • The object comes from another system and only has the same name — Object from another system with the same name. These are then two different objects with the same name; a Conflict is the same object in two states.
  • An Overwrite hits an object with a different name here — Overwrites "…" and changes its name. If a second object here already carries the imported name, the icon turns into a warning: The name "…" is then in use twice. That second object stays as it is.

An object whose content cannot be read in the file carries a red note under its name that names the part concerned — e.g. Content of "Data filter" in the file cannot be read, on a value table Content of "Value table" in the file cannot be read. If the part cannot be determined, it reads Content in the file cannot be read. Below the list there is then, once for the whole file: The file contains unreadable content and cannot be imported. Correct the affected connections, routes and value tables in the source system and export the configuration again. Import stays disabled, even if you set the object to Skip.

Import completes the process. The result is always a draft — Configuration imported as draft v9 or Changes merged into draft v8. From there, you continue as with any draft: validate, activate.

If the import does not go through at this point, the dialog says why:

MessageWhat to do
The configuration has changed since the file was checked. Start the import again.start the import again; the file is then checked against the new state
The draft to import into has been discarded in the meantime. Start the import again.start the import again
The import took too long and was cancelled. It may have been applied anyway — reload the page and check the draft before importing again.look first, then import again if needed
The import could not be completed.another error; after Technical details: follows the system's message

See also​