Web アプリケーションでのジオプロセシングタスクの使用—ArcMap

Web アプリケーションにおけるジオプロセシングタスク
ArcGIS API for JavaScript でのジオプロセシングタスクの使用

ArcGIS API for JavaScript の使用により、Web ブラウザーは ArcGIS Server サービスと通信し、地理データを描画して解析を実行できるようになります。

Web URL を介してライブラリにアクセス可能なため、ライブラリをダウンロードする必要はありません。ArcGIS API for JavaScript のドキュメントでは、コードサンプル、チュートリアル、ガイド、および詳細な参考資料が提供されています。

Web アプリケーションにおけるジオプロセシングタスク

ジオプロセシングサービスを使用して、ジオプロセシング機能およびデータの解析を Web アプリケーションに追加できます。各ジオプロセシングサービスには、1 つ以上のジオプロセシングタスクが含まれています。

ArcGIS Server Services Directory から参照すると、ジオプロセシングサービス、サービス内のタスク、および各タスクのパラメーターとプロパティを検索できます。トピック「ジオプロセシング REST サービス」では REST リソースの階層に関する情報を提供し、トピック「ジオプロセシングタスクの概要」ではジオプロセシングタスク、それらのタスクパラメーター、およびタスクへのアクセス方法に関する情報を提供しています。ジオプロセシングタスクにアクセスし機能を実行するための便利なオブジェクトとメソッドが ArcGIS API for JavaScript に用意されています。

タスクによって提供されるジオプロセシング機能を Web アプリケーションに追加するには、次の 4 つのステップに従います。

ジオプロセシングタスクの初期化
タスクのパラメーターの設定
タスクの実行
結果のレンダリング

これらの 4 つのステップを実行すると、アプリケーションでサーバーと通信してタスクを正常に実行し、必要に応じて結果を視覚化できます。

ArcGIS API for JavaScript でのジオプロセシングタスクの使用

次の 4 つのステップで、ArcGIS API for JavaScript を使用してジオプロセシング機能を正常に追加できます。

ステップ 1: ジオプロセシングタスクの初期化

ジオプロセシングタスクを初期化するには、タスクの URL を知っておく必要があります。ジオプロセシングタスクの URL のテンプレートは https://<ArcGIS ホスト>/<GP サービス名>/GPServer/<GP タスク名> です。ジオプロセシングタスクを初期化するために、次に示すコードを JavaScript アプリケーションに追加します。

初期化の際は必ず、ジオプロセシングタスクインスタンスの outSpatialReference プロパティを Web マップの空間参照に設定してください。ジオプロセシングタスクのデータセットでは別の空間参照が使用されていることがあるため、タスクの出力でも同様に、別の空間参照が使用される場合があります。ただし、Web アプリケーションは、タスクの出力でマップと同じ空間参照が使用されているとみなします。これが、出力を描画するときの予期しない動作の原因になることがあります。したがって、ユーザーは、ジオプロセシングタスクの出力空間参照プロパティを設定する必要があります。サーバーは、outSpatialReference プロパティで指定された空間参照で出力を返します。

ジオプロセシングタスクの初期化

// esri.tasks.gp is required for using Geoprocessor.
//  Add it along with other dojo.require statements.
dojo.require(esri.tasks.gp); 
/* Step 1: Initialize Geoprocessing Task as a global variable. 
    That is, declare the variable outside a function definition 
    since we will be using gpTask variable in other methods */
var gpTaskUrl="https://myserver/ArcGIS/rest/services/" +
                   "BufferPoints/GPServer/BufferPoints";
var gpTask = new esri.tasks.Geoprocessor(gpTaskUrl);	
// Set output spatial reference property to map's spatial reference.
//   myMap is assumed to be an instance of map container esri.map.
gpTask.outSpatialReference=myMap.spatialReference;

ステップ 2: タスクパラメーターの設定

ジオプロセシングタスクを実行する際は、Web アプリケーションがジオプロセシングタスクのパラメーター値を提供する必要があります。タスクのパラメーター要件を確認するには、タスクの URL をコピーして Web ブラウザーのアドレスバーに貼り付け、Services Directory のタスクページを開きます。タスクページには、すべてのタスクパラメーターとパラメーターのデータタイプの一覧が表示されます。タスクページにはまた、ジオプロセシング機能、アクセス、および使用に関する詳細情報を探すことができるヘルプの URL も示されています。

タスクパラメーターのプロパティの詳細

タスクを正常に実行するには、タスクページの記載どおりに、タスクのすべての必須入力パラメーター (esriGPParameterTypeRequired) の値を指定する必要があります。通常、タスクの値は、次の 1 つ以上のソースから取得されます。

Web アプリケーションを使用してユーザーが入力した値
現在の Web マップフィーチャレイヤーまたはグラフィックスレイヤーの 1 つから取得された値
クエリ、ルートタスクなどの他のタスクの結果
他のジオプロセシングタスクの結果

次の JavaScript コードは入力フィーチャの作成例を示しています。FeatureLayer (フィーチャレイヤー)からの GPFeatureRecordsetLayer パラメーターが Web マップに追加されて buffDistance が作成され、GPLinearUnit パラメーターが、id="distance" を示す dojo テキスト入力から取得されます。この例では、ユーザーが対話的に距離値を入力することを前提としています。タスクパラメーターが作成されると、JSON 構造が、パラメーターの名前と値のペアを使って構築され、サーバーに送信されます。

パラメーターの設定

//Step 2: Setup Parameters of the task
function setupParameters(){
   /* The code below assumes that the web map 
     has a featurelayer with id fLayer. */
   // Get Input Parameter 1 : GPFeatureRecordSetLayer from fLayer.
   var inputFeatures = new esri.tasks.FeatureSet();			    
   inputFeatures.features = map.getLayer("fLayer").graphics;
   inputFeatures.fields=map.getLayer("fLayer").fields;
   // Get Input Parameter 2 : GPLinearunit from a dojo UI element
   var buffDistance = new esri.tasks.LinearUnit();
   buffDistance.distance=dojo.byId(“distance”).value;
   buffDistance.units=”esriMiles”;
   // Create Parameter list with name-value pairs.
   // Names must match the parameter name in Task page.
   // Parameters must be in the same-order as in Task page.
   var params= {"Input_Features":inputFeatures, 
              "Distance":buffDistance};
   // Return name-value pairs of parameters
   return params;
}

ステップ 3: タスクの実行

タスクを実行するには、ジオプロセシングタスクでサポートされている操作に基づいてジオプロセッサインスタンス (gpTask) の execute または submitJob メソッドを使用する必要があります。タスクでサポートされている操作はタスクページで確認できます。トピック「タスク操作: 実行」および「タスク操作: ジョブの送信 (submitJob)」では、これらの操作の違いと操作におけるサーバー/クライアント通信について説明しています。

タスク操作: 実行

タスクでサポートされている操作がタスク実行である場合は、ジオプロセシングインスタンスの execute メソッドを使用して、パラメーターを渡す必要があります。リクエストの成功また失敗時にアプリケーションを操作するイベントハンドラーの定義が必要です。タスクが正常に実行され、結果とジオプロセシングメッセージが返されると、onExecuteComplete イベントが生成されます。タスクの実行に失敗すると、onError イベントが生成されます。タスクが失敗した場合、サーバーは、HTML エラーコードとジオプロセシングメッセージ (ある場合) を含むエラーインスタンスを返します。

タスク操作: 実行

function myGPExecuteTask(){
 // Get params from setupParameters method described above. var params=setupParameters();
 // Setup onTaskSuccess and onTaskFailure event handlers. dojo.connect(gpTask, "onExecuteComplete",onTaskSuccess);
 dojo.connect(gpTask, "onError",onTaskFailure);
 // Execute gpTask with params gpTask.execute(params);
}
// Callback when the Task operation succeeded function onTaskSuccess(results, messages) {
  // Do something with the results...  // More info on rendering the results in section below    
}
// Handler that is invoked when the Task operation has failed function onTaskFailure(error) {
  // Report error   alert("Error:"+ error); 
}

タスク操作: ジョブの送信 (submitJob)

タスクでサポートされている操作が submitJob 操作である場合は、Geoprocessor.submitJob メソッドを使用して、パラメーターを渡す必要があります。submitJobの場合は、次の 3 つのイベントが生成されます。これらのイベントは Web アプリケーションで適切に処理される必要があります。


onStatusUpdate	現在のジョブのステータスが受信された場合
onJobComplete	ジョブが正常に完了した場合
onError	ジョブが失敗した場合

onStatusUpdate: execute とは異なり、submitJob の場合は、サーバーがジョブを作成して jobId を割り当てます。submitJob 操作では、ジョブが完了したときにクライアントに通知されないため、サービスを確認してジョブのステータスを判断するのはクライアントの役目です。デフォルトでは、Web アプリケーションがステータスリクエストをサーバーに毎秒送信して、タスクのステータスを判断します。ステータス応答が受信されるたびに、onStatusUpdate イベントが生成されます。必要に応じて、Geoprocessor.setUpdateDelay メソッドを通じてステータス確認の間隔を長くしたり、短くしたりできます。ジョブのステータスの確認が行われるたびに onStatusUpdate イベントが生成されます。イベントハンドラーは、ジョブ ID、ジョブのステータス、およびサーバーによって返された GPMessages を含む JobInfo インスタンスを受け取ります。ユーザーは、この情報を使って、タスクの進行状況を追跡できます。
onJobComplete: JobInfo.jobStatus = STATUS_SUCCEEDED である場合は、onJobComplete イベントが生成されます。操作の完了時に、結果は、自動的にクライアントに返されるのではなく、サーバー上に保存されます。クライアントは、その結果を取得するためにリクエストを送信しなければなりません。onJobComplete イベントハンドラー内で、Geoprocessor.getResultData メソッドを呼び出して結果を取得できます。各出力パラメーターは独立したリソースであるため、ジオプロセシングインスタンスの getResultData メソッドは、タスクの出力パラメーターごとに呼び出す必要があります。ユーザーは、イベントハンドラーによって返された jobId と出力パラメーターの名前を getResultData メソッドに指定する必要があります。また、onGetResultDataComplete イベント用のイベントハンドラーも作成する必要があります。Web アプリケーションで出力パラメーターの結果値が受信されると、onGetResultDataComplete イベントが生成されます。
onError: submitJob リクエストまたはステータスリクエストがタイムアウトになった場合や、ジオプロセシングタスクが失敗した場合は、onError イベントが生成されます。このイベントでは、HTML エラーコードを含むエラーインスタンスが返されます。

submitJob 操作におけるジョブ、ジョブ ID、ジョブステータス、およびサーバー/クライアント通信の詳細については、「タスク操作: ジョブの送信 (submitJob)」をご参照ください。次のコードは、サーバーにジョブを送信してイベントを処理する方法を示しています。

タスク操作: ジョブの送信 (submitJob)

function myGPSubmitJob(){
 // Get params from setupParameters method described above.
 var params=setupParameters();
 // Setup event handlers.
 dojo.connect(gpTask, "onJobComplete",onTaskComplete);
 dojo.connect(gpTask, "onError",onTaskFailure);
 dojo.connect(gpTask, "onStatusUpdate",onTaskStatus);
 gpTask.submitJob(params);
}
// Event handler for onJobComplete event
function onTaskComplete(jobInfo) {
    /* Get the value of an output parameter Buffer_polygons
      using getResultData. The name of the output
      may vary in your gpTask*/      
    dojo.connect(gpTask, "onGetResultDataComplete",
                      onTaskResultComplete);
    gpTask.getResultData(jobInfo.jobId, 
                          "Buffer_polygons");
}
// Event handler for onStatusUpdate event
function onTaskStatus(jobInfo) {
     //write status to console to help debugging
    console.log(jobInfo.jobStatus);
}
// Event handler for onError event
function onTaskFailure(error) {
  // Report error 
  alert("Error:"+ error); 
}

ステップ 4: 結果のレンダリング

ジオプロセシングタスクの結果は、出力パラメーターのデータタイプに基づいてレンダリングされます。


GPFeatureRecordSetLayer	出力フィーチャは、通常、ジオプロセシング結果を表示するためにグラフィックスレイヤーとして Web マップ上に描画されます。
GPRecordSet	出力レコードがグリッドで表示されるか、またはチャートとグラフの作成に値が使用されます。
GPRasterDataLayer	出力ラスターをダウンロードできますが、マップ上には描画できません。ただし、結果マップサービスを使用してラスターデータを視覚化できます。詳細については、「結果マップサービス」と「Web アプリケーションでの結果マップサービスの使用」をご参照ください。
GPDataFile	出力ファイルをダウンロードできるか、.gpx や .csv などのファイルを Web アプリケーションで処理できます。
GPBoolean、GPDataFile、GPLong、GPDouble、GPString、GPLinearUnit、GPDate	出力は、HTML または他のウィジェットを使用して表示されます。

onExecuteComplete イベントハンドラーからの結果

execute 操作の場合は、onExecuteComplete イベントによって、ジオプロセシングタスクの結果とメッセージが返されます。結果のインスタンスは、タスクのすべての出力パラメーターの配列であり、配列内のエントリは常に、タスクページに表示されている順序どおりになります。このため、配列内の位置によってパラメーター値を識別できます。配列内の出力パラメーターごとに、パラメーター名、パラメーターのデータタイプ、および値が示されます。次のコードは、結果内の最初の出力パラメーターにアクセスする方法を示しています。次のコードでは、出力パラメーターが GPFeatureRecordSetLayer 出力であることがわかっているため、コードは、その出力をグラフィックレイヤーとしてレンダリングし、Web アプリケーションに追加する方法を示しています。

onExecuteComplete イベントハンドラーからの結果のレンダリング

function onTaskSuccess(results, messages) {
    /* Retrieve the output parameter value based 
      on its position from the result instance.
      In the case shown below, the output is the first output 
      parameter of the task and it
      is a GPFeatureRecordSetLayer.*/
    var featureset = results[0].value;
   
    // Create a graphics layer with features
    var taskResultLayer= new esri.layers.GraphicsLayer
              ({id:"MyGPExecuteResultLayer"});
    
    // Create a symbol based on the geometry. 
    // The geometry is assumed to be polygons in the code below
    var simplePolySymbol = new esri.symbol.SimpleFillSymbol();
    simplePolySymbol.setOutline(new esri.symbol.SimpleLineSymbol(
                  esri.symbol.SimpleLineSymbol.STYLE_SOLID,
                  new dojo.Color([0,0,0,0.5]), 1));
    simplePolySymbol.setColor(new dojo.Color([255,0,0,0.7]));
    
    // Create graphics from features and add it graphicslayer 
    dojo.forEach(featureset.features,function(feature){
             feature.setSymbol(simplePolySymbol);
             //Add feature to the graphics layer
             taskResultLayer.add(feature);});
    }
    // Add graphicslayer to webmap 
    //  myMap is assumed to be an instance of map container esri.map
    myMap.addLayer(taskResultLayer)
}

onGetResultDataComplete イベントハンドラーからの結果

onGetResultDataComplete イベントは結果のインスタンスを提供します。onExecuteComplete イベントからの結果とは異なり、結果のインスタンスには、要求されたパラメーターの値のみが含まれます。パラメーター結果には、要求されたパラメーターの名前、データタイプ、および値が示されます。パラメーター値は、必要に応じて結果から取得して使用されます。次のコードは、パラメーター結果のインスタンスからの GPFeatureRecordSetLayer パラメーター結果のレンダリングを示しています。

onGetResultDataComplete イベントハンドラーからの結果

function onTaskResultComplete(paramResult) {
   // Retrieve the value of the parameter from the paramresult   var featureSet = paramResult.value;
   // Create a graphics layer with features   var taskResultLayer= new esri.layers.GraphicsLayer              ({id:"MyGPSubmitJobResultLayer"});
       // Create a symbol based on the geometry. 
   // The geometry is assumed to be polygons in the code below   var simplePolySymbol = new esri.symbol.SimpleFillSymbol();
   simplePolySymbol.setOutline(new esri.symbol.SimpleLineSymbol(                  esri.symbol.SimpleLineSymbol.STYLE_SOLID,                  new dojo.Color([0,0,0,0.5]), 1));
   simplePolySymbol.setColor(new dojo.Color([255,0,0,0.7]));
       // Create graphics from features and add it graphicslayer 
   dojo.forEach(featureset.features,function(feature){
             feature.setSymbol(simplePolySymbol);
             //Add feature to the graphics layer             taskResultLayer.add(feature);});
   }
   // Add graphicslayer to webmap    //   myMap is assumed to be an instance of map container esri.map.
   myMap.addLayer(taskResultLayer) }

Web アプリケーションにおけるジオプロセシング タスク

ArcGIS API for JavaScript でのジオプロセシング タスクの使用

ステップ 1: ジオプロセシング タスクの初期化

ステップ 2: タスク パラメーターの設定

ステップ 3: タスクの実行

タスク操作: 実行

タスク操作: ジョブの送信 (submitJob)

ステップ 4: 結果のレンダリング

onExecuteComplete イベント ハンドラーからの結果

onGetResultDataComplete イベント ハンドラーからの結果

Web アプリケーションにおけるジオプロセシングタスク

ArcGIS API for JavaScript でのジオプロセシングタスクの使用

ステップ 1: ジオプロセシングタスクの初期化

ステップ 2: タスクパラメーターの設定

onExecuteComplete イベントハンドラーからの結果

onGetResultDataComplete イベントハンドラーからの結果