高度なサービスプロパティ

ワークフローによっては、公開したジオプロセシングサービスのプロパティを管理者が調整する必要があります。これらの調整は、スタンドアロンサーバーとフェデレーションサーバーの両方に適用されます。次のようなケースがあります。

大量のメモリーを必要とする大規模なラスターデータセットを使用した空間解析。
Web ツールやジオプロセシングサービス用の大きな入力ファイルをアップロード。
パフォーマンスの最適化。
カスタムログの要件。
ジオプロセシングサービスの失敗時に追加診断出力を取得。
ジオプロセシングサービス内の個々のタスクを視覚化。

これらのプロパティの調整が必要な他の一般的なシナリオには、パフォーマンスの最適化、カスタムログ要件、ジオプロセシングサービス失敗時の追加診断出力の取得、ジオプロセシングサービス内の個々のタスクの視覚化制御などがあります。

以下に説明するほとんどのプロパティは、Administrator REST API でのみ設定できます。ユーザーや管理者が Administrator REST API にアクセスできるようになったら、変更が必要なジオプロセシングサービスのサービスプロパティを編集する必要があります。

ヒープサイズの変更

ヒープサイズプロパティは、ArcGIS Pro から Web ツールやジオプロセシングサービスにアクセスする際にクライアントから提供される最大ファイルサイズと、ジオプロセシングサービスが使用できる最大メモリーを制御します。ヒープサイズは、すべてのジオプロセシングサービスに対してサーバーレベルで設定することも、単一サービスに対して設定することもできます。

個々のサービスのヒープサイズを変更すると、サーバー全体のすべてのサービスのヒープサイズを変更するよりも、パフォーマンスが向上します。各サービスのデフォルトヒープサイズは 64 MB です。入力ファイルまたはフィーチャクラスがデフォルトサイズよりも大きい場合は、次の手順に従って、サービスヒープサイズを変更します。

変更したいジオプロセシングサービスのサービスプロパティの編集エンドポイントにアクセスします。通常は https://organization.example.com/serverwebadaptor/admin/services/servicename.GPServer/edit になります。
既存の frameworkProperties、通常はすべてのサービスプロパティの中で下部に近いプロパティを調べます。
javaHeapSize が frameworkProperties にリストされていない場合は、例 {"javaHeapSize":"128"} を追加します。 javaHeapSize が含まれている場合は、適切な量まで値を増やします。
編集を保存 をクリックし、編集を保存して終了します。

サーバー全体のすべてのジオプロセシングサービスのヒープサイズを変更するには、以下の手順を実行します。 SOC の最大ヒープサイズのデフォルト値は、64 MB に設定されています。適切な値まで増やします。

コンピューターの編集エンドポイントにアクセスします。通常は https://organization.example.com/serverwebadaptor/admin/machines/machinename/edit
SOC maximum heap size (in MB) の値を増やします。
編集を保存 をクリックして、編集を終了します。

アップロードサイズの設定

アップロードサイズの設定は、REST エンドポイントを使用してサービスに接続するクライアントがアップロードできるファイルサイズを制御するものです。通常、これらのクライアントは、カスタム Web アプリを通じて、サービスを使用する Web クライアントです。デフォルトでは、制限は 2 GB に設定されます。この設定によって適切な値を指定できるため、サービスに大きなサイズのファイルがアップロードされるのを防ぐことができます。

アップロードサイズを設定するには、変更したいジオプロセシングサービスのサービスプロパティの編集エンドポイントにアクセスします。通常は https://organization.example.com/serverwebadaptor/admin/services/servicename.GPServer/edit になります。 maxUploadFileSize プロパティの値を更新します。最大ファイルアップロードサイズを 100 MB に制限するサンプルエントリーは "maxUploadFileSize": 100, になります。

注意:

Web ツールを公開するときに、Web ツールとして共有ツール の構成パネルで、アップロード チェックボックスがオンになっていることを確認します。また、ArcGIS Server Manager でサービスの ケーパビリティー 設定ページを使用して、既存のサービスでこの設定を有効にすることもできます。

アップロードタイプの設定

Web ツールにアップロードできるのは、特定のファイルに限られます。ファイルは、拡張子のタイプで制限されます。拡張子のタイプは、サービスレベルで設定されます。

アップロードタイプを設定するには、変更したいジオプロセシングサービスのサービスプロパティの編集エンドポイントにアクセスします。通常は https://organization.example.com/serverwebadaptor/admin/services/servicename.GPServer/edit になります。変更を許可したいファイル拡張子を追加して allowedUploadFileTypes プロパティを更新します。 .kml ファイルと .gpx ファイルの変更を許可するサンプルプロパティは "allowedUploadFileTypes": ".kml,.gpx" です。

注意:

最大ドメイン数の変更

maxDomainCodeCount 設定は、サービスの応答で返されるドメインの数を制御します。ドメインの説明は、フィーチャ出力の応答で返されるコードと対応しています。この設定のデフォルトは 1000 です。出力フィーチャ内のドメインが 1,000 を超える場合、ドメイン情報は返されません。ドメイン情報を返すと、応答のサイズが増加する可能性があります。ドメインが必要でない場合、この値を 0 またはサービス内にあるドメインの数より、小さい値に設定します。

最大ドメイン数を変更するには、変更したいジオプロセシングサービスのサービスプロパティの編集エンドポイントにアクセスします。通常は https://organization.example.com/serverwebadaptor/admin/services/servicename.GPServer/edit で、maxDomainCodeCount プロパティを更新して最大制限を設定します。最大ドメイン数を 50 に制限するサンプルは "maxDomainCodeCount": 50, になります。

ローカル一時フォルダー

ローカル一時フォルダーは、サーバーが複数のコンピューターを持つクラスターに属している場合、または UNC パスを使用してディレクトリーが参照される場合に、ArcGIS Server が中間出力を書き込むディレクトリーです。これにより、中間データを UNC パスのスクラッチジオデータベースやスクラッチフォルダーに書き込む手間を省いて、パフォーマンスを向上できます。完了時に、結果がローカルの一時フォルダーからジョブディレクトリー (UNC パスであることができる) にコピーされます。 Windows では、ArcGIS Server 用の典型的なローカル一時フォルダーは c:/Users/arcgisuser/AppData/Local/Temp/system/servicename_gpserver/jobID/scratch です。現在、サーバーのデプロイメント後にこの一時フォルダーの場所を変更することはできません。

同期サービスでのジョブディレクトリーの再利用

Web ツールが同期ジオプロセシングサービスに基づいている場合、"reusejobdir": "true" を適用することで、ジョブディレクトリーを再利用してパフォーマンスを向上させることができます。通常、同期ジオプロセシングサービスを実行するたびに、サーバーコンピューターの arcgisjobs フォルダーにジョブフォルダーが作成されます。そのジョブフォルダーは、完了時に ArcGIS Server によって削除されます。 reusejobdir プロパティを true に設定することで、ジョブの実行が終了した後もジョブフォルダーが残されます。これにより、次の実行のためにテンポラリー GDB とテンポラリフォルダーを作成する時間が節約されるため、パフォーマンス上のメリットが得られます。必要に応じて、このプロパティを "false" に戻すかこのプロパティを削除する場合は、管理者に連絡して、このサービスの既存のジョブフォルダーを削除します。

変更したいジオプロセシングサービスのサービスプロパティの編集エンドポイントにアクセスします。通常は https://organization.example.com/serverwebadaptor/admin/services/servicename.GPServer/edit になります。

以下は、reusejobdir プロパティを示す単純化した JSON です。その他のプロパティは、このプロパティに関連する変更をハイライトするために非表示になっています。

{
 "serviceName": "sample",
 "type": "GPServer",
 "other_properties": "other_values",
 "properties": {
     "other_properties": "other_values",
     "reusejobdir": true,
     "executionType": "Synchronous"
 },
 "portalProperties": {},
 "extensions": []
}

ArcGIS Server ログにメッセージを書き込む

Web ツールが ArcGIS Server 11.3 以降に公開されている場合、Web ツールからのメッセージのコピーを ArcGIS Server ログに含めることができます。 ArcGIS Server ログのメッセージレベルは、Web ツールのメッセージレベルと一致します。 Web ツールのメッセージには、エラー、警告、情報の 3 つのレベルが存在し、それぞれ ArcGIS Server の重大、警告、情報と一致します。スクリプトツールメッセージを使用して、Web ツールメッセージを手動で設定します。多くのジオプロセシングツールには、プリセットメッセージも含まれています。 ArcGIS Server にメッセージのログを適切に記録するには、適宜サーバーログ設定を指定します。

logGPMessages プロパティを示す単純化した JSON。その他のプロパティは、このプロパティに関連する変更をハイライトするために非表示になっています。

{
 "serviceName": "sample",
 "type": "GPServer",
 "other_properties": "other_values",
 "properties": {
     "other_properties": "other_values",
     "logGPMessages": true,
     "executionType": "Asynchronous"
 },
 "portalProperties": {},
 "extensions": []
}

特殊なケースで結果を返す

非同期ジオプロセシングサービスまたは非同期ジオプロセシングサービスに基づく Web ツールが失敗した場合またはキャンセルされた場合、結果はありません。このような Web ツールまたはジオプロセシングサービスが ArcGIS Server 11.5 以降に公開されており、ArcGIS REST API の results または result リソースを介してそのツールまたはサービスにアクセスしている場合は、引き続き ArcGIS Server を有効にして結果を返すことができます。同期ジオプロセシングサービスまたは同期ジオプロセシングサービスに基づく Web ツールを使用している場合、この機能は使用できません。失敗したジョブまたはキャンセルしたジョブの場合、ArcGIS Pro で結果にアクセスすることはできません。

saveRESTResultsOnFailOrCancel プロパティを設定するには、変更したいジオプロセシングサービスのサービスプロパティの編集エンドポイントにアクセスします。通常は https://organization.example.com/serverwebadaptor/admin/services/servicename.GPServer/edit になります。

saveRESTResultsOnFailOrCancel プロパティを示す単純化した JSON。その他のプロパティは、このプロパティに関連する変更をハイライトするために非表示になっています。

{
 "serviceName": "sample",
 "type": "GPServer",
 "other_properties": "other_values",
 "properties": {
     "other_properties": "other_values",
     "saveRESTResultsOnFailOrCancel": true,
     "executionType": "Asynchronous"
 },
 "portalProperties": {},
 "extensions": []
}

特定ツールのブロック

Web ツールまたはジオプロセシングサービスを公開する際、場合によっては、特定のタスクへのアクセスを無効化またはブロックする必要があります。 ArcGIS Server 11.5 以降では、blockedTools または allowedTools プロパティをサービスプロパティに追加し、特定のツールをブロックします。

blockedTools プロパティでは、特定のツールを利用できないようにします。 allowedTools プロパティでは、特定のツールのみを利用できるようにします。他のすべてのツールにはアクセスできなくなります。必要に応じてこれらのプロパティを使い分けてください。タスクを指定するには、タスクの名前または表示名を使用します。タスクの名前が別のタスクの表示名と一致する場合、両方のタスクが認識され、ともにブロックまたは許可されます。

ブロックする複数のタスク名を持つ blockedTools プロパティを示す、単純化した JSON。複数の名前はセミコロンで区切って指定します。

{
 "serviceName": "sample",
 "type": "GPServer",
 "other_properties": "other_values",
 "properties": {
     "other_properties": "other_values",
     "blockedTools": "extractData;bufferInputs",
     "executionType": "Synchronous"
 },
 "portalProperties": {},
 "extensions": []
}

高度なサービス プロパティ

ヒープ サイズの変更

アップロード サイズの設定

注意:

アップロード タイプの設定

注意: