Web ツールの設定

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

ヒント:

公開されたツールの設定の管理と変更については、ArcGIS Server Manager を使用します。

設定

次のサブセクションでは、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 を参照します。 現在のリリースではフィーチャ レイヤーまたはフィーチャ サービスのみを構成できます。 [フィーチャ レイヤーを変換] チェックボックスがオンになっている場合、このパラメーターまたはプロジェクト データのフィーチャ レイヤーまたはサービスが公開時にフィーチャクラスに変換されます。 オフになっている場合、フィーチャ レイヤーの URL が保持されます。

位置

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

共有範囲

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

構成

パラメーター説明

アップロード

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

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

実行モード: [同期] または [非同期]

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

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

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

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

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

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

メッセージ レベル

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

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

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

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

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

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

コンテンツ

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

ツールの追加

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

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

ツール名の右側にある編集ボタンをクリックすると、ツールのプロパティを変更することができます。

パラメーター説明

名前

ツールの名前。 名前は、ツールのメタデータ ラベルから継承します。

説明

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

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

パラメーター説明

名前

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

説明

タイプ

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

入力モード

クライアントがフィーチャをタスクに入力する方法は、入力モードによって決定されます。

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

[ジオメトリ タイプ] (フィーチャ セットとフィーチャ レイヤーにのみ適用されます)

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

[スキーマ] (フィーチャ セット、フィーチャ レイヤー、レコード セット、テーブル ビューに適用されます)

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

デフォルト値

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

次のパラメーターは、フィーチャ データ タイプの出力にのみ適用されます。

パラメーター説明

フィーチャ サービス出力

Web ツールを使用するときに、ユーザーが出力をフィーチャ サービスとして保存することを可能にする、任意の出力パラメーターです。 このパラメーターは、Web ツールとして公開するときのみサポートされています。 スタンドアロン サーバーへのジオプロセシング サービスの公開はサポートされていません。

Web Manager の設定

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

注意:

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

パラメーター

パラメーター説明

クラスター

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

ディレクトリ

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

機能

パラメーター説明

WPS

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

WPS の詳細

プール

パラメーター説明

インスタンスの数

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

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

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

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

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

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

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

プロセス

パラメーター説明

リサイクル

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

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


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