Regel (SPM)
Eine Regel ist ein allgemein definiertes Script, welches bei einer Sendung oder einem Packstück mit fixen Parametern aufgerufen wird.
Die fixen Parameter sind vom definierten Regelwerk abhängig. Grundsätzlich stehen alle Parameter einer Sendung zur Verfügung.
Eingabeparameter
Name
Der Name dient zu Referenzzwecken und zum Wiederfinden der Regel als Teil eines Regelwerkes.
Typ
Der Typ definiert die erwarteten Eingabeparameter in einem Regelwerk.
Bereich (min / max)
Definiert ob diese Regel als Parameter einen Min- und Max-Wert akzeptiert oder nur einen (fixen) Wert. Die Option hängt auch vom verwendeten Datentyp ab:
| Typ | fixer Wert möglich | Min- / Max-Wert möglich |
|---|---|---|
| Integer | ja | ja |
| Long | ja | ja |
| Double | ja | ja |
| String | ja | nein |
| Boolean | ja | nein |
| Date | ja | ja |
Paketregel
Die Option Paketregel gibt an, ob diese Regel pro Paket durchlaufen werden soll. Falls aktiviert haben Sie im Script Zugriff auf die Variable packageData.
Script
Hauptartikel: Script
Über diesen Button gelangen Sie in den Scripteditor. Das Script erwartet immer eine Rückgabe vom Typ Boolean (Regel erfolgreich / nicht erfolgreich).
Standardmäßig haben Sie immer Zugriff auf die Variable shipment, welches der aktuellen Sendung entspricht.
Sie haben je nach Einstellung in den Punkten Typ, Bereich und Paketregel Zugriff auf unterschiedliche zusätzliche Variablen.
| Variable | Bedingung | Beschreibung |
|---|---|---|
| shipment | immer verfügbar | Aktuelle Sendungsdaten |
| packageData | Paketregel aktiv | Aktuelle Packstückdaten (wird pro Packstück einmal aufgerufen) |
| fixedValue | Bereich (min / max) deaktiviert | Eingegebener Fixwert im jeweiligen Regelwerk |
| minValue | Bereich (min / max) aktiviert | Eingegebener Minimalwert im jeweiligen Regelwerk |
| maxValue | Bereich (min / max) aktiviert | Eingegebener Maximalwert im jeweiligen Regelwerk |
Bitte beachten Sie, dass Elemente der Variablen shipment und packageData eventuell keinen Wert haben (null). Sie sollten insbesondere bei der Prüfung auf Werte in den customInformations (KV-Map in beiden Variablen) prüfen ob:
- Das Element customInformation != null ist
- Der zu Suchende Key vorhanden ist.
- Der Wert des hinterlegten Keys != null ist.
Beschreibung
Die Beschreibung gibt Ihnen die Möglichkeit in eigenen Worten kurz zu Beschreiben, was die Aufgabe dieser Regel ist, welche Parameter Sie im Regelwerk benötigt und in welcher Form.
Dies ist ein Freitextfeld und kann beliebig gefüllt werden.