Script (Tarifwerk) - Versionsgeschichte

Ddang am 18. Oktober 2024 um 14:34 Uhr

2024-10-18T14:34:26Z

Ddang am 18. Oktober 2024 um 14:33 Uhr

2024-10-18T14:33:42Z

Ddang am 18. Oktober 2024 um 14:06 Uhr

2024-10-18T14:06:59Z

Sbaumbach am 24. Februar 2017 um 16:09 Uhr

2017-02-24T16:09:55Z

Sbaumbach am 24. Februar 2017 um 12:29 Uhr

2017-02-24T12:29:57Z

Sbaumbach: Die Seite wurde neu angelegt: „ TW Script Editor.pngScripte bilden die zentrale Stelle im Tarifwerk um Regeln für Zuschläge un…“

2017-02-24T12:28:47Z

Die Seite wurde neu angelegt: „ frameless|right|super|475x413px|TW Script Editor.pngScripte bilden die zentrale Stelle im Tarifwerk um Regeln für Zuschläge un…“

Neue Seite

[[File:TW Script Editor.png|frameless|right|super|475x413px|TW Script Editor.png]]Scripte bilden die zentrale Stelle im Tarifwerk um Regeln für Zuschläge und Tarifwerke aufzubauen. Dies können simple Abfragen sein, wie z.B. prüfen, ob es sich um eine Inselzustellung handelt, oder aber komplexe Konstrukte, die Frachtführer- oder Kundenspezifische Anforderungen umsetzen.

Alle Scripte verwenden den Pegasus Parser, eine Eigenentwicklung der Heidler Strichcode GmbH. Die Scriptsprache basiert auf der Programmiersprache Java, was manche Dinge komplizierter machen kann, dafür aber deutlich mehr Flexibilität und Performance bietet.

== Scripteditor ==

Der Scripteditor ist in drei Bereiche unterteilt:

=== Informationpanel ===

Das Informationspanel befindet sich links oben. Es zeigt Ihnen alle Informationen an, welche Sie für die Scriptentwicklung benötigen.

Zunächst wird Ihnen aufgelistet, welche Variablen Sie zur Verfügung haben und welchen Typ (welche Klasse) die Variablen besitzen. Im Tarifwerk erhalten Sie hier meist die Variable shipment, was der aktuellen Sendung entspricht, und eventuell die Variable packageData, was dem aktuellen Packstück entspricht.

Der Erwartete Rückgabetyp ist der Typ des Wertes, welchen Sie in diesem Script zurückgeben müssen. Im Tarifwerk wird in der Regel nur Boolean (true oder false) oder Double (Gleitkommazahl mit doppelter Präzision) erwartet.

=== Button-Leiste ===

Die Button-Leiste befindet sich rechts oben. Sie können damit zusätzliche Anpassungen und Tests vornehmen.

==== Importe ====

Der Button Importe öffnet einen Editor, in dem Sie zusätzliche Klassen (Funktionalitäten) zum aktuellen Script hinzufügen können. Über den Button Suchen können Sie die aktuell eingegebene Klasse suchen. Bei Erfolg wird Ihnen diese Klasse in der Liste darüber angezeigt.

Folgende Klassen und Interfaces sind standardmäßig Importiert und müssen nicht angegeben werden:

*java.util.Date
*java.text.SimpleDateFormat
*java.util.ArrayList
*java.util.List
*java.util.Map
*java.util.HashMap

==== Variablen ====

Der Variableneditor ermöglicht es Ihnen, diverse Testszenarien aufzubauen, indem Sie die Werte der gegebenen Variablen beliebig verändern können. Bei komplexeren Variablen-Typen (wie z.B. Sendung oder Packstück) wird die Variable im JSON-Format angezeigt und editiert. Es gelten die üblichen Regeln für Escape-Zeichen.

==== Test ====

Über den Button Test können Sie Ihr aktuelles Script testen. Falls ein Syntaxfehler vorhanden ist, wird Ihnen dieser mit Angabe der Zeile angezeigt. Zusätzlich können Sie, solange das Ergebnisfenster offen ist, die komplette erstellte Klasse im Ordner Tarifwerk\compile\scriptbase einsehen.

=== Editor ===

Im Editor können Sie Ihr Script implementieren. Der Editor besitzt einige Features um das Erstellen von Scripten einfacher zu machen:

*Falls ein Script einzeilig ist und nicht mit einem Semikolon endet benötigen Sie kein return Statement. Dieses wird automatisch hinzugefügt.
*Der Scripteditor besitzt Code-Highlighting um Variablen, Kommentare und Klassen voneinander trennen zu können
*Der Scripteditor besitzt eingeschränkte Code-Vervollständigungs-Features. Diese aktiviert man über die Tastenkombination Strg+Leer

== Zusatzfunktionen ==

Der Scripteditor kommt standardmäßig mit einigen zusätzlichen Funktionen. Viele dieser Funktionen entsprechen den Parserausdrücken aus dem HVS32.

Die Detailbeschreibung und Verwendung können Sie der Code-Vervollständigung (Strg+Leer) entnehmen. Oft verwendete und nützliche Funktionen sind:

*ATrim: Entfernt alle Leerzeichen am Anfang und Ende des Strings.
*Left: Gibt die ersten n Stellen eines String zurück.
*Right: Gibt die letzten n Stellen eines Strings zurück.
*DEBUG: Zeigt den Wert einer Variable in einer Message Box an. (Bitte niemals ein Script speichern was diese Funktionen enthält)
*DateTimeFormat: Konvertiert einen String in ein Datum.
*FormatDateTime: Konvertiert ein Datum in einen String.
*GetListItem: Extrahiert aus einem String das n-te Element was durch ein Trennzeichen getrennt wurde.
*LeftPad: Füllt einen String links mit der angegebenen Anzahl Stellen und Zeichen auf

 

== Besonderheiten ==

Da der Pegasus Parser auf Java basiert, muss man einige Dinge beachten, die in anderen Scriptsprachen (wie z.B. Javascript) nicht üblich sind.

=== Stringvergleiche ===

Zahlen werden wie üblich über ein doppeltes == verglichen:
<pre>int a = 5;
if (a == 5) {
....</pre>

Strings können damit leider nicht verglichen werden. Stattdessen muss man die Methode equals() verwenden:
<pre>String a = "test";
if (a.equals("test")) {
...</pre>

Vergleiche ohne Beachtung von Groß- und Kleinschreibung geschehen über die Methode equalsIgnoreCase().

=== Elemente von Variablen ===

Elemente von Variablen (wie z.B. die Zieladress-PLZ der Sendung) werden über Getter- und Setter-Methoden gelesen und gesetzt.

Diese besitzen immer den Prefix "get" bzw. "set" und das nächste Zeichen wird als Großbuchstabe geschrieben. Bei Boolean wird "is" statt "get" verwendet. Beispiele:
<pre>shipment.getReceiverZipcode()
shipment.getShipmentWeight()
shipment.isIsle()
packageData.getPackageType()</pre>

=== Direktes definieren von Nicht-int Zahlen. ===

Wenn Sie einen double, float oder long direkt im Quelltext deinieren wollen, benötigen diese nach der Zahl einen entsprechenden Suffix:
<pre>double d = 4.3d;
float f = 5.4f;
long l = 200000l;</pre>

== Beispielscripte ==

=== Prüfen auf Inselzustellung ===
<pre>shipment.isIsle()</pre>

Es wird die entsprechende Inseltabelle für den jeweiligen Frachtführer benötigt.

=== Auf bestimmte Länder prüfen ===
<pre>final List<String> zielLaender = java.util.Arrays.asList("DE", "CH", "AT");
return zielLaender.contains(shipment.getReceiverCountry());</pre>

Die Elemente DE, CH, AT müssen durch die gewünschten Länder im ISO2 Format ersetzt werden.

=== Auf bestimmte Versandart prüfen ===
<pre>shipment.getServiceType().equals("VID")</pre>

Die Versandart ID "VID" muss durch die Gewünschte ersetzt werden. Falls mehrere Versandarten in Frage kommen, kann man auch hier eine Liste wie im Beispiel darüber erstellen.

=== Nachnahme-Sendung ===
<pre>shipment.getCodAmount() > 0d</pre>

=== Verpackungsart prüfen ===
<pre>packageData.getPackageType().equals("KT")</pre>

Die Verpackungsart sollte meist auch nur mit Packstück-Tarifwerken und -Zuschlägen definiert werden.

 

← Nächstältere Version		Version vom 18. Oktober 2024, 14:06 Uhr
Zeile 1:		Zeile 1:
		+	[[en:Script (Tarifwerk) (en)]]

	[[File:TW Script Editor.png\|frameless\|right\|super\|475x413px\|TW Script Editor.png]]Scripte bilden die zentrale Stelle im Tarifwerk um Regeln für [[Zuschlag_(Tarifwerk)\|Zuschläge]] und [[Tarifwerk_(Tarifwerk_/_Stammdaten)\|Tarifwerke]] aufzubauen. Dies können simple Abfragen sein, wie z.B. prüfen, ob es sich um eine Inselzustellung handelt, oder aber komplexe Konstrukte, die Frachtführer- oder Kundenspezifische Anforderungen umsetzen.		[[File:TW Script Editor.png\|frameless\|right\|super\|475x413px\|TW Script Editor.png]]Scripte bilden die zentrale Stelle im Tarifwerk um Regeln für [[Zuschlag_(Tarifwerk)\|Zuschläge]] und [[Tarifwerk_(Tarifwerk_/_Stammdaten)\|Tarifwerke]] aufzubauen. Dies können simple Abfragen sein, wie z.B. prüfen, ob es sich um eine Inselzustellung handelt, oder aber komplexe Konstrukte, die Frachtführer- oder Kundenspezifische Anforderungen umsetzen.

← Nächstältere Version		Version vom 24. Februar 2017, 12:29 Uhr
Zeile 1:		Zeile 1:

−	[[File:TW Script Editor.png\|frameless\|right\|super\|475x413px\|TW Script Editor.png]]Scripte bilden die zentrale Stelle im Tarifwerk um Regeln für Zuschläge und Tarifwerke aufzubauen. Dies können simple Abfragen sein, wie z.B. prüfen, ob es sich um eine Inselzustellung handelt, oder aber komplexe Konstrukte, die Frachtführer- oder Kundenspezifische Anforderungen umsetzen.	+	[[File:TW Script Editor.png\|frameless\|right\|super\|475x413px\|TW Script Editor.png]]Scripte bilden die zentrale Stelle im Tarifwerk um Regeln für [[Zuschlag_(Tarifwerk)\|Zuschläge]] und [[Tarifwerk_(Tarifwerk_/_Stammdaten)\|Tarifwerke]] aufzubauen. Dies können simple Abfragen sein, wie z.B. prüfen, ob es sich um eine Inselzustellung handelt, oder aber komplexe Konstrukte, die Frachtführer- oder Kundenspezifische Anforderungen umsetzen.

	Alle Scripte verwenden den Pegasus Parser, eine Eigenentwicklung der Heidler Strichcode GmbH. Die Scriptsprache basiert auf der Programmiersprache Java, was manche Dinge komplizierter machen kann, dafür aber deutlich mehr Flexibilität und Performance bietet.		Alle Scripte verwenden den Pegasus Parser, eine Eigenentwicklung der Heidler Strichcode GmbH. Die Scriptsprache basiert auf der Programmiersprache Java, was manche Dinge komplizierter machen kann, dafür aber deutlich mehr Flexibilität und Performance bietet.

@@ Zeile 7: / Zeile 7: @@
 == Scripteditor ==
-The script editor is divided into three areas:
+Der Scripteditor ist in drei Bereiche unterteilt:
-=== Information panel ===
+=== Informationspanel ===
-The information panel is located at the top left. It shows you all the information you need for script development.
+Das Informationspanel befindet sich links oben. Es zeigt Ihnen alle Informationen an, welche Sie für die Scriptentwicklung benötigen.
-First of all, it lists which variables you have available and which type (which class) the variables have. In the tariff structure, you will usually see the variable shipment, which corresponds to the current shipment, and possibly the variable packageData, which corresponds to the current package.
+Zunächst wird Ihnen aufgelistet, welche Variablen Sie zur Verfügung haben und welchen Typ (welche Klasse) die Variablen besitzen. Im Tarifwerk erhalten Sie hier meist die Variable shipment, was der aktuellen Sendung entspricht, und eventuell die Variable packageData, was dem aktuellen Packstück entspricht.
-The Expected return type is the type of value that you must return in this script. As a rule, only Boolean (true or false) or Double (floating point number with double precision) is expected in the tariff plant.
+Der Erwartete Rückgabetyp ist der Typ des Wertes, welchen Sie in diesem Script zurückgeben müssen. Im Tarifwerk wird in der Regel nur Boolean (true oder false) oder Double (Gleitkommazahl mit doppelter Präzision) erwartet.
-=== Button bar ===
+=== Button-Leiste ===
-The button bar is located at the top right. You can use it to make additional adjustments and tests.
+Die Button-Leiste befindet sich rechts oben. Sie können damit zusätzliche Anpassungen und Tests vornehmen.
-==== Imports ====
+==== Importe ====
-The Imports button opens an editor in which you can add additional classes (functionalities) to the current script. You can use the Search button to search for the currently entered class. If successful, this class will be displayed in the list above.
+Der Button Importe öffnet einen Editor, in dem Sie zusätzliche Klassen (Funktionalitäten) zum aktuellen Script hinzufügen können. Über den Button Suchen können Sie die aktuell eingegebene Klasse suchen. Bei Erfolg wird Ihnen diese Klasse in der Liste darüber angezeigt.
-The following classes and interfaces are imported by default and do not need to be specified:
+Folgende Klassen und Interfaces sind standardmäßig Importiert und müssen nicht angegeben werden:
 *java.util.Date
@@ Zeile 34: / Zeile 34: @@
 *java.util.HashMap
-==== Variables ====
+==== Variablen ====
-The variable editor allows you to set up various test scenarios by changing the values of the given variables as required. For more complex variable types (such as shipment or package), the variable is displayed and edited in JSON format. The usual rules for escape characters apply.
+Der Variableneditor ermöglicht es Ihnen, diverse Testszenarien aufzubauen, indem Sie die Werte der gegebenen Variablen beliebig verändern können. Bei komplexeren Variablen-Typen (wie z.B. Sendung oder Packstück) wird die Variable im JSON-Format angezeigt und editiert. Es gelten die üblichen Regeln für Escape-Zeichen.
 ==== Test ====
-You can test your current script using the Test button. If there is a syntax error, this is displayed along with the line. In addition, you can view the complete class created in the folder Tarifwerk\compile\scriptbase as long as the results window is open.
+Über den Button Test können Sie Ihr aktuelles Script testen. Falls ein Syntaxfehler vorhanden ist, wird Ihnen dieser mit Angabe der Zeile angezeigt. Zusätzlich können Sie, solange das Ergebnisfenster offen ist, die komplette erstellte Klasse im Ordner Tarifwerk\compile\scriptbase einsehen.
 === Editor ===
-You can implement your script in the editor. The editor has several features to make creating scripts easier:
+Im Editor können Sie Ihr Script implementieren. Der Editor besitzt einige Features um das Erstellen von Scripten einfacher zu machen:
-*If a script is single-line and does not end with a semicolon, you do not need a return statement. This is added automatically.
+*Falls ein Script einzeilig ist und nicht mit einem Semikolon endet benötigen Sie kein return Statement. Dieses wird automatisch hinzugefügt.
-*The script editor has code highlighting to separate variables, comments and classes from each other
+*Der Scripteditor besitzt Code-Highlighting um Variablen, Kommentare und Klassen voneinander trennen zu können
-*The script editor has limited code completion features. These are activated via the key combination Ctrl+Space
+*Der Scripteditor besitzt eingeschränkte Code-Vervollständigungs-Features. Diese aktiviert man über die Tastenkombination Strg+Leer
-== Additional functions ==
+== Zusatzfunktionen ==
-The script editor comes with some additional functions as standard. Many of these functions correspond to the parser expressions from the HVS32.
+Der Scripteditor kommt standardmäßig mit einigen zusätzlichen Funktionen. Viele dieser Funktionen entsprechen den Parserausdrücken aus dem HVS32.
-The detailed description and use can be found in the code completion (Ctrl+Space). Frequently used and useful functions are
+Die Detailbeschreibung und Verwendung können Sie der Code-Vervollständigung (Strg+Leer) entnehmen. Oft verwendete und nützliche Funktionen sind:
-*ATrim: Removes all spaces at the beginning and end of the string.
+*ATrim: Entfernt alle Leerzeichen am Anfang und Ende des Strings.
-*Left: Returns the first n digits of a string.
+*Left: Gibt die ersten n Stellen eines String zurück.
-*Right: Returns the last n digits of a string.
+*Right: Gibt die letzten n Stellen eines Strings zurück.
-*DEBUG: Displays the value of a variable in a message box. (Please never save a script that contains these functions)
+*DEBUG: Zeigt den Wert einer Variable in einer Message Box an. (Bitte niemals ein Script&nbsp;speichern was diese Funktionen enthält)
-*DateTimeFormat: Converts a string into a date.
+*DateTimeFormat: Konvertiert einen String in ein Datum.
-*FormatDateTime: Converts a date into a string.
+*FormatDateTime: Konvertiert ein Datum in einen String.
-*GetListItem: Extracts the nth element from a string that was separated by a separator.
+*GetListItem: Extrahiert aus einem String das n-te Element was durch ein Trennzeichen getrennt wurde.
-*LeftPad: Fills a string on the left with the specified number of digits and characters
+*LeftPad: Füllt einen String links mit der angegebenen Anzahl Stellen und Zeichen auf
 &nbsp;

@@ Zeile 8: / Zeile 8: @@
 Der Scripteditor ist in drei Bereiche unterteilt:
-=== Informationpanel ===
+=== Informationspanel ===
 Das Informationspanel befindet sich links oben. Es zeigt Ihnen alle Informationen an, welche Sie für die Scriptentwicklung benötigen.
@@ Zeile 96: / Zeile 96: @@
 === Direktes definieren von Nicht-int Zahlen. ===
-Wenn Sie einen double, float oder long direkt im Quelltext deinieren wollen, benötigen diese nach der Zahl einen entsprechenden&nbsp;Suffix:
+Wenn Sie einen double, float oder long direkt im Quelltext definieren wollen, benötigen diese nach der Zahl einen entsprechenden&nbsp;Suffix:
 <pre>double d = 4.3d;
 float f = 5.4f;