Web ツールの設定

ツールを Web ツールとして共有するときに、選択したパラメーター設定により、クライアント アプリケーションによって、どのように使われるかが決定します。 最も一般的、かつ頻繁に変更されるパラメーターは、共有時に設定できます。 それほど使われない設定は、ツールが共有された後に、ArcGIS Server Manager で変更できます。 一部の高度な設定は、ArcGIS Server Administrator の REST API でしか設定できません。 このような高度な設定を変更しなければならない Web ツール (ジオプロセシング サービス) はほとんどありません。

設定

次のサブセクションでは、Web ツールの共有時に使用できる設定について説明します。

一般

次の一般的なパラメーター設定を使用できるようになりました。

パラメーター説明

名前

ポータルで共有される Web ツールの名前。 この名前はポータル上で一意でなくてはならず、空白や特殊記号は使えません。 このパラメーターは、ツールのメタデータから継承されます。

サマリー

ドキュメントを説明し、Web ツールを検索可能にするサマリーとタグ。 これらのパラメーターは、ツールのメタデータから継承されます。 サマリーとタグは、ArcGIS Enterprise 10.9 以前のポータルで共有する場合は必須です。

最大 128 個のタグを使用できます。

タグ

バージョン

共有先の ArcGIS Enterprise または ArcGIS Server のバージョン。 このパラメーターは、Web ツール用のオフライン サービス定義またはジオプロセシング サービス用のオフライン サービス定義を保存する場合にのみ有効になります。

データ

データの処理方法を指定します。

  • [URL 以外のデータ] - データがサーバーにコピーされるか (静的になる)、Web ツールで参照されるかを制御します。 [登録済みデータを参照] オプションを使用するには、サーバー データ ストアで一致するエントリをデータに設定する必要があります。 サーバーのデータ ストアがデータを設定していない場合は、公開中にコピーされます。 これは、Web ツールとして公開する場合や、接続されたサービス定義として保存する場合にのみ適用されます。 結果をオフライン サービス定義として保存した場合、[参照データ] オプションを選択する場合は、パラメーターのすべてのデータを参照できることを確認してください。これは、サーバーのデータ ストアがデータを設定していない場合、データをコピーする以外の方法はないためです。
  • [URL データ] - 公開時にデータを URL のままにするか、別のデータ タイプに変換するかを制御します。 このオプションは、ArcGIS Pro 3.2 以降で使用できます。 URL データは、別のタイプの Web レイヤーまたはサービスの URL を参照します。 フィーチャ レイヤーフィーチャ サービス、または Web イメージ レイヤーのフィーチャ サブレイヤーのみを構成できます。 [フィーチャ レイヤーを変換] チェックボックスがオンになっている場合、このパラメーターまたはプロジェクト データのフィーチャ レイヤーまたはサービスが公開時に、フィーチャクラスに変換されます。 オフになっている場合、フィーチャ レイヤーの URL が保持されます。 公開時に常に URL が維持されるため、Web イメージ レイヤーの URL を変換するオプションはありません。 このオプションは、デフォルトでオンになっています。

URL データのコピー、参照、および使用の詳細

位置

Web ツール アイテムを作成するかどうかを指定します。

  • [フォルダー] - Web ツール アイテムが作成されるポータル フォルダーを選択または作成します。 デフォルトは、ポータルのルートです。
  • [サーバーおよびフォルダー] - サーバーでは、Web ツールは 1 つ以上のフェデレーション サーバーを持つポータルで、共有する必要があります。 ポータルに複数のフェデレーション サーバーがある場合は、Web ツールが公開されるサーバーを選択できます。 フォルダーでは、既存のフォルダーを選択するか、ArcGIS Server サイト上で、フォルダーを作成できます。 デフォルトは、ArcGIS Server サイトのルートです。

共有範囲

Web ツールを誰と、どのグループと共有するかを指定します。 Web ツールは、常に [マイ コンテンツ] で共有されます。 Web ツールを [すべてのユーザー] と共有すると、アイテムはパブリックになります。ポータル Web サイトにアクセスできるユーザーは誰でも、そのアイテムを見つけて使用することができ、グループの所有者は、そのアイテムをグループ コンテンツに含めることができます。 Web ツールを [ArcGIS Enterprise] と共有すると、Web ツールは、アイテムにアクセス権を持つポータルのすべてのメンバーと共有されます。 自分が所属しているグループに共有することもできます。

構成

次の構成パラメーター設定を使用できるようになりました。

パラメーター説明

アップロード

クライアントがサーバーにファイルをアップロードし、Web ツールがそれを入力として使用できるかどうかを制御します。 アップロード操作は通常、Web クライアントが使用しますが、サーバーにファイルを送信して、処理を実行する手段が必要となります。 アップロード処理では、アップロードが完了すると、ファイルの個別値が返されます。Web アプリは、この個別値を Web ツールに渡します。

このオプションは、デフォルトで無効に設定されています。 サービスへのアップロードを許可することにより、セキュリティ上のリスクが生じる可能性があります。 必要な場合にのみ、有効にしてください。

実行モード

クライアント (Web ツールを使用するアプリケーション) がどのように Web ツールとやり取りし、結果を取得するかを指定します。 Web ツールが [同期] に設定されている場合、クライアントは、タスクが終了するまで待ちます。 通常、同期サービスは短時間で実行されます (数秒以内)。 [非同期] に設定されたサービスは一般的に実行時間が長いため、クライアントは、サーバーに対してサービスが終了したかどうかを定期的に問い合わせて、終了したら結果を得る必要があります。 非同期サービスを使用する Web アプリには、ステータスを検査して、実行終了後に結果を処理するロジックを実装する必要があります。

マップ イメージ レイヤーの出力を表示

Web ツールを公開するときに、出力をマップ イメージとして表示できます。 サーバー上でマップ イメージが作成され、クライアントに画像 (スタイル情報を含んだ .tiff ファイル) として返送されます。 マップ イメージのシンボル、ラベル設定、透過表示および他のプロパティは、ArcGIS Pro セッションの出力レイヤーが公開された当初のものと同じです。 [マップ イメージ レイヤーの出力を表示] を使用する理由は、以下のとおりです。

  • クライアントがシンボル化して描画しなければならない大量のフィーチャをツールが出力する場合に、クライアントは、マップ イメージを高速に受信できます。
  • データ分布の観点から、クライアントにはフィーチャを送信せず、マップ イメージだけを送信します。
  • ツールの結果は、ネットワークやトポロジなどの非可搬性データセットです。 クライアントに出力を送信する唯一の方法は、マップ イメージです。
注意:

出力マップ イメージは、Web ツールを [非同期] に設定した場合のみ使用できます。

このパラメーターは、Kubernetes に Web ツールを公開する場合はサポートされません。

メッセージ レベル

Web ツールを実行したクライアントに、次のさまざまなレベルのメッセージを返すことができます。

  • [なし] - クライアントにジオプロセシング メッセージは返されません。操作が成功したか失敗したかということのみ返されます。 これがデフォルトです。
  • [エラー] - エラーを表示するツール メッセージのみが、クライアントに返されます。
  • [警告] - ツールのエラー メッセージと警告メッセージが、すべてクライアントに返されます。
  • [情報] - 操作により、出力されたツール メッセージがすべて、クライアントに返されます。
注意:

レベルに関係なく、すべてのメッセージには、データセットのパスと名前が含まれる可能性があり、これによって、セキュリティ上のリスクが生じる可能性があります。 [情報] レベルは、冗長であり、一般に、データセットのパスと名前への参照が含まれています。 通常、開発中はメッセージを返して、稼働中はこれをオフにしておくようにします。

返されるレコードの最大数

サーバーがクライアントに返すことのできる結果の最大数です。 この値を大きな数字に設定すると、GIS サーバーで数多くの個別レコードまたはフィーチャをクライアントに返す処理をすることができます。 フィーチャをまったく返さないようにするには、この値を 0 に設定します。 通常、この値を 0 に設定するのは、[マップ イメージ レイヤーの出力を表示] を有効にした場合のみです。

前述のパラメーター設定は、サマリーとタグを除いて、Web ツールが共有された後に、ArcGIS Server Manager で変更できます。 このような説明は、共有されている Web ツールのアイテム ページ (ポータル内) で更新できます。

コンテンツ

次の設定は、Web ツールの公開時にしか変更できません。

ツールの追加

ジオプロセシング履歴から既存の Web ツールに他のツールを追加するには、[コンテンツ] タブの [ツールの追加] ボタン ツールの追加 をクリックします。 ツールを削除するには、ツール名をクリックし、[削除] を選択します。

ツールのプロパティの構成

ツール プロパティを構成するには、ツール名の横にある編集ボタン ツールのプロパティの構成 をクリックします。

プロパティ説明

名前

ツールの名前。 デフォルトは、ツール メタデータに基づきます。

説明

ツールの説明。 説明は、ツールのメタデータから継承しません。 空の場合は、説明を指定すると、履歴から共有されるたびに保持されます。

次のプロパティは、各パラメーターに対して構成できます。

プロパティ説明

名前

パラメーターの名前と説明。 どちらのプロパティもパラメーター名と、ツールのメタデータの説明から継承します。 ここで変更することもできますが、元のツールのメタデータには影響しません。

説明

タイプ

パラメーター タイプは、クライアントがツールを正常に実行するために、値を指定する必要があるかどうかを定義します。 [コンテンツ] タブでは、オプション パラメーターを必須パラメーターに変更することしかできません。 必須パラメーターをオプション パラメーターに変更するには、共有ウィンドウを終了し、ツールのプロパティを編集してから、ツールを再実行して、新しい結果を作成する必要があります。

データ タイプをコンポジットに維持

このプロパティは、パラメーターがコンポジット データ タイプである場合にのみ使用できます。 パラメーターをコンポジットデータ タイプとして公開するかどうかを指定します (オン)。 デフォルトはオフです。

入力モード

クライアントがフィーチャをタスクに入力する方法を指定します。 GUI の設計と使用法については、パラメーターの入力モードをご参照ください。

  • [ユーザー定義値] - クライアントが、パラメーターの値を指定します。
  • [選択リスト] - 文字列 (選択リスト) のリストを提供し、クライアントは選択リストから、1 つ以上の文字列を選択する必要があります。 入力のデータ タイプに応じて、文字列が決定されます。この文字列は、レイヤーの名前や、単純なキーワード オプションなどです。
  • [定数] - 結果を作成したときに、パラメーターに指定した値が使用されます。 その値は定数であり、クライアントは変更できないため、サービス公開時のタスク パラメーターにはなりません。
  • [混合モード: ユーザー定義と選択リスト] - コンポジットまたは値テーブル パラメーターでのみ使用できます。 入力モードは、コンポジットの各データ タイプか、値テーブルの各列の各データ タイプに対して構成できます。 選択リストをサポートしていないデータ タイプがある場合は、ユーザー定義のオプションのみを構成に使用できます。

データ タイプを文字列に変換

このプロパティは、面積単位データ タイプにのみ適用されます。 これは、面積単位を文字列データ タイプに変換するか (オン)、または面積単位として公開するか (オフ) を指定します。 デフォルトはオフです。

デフォルト値の削除

ArcGIS Pro 3.3 以降、これをオンにすると、ツール実行時に使用されたデフォルト値は、公開プロセスの際に削除されます。 デフォルトはオフです。

デフォルト値

ツールのデフォルト値は、ツールの実行中に指定されるパラメーター値によって決定されます。 パラメーターのデフォルト値を追加または変更するには、対応するパラメーターで、ツールを再度実行する必要があります。

デフォルト レイヤーのみを使用

このプロパティは、選択リストの入力モードのみに適用されます。 ツールの実行時に使用されるオプションのみを、このチェックボックスの下のリスト ビューで、オンにするかどうかを指定します (オン)。 デフォルトはオフです。

ジオメトリ タイプ

このプロパティは、フィーチャのみに適用されます。 ジオメトリ タイプは、結果の作成に使用された入力フィーチャと出力フィーチャから派生します。 [コンテンツ] タブで、変更することはできません。 指定されたジオメトリ タイプのフィーチャを使用してツールを再実行したら、その操作によって作成された結果を共有する必要があります。

スキーマ

このプロパティは、フィーチャとテーブルのみに適用されます。 スキーマは、クライアントがツールへの入力用のフィーチャを作成する際に指定する必要のあるフィールド (属性) のリストです。 このフィールドのリストは、結果を作成したツールへの入力または出力として使用されるレイヤーまたはデータセットと同じです。

次の構成パラメーターは、ツール全体に適用されます。

パラメーター説明

出力フィーチャ サービス パラメーター (オプション) の追加

Web ツールを使用するときに、出力をフィーチャ サービスとして保存できるかどうかを指定する任意の出力パラメーターです (オン)。 このパラメーターは、非同期モードで Web ツールとして公開するときのみ、サポートされています。 そうでなければ、構成で使用できません。 デフォルト設定はオンです。

すべてのデフォルト値の削除

ArcGIS Pro 3.3 以降、これをオンにすると、ツールの実行時に使用されたすべてのデフォルト値は削除され、上記のツール パラメーター構成の [デフォルト値の削除] チェックボックスが自動的にオンになります。 デフォルトはオフです。

ArcGIS Server Manager の設定

以下のサブセクションのパラメーター設定は、ArcGIS Server Manager でしか変更できません。 前述した構成設定は、サービスの公開後に、ArcGIS Server Manager でも変更できます。

注意:

設定を変更すると、サービスが再起動されます。

パラメーター

次のパラメーター設定を利用できます。

パラメーター説明

クラスター

サービスが実行されるクラスターです。 この設定は、ArcGIS Server がクラスターに参加している場合にのみ変更できます。

ディレクトリ

ツールの実行時に、サーバーがファイルを書き込むために使用するディレクトリです。

機能

次の機能のパラメーター設定を利用できます。

パラメーター説明

WPS

ジオプロセシング サービスで WPS ケーパビリティを有効にすると、他のクライアントが OGC 標準プロトコルを通じてツールに接続して、それを使用することができます。

WPS の詳細

プール

次のプール パラメーター設定を利用できます。

パラメーター説明

インスタンスの数

サービスの最小インスタンス数と最大インスタンス数。 デフォルト値は、最小値が 1、最大値が 2 です。 最小値を 0 に設定すると、システムのリソースが減少します。インスタンスは、クライアントからリクエストを受けると開始します。

クライアントがサービスを使用できる最大時間

インスタンスを使用できる秒単位の最大時間です。 実行時間の長いジオプロセシング タスクでは、場合によっては、デフォルトの 600 秒 (10 分) を長くする必要があります。 また、クライアントがサービスを使わないよう、この時間を短くできます。

クライアントがインスタンス取得を待つ最大時間

クライアントがインスタンスへの接続を待つ秒単位の最大時間です。 すべてのインスタンスがリクエストの処理に使用されている場合、以降のリクエストは、キューに配置されます。 インスタンスを取得する前に、タイムアウトが経過すると、タスクは失敗します。 デフォルト値は 60 秒 (1 分) です。

使用されていないインスタンスが実行を継続できる最大時間

プールが縮小するまでインスタンスがアクティブであり続ける秒単位の最大時間です。 使用されていないインスタンスが実行を継続できる最大時間が経過すると、インスタンスの最小数より多い、使用されなかったインスタンスは停止します。

プロセス

次のプロセスのパラメーター設定を利用できます。

パラメーター説明

リサイクル

サービスをリサイクルする頻度とタイミングを制御します。 デフォルトでは 24 時間ごと、真夜中に開始します。

ジオプロセシング サービスは、低分離性でも高分離性でも実行できる他のサービス タイプとは異なり、高分離性でのみ実行されます。


このトピックの内容
  1. 設定
  2. ArcGIS Server Manager の設定