Formeln
Ihr Leitfaden zur V5-Integration!
Die Integration von Formeln zwischen V5 Traceability und dem ERP-System eines Kunden ermöglicht den Import von Formeln/Rezepten/Stücklisten, über die sie dann geplant werden können Arbeitsanweisungen zu produzieren Chargen or produkte über das V5-Terminal.
Weitere Informationen zur Funktionsweise des Formulierungsmoduls in V5 Traceability finden Sie in unserem Modulhandbuch werden auf dieser Seite erläutert.
Inhaltsverzeichnis
1. Layout des Kontrollzentrums
Im Hinblick darauf, wie wir Formeldetails mit dem verknüpfen können, was wir im Control Center sehen, werden wir die V5-API und das Gateway verwenden, um beide oberen Bereiche zu füllen ‘Formula’ Bereich zur Eingabe von Formelkopfdaten sowie im unteren Bereich ‘Formula Step’ Panel zum Ausfüllen der Formelschrittdetails.
Abhängig von unserer Integrationsmethode werden wir die nutzen ‘Formula’ , ‘FormulaStep’ Endpunkte, um beide Panels zu füllen und die Einrichtung unserer Formel abzuschließen.
2. API-Links
Weitere Informationen zu den Definitionen dieser Datenbankklassen finden Sie unter den folgenden Links:
3. Integrationsvorlage
Die Integrationsvorlage für Formeln kann heruntergeladen werden werden auf dieser Seite erläutert.
4. Feldführer für Formeln
4.1. Primärschlüssel
Primärschlüssel sind die eindeutige Kennung für jede Tabelle innerhalb der V5-API. Für Formula, das ist:
commodity.code – Der zugrunde liegende Warencode der Formel. Die Formel-/Rezeptnummer.
Für FormulaStep, die Primärschlüssel sind:
formula.commodity.code – Derselbe Warencode für die Formel selbst wie oben beschrieben.
sequence – Wird verwendet, um die Reihenfolge der einzelnen Formelschritte innerhalb einer Formelkonfiguration festzulegen, z. B. 1, 2, 3 usw.
4.2. Benötigte Felder
Weitere Felder, die von SG zum Ausfüllen einer gültigen Formelzeile im Control Center benötigt werden, sind:
Für Formula:
type - Der Typ der Formel. Dies sollte 0 (für eine Chargenformel) oder 1 (für eine Produktformel) sein.
defaultSize - das 'Basisgröße' der betreffenden Formel.
commodity.units.code – Die Gewichtseinheit, in der die Formel erstellt werden soll. Wenn nicht angegeben, wird die Formel in der Standardmaßeinheit der Datenbank erstellt.
Für FormulaStep:
type - die Formel Step tippe.
Die Schritttypen sind wie folgt:
0 – Wiegen
1 – Schlüsseleingabe
2 – Frage
3 – Nachricht
4 – Containerwechsel
5 – Produktkomponente
6 – Produktverpackung
7 – Submix
8 – Zusammenstellung
9 - Massenabgabe
10 – Optional
11 – Scannen
12 - Überarbeiten
13 – Aussetzen
4.3. Bevorzugte Felder
Bevorzugte Felder dienen dazu, der betreffenden Formel weitere Informationen hinzuzufügen. Sie sind zwar nicht erforderlich, aber nützlich, wenn es um zusätzliche Funktionen innerhalb der V5-Rückverfolgbarkeit geht.
Für Formula Diese Felder sind:
commodity.units.code – Die Gewichtseinheit, in der die Formel erstellt werden soll. Wenn nicht angegeben, wird die Formel in der Standardmaßeinheit der Datenbank erstellt.
minimumProducts - Die Mindestgröße der Charge, die produziert werden kann
maximumProducts – Die maximale Größe der Charge, die produziert werden kann.
Für FormulaStep Diese Felder sind:
sequence – die Reihenfolge des Rezepturschrittes, also in welcher Reihenfolge er bei der Produktion abgearbeitet werden soll.
commodity.code – die Ware/Zutat, die für den jeweiligen Schritt verwendet werden soll
targetQty – das Zielgewicht für den jeweiligen Schritt
unit.code – die UoM dieses bestimmten Schritts
question.question– Soll es sich bei diesem Schritt um eine Frage oder Nachricht handeln, so kann diese über dieses Feld eingegeben werden.
Wir können, wie wir in den Abschnitten „Primärschlüssel“ und „Pflichtfelder“ gesehen haben, zwischen diesen 2 'formula'Und'formulaStep' Klassen und können daher die oben genannten Datenpunkte zur Verwendung mit beiden Klassen enthalten, vorausgesetzt, wir können erfolgreich zu dieser Klasse wechseln.
4.4. Weitere Felder
Es können auch zusätzliche Felder eingebunden werden, wie z FormulaStep:
upperTol - Die obere Toleranz für diesen bestimmten Schritt, d. h. das Gewicht darf maximal über der Zielmenge liegen, um bei der Herstellung der Formel akzeptabel zu sein.
lowerTol – Die geringere Toleranz für diesen bestimmten Schritt, d. h. das Gewicht darf maximal unter der Zielmenge liegen, um bei der Herstellung der Formel akzeptabel zu sein.
schedule – Ob der Schritt eingeplant werden soll, wenn die Formel erstellt wird. Nützlich für Schritte, die Untermischungen sind und gleichzeitig mit einer Masterformel erstellt werden müssen.
Wie oben besprochen, könnten wir diese Datenpunkte weiterhin nutzen, wenn wir das verwenden ‘formula’ Endpunkt, einfach durch Überqueren zum ‘formulaStep’ Klasse durch Hinzufügen ‘formulaStep’ zu jedem der oben genannten Punkte.
5. Methodik
Abhängig von unserer Integrationsmethodik für Formeln würden wir im Allgemeinen unterschiedliche Endpunkte verwenden; Für die API-Integration würden wir im Allgemeinen verwenden ‘Formula’, und für CSV ‘FormulaStep’. Wir können uns jetzt beides ansehen und sehen, warum das so ist.
5.1. JSON – Importieren
Formel:
Wir können das nutzen ‘Formula’ Endpunkt zum Erstellen neuer Formeln für die Produktion in V5 Traceability. Wie wir sehen werden, können wir mit diesem Endpunkt problemlos sowohl den Formelkopf als auch die Schrittinformationen in einer Datei erfassen.
‘Formula’ Endpunkt/URI importieren –
http://host:port/V5-API/api/integrate/import/formula
Für diesen Beispielimport mit der ‘Formula’ Endpunkt können wir eine grundlegende Importdatei für eine einzelne Formel mit zwei Formelschritten wie folgt strukturieren:
Diese JSON-Beispieldatei kann heruntergeladen werden werden auf dieser Seite erläutert.
Mithilfe des API-Handbuchs können wir die Pfade planen, die wir zum Durchlaufen der verschiedenen Klassen verwenden, die wir für diesen Import verwenden müssen. Im ‘Formula’ Klasse können wir sehen, dass wir hier nur die verwenden ‘type’ , ‘productionLocation’. Von hier aus müssen wir unsere Formel für Wareninformationen definieren, was wir durch Überqueren erreichen können ‘Formula’ zu ‘Commodity’. Hier können wir die Wareninformationen für die Formel selbst eingeben (Code, Beschreibung usw.).
Um dann die Formelschritte zu definieren, müssen wir zunächst zu durchlaufen ‘FormulaStep’ Klasse, in der wir den Schritttyp, die Zielmenge, Toleranzen usw. definieren können. Von hier aus würden wir wieder zur Klasse wechseln ‘Commodity’ Klasse, mit der Ausnahme, dass wir hier aufgrund des von uns gewählten Wegs zur Klasse die Wareninformationen für die Zutat definieren, die für einen bestimmten Formelschritt verwendet werden soll, und nicht die Kopfinformationen, die wir oben bereits definiert haben.
Von hier aus würden wir dann beide Seiten durchqueren ‘Commodity’ Klassen, um zum zu gelangen ‘WeightUnit’ Klasse, in der wir die UoM sowohl für die Formel selbst als auch für jeden einzelnen Schritt definieren können. Obwohl wir hierfür dieselbe Klasse verwenden, sind wir auf zwei verschiedene Arten dorthin gelangt, was sich in den Definitionen widerspiegelt, die wir sehen können (commodity.units.code vs formulaStep.commodity.units.code), so dass wir bei Bedarf unterschiedliche UoMs verwenden können.
Eine Zusammenfassung der zur Erstellung der obigen JSON-Datei erforderlichen Pfadfindung finden Sie hier:
Den Rest unserer benötigten Datenpunkte können wir mit einer ähnlichen Pfadfindungsmethode aufbauen.
Wenn wir die JSON-Datei oben ausführen, sehen wir, dass diese neue Formel zusammen mit ihren Schritten jetzt auf der Registerkarte „Formeln“ im Kontrollzentrum sichtbar ist.
Formelschritt:
‘FormulaStep’ Endpunkt/URI importieren –
http://host:port/V5-API/api/integrate/import/formula_step
Für diesen Beispielimport mit der ‘FormulaStep’ Endpunkt werden wir versuchen, die gleiche Formel wie oben zu importieren, aber wir werden nur ihren Namen ändern. Mithilfe dieses Endpunkts können wir diese Datei wie folgt strukturieren:
Wir können auch die verwenden ‘FormulaStep’ Endpunkt zum Erstellen neuer Formeln für die Produktion in V5 Traceability. Dies würde weitgehend genauso funktionieren wie die Verwendung ‘Formula’ oben, aber wir müssten die Datenbankklassen effektiv in umgekehrter Reihenfolge durchlaufen, anstatt von ‘Formula’ zu ‘FormulaStep’, wir würden gehen ‘FormulaStep’ zu ‘Formula’. Wir können unten sehen, wie das funktionieren würde:
Diese JSON-Beispieldatei kann heruntergeladen werden werden auf dieser Seite erläutert.
Wie wir hier sehen können, geben wir hinsichtlich der Schritte die gleichen Informationen ein und ändern lediglich den Formelnamen. Beachten Sie hier die Durchquerung von ‘formulaStep’ Klasse zum ‘formula’ Klasse und die Tatsache, dass diese Informationen für jeden Formelschritt verschachtelt werden müssen.
Wenn wir nun diese JSON-Beispieldatei ausführen, wird unsere Duplikatformel nun mit den gleichen Einstellungen erstellt, die wir bei der Verwendung gesehen haben ‘Formula’ Endpunkt.
5.2. JSON – Exportieren
Was den Rückempfang von Dateien zu Formeln/Rezepten von der V5-API betrifft, verfolgen wir hier keine wirklichen Verbrauchsdaten, sondern exportieren stattdessen einfach die Konfiguration/Einrichtung einer Formel. Hierfür gibt es noch einige Optionen, wenn wir die verfügbaren prüfen ‘IntegrationExport’ Leistungen:
Formel:
Endpunkt/URI exportieren –
http://host:port/V5-API/api/integrate/export/formula/{code}
Dieser Endpunkt exportiert eine JSON-Datei mit allen zugehörigen Informationen für eine bestimmte Formel. Wenn wir diese GET-Anfrage für die Formel ausführen, die wir über erstellt haben ‘Formula’ Endpunkt erhalten wir eine Rückgabedatei, die etwa so aussieht:
Eine Beispiel-JSON-Datei kann heruntergeladen werden werden auf dieser Seite erläutert.
All Formulas:
Endpunkt/URI exportieren –
http://host:port/V5-API/api/integrate/export/formulas
Dieser Endpunkt exportiert eine JSON-Datei, die eine Liste aller im System enthaltenen Formeln enthält. Beachten Sie, dass dadurch nur die Kopfdaten für jede Formel zurückgegeben werden. Informationen zum Abrufen von Formelschritten finden Sie unten.
Beispiel-JSON-Dateien dieses Typs können heruntergeladen werden werden auf dieser Seite erläutert.
Formelschritt:
Endpunkt/URI exportieren –
http://host:port/V5-API/api/integrate/export/formula_step/{code}/{sequence}
Dieser Endpunkt kann so konfiguriert werden, dass er Daten für einen bestimmten Schritt einer bestimmten Formel zurückgibt. Wir würden anhand seiner Sequenznummer angeben, welchen Schritt wir abrufen möchten. Wenn wir diesen Endpunkt erreichen, um Schritt 1 der ersten Beispielformel abzurufen, die wir oben erstellt haben, erhalten wir eine Rückgabe, die etwa so aussieht:
Diese JSON-Beispieldatei kann heruntergeladen werden werden auf dieser Seite erläutert.
Formelschritte:
Endpunkt/URI exportieren –
http://host:port/V5-API/api/integrate/export/formula_steps/{all}
Dieser Endpunkt stellt eine Liste aller Formelschritte im System bereit. Wir können die Rückgabe ändern, indem wir beides verwenden ‘/true’ or ‘/false’ an Stelle von ‘/{all}’ in der URI oben. ‘True’ exportiert eine Liste aller Schritte im System ‘false’ gibt eine Liste der Schritte zurück, die nicht als bereits exportiert markiert sind.
Das Layout würde dem obigen Beispiel sehr ähnlich aussehen, nur mit mehr Schritten. Ein Beispiel für a ‘true’ Export dieser Art kann heruntergeladen werden werden auf dieser Seite erläutert.
5.3. CSV – Importieren
Hinweis: Nach dem Import können Formeln vor Änderungen geschützt werden, indem Sie das Kontrollkästchen „Vom Import ausgenommen“ in der Formelüberschrift aktivieren. Control Center. Dies gilt nur für die CSV-Methode.
Wir haben in den JSON-Beispielen oben gesehen, dass wir beide verwenden können ‘formula’ , ‘formulaStep’ Endpunkte für diese bestimmte Methodik. Für CSV-Importe verwenden wir jedoch nur die ‘formulaStep’ Endpunkt.
Dateiname der Kopf-/Spaltendefinition: “formulaStep.csvh”
Fertige Header-Dateien sollten abgelegt werden in: “<installdir>\SG Control Center\gateway\import\column_defs”
CSV-Dateiname importieren: “formulaStep-datetime.csv”
CSVs für den Import sollten abgelegt werden in: “<installdir>\SG Control Center\gateway\import”
Header-Datei:
Header-Dateien werden im Allgemeinen von SG Systems kompiliert, bevor CSV-Integrationen stattfinden, aber wir sehen unten ein einfaches Beispiel dafür, wie wir es für Jobs verwenden können:
Weitere Informationen zur Strukturierung dieser Dateien finden Sie im Hauptintegrationsseite. Diese Beispiel-Header-Datei kann heruntergeladen werden werden auf dieser Seite erläutert.
CSV-Importdatei:
Anschließend können wir die definierte Reihenfolge der Datenpunkte im Header verwenden, um unsere Importdatei zu strukturieren. SG Systems kann hierfür eine Vorlagendatei bereitstellen, die den Datenpunkt für jede Spalte auflistet, um die Dinge beim Ausfüllen der Liste klarer zu gestalten. Beachten Sie, dass diese erste Zeile vom Control Center ignoriert werden kann und daher bei der Übermittlung zum Import in der Datei beibehalten werden kann.
Auch hier erstellen wir ein Duplikat der beiden Formeln, die wir oben mit der JSON-Methode erstellt haben. Eine Beispiel-CSV-Importdatei für eine Formel könnte etwa so aussehen:
Diese Beispielimportdatei kann heruntergeladen werden werden auf dieser Seite erläutert.
Nach Abschluss des Imports können wir sehen, dass diese zusätzliche Formel mit denselben Schritten wie die Formeln, die wir oben mithilfe von JSON-Importen erstellt haben, zum Control Center hinzugefügt wurde.
5.4. CSV – Exportieren
Für unsere CSV-Exporte nutzen wir einfach dasselbe ‘formulaStep’ Header-Datei/Endpunkt wie oben für die Importe. Dieses kann heruntergeladen werden werden auf dieser Seite erläutert.
Dateiname der Kopf-/Spaltendefinition: “formulaStep.csvh”
Fertige Header-Dateien sollten abgelegt werden in: “<installdir>\SG Control Center\gateway\export\order”
CSV-Dateiname exportieren: “FormulaStep-datetime.csv”
CSVs für Exporte werden generiert in: “<installdir>\SG Control Center\gateway\export”
Dies ist die einzige Möglichkeit, Formeldaten von V5 Traceability in Form einer CSV zurückzuerhalten.
Dieser Export müsste auch im Gateway-Bereich des Control Centers aktiviert werden. Wir können hier den Export auswählen ‘Formulas’.
Header-Datei:
Für dieses Beispiel können wir den Header, der zuvor für den Import verwendet wurde, für den Export verwenden. Bei Bedarf können weitere Datenpunkte hinzugefügt werden.
CSV-Exportdatei:
Wenn Sie diesen Export unter Verwendung des zuvor verwendeten Headers aktivieren, erhalten Sie eine Exportdatei für unsere drei neuen Formeln, die wie folgt aussehen würde:
5.5. Formeln schützen
Einzigartig beim CSV-Importmechanismus ist das Kontrollkästchen „Geschützt“ neben der Formelüberschrift im Control Center:
Wenn diese Option aktiviert ist, wird die Formel vor allen Änderungen geschützt, die durch nachfolgende formulaStep-CSV-Importe vorgenommen werden.
Wie oben angegeben, ist dies nur bei der CSV-Importmethode der Fall. Durch Aktivieren dieses Kontrollkästchens wird eine Formel nicht vor Aktualisierungen über JSON/API geschützt.
