Color scheme: Dark
You are here: start » en » Documentation » Data integration and data access » WKL Database Gateway » Overview of WKL Database Gateway Manager and the VBA class » Administrator guide for WKL Database Gateway Manager » Oversee database updates and decide on packages

Oversee database updates and decide on packages

The data service can apply updates of a business application to its database: the vendor ships a signed package, and the service checks it, backs up the database, and applies it. Some packages wait for your decision. The Datenbank-Updates (Database updates) area shows what is waiting and why, who is holding a package back, and what was applied when, and it carries out your decisions without you working on the server.

Prerequisites

  • The IT department has set up a protected configuration for the database on the server; only they decide which databases the service updates and which publishers it trusts (Service configuration (reference), section “Gateway:Updates” (data service documentation)). Without a configuration, the area says in one sentence that no database is set up yet, and shows neither the choice nor the tabs.
  • Reading needs a rule with admin, even a read-only one. Deciding and changing settings needs the right to change.

Solution overview

The service distinguishes two kinds of packages:

KindMeaningDefault
Erweiternd (Expanding, expand)Older versions of the application keep working afterward, for example because only columns or tables are addedThe service applies the package as soon as it is in the inbox
Einschränkend (Contracting, contract)Older versions stop working afterward, for example because a column is removedThe package waits for confirmation. The service then announces it to the applications and applies it at the deadline, once no older version is working with the database

The Datenbank-Updates area (under Betrieb, Operations) shows the selected Datenbank (Database) at the top, with a line on its state: product, schema version, and what is pending. Below it are six tabs:

TabContents
Offene Pakete (Pending packages)Packages that are neither applied nor dismissed: file, schema version, kind, Stand (State: waiting, announced, being applied, failed, refused), Frist (UTC) (Deadline), Nächster Schritt (Next step), Grund (Reason), and the service's message
Sitzungen (Sessions)Applications currently working with the database. Hält auf (Holds back) tells whether a session holds an announced package back: sessions of an older version do, sessions that name no product and version do not
Abweichungen (Drift)Objects changed outside a package since the last one, or missing
Verlauf (History)The last 50 finished packages, newest first: result, receipt, who confirmed when, checksum
Schritte (Steps)The steps of these packages, grouped by package: every script and the deployment plan, with time, duration, and result
Einstellungen (Settings)How the service handles the database: confirmation per kind, lead time, session window, notification channels, backup retention

The commands act on the package you selected under Offene Pakete. Paket bestätigen … (Confirm package) is available only while a package waits for confirmation. An empty list says what that means, such as “Kein Paket offen.” (No open package.)

CommandFor the stateEffect
Paket bestätigen … (Confirm package)waitingExpanding: the package runs at once. Contracting: the service checks it, announces it, and applies it at the deadline
Weitere (More) > Frist verschieben … (Move deadline)announcedA new deadline in UTC, not in the past; the applications read it with their next request
Weitere > Ankündigung abbrechen … (Cancel announcement)announcedThe package waits again and needs a new confirmation
Weitere > Erneut einspielen … (Apply again)failed, refusedThe service takes the unchanged file as a new package, with every check
Weitere > Paket verwerfen … (Dismiss package)failed, refusedThe package leaves the pending packages; the file stays on the server in the failed folder
Weitere > Paket hochladen … (Upload package)–Puts a package file (.zip, 64 MiB at most) into the inbox of the selected database; the service takes it at once

Each command asks first and says what will happen. If the state does not fit, the app says so instead of sending the command. Every decision is recorded in the service's change log, and a confirmed package also carries your name in the database.

Steps

Confirm a waiting package

  1. Open the Datenbank-Updates area, and select the Datenbank at the top.
  2. On the Offene Pakete tab, select the package whose state is Wartet (Waiting).
  3. If it is contracting, check the Sitzungen tab to see who is working with the database.
  4. Select Paket bestätigen …, and confirm the question.

Result: An expanding package is applied and appears under Verlauf. A contracting package appears under Offene Pakete as Angekündigt (Announced) with its Frist (UTC). At the deadline, the service applies it as soon as no session of an older version is open; until then, it tries again every minute.

Move the deadline of an announced package

  1. Under Offene Pakete, select the package whose state is Angekündigt.
  2. Select Weitere > Frist verschieben ….
  3. Enter the new deadline in UTC as YYYY-MM-DD hh:mm, for example 2026-11-03 06:00.

Result: The Frist (UTC) column shows the new deadline. If the package should not run at all, select Ankündigung abbrechen … instead; it then waits for confirmation again.

Deal with a failed or refused package

  1. Select the package under Offene Pakete. Grund and the message say what happened; for a failed package, the Schritte tab shows which step failed.
  2. Fix the cause, such as the backup (reason 5) or drift (reason 11). A failed package has not changed the database: the service rolls everything back.
  3. Select Weitere > Erneut einspielen … to have the same file checked and applied again. If the file itself is faulty, select Paket verwerfen … and upload the vendor's corrected file with Paket hochladen ….

Result: The new package appears under Offene Pakete with its state, and the old one appears under Verlauf as Verworfen (Dismissed).

Apply a package without access to the server

  1. Select the Datenbank at the top.
  2. Select Weitere > Paket hochladen …, and choose the vendor's file (<product>-schema-<version>.zip).

Result: The service takes the package like a file placed in the inbox: it checks the signature and the publisher, then applies the package or lets it wait, as the settings say. If the same package is already waiting, the service refuses it.

Change the settings of a database

  1. Select the Datenbank at the top and the Einstellungen tab. The line at the top says whether the database has its own settings or uses the defaults.
  2. Change the fields; below each one, you see what it does, which values are allowed, and the default.
  3. Select Speichern (Save). Verwerfen (Discard) shows again what the service has stored; Vorgaben (Defaults) deletes the database's own settings.
SettingValuesDefault
Erweiternde Pakete, Einschränkende Pakete (Expanding, Contracting packages)Automatisch (Automatic) or Nach Bestätigung (After confirmation)expanding automatic, contracting after confirmation
Vorlauf einer Ankündigung (Announcement lead time)0 to 10,080 minutes; applies when the package names no lead time of its own60
Zeitfenster einer Sitzung (Session window)1 to 1,440 minutes after the last request through the service15
Ereignisprotokoll, Datei je Tag, Mail (Event log, Daily file, Email)Channels that report what becomes of a package; email needs Empfänger der Mail (Email recipients, separated by ;) and the service's mail accessevent log only
Immer behalten (Always keep)1 to 1,000 backups the service never deletes10
Ältere löschen nach (Delete older after)0 to 3,650 days; 0: only the count matters30

Result: The line at the top shows when the settings were changed (UTC). The service applies them from its next pass. It refuses a value outside the limits, or email without recipients; everything then stays as it was.

Remarks

  • Keeping it current. The page reads when it first opens and with Aktualisieren (Refresh). The service checks for new packages and expired deadlines every few seconds; Aktualisieren shows what it has done since.
  • State not read. If the database cannot be reached or the service is applying a package right now, the line at the top says so, and the lists stay empty. You can still change the settings; try Aktualisieren again shortly.
  • Drift. An object that someone changed outside a package can hold a package back (reason 11): check with the vendor whether the change should stay. For an encrypted object, the service sees only the modification date; that row is a hint and holds no package back.
  • What the app does not change. The connection, publisher keys, folders, and the kind of backup are in the protected configuration on the server; the administration deliberately cannot change them.
  • Times. All times are UTC.
en/wiki/data-conectivity/database-gateway/admin/admin-guide/database-updates.txt · Last modified: by Wolfgang van der Stille