ルート検索サービスのプロパティファイル

プロパティファイルからルート検索サービスの高度なプロパティを指定します。

追加サービスのプロパティ

ネットワークデータセットからルート検索サービスを構成する場合は、サービスインスタンスの最小数と最大数、サービスの REST API でサポートされている 1 つ以上のパラメーターのデフォルト値など、ルート検索サービスの追加設定を含むプロパティファイルを指定できます。たとえば、ルート検索サービスとルート案内サービスを利用するアプリケーションで出力ルートからの移動時間および移動距離の値だけが使用され、ルート案内もルートジオメトリーも必要でない場合は、デフォルトで目的の出力だけが返されるように、プロパティファイルを使用してルート検索サービスとルート案内サービスを構成することができます。これにより、クライアントアプリケーションで使用されていない余分な出力が生成されなくなるため、ルート検索サービスとルート案内サービスのパフォーマンスが最適化されます。

プロパティファイルには、これらの設定が JavaScript Object Notation (JSON) 形式で格納されています。このヘルプトピックでは、JSON 形式に関する基礎知識があることを想定しています。

プロパティファイルを指定することで、ルート検索サービスの高度なプロパティを構成できます。デフォルトのプロパティファイルは publishroutingservices.json という名前です。

このファイルは、ArcGIS Server インストールディレクトリー内の <install folder>/framework/runtime/ArcGIS/Resources/ArcToolBox/Services/routingservices にあります。

このセクションでは、デフォルトファイルを例にしてプロパティファイルの構造を説明します。プロパティを変更するには、デフォルトファイルのコピーを作成し、テキストエディターを使用してそのコピーを編集します。ルート検索の構成プロセスを呼び出す場合は、変更を加えたファイルを入力値として指定します。

プロパティファイルの構造

このプロパティファイルには、routingServices という最上位のオブジェクトがあり、mapServices オブジェクトと gpServices オブジェクトが含まれています。これらのオブジェクトにはそれぞれ、特定のルート検索サービスを表す 1 つ以上のオブジェクトを含めることができます。

プロパティファイル内の最上位の JSON オブジェクト mapServices オブジェクトでは networkAnalysis マップサービスのプロパティを定義し、gpServices オブジェクトでは asyncNetworkAnalysis、syncNetworkAnalysis、および routingUtilities ジオプロセシングサービスのプロパティを定義します。

{
 "routingServices": {
     "mapServices": {
         "networkAnalysis": {
         }
     },
     "gpServices": {
         "asyncNetworkAnalysis": {
         },
         "syncNetworkAnalysis": {
         },
         "routingUtilities": {
         }
     }
 }
}

networkAnalysis などのマップサービスオブジェクトには、マップサービスのサービスレベルプロパティを定義する serviceProperties オブジェクトと、マップサービスで使用される 1 つ以上のレイヤーのプロパティを定義する layerProperties オブジェクトが含まれています。

asyncNetworkAnalysis などのジオプロセシングサービスオブジェクトには、ジオプロセシングサービスのサービスレベルプロパティを定義する serviceProperties オブジェクトと、ジオプロセシングサービスで使用される 1 つ以上のジオプロセシングツールのプロパティを定義する toolProperties オブジェクトが含まれています。

serviceProperties と layerProperties または toolProperties を含むサービス JSON オブジェクト。

{
 "routingServices": {
     "mapServices": {
         "networkAnalysis": {
             "serviceProperties": {
             },
             "layerProperties": {
             }
         }
     },
     "gpServices": {
         "asyncNetworkAnalysis": {
             "serviceProperties": {
             },
             "toolProperties": {
             }
         },
         "syncNetworkAnalysis": {
             "serviceProperties": {
             },
             "toolProperties": {
             }
         },
         "routingUtilities": {
             "serviceProperties": {
             },
             "toolProperties": {
             }
         }
     }
 }
}

サービスオブジェクトに含まれる serviceProperties オブジェクトでは、コンピューター当たりのサービスインスタンスの最大数 (MaxInstances) や、クライアントがサービスを利用できる秒単位の最大時間 (UsageTimeout) など、1 つ以上のサービスレベルプロパティを定義します。

マップサービスの layerProperties オブジェクトでは、route、closestFacility、serviceArea、および odCostMatrix レイヤーのプロパティを定義します。レイヤーのプロパティは、defaultValues オブジェクトの一部として定義されます。

ジオプロセシングサービスの toolProperties オブジェクトでは、FindRoutes、FindClosestFacilities、GenerateServiceAreas、GenerateOriginDestinationCostMatrix、SolveLocationAllocation、SolveVehicleRoutingProblem、EditVehicleRoutingProblem、SolveLastMileDelivery、SnapToRoads など、ジオプロセシングツールのプロパティを定義します。ツールのプロパティは、defaultValues オブジェクトの一部として定義されます。 constantParameters オブジェクトでは、ツールのパラメーターのうち、ジオプロセシングサービスの REST API で使用できない 1 つ以上のパラメーターを表示できます。

マップサービス内のレイヤーの layerProperties オブジェクトとジオプロセシングサービス内のツールの toolProperties オブジェクト

{
 "routingServices": {
     "mapServices": {
         "networkAnalysis": {
             "serviceProperties": {
             },
             "layerProperties": {
                 "route": {
                     "defaultValues": {
                     }
                 },
                 "closestFacility": {
                     "defaultValues": {
                     }
                 },
                 "serviceArea": {
                     "defaultValues": {
                     }
                 },
                 "odCostMatrix": {
                     "defaultValues": {
                     }
                 }
             }
         }
     },
     "gpServices": {
         "asyncNetworkAnalysis": {
             "serviceProperties": {
             },
             "toolProperties": {
                 "FindRoutes": {
                     "defaultValues": {
                     },
                     "constantParameters": []
                 },
                 "FindClosestFacilities": {
                     "defaultValues": {
                     },
                     "constantParameters": []
                 },
                 "GenerateServiceAreas": {
                     "defaultValues": {
                     },
                     "constantParameters": []
                 },
                 "GenerateOriginDestinationCostMatrix": {
                     "defaultValues": {
                     },
                     "constantParameters": []
                 },
                 "SolveLocationAllocation": {
                     "defaultValues": {
                     },
                     "constantParameters": []
                 },
                 "SolveVehicleRoutingProblem": {
                     "defaultValues": {
                     },
                     "constantParameters": []
                 },
                 "SolveLastMileDelivery": {
                     "defaultValues": {
                     },
                     "constantParameters": []
                 }
             }
         },
         "syncNetworkAnalysis": {
             "serviceProperties": {
             },
             "toolProperties": {
                 "EditVehicleRoutingProblem": {
                     "defaultValues": {
                     },
                     "constantParameters": []
                 },
                 "SnapToRoads": {
                     "defaultValues": {
                     },
                     "constantParameters": []
                 }
             }
         },
         "routingUtilities": {
             "serviceProperties": {
             }
         }
     }
 }
}

プロパティファイルの編集とアップロード

ルート検索サービスを構成するときに、インスタンスの最小数や最大数など、ユーザー指定のプロパティを含むプロパティファイルをアップロードできます。プロパティファイルは、ArcGIS Server インストールディレクトリー内の <install folder>/framework/runtime/ArcGIS/Resources/ArcToolBox/Services/routingservices/publishroutingservices.json にあります。プロパティを変更するには、このファイルのコピーを作成し、テキストエディターを使用してそのコピーを編集します。

ヒント:

このファイルを編集する際には、JSON 構文を解釈する Visual Studio Code などのテキストエディターを使用して、プロパティファイルの編集中に構文エラーが発生しないようにすることをおすすめします。プロパティファイルに JSON 構文エラーがあると、ルート検索サービスの構成プロセスが正常に実行されません。

ルート検索サービスのプロパティ ファイル

追加サービスのプロパティ

プロパティ ファイルの構造

プロパティ ファイルの編集とアップロード

ヒント:

ルート検索サービスのプロパティファイル

プロパティファイルの構造

プロパティファイルの編集とアップロード