Skip To Content

Task-Parametereigenschaften (REST)

In diesem Thema

Jeder Geoverarbeitungs-Task weist mindestens einen Parameter auf. Jeder Parameter eines Tasks weist eine Reihe von beschreibenden Eigenschaften auf, damit Sie den Parameter besser verstehen und einen geeigneten Wert für die erfolgreiche Ausführung des Tasks angeben können. Die folgende Bildschirmaufnahme zeigt den Task-Beispielparameter "Distance", wie auf der Seite des Geoverarbeitungs-Tasks im Services-Verzeichnis dargestellt. Nachfolgend werden die einzelnen Eigenschaften näher beschrieben.

Task-Parametereigenschaften

Datentyp

Der Datentyp des Parameters gibt den Wertetyp an, den der Client für den Parameter angeben muss. Als Wert eines Parameters kann einfach "String", "Long", "Double", "Boolean" oder "Date" verwendet werden. Es kann sich auch um ein Feature-Set (eine Sammlung von Features mit Attributen, ähnlich einer Feature-Class), eine Tabelle oder ein Raster handeln. Lautet der Datentyp z. B. "Long", müssen Sie einen numerischen Wert zwischen −2.147.483.648 und 2.147.483.647 angeben. Alle anderen Dezimal- oder Zeichenfolgenwerte führen zu unerwartetem Verhalten des Werkzeugs. Ebenso müssen Sie beim Datentyp "Raster" geeignete Rasterdaten angeben, damit das Werkzeug erfolgreich ausgeführt wird. Die folgende Liste enthält die Datentypen eines Task-Parameters und die erwarteten Werte.

DatentypWertJSON-Repräsentationsbeispiel

GPLong

Eine Ganzzahl zwischen −2.147.483.648 und 2.147.483.647

345

GPDouble

Dezimalwerte

1.414

GPString

String

TestString

GPBoolean

true oder false

true

GPLinearUnit

Ein Wert, der einen Entfernungswert und die entsprechende Maßeinheit wie Meilen, Kilometer, Fuß usw. enthält.

{ "distance" : 345.678, "units" : "esriMiles" }

GPDate

Zahl, die die Anzahl an Millisekunden seit 1. Januar 1970 in UTC angibt.

1199145600000

GPDataFile

Jeder Dateityp wie .txt, .pdf, .csv usw.

{ "url" : "http://myserver/myfile" }

GPRasterDataLayer

Rasterdaten, die aus einer Matrix von Zellen (oder Pixel) bestehen, die als Zeilen und Spalten (Gitter) angeordnet sind, wobei jede Zelle einen Wert enthält, der Informationen darstellt, z. B. die Temperatur.

{ "url" : "http://myserver/lake.tif", "format" : "tif" }

GPRecordSet

Tabellen, die aus Spalten und Zeilen bestehen.

{
"fields":[{"name":"Id","type":"esriFieldTypeString","alias":"Id"},
{"name":"State_Name","type":"esriFieldTypeString","alias":"State
Name"},
{"name":"State_Abbr","type":"esriFieldTypeString","alias":"State
Abbr"}],
"features" : [
 { "attributes" : {"Id" : 43, "State_Name" :
"California","State_Abbr":"CA"},
{ "attributes" : {"Id" : 67, "State_Name" :
"Colorado","State_Abbr":"CO"}]}
TypeString","alias":"Id"},

GPFeatureRecordSetLayer

Features, die eine Geometrie, einen Raumbezug, Felddefinitionen und Features aufweisen.

GPFeatureRecordSetLayer JSON

{ 
"geometryType" : "esriGeometryPoint",
"fields":[
  {"name":"Id","type":"esriFieldTypeOID","alias":"Id"},
  {"name":"Name","type":"esriFieldTypeString","alias":"Name"}],
"spatialReference" : {"wkid" : 4326},
"features" : [
    { "geometry" : {"x" : -104.44, "y" : 34.83,
           "spatialReference" : {"wkid" : 4326}}, 
      "attributes" : 
           {"Id" : 43,"Name" : "Feature 1"}},
    { "geometry" : {"x" : -100.65, "y" : 33.69,
            "spatialReference" : {"wkid" : 4326}},
      "attributes" : 
           {"Id" : 42,"Name" : "Feature 2"}}
    ]
}

GPMultiValue

Ein Array von GV-Parameterwerten des gleichen Datentyps.

Beispiele: GPMultiValue:GPString, GPMultiValue:GPLinearUnit

["Parcels", "Street Lights"]

[ { "distance" : 345.67, "units" : "esriMiles" }, { "distance" : 36, "units" : "esriMiles" } ]

Hinweis:
  • Wenn Sie bei GPRecordSet- und GPFeatureRecordSetLayer-Parametern eine große Anzahl an Datensätzen und Features haben, können Sie die JSON-Struktur in einer Datei speichern und die URL als eine Eingabe angeben. Beispiel: { "url" : "http://myserver/myfeatures/afile.txt"}. In der Textdatei müssen das Feature-Set bzw. das Datensatz-Set JSON-Format aufweisen.
  • Beim Datentyp GPMultiValue:GPFeatureRecordSetLayer müssen die Feature-Sets für die erfolgreiche Ausführung Felddefinitionen aufweisen.

Angezeigter Name

Der Anzeigename ist ein aussagekräftiger Name für den Parameter.

Richtung

Die Richtung gibt an, ob der Parameter ein Eingabe- oder ein Ausgabeparameter ist.

  • esriGPParameterDirectionInput : Eingabeparameter
  • esriGPParameterDirectionOutput : Ausgabeparameter

Bei der Ausführung eines Tasks muss der Client nur die Werte für die Eingabeparameter angeben. Bei erfolgreicher Task-Ausführung erstellt der Server die Ausgabeparameter, und der Client kann auf die Werte dieser Ausgabeparameter zugreifen.

Standardwert

Beim Veröffentlichen eines Geoverarbeitungs-Service werden die Geoverarbeitungs-Tasks aus erfolgreichen Ergebnissen des Geoverarbeitungswerkzeugs erstellt. Der Standardwert zeigt die Werte der Parameter im Ergebnis, aus dem der Task erstellt wurde. Der Standardwert eines Eingabeparameters ist ein Beispiel für den Parameterwert, der für die erfolgreiche Ausführung des Tasks übergeben werden sollte. Der Standardwert eines Ausgabeparameters ist wiederum ein Beispiel für erwartete Ausgaben aus dem Task.

  • Der Standardwert von GPFeatureRecordSet und GPRecordSet enthält zusätzliche Informationen zum Schema des Feature-Sets/Datensatz-Sets. Das Schema umfasst Geometrietyp, HasZ, HasM, Raumbezug, Felder und Features. Die Bildschirmaufnahme unten zeigt ein Beispielschema des Datentyps GPFeatureRecordSet.

    Eigenschaft "Standardwert"

    Für die erfolgreiche Ausführung des Werkzeugs sollte der Client Eingabe-Feature-Sets liefern, die mit dem vom Standardwert definierten Schema übereinstimmen. Die Features-Eigenschaft des Schemas lautet in den meisten Fällen "Kein". Wenn der Task allerdings mit der Option Features einbeziehen veröffentlicht wurde, werden die einbezogenen Features im Standardwert angegeben.

  • Die Parameter GPDataFile, GPRasterData und GPRasterDataLayer besitzen keine Standardwerte.

Parametertyp

Es gibt drei Typen von Parametern:

  1. esriParameterTypeRequired: Parameter ist für eine erfolgreiche Ausführung erforderlich. Bei der Ausführung einer Operation für die Task-Ressource muss der Client einen Wert für den Parameter angeben.
  2. esriParameterTypeOptional: Parameter ist für eine erfolgreiche Ausführung optional.
  3. esriParameterTypeDerived: Der Parameterwert ist ein Ausgabeparameter, der von anderen Eingabeparametern abgeleitet wurde, sodass der Client keinen Wert angeben muss.

Kategorie

Wenn viele Eingabe- und Ausgabeparameter vorhanden sind, werden sie vom Autor des Werkzeugs für ein besseres Verständnis normalerweise in bestimmte Kategorien gruppiert. Die folgende Bildschirmaufnahme zeigt ein Beispiel für Kategorien, wie im Werkzeug-Dialogfeld von ArcGIS for Desktop dargestellt.

Eigenschaft "Kategorie"

Die Kategorie gibt an, ob der Parameter einer bestimmten Kategorie angehört, die vom Autor des Werkzeugs entwickelt wurde. Der Kategorienwert kann bei der Entwicklung von Widgets für Geoverarbeitungs-Tasks verwendet werden.

Auswahlliste

Einige GPString-Parameter weisen die zusätzliche Eigenschaft "Auswahlliste" auf. Eine Auswahlliste ist ein vordefinierter Satz von Werten, die vom Publisher für die erfolgreiche Ausführung des Werkzeugs festgelegt werden. Für die erfolgreiche Ausführung muss der Client einen der Werte aus der Auswahlliste auswählen. Der Task schlägt fehl, wenn der Client einen Wert angibt, der nicht aus der Auswahlliste stammt. Die folgende Bildschirmaufnahme zeigt für den GPString-Parameter "Transportation_mode_network" die Auswahllistenwerte Straßennetz, Fahrradnetzwerk oder Gehnetzwerk. Wenn solche Auswahllistenwerte angegeben werden, muss der Client für die erfolgreiche Ausführung einen der Werte auswählen.

Eigenschaft "Auswahlliste"

Weitere Informationen zur Erstellung von Auswahllistenwerten für Parameter bei der Veröffentlichung eines Tasks

Verwandte Themen