Ein Skriptwerkzeug ist ein Geoverarbeitungswerkzeug, das ein Skript oder eine ausführbare Datei ausführt. Skriptwerkzeuge führen diese Skripte aus, indem ein Geoverarbeitungswerkzeug als Schnittstelle zum Skript verwendet wird. Wenn Sie ein Skriptwerkzeug erstellen, geben Sie Parameter an, die für die Ausführung des Skripts erforderlich sind. Die gängigsten Parameter sind Eingabe- und Ausgabe-Datasets, Feldnamen und Zeichenfolgen, die aus einer Liste ausgewählt werden. Wenn das Skriptwerkzeug ausgeführt wird, werden die Parameterwerte an Ihr Skript übergeben und vom Skript verwendet.
Viele Skriptwerkzeuge führen ein Python-Skript (.py) aus, das ArcPy verwendet, ein Python-Site-Paket, das mit ArcGIS installiert wird. ArcPy bietet Zugriff auf Geoverarbeitungswerkzeuge sowie zusätzliche Funktionen, Klassen und Module, mit denen Sie einfache oder komplexe Workflows erstellen können. Ihr Skript kann durch ArcPy auf die Geoverarbeitungsumgebung von ArcGIS zugreifen, was Vorteile wie On-the-fly-Projektion, Unterstützung von Auswahlsätzen, Validierung von Eingaben, Fehlermeldungen und Aufzeichnung von Verläufen bietet.
Skriptwerkzeuge werden in einer Toolbox erstellt. Um ein Skriptwerkzeug zu erstellen, klicken Sie im Bereich Katalog mit der rechten Maustaste auf eine Toolbox, und wählen Sie Neu > Skript aus.
Eigenschaften
Wenn Sie ein Skriptwerkzeug erstellen, wird das Dialogfeld mit den Eigenschaften des Skriptwerkzeugs mit den folgenden seitlichen Registerkarten angezeigt:
- Allgemein
- Parameter
- Ausführung
- Validierung
Allgemein
Die Registerkarte Allgemein enthält Eigenschaften wie den Namen, die Beschriftung und die Beschreibung des Werkzeugs.
Hinweis:
Wenn Ihre Toolbox eine Toolbox der Vorversion (.tbx) ist, gibt es auch eine Eigenschaft, um den Pfad des Ausführungsskripts des Werkzeugs relativ zur Toolbox-Datei zu speichern. Wenn Ihre Toolbox eine ArcGIS-Toolbox (.atbx) ist, wird dieses Verhalten anders gehandhabt. Wenn sich das Skript im gleichen Verzeichnis wie die .atbx-Datei oder in einem Ordner befindet, der dem Ordner der .atbx-Datei untergeordnet ist, wird ein relativer Pfad verwendet. Wenn das Skript und die .atbx-Datei vollständig getrennt sind, wird ein absoluter Pfad verwendet.
Parameter
Die Registerkarte Parameter enthält eine Tabelle der Parametereigenschaften, wobei jede Zeile ein Parameter ist. Die Tabelle ist standardmäßig leer. Für jeden Parameter definieren Sie eine Anzahl von Eigenschaften wie die Beschriftung, die für den jeweiligen Parameter in der Benutzeroberfläche angezeigt wird, den zulässigen Datentyp und ob der Parameter optional oder erforderlich ist. Sie müssen zumindest die Parametereigenschaften Beschriftung, Name, Datentyp, Typ und Richtung angeben.
| Eigenschaft | Beschreibung |
|---|---|
Beschriftung | Der Name des Parameters, wie er im Werkzeug angezeigt wird. |
Name | Der Name des Parameters, wenn das Skriptwerkzeug als Funktion aus einem anderen Python-Skript abgerufen wird. |
Datentyp | Der Datentyp, den der Parameter akzeptiert. Hiermit wird das im Werkzeug verwendete Steuerelement festgelegt. Wenn Sie beispielsweise Feature-Layer auswählen, können Sie einen Layer aus einer aktiven Karte auswählen oder zu einer Feature-Class navigieren. |
Typ | Parameter können erforderlich oder optional sein. Wenn der Parameter erforderlich ist, muss ein Wert angegeben werden, andernfalls kann das Werkzeug nicht ausgeführt werden. Wenn der Parameter optional ist, kann das Werkzeug ohne Angabe eines Wertes ausgeführt werden. |
Richtung | Paramater können vom Typ "Eingabe" oder "Ausgabe" sein. Eingabeparameter stellen vorhandene Daten dar, die verarbeitet werden sollen, oder Werte, die bei der Verarbeitung verwendet werden sollen. Ausgabeparameter stellen Daten dar, die das Werkzeug erstellt, oder Werte, die berechnet werden. |
Kategorie | Durch die Eingabe des Namens einer Kategorie wird der Parameter einer Dropdown-Gruppe im Dialogfeld des Werkzeugs zugeordnet. |
Filter | Mit Filtern können Sie festlegen, ob nur bestimmte Typen eines Datasets, einer Datei oder eines Feldes, bestimmte Werte oder Werte in einem Bereich als Eingabe für ein Werkzeug akzeptiert werden. Sie können beispielsweise einen Feature-Class-Parameter so filtern, dass nur Point-Feature-Classes akzeptiert werden. Sie können auch einen numerischen Parameter so konfigurieren, dass nur Werte zwischen 1 und 10 akzeptiert werden. |
Abhängigkeit | Sie können einen Parameter als abhängig von einem anderen Parameter festlegen. Ein Feldparameter ist beispielsweise abhängig von einem Dataset-Parameter. Durch die Festlegung dieser Abhängigkeit können Sie ein Feld aus dem abhängigen Dataset auswählen. |
Standard | Ein automatisch für den Parameter festgelegter Wert, wenn das Dialogfeld des Werkzeugs angezeigt wird. |
Umwelt | Ein Parameter kann seinen Standardwert aus einer Geoverarbeitungsumgebung ableiten. Wenn die angegebene Geoverarbeitungsumgebung also festgelegt wird, wird der Wert als Standardwert für den angegebenen Parameter verwendet, wenn das Dialogfeld des Werkzeugs angezeigt wird. |
Symbolisierung | Der Pfad zu einer Layer-Datei, die die Symbolisierung des Parameters definiert. Sie können beispielsweise festlegen, dass ein Ausgabe-Dataset-Parameter dieselbe Symbolisierung wie die Layer-Datei hat, wenn die Ausgabe erstellt und der Karte hinzugefügt wird. |
Ausführung
Die Registerkarte Ausführung enthält Eigenschaften im Zusammenhang mit dem Ausführungscode des Skriptwerkzeugs oder den Pfad zu einer Python- oder R-Skriptdatei. Darüber hinaus enthält die Seite Optionen, um den Ausführungscode des Skriptwerkzeugs einzubetten und mit einem Kennwort zu schützen oder um den Ausführungscode in eine neue Datei zu exportieren.
Sie können den Ausführungscode in die Toolbox oder in einen Link zu einer externen Skriptdatei einbetten. Unabhängig vom Speicherort des Ausführungscodes umfasst die Seite einen Code-Editor, mit dem Sie den Ausführungscode ändern können. Klicken Sie alternativ auf die Schaltfläche In Skript-Editor öffnen, um den Ausführungscode in einem Skript-Editor zu öffnen. Ihren bevorzugten Skript-Editor können Sie in den Geoverarbeitungsoptionen festlegen.
Validierung
Auf der Seite Validierung wird der Validierungscode des Skriptwerkzeugs angezeigt. Anhand der Validierung können Sie anpassen, wie Werkzeugparameter reagieren und mit Werten und anderen Parametern im Skriptwerkzeug interagieren. Validierungscode wird in Python erstellt.
Mit dem Python-Codeblock ToolValidator können Sie das Aussehen, das Verhalten und die Meldungen Ihres Skriptwerkzeugs steuern. Sie können den Validierungscode direkt in einem Code-Editor bearbeiten, oder Sie können auf die Schaltfläche In Skript-Editor öffnen klicken, um den Validierungscode im bevorzugten Skript-Editor zu öffnen, der in den Geoverarbeitungsoptionen festgelegt wurde.