Sage 100 Konnektor
Überblick
Die Anbindung setzt eine unterstützte Sage 100-Version voraus. Danach sind es zwei Dinge: Sie richten den Zugang in Ihrer Sage 100 ein, und Sie teilen uns drei Angaben mit, die wir bei Workist hinterlegen.
Voraussetzung an Ihre Sage 100
Sage 100 der Sage GmbH (Deutschland, Österreich, Schweiz), Version 9.0.7 bis 9.0.11.
In Ihrer Sage 100 einzurichten
| Schritt | Wo |
|---|---|
| Sage Connectivity Gateway verbinden | Sage Server Manager → Externe API |
| Workist API-Erweiterung installieren | AppDesigner (Metadatenimport, siehe Installationsanleitung) |
| Datenbanken für die Konnektivität freigeben | Sage 100 Administrator |
| Workist Client-ID als Benutzer eintragen und berechtigen | Sage 100 Administrator |
| Applikationsserver neu starten | Sage Server Manager |
Angaben, die Workist von Ihnen benötigt
| Angabe | Wo Sie sie finden |
|---|---|
| EntitlementID | Sage Server Manager → Externe API → Konfiguration |
| Mandant | Sage 100 Administrator |
| Belegart | Sage 100 Warenwirtschaft |
Unterstützte Sage 100-Versionen
Der Konnektor arbeitet mit der Sage 100 der Sage GmbH – der Ausprägung für Deutschland, Österreich und die Schweiz. Unterstützt werden diese Versionen:
| Sage 100-Version | Unterstützt |
|---|---|
| 9.0.11 | ja |
| 9.0.10 | ja |
| 9.0.9 | ja |
| 9.0.8 | ja |
| 9.0.7 | ja |
| 9.0.6 und älter | nein |
Die Workist API-Erweiterung enthält für jede dieser Versionen ein eigenes Paket. Installiert wird ausschließlich das Paket, das zu Ihrer Sage 100-Version passt – die Pakete sind nicht untereinander austauschbar. Welche Version bei Ihnen im Einsatz ist, nennt Ihnen Ihr Sage 100-Partner.
Läuft Ihre Sage 100 auf einer älteren Version, ist ein Update auf mindestens 9.0.7 Voraussetzung für die Anbindung. Ist Ihre Version hier nicht aufgeführt, sprechen Sie uns an – wir prüfen die Verfügbarkeit des passenden Pakets.
Ab Version 9.0.9 werden die Berechtigungen beim Metadatenimport erzeugt. In früheren Versionen müssen sie über ein mitgeliefertes SQL-Skript eingespielt werden – die Installationsanleitung beschreibt beide Wege.
Sage vertreibt in anderen Märkten eigenständige Produkte unter demselben Namen – etwa Sage 100 in den USA (früher Sage MAS 90 bzw. MAS 200) oder Sage 100 Comptabilité und Gestion Commerciale in Frankreich. Diese haben ein anderes Datenmodell und eine eigene Versionszählung. Mit ihnen ist der Workist Sage 100-Konnektor nicht kompatibel.
Einrichtung in Ihrer Sage 100
Damit Workist Daten aus Ihrer Sage 100 lesen und Belege anlegen kann, werden zusätzliche API-Endpunkte in Sage 100 installiert. Die Einrichtung nimmt in der Regel ein Sage 100-Berater vor. Die offizielle Anleitung zum Sage Connectivity Gateway finden Sie in der Sage Dokumentation:
Einrichtung der Sage 100 – Sage Dokumentation ↗Voraussetzung: 3rd Party Gateway-Lizenz
Für die externe Nutzung der Sage 100 API wird eine Lizenz 3rd Party Gateway benötigt. Bei der Lizenzierung registriert Sage die E-Mail-Adresse Ihres Hauptansprechpartners zusammen mit einer KundenID – der EntitlementID – im Entitlement Service. Diese Adresse benötigen Sie für Schritt 1 der Einrichtung.
Einrichtung Schritt für Schritt
- Sage Connectivity Gateway verbinden im Sage 100 Server Manager unter Externe API → Verbindung herstellen. Die Anmeldung erfolgt über Sage ID mit der E-Mail-Adresse des Hauptansprechpartners. Anschließend wählen Sie das Entitlement und den Applikationsserver aus, an den Anfragen weitergeleitet werden.
- Workist API-Erweiterung installieren über Metadaten → Import im AppDesigner. Verwendet wird ausschließlich das Paket, das zu Ihrer Sage 100-Version passt – siehe Downloads.
- Datenbanken freigeben im Sage 100 Administrator. Die Datenbanken, die über die Konnektivität erreichbar sein sollen, müssen explizit freigegeben werden.
- Workist Client-ID eintragen und berechtigen im Sage 100 Administrator. Sie tragen die Client-ID anstelle einer Sage ID ein und ordnen sie einem Sage 100 Benutzer zu. Vergeben Sie einen sprechenden Namen (etwa „Workist"), damit erkennbar bleibt, zu welchem Partner-Dienst der Benutzer gehört. Die Berechtigungen dieses Benutzers bestimmen, was Workist darf – siehe Benötigte Berechtigungen.
- Applikationsserver neu starten, damit die Änderungen wirksam werden.
Pro Kundeninstallation ist genau eine Verbindung zum Connectivity Gateway möglich.
Downloads
Die Workist API-Erweiterung ermöglicht die Kommunikation zwischen Sage 100 und Workist. Die Installationsanleitung beschreibt die notwendigen Schritte zur Installation in Ihrer Sage 100-Umgebung.
| Datei | Inhalt |
|---|---|
| Workist API-Erweiterung Version 7.1 (ZIP) | Je ein Paket pro unterstützter Sage 100-Version |
| Workist API Installationsanleitung (PDF) | Metadatenimport, Dateiverteilung, Fehleranalyse |
Workist Client-ID
Workist authentifiziert sich gegenüber Ihrem Sage 100-System über Sage ID mittels OpenID Connect im Maschine-zu-Maschine-Betrieb (M2M).
Die Workist Client-ID lautet: WPw9RlvT5I5XCX25kAsOKB3REYv98FRq
Die Client-ID ist eine öffentliche Anwendungskennung und für alle Workist-Kunden identisch. Es gibt kein Passwort und kein Client Secret, das Sie hinterlegen müssten.
Im M2M-Betrieb tritt die Client-ID an die Stelle der Sage ID-E-Mail-Adresse als Identität des aufrufenden Systems. Sie wird also dort hinterlegt, wo bei einem interaktiven Benutzer das Sage-Konto eingetragen wird – nicht als Kennwort, nicht als Lizenzschlüssel und nicht als Eingabe im Server Manager.
Benötigte Berechtigungen
Die für die API relevanten Berechtigungen werden im Sage 100 Administrator im Bereich API aufgeführt:
| Bereich | Berechtigungen |
|---|---|
API.VK | Verkaufsbeleg, Verkaufsbelegposition, VKBeleg, VKBelegePositionen, VKBelegPositionLager, VKArtikelPreisfinding |
API.EK | EKBeleg, EKBelegPosition, EKBelegPositionLager |
API.Artikel | Artikel, Lagerplatzbestände |
API.Kunden | Kunde |
API.Ansprechpartner | Ansprechpartner |
API.Lager | Lagersuche |
API.Lieferanschriften | Lieferanschriften |
API.Projekte | Projekte |
Zusätzlich legt die API-Erweiterung Berechtigungen im Bereich SData-Dienste an (Stammdaten, Bewegungsdaten und Realtime-Data).
Angaben für die Workist-Konfiguration
Damit Workist Ihre Sage 100 ansprechen kann, brauchen wir drei Angaben von Ihnen. Alle drei entnehmen Sie Ihrer Sage 100 – an der Schnittstelle selbst müssen Sie nichts einrichten.
| Angabe | Wo Sie sie finden | Wofür |
|---|---|---|
| EntitlementID | Server Manager → Externe API → Konfiguration | Identifiziert Ihre Installation im Connectivity Gateway |
| Mandant | Sage 100 Administrator | Bestimmt, in welchem Mandanten gelesen und geschrieben wird |
| Belegart | Sage 100 Warenwirtschaft | Bestimmt, welche Belegart Workist anlegt |
EntitlementID
Die EntitlementID identifiziert Ihre Sage 100-Installation gegenüber dem Connectivity Gateway. Sie entsteht bei der Lizenzierung des 3rd Party Gateway und ist im Sage 100 Server Manager unter Externe API → Konfiguration einsehbar. Im selben Dialog legen Sie fest, an welchen Applikationsserver Anfragen weitergeleitet werden, und hinterlegen bei Bedarf einen Proxy.
Mandant
Workist arbeitet in genau einem Mandanten Ihrer Sage 100. Dessen Datenbank muss im Sage 100 Administrator ausdrücklich für die Konnektivität freigegeben sein – siehe Schritt 3 der Einrichtung.
Belegart
Welche Belegart Workist anlegt, legen Sie fest. Technisch wird sie über ein Kennzeichen angesprochen. Anlegen lassen sich ausschließlich Initialbelegarten – zur Auswahl stehen diese Verkaufsbelegarten:
| Kennzeichen | Bezeichnung |
|---|---|
VFR | Rechnung |
VLL | Lieferschein |
VPA | Angebot |
VPM | Musterbeleg |
VSD | Direktrechnung |
VSL | Sofortrechnung |
VSS | Sofortauftrag |
VVA | Auftragsbestätigung |
Maßgeblich ist, welche dieser Belegarten in Ihrer Sage 100 konfiguriert sind. Die vollständige Übersicht führt Sage in der Dokumentation der Beleg-API:
Beleg API – Sage Dokumentation ↗Was Workist in Ihrer Sage 100 berührt
Für die Einführung ist weniger die Schnittstelle selbst relevant als das Datenmodell dahinter: welche Tabellen Workist liest, wo geschrieben wird und was die Installation an Ihrem Datenbestand verändert.
Gelesene Daten
Workist liest, um Angaben aus dem eingehenden Dokument gegen Ihr System zu validieren: Stammdaten zu Kunde, Artikel, Lieferadresse, Projekt.
| Bereich | Sage 100-Tabellen | Wofür Workist es liest |
|---|---|---|
| Kundenstamm | Kundenstamm (Sage-Datensatz recKundenstamm) | Kundenerkennung |
| Lieferanschriften | KHKAdressen, KHKAdressenverweise, KHKKontokorrent | Auflösen der Lieferadresse |
| Ansprechpartner | KHKAnsprechpartner + dieselben Adresstabellen | Ansprechpartner am Beleg |
| Artikel | KHKArtikel, KHKArtikelVarianten (+ KHKArtikelgruppen, KHKVariantenAnzeigeTexte u. a.) | Artikelerkennung, Mengeneinheiten |
| Projekte | KHKProjekte | Rahmenverträge |
Alle Lesezugriffe erfolgen mandantenbezogen – die Abfragen filtern auf den Mandanten des angesprochenen DataSets.
Geschriebene Daten
Workist schreibt nicht per SQL in Ihre Tabellen. Belege entstehen über die Belegerfassung von Sage 100, Kunden über den Kundenstamm. Damit greifen Ihre Nummernkreise, Preisfindung, Steuerlogik und Validierungen unverändert.
| Was Workist anlegt | Über | Ergebnis in Sage 100 |
|---|---|---|
| Verkaufsbeleg mit Positionen | Belegerfassung | Beleg in KHKVKBelege / KHKVKBelegePositionen |
| Kunde | Kundenstamm | Datensatz im Kundenstamm |
Bestehende Belege werden nicht geändert oder gelöscht – es gibt ausschließlich die Anlage.
Zusätzliche Felder in Ihren Tabellen
Die Installation legt zwei benutzerdefinierte Felder an. Sie werden über das mitgelieferte
Skript UpdateUserFields-Workist.sql erzeugt und dienen der Rückverfolgbarkeit.
| Feld | Bezeichnung in Sage 100 | Typ | Tabellen |
|---|---|---|---|
USER_WorkistBearbeiter | Bearbeitet von in Workist | varchar(200) | KHKVKBelege, KHKArchivVKBelege, tKHKPrintBelegKopfVK |
USER_WorkistReferenz | Workist Referenz | varchar(200) | KHKVKBelege, KHKArchivVKBelege, tKHKPrintBelegKopfVK |
Zusätzlich werden die Felder in USysClassFields für die Klasse VKBeleg registriert, damit
sie in Sage 100 verfügbar sind.
Diese beiden Felder werden nicht über den Metadatenimport angelegt. Das Skript
UpdateUserFields-Workist.sql aus dem Paketordner SKRIPTE muss auf den betroffenen
Datenbanken ausgeführt werden. Die Installationsanleitung führt dieses Skript nicht auf.
Feldreferenz
Welche Felder Workist im Einzelnen in den Verkaufsbeleg schreibt und welche Stammdatenfelder Workist aus Ihrer Sage 100 liest, steht in der Sage 100 Feldreferenz.