Workflow Manager のライセンスで利用可能。
ArcGIS Workflow Manager (Classic) Desktop では、複数のカスタム ステップを用意しています。 このステップについて以下で説明します。
すべてのプラットフォーム向けライブラリ
すべてのプラットフォーム向けライブラリには、ArcMap、ArcCatalog、ArcGIS Pro、および ArcGIS Server で使用できるステップが含まれています。 以下のセクションでは、各ステップ、引数、およびリターン コードについて説明します。
AddJobHold - JTXSteps.AddJobHold
現在のジョブにホールド (一時停止) を追加します。
引数
下表は、このステップの引数をリスト表記したものです。
| 引数 | 説明 | 引数タイプ |
|---|---|---|
/holdType:<hold type> | ホールド タイプの名前。 | 必須 |
/holdComment:<string> | ホールド タイプに追加するコメント。 | オプション |
リターン コード
以下のリターン コードがあります。
- 1 = Success (成功)
- 0 = Failure (失敗)
CheckAOI - JTXSteps.CheckAOI
現在のジョブに対象位置 (LOI) があるかどうかをチェックします。
引数
引数は不要です。
リターン コード
以下のリターン コードがあります。
- 1 = The job has an LOI. (LOI がある)
- 2 = The job does not have an LOI. (LOI がない)
CleanUp - JTXSteps.CleanUp
引数に基づいてジョブを消去します。 管理システムの設定を有効にして、他のユーザーが所有するバージョンを削除できるようにします。 ユーザー名とパスワードが求められます。
注意:
別のユーザーが所有するバージョンを削除する場合は、ジオデータベース スーパー ユーザーの認証情報を指定する必要があります。
引数
下表は、このステップの引数をリスト表記したものです。
| 引数 | 説明 | 引数タイプ |
|---|---|---|
/version|v | バージョンを消去します。 | オプション |
/mxd|m | MXD を消去します。 | オプション |
/attachments|a | アタッチメントを消去します。 | オプション |
リターン コード
ステップが成功すると 0 が返されます。
CloseJob - JTXSteps.CloseJob
ワークフローが完了すると手動プロセスになるのではなく、ステップとしてジョブを終了します。
引数
引数は不要です。
リターン コード
ステップが成功すると 0 が返されます。
CreateJob - JTXSteps.CreateJob
引数に基づいて子ジョブを作成します。
引数
下表は、このステップの引数をリスト表記したものです。
| 引数 | 説明 | 引数タイプ |
|---|---|---|
/jobtypename:<job type name> | ジョブ タイプの名前 | 必須 |
/assigngroup:<group to assign to> | ジョブが割り当てられるグループ | オプション |
/assignuser:<user to assign to> | ジョブが割り当てられるユーザー | オプション |
リターン コード
ステップが成功すると 0 が返されます。
CreatePDF - JTXSteps.CreatePDF
ジョブのベースマップの PDF ドキュメントを作成し、ジョブに添付します。
引数
下表は、このステップの引数をリスト表記したものです。
| 引数 | 説明 | 引数タイプ |
|---|---|---|
/initdir:<initial directory> | PDF が保存される場所。 | オプション |
/noattach | PDF をジョブに添付しない | オプション |
/resolution:<dpi> | PDF の解像度 | オプション |
リターン コード
ステップが成功すると 0 が返されます。
CreateVersion - JTXSteps.CreateVersion
ジョブのバージョンを作成します。 バージョンの保護レベルは、Version、Access、Scope のいずれかの引数によって指定されます。 ステップは、従来のデータ ワークスペースおよびフィーチャ サービス データ ワークスペースに対応しています。
引数
下表は、このステップの引数をリスト表記したものです。
| 引数 | 説明 | 引数タイプ |
|---|---|---|
/scope:<public|private|protected> | バージョンの保護レベル デフォルトは private です。 | オプション |
リターン コード
ステップが成功すると 0 が返されます。
ExecuteGPTool - JTXSteps.ExecuteGPTool
ジオプロセシング ダイアログ ボックスを表示せずに、ジオプロセシング ツール、モデル、スクリプトを実行します。 ツールから出力された整数は、リターン コードとして使用され、ツールの実行完了時にワークフローのパスを誘導することができます。
注意:
JTXSteps.ExecuteGPTool ステップの使用時に [引数名の検証] はサポートされません。
引数
下表は、このステップの引数をリスト表記したものです。
| 引数 | 説明 | 引数タイプ |
|---|---|---|
/toolboxpath:<toolboxpath> | ツールボックスの .tbx ファイルへの絶対パスとツール名。 | 必須 |
/tool:<tool> | ツールボックスに表示されるツール名。 | 必須 |
/param:<ParamName>:<ParamValue> | ツールをオーバーライドするパラメーター (複数回指定可)。 | オプション |
/attach | ツールの実行完了後、ジョブにログを添付します。 | オプション |
/outParam:<parameter name> | 戻り値として使用する出力パラメーター。 | オプション |
リターン コード
以下のリターン コードがあります。
- 0 = Success (成功)
- 1 = Cancel (キャンセル)
注意:
引数 /outParam が使用されている場合、成功を示すリターン コードは、指定したジオプロセシング ツールの出力パラメーターの値になります。キャンセルした場合のリターン コードは -1 です。
ExecuteSQL - JTXSteps.ExecuteSQL
SQL クエリを送信します。
引数
下表は、このステップの引数をリスト表記したものです。
| 引数 | 説明 | 引数タイプ |
|---|---|---|
/database:<jtxsystem|data> | SQL クエリの送信先データベース | 必須 |
/sql:<sql command> | データベースに送信される SQL クエリ | 必須 |
リターン コード
ステップが成功すると 0 が返されます。
ExecuteURL - JTXSteps.ExecuteURL
応答を表示するブラウザーを開かずに URL を呼び出します。 たとえば、ジオプロセシング サービスやその他の Web サービスを、ワークフローのステップとして呼び出すことができます。
引数
下表は、このステップの引数をリスト表記したものです。
| 引数 | 説明 | 引数タイプ |
|---|---|---|
/url:<url> | 呼び出す URL。 | 必須 |
/timeout:<timeout in seconds> | リクエストのタイムアウト (秒)。 | オプション |
/proxy:<proxy> | 使用するプロキシ サーバー。 | オプション |
/addjobcomment | ジョブに、応答とともにコメントを追加します。 | オプション |
/postdata:<data to post> | URL の呼び出し時に送信するデータ。 | オプション |
リターン コード
ステップが成功すると 200 が返されます。
ExecuteWorkflow - JTXSteps.ExecuteWorkflow
あるジョブ タイプに関連する別のワークフローを実行します。
引数
下表は、このステップの引数をリスト表記したものです。
| 引数 | 説明 | 引数タイプ |
|---|---|---|
/jobtype:<job type name> | ジョブ タイプの名前 | 必須 |
/donotuseaoi | ジョブの AOI を使用しない | 必須 |
/donotuseversion | ジョブ バージョンを使用しない | オプション |
/donotcopyactivities | アクティビティを親ジョブの履歴にコピーしない | オプション |
リターン コード
ステップが成功すると 0 が返されます。
ReassignJob - JTXSteps.ReassignJob
ジョブを再割り当てします。
引数
下表は、このステップの引数をリスト表記したものです。
| 引数 | 説明 | 引数タイプ |
|---|---|---|
/assignType:<user|group> | ジョブをユーザーまたはグループに再割り当てする | 必須 |
/assignTo:<user or group name> | ジョブが割り当てられるユーザーまたはグループ。 | 必須 |
リターン コード
ステップが成功すると 0 が返されます。
ReturnValue - JTXSteps.ReturnValue
渡された拡張プロパティまたはトークンの値を取得します。この値が、ワークフローの次のパスのリターン コードになります。
引数
下表は、このステップの引数をリスト表記したものです。
| 引数 | 説明 | 引数タイプ |
|---|---|---|
/value:<extended properties field> | 戻り値の取得元の拡張プロパティ フィールド。 | 必須 |
リターン コード
ステップは、指定された拡張プロパティ フィールドの値を返します。
SendNotification - JTXSteps.SendNotification
引数で指定されたタイプの通知を送信します。
引数
下表は、このステップの引数をリスト表記したものです。
| 引数 | 説明 | 引数タイプ |
|---|---|---|
/notifType:<type> | 送信する通知のタイプ。 | 必須 |
リターン コード
ステップが成功すると 0 が返されます。
SetVersion - JTXSteps.SetVersion
ジョブのバージョンを、名前付きバージョンに設定します。 たとえば、ジョブのバージョンを「Quality Control version」に設定し、そのバージョンにポストされた編集内容を検証します。 ステップ引数がない場合、ジョブ バージョンは元のバージョンにリセットされます。 ステップは、従来のデータ ワークスペースおよびフィーチャ サービス データ ワークスペースに対応しています。
引数
下表は、このステップの引数をリスト表記したものです。
| 引数 | 説明 | 引数タイプ |
|---|---|---|
/version:<versionName> | ジョブ バージョンとして使用するバージョン。 | オプション |
リターン コード
ステップが成功すると 0 が返されます。
UpdateExtentFeatureClass - JTXSteps.UpdateExtentFeatureClass
ジョブ情報を使用してフィーチャクラスを更新し、ステータスを視覚的に示します。
引数
下表は、このステップの引数をリスト表記したものです。
| 引数 | 説明 | 引数タイプ |
|---|---|---|
/fclass:<fully qualified feature class name> | 更新するフィーチャクラス (データ ジオデータベース内に格納されているもの)。 | 必須 |
/jobfield:<field name> | ジョブ ID が格納されるフィールド。 | オプション |
/datefield:<field name> | 日時が格納されるフィールド。 | オプション |
リターン コード
ステップが成功すると 0 が返されます。
VersionExists - JTXSteps.VersionExists
ジョブに既存のジオデータベース バージョンがあるかどうかをチェックします。 ステップは、従来のデータ ワークスペースおよびフィーチャ サービス データ ワークスペースに対応しています。
引数
引数は不要です。
リターン コード
以下のリターン コードがあります。
- 1 = Version exists (バージョンが存在する)
- 2 = Version doesn't exist (バージョンが存在しない)
- 3 = No data workspace selected (データ ワークスペースが選択されていない)
ArcGIS Pro および ArcGIS Desktop 専用ライブラリ
ArcGIS Pro および ArcGIS Desktop 専用ライブラリには、ArcGIS Pro、ArcMap、および ArcCatalog でのみ実行できるステップが含まれています。 以下のセクションでは、各ステップ、引数、およびリターン コードについて説明します。
AddAttachments - JTXDesktopSteps.AddAttachments
ジョブに、リンク、埋め込み、または URL アタッチメントを追加します。
引数
引数は不要です。
リターン コード
以下のリターン コードがあります。
- 1 = Success (成功)
- 0 = Failure (失敗)
CreateJobAdvanced - JTXDesktopSteps.CreateJobAdvanced
ジョブを作成し、ジョブの依存関係を使用して親/子関係を定義できるようにします。 子ジョブを作成すると、開始日、期日、データ ワークスペース、および優先度が、親ジョブからコピーされます。 ジョブの割り当ては、ステップ引数に値が指定されていない場合、そのジョブ タイプのデフォルト プロパティからコピーされます。 ステップは、従来のデータ ワークスペースおよびフィーチャ サービス データ ワークスペースを持つジョブのバージョン作成に対応しています。 子ジョブがフィーチャ サービス データ ワークスペースを使用して設定されている場合、sde.Default のみが親バージョンになれます。
引数
下表は、このステップの引数をリスト表記したものです。
| 引数 | 説明 | 引数タイプ |
|---|---|---|
/jobtypename:<job type name> | ジョブ タイプの名前 | 必須 |
/assigngroup:<group to assign to> | ジョブが割り当てられるグループ | オプション |
/assignuser:<username to assign to> | ジョブが割り当てられるユーザー | オプション |
/dependThisStep | 依存関係を作成し、このステップの現在のジョブをホールドします。 | オプション |
/dependNextStep | 依存関係を作成し、現在のジョブをワークフローの次のステップでホールドします。 | オプション |
/dependStatus:<Status Type Name> | 依存関係のステータス タイプの名前。 現在のジョブは、新しいジョブがこのステータスに達するまでホールドされます。 | オプション |
/useparentaoi | 現在のジョブの AOI を新しいジョブの AOI として使用する | オプション |
/aoiOverlapFeatureClassName:<fully qualified feature class name > | 現在のジョブの AOI と指定したフィーチャクラスのオーバーラップに基づいてジョブを作成します。 | オプション |
/numberJobs:<number of jobs to create> | ジョブのデフォルト作成数 | オプション |
/createVersionSetting:<the version to use as the parent version> | ジョブの作成時に使用するバージョン。 | オプション |
/assignVersionSetting:<the existing version the job will be assigned to> | ジョブの作成時に使用する既存のバージョン。 | オプション |
/setExtendedProps:<ChildJobFullyQualifiedExtendedPropertiesTableName.FieldName=[JOBEX:ParentJobFullyQualifiedExtendedPropertiesTableName.FieldName]>; <ChildJobFullyQualifiedExtendedPropertiesTableName.FieldName=[JOBEX:ParentJobFullyQualifiedExtendedPropertiesTableName.FieldName]>;... | 拡張プロパティの値が、現在のジョブの拡張プロパティの値のいずれか (JTX トークンによって指定)、または所定の文字列値に設定される 複数の拡張プロパティの値を設定する場合は、各値をセミコロンで区切る | オプション |
/dueDate:<due date of the new job> | 新しいジョブの期日 | オプション |
/jobDuration:<duration of the new job> | 新しいジョブの期間 | オプション |
/child | ジョブを、既存ジョブの子として作成します。 | オプション |
リターン コード
以下のリターン コードがあります。
- 0 = Success (成功)
- 1 = Failure (失敗)
DefineAOI - JTXDesktopSteps.DefineAOI
ユーザーが AOI を定義できるようにするためのツールを表示します。
引数
引数は不要です。
リターン コード
以下のリターン コードがあります。
- 1 = Success (成功)
- 0 = Failure (失敗)
EditExtendedProperties - JTXDesktopSteps.EditExtendedProperties
ジョブの拡張プロパティを表示して、必要なプロパティを定義できるようにします。 このステップは、ワークフローの別のステージで別の拡張プロパティが開くようにして、そのワークフローで複数回実行できます。 これにより、そのジョブ タイプに設定されたいくつかの拡張プロパティを選択して、ポップアップ形式で表示できるようになります。 拡張プロパティを選択するには、引数エディターを開くか引数ボックスに入力します。 選択されたプロパティはすべて、表示可能、編集可能などのジョブ タイプに設定されたプロパティが適用されます。 引数が指定されていない場合は、そのジョブ タイプで選択されたすべての拡張プロパティが、ステップの実行時に表示されます。 引数エディターには、リポジトリ内のすべてのジョブ タイプに構成されたすべてのテーブルおよびフィールドが含まれます。ただし、そのジョブ タイプに設定されていないプロパティが選択された場合、それらのプロパティはポップアップには表示されません。 引数は、拡張プロパティのテーブル名およびフィールド名で構成されます。 たとえば、RequestorInformation テーブルの RequestorName<fieldName> フィールドを表示する場合、引数は /Property: RequestorInformation.RequestorName になります。
引数
下表は、このステップの引数をリスト表記したものです。
| 引数 | 説明 | 引数タイプ |
|---|---|---|
/Property:<Property Name> | 拡張プロパティのテーブル名およびフィールド名 | 必須 |
リターン コード
ステップが成功すると 1 が返されます。
Import/Launch Mapping Items - JTXDesktopSteps.LaunchArcMap
ArcGIS Pro または ArcMap を起動して、ジョブ バージョンにレイヤーを提供し、ジョブの対象位置にマップをズームします。
引数
ステップ引数の詳細については、「Import/Launch Mapping Items ステップ」をご参照ください。
リターン コード
ステップが成功すると 0 が返されます。
LaunchGPTool - JTXDesktopSteps.LaunchGPTool
ワークフローからジオプロセシング ツールを実行します。 ツールから出力された整数は、リターン コードとして使用され、ツールの実行完了時にワークフローのパスを誘導することができます。
引数
下表は、このステップの引数をリスト表記したものです。
| 引数 | 説明 | 引数タイプ |
|---|---|---|
/toolboxpath:<toolboxpath> | ツールボックスの .tbx ファイルへの絶対パスとツール名。 | オプション |
/toolbox:<toolbox> | ツールボックスがシステム ツールボックス内にある場合は、ツールボックス名。 | オプション |
/tool:<tool> | ツールボックスに表示されるツール名。 | 必須 |
/param:<ParamName>:<ParamValue> | ツールをオーバーライドするパラメーター (複数回指定可)。 | オプション |
/attach | ツールの実行完了後、ジョブにログを添付します。 | オプション |
/license:<enum value> | ツールを実行するために使用する追加ライセンスのライセンス コード。 | オプション |
/outParam:<parameter name> | 戻り値として使用する出力パラメーター。 | オプション |
リターン コード
以下のリターン コードがあります。
- 0 = Success (成功)
- 1 = Cancel (キャンセル)
注意:
引数 /outParam が使用されている場合、成功を示すリターン コードは、指定したジオプロセシング ツールの出力パラメーターの値になります。キャンセルした場合のリターン コードは -1 です。
SelectDataWorkspace - JTXDesktopSteps.SelectDataWorkspace
あらかじめ構成されているデータ ワークスペースのリストから、ジョブで使用するデータ ワークスペースを選択するためのフォームを表示します。
引数
引数は不要です。
リターン コード
以下のリターン コードがあります。
- 1 = Success (成功)
- 0 = Failure (失敗)
ArcGIS Pro 専用ライブラリ
ArcGIS Pro 専用ライブラリには、ArcGIS Pro でのみ実行できるステップが含まれています。 以下のセクションでは、各ステップ、引数、およびリターン コードについて説明します。
Import Task - ArcGISProSteps.OpenTask
ArcGIS Pro プロジェクトでタスクを開きます。
引数
下表は、このステップの引数をリスト表記したものです。
| 引数 | 説明 | 引数タイプ |
|---|---|---|
/taskfile:<name of the file> | タスク ファイルはプロジェクトで開かれる | オプション |
/task:<name of the task within the task item> | タスク アイテム内の開くタスク | オプション |
リターン コード
以下のリターン コードがあります。
- 0 = Failure (失敗)
- 1 = Success (成功)
Open Pro Project Items - ArcGISProSteps.OpenMap
ArcGIS Pro プロジェクトでマップを開きます。
引数
下表は、このステップの引数をリスト表記したものです。
| 引数 | 説明 | 引数タイプ |
|---|---|---|
/map:<mapname> | プロジェクトで開くマップ。 | オプション |
/nobookmark | ジョブの LOA をブックマークとして追加しません。 | オプション |
/taskItem:<name of task project item> | プロジェクトで開くタスク アイテム。 | オプション |
/task:<name of the task within the task item> | タスク アイテム内の開くタスク。 | オプション |
/resetVersion | ステップの完了時に、バージョンをデフォルト バージョンにリセットします。 | オプション |
/closeMaps | ステップの完了時に、開いているマップを閉じます。 | オプション |
リターン コード
以下のリターン コードがあります。
- 0 = Failure or cancel (失敗またはキャンセル)
- 1 = Success (成功)
Import/Launch Mapping Items ステップ
引数が指定されていない Import/Launch Mapping Items ステップで想定される動作について、下表で詳しく説明します。
| ジョブ タイプのマップ ドキュメントは定義されているか | データ ワークスペースおよびバージョンがあるマッピング アイテムを開く | データ ワークスペースはあるがバージョンがないマッピング アイテムを開く | データ ワークスペースがないマッピング アイテムを開く |
|---|---|---|---|
はい | ArcMap は、定義されているマップ ドキュメントを使用して開きます。 レイヤーは、フィーチャクラスのショート ネームに基づいて、ジョブのバージョンから提供されます。 マップは、対象地域にズームします。 注意:ショート ネームは、完全修飾名ではなく、フィーチャクラス名です (たとえば、「NIS.Streets」ではなく「Streets」です)。 ベースマップが最初にどのように定義されたかに関係なく、ショート ネームが一致するレイヤーが提供されます。 | これは、バージョンが存在する場合のシナリオと同じですが、レイヤーを提供するためのデータ ワークスペースのデフォルト バージョンが使用されている場合は例外です。 | レイヤー ソースは変更されません。 マップは LOI にズームします。 |
No | ArcMap は、空のドキュメントを使用して開きます。 この場合は、マップが存在しないので、提供されるレイヤーもありません。 マップにレイヤーが追加された後、[Workflow Manager] ツールバーの [データの追加] ボタンをクリックすると、ジョブに定義されているバージョンまたは選択したデータ ワークスペースのデフォルト バージョンに移動します。 | これは、バージョンが存在する場合のシナリオと同じです。 | ArcMap は、空のドキュメントを使用して開きます。 [Workflow Manager] ツールバーの [データの追加] ボタンは使用できません。 ジョブに LOI が存在する場合は、[LOI にズーム] ツールを使用できます。 |
Workflow Manager (Classic) で開いたマップでは、ベースマップ レイヤーは再ポイントされません。
注意:
ArcGIS Pro マップ (.mapx) が Workflow Manager (Classic) リポジトリに格納され、ArcGIS Pro マップ (.mapx)、レイアウト (.pagx)、または Web マップが ArcGIS Online に格納されている、あるいは Portal for ArcGIS が ArcMap 用に構成された [ジョブ タイプ] の値およびステップとともに使用されている場合は、マップが開かずにエラー メッセージが表示されます。 ステップが、ArcMap のフィーチャ サービス データ ワークスペースを使用して実行される場合は、マップが開かずにエラー メッセージが表示されます。
引数の説明
Import/Launch Mapping Items ステップには、多数のオプション パラメーターを指定できます。そのため、コードを記述しなくてもカスタマイズできます。
ArcMap 引数エディターを起動すると、デフォルト設定された動作により、ステップ タイプの実行タブが表示されます。
注意:
マップ内のレイヤーは、再ポイントのためのバージョンおよびユーザー接続情報について、Workflow Manager (Classic) システムのデータ ワークスペースのデータを参照する必要があります。 マップ レイヤーが Workflow Manager (Classic) システムのデータ ワークスペースのデータを参照しているが、ジョブにジョブ バージョンが指定されていない場合、マップ レイヤーは、データ ワークスペースのデフォルト データベース バージョンに対して再ポイントされます。 以下の状況では、マップ レイヤーは再ポイントされません。
- ジョブ マップが定義されていない場合、再ポイントするレイヤーがないため、空のマップが開きます。
- ステップがバージョンのみを変更するように構成されており、ジョブ マップのレイヤーがデータ ワークスペースのレイヤーではない場合、レイヤーは、破損したデータ ソースを使用して表示されます。
- レイヤーがデータ ワークスペースのレイヤーではなく、ジョブ タイプ プロパティで再ポイントのために選択されている場合、レイヤーは、破損したデータ ソースを使用して表示されます。
- レイヤーがデータ ワークスペースのレイヤーではなく、ジョブ タイプ プロパティで再ポイントのために選択されている場合、レイヤーは、デフォルト データベース バージョンに対して再ポイントされます。
Workflow Manager (Classic) のマップとバージョニングの詳細
| 説明的な名前 | 引数の例 | 振舞い |
|---|---|---|
Zoom to LOI (LOI にズーム) | または | デフォルト動作により、マップはジョブの AOI に画面移動し、係数 1 を使用してシェープのジオメトリにズームします。 /nozoomloi オプションを使用してマップを移動またはズームしないようにしたり、引数 /aoifactor を使用して、より大きいズーム係数で AOI にズームしたりすることができます。 ズーム係数は、POI には適用されません。 POI が 1 つの場合、マップは 1:2,000 にズームします。POI が複数の場合は POI の範囲にズームします。 |
Do not change any connection information (接続情報を変更しない) | | /norepoint が使用されない場合、デフォルト動作では、マップ内のすべてのレイヤーが現在のデータ ワークスペースと、必要な場合はジョブのバージョンに変更されます。 |
Change only the version for job's data workspace (ジョブのデータ ワークスペースのバージョンのみ変更する) | | /changeversiononly オプションを使用すると、そのジョブ タイプのマップ ドキュメントのレイヤーのバージョンが変更されます。 ユーザー データおよび接続情報は、最初に構成されたままで変更はされません。 データ ワークスペースのすべてのレイヤーは、ジョブ タイプ プロパティで再ポイントのために選択されているかどうかに関係なく、再ポイントされます。 データ ワークスペース以外のレイヤーは、破損したデータ ソースを使用して表示されます。 注意:個別のログインを使用している場合、このオプションはマップ レイヤーを再ポイントせず、デフォルト バージョンをポイントします。 |
Save MXDs (MXD を保存する) | | /nosavemxd 引数が使用されない場合、デフォルト動作では、ジョブのマップ ドキュメントは Workflow Manager (Classic) データベースに保存されます。 ワークフローでこのステップを使用してジョブのマップ ドキュメントを開くたびに、データベースに最後に保存されたマップが読み込まれます。 ただし、/nosavemxd オプションを選択した場合、ジョブのマップ ドキュメントは Workflow Manager (Classic) データベースに保存されません。 ジョブ マップの範囲を変更して閉じた場合、変更後の範囲は保存されず、次にマップを開くときは元の範囲が使用されます。 注意:ArcMap では、マップを閉じるたびにマップの保存を確認するメッセージを表示しますが、/nosavemxd を使用していると、ArcMap のメッセージで [はい] をクリックしても、マップは保存されません。 大きいマップ ドキュメントでは、場合によっては MAXBLOBSIZE SDE 構成設定を調整する必要があります。 このオプションにより、マップ ドキュメントを閉じないで、ArcMap でジョブを切り替えることもできます。 |
Clip Data Frame to AOI (データ フレームを AOI にクリップする) | | 引数 /cliptoaoi を使用すると、ジョブのマップ ドキュメントのデータ フレームが AOI のシェープにクリップされます。 ジョブのマップ ドキュメントで AOI が定義されていない場合、マップ ドキュメント内の表示可能なすべてのデータが表示されます。 注意:この引数によってレイヤーにフィルター設定が作成されることはありません。 マップのレイヤー内のすべてのフィーチャは、それぞれのテーブルからアクセス可能です。 |
Wait for ArcMap to close (suspend Workflow Manager (Classic)) (ArcMap の終了 (Workflow Manger (Classic) の一時停止) を待機する) | | 引数 /nowait が使用されない場合、Workflow Manager (Classic) のデフォルト動作では、ArcMap プロセスの実行中、アプリケーションが表示されません。 つまり、Workflow Manager (Classic) で作業しながら ArcMap アプリケーションを操作することはできません。 /nowait オプションを使用すると、ArcMap が別のプロセスで起動し、ユーザーは、ArcMap を実行しながら Workflow Manager (Classic) アプリケーションを操作することができます。 注意:このオプションは、カスタム ステップ オブジェクトでワークフロー ステップの [Launch process asynchronously] オプションを使用できないため、追加されました。 |
Use existing ArcMap session (既存の ArcMap セッションを使用する) | | /useexisting 引数が設定されない場合、デフォルト動作では、ステップの実行中に新しい ArcMap セッションが開きます。 /useexisting オプションを使用すると、ステップの実行時に ArcMap セッションが開いている場合、Workflow Manager (Classic) は、その既存のセッションでジョブのマップ ドキュメントを開きます。 ArcMap セッションが開いていない場合、Workflow Manager (Classic) はセッションを開きます。 |
Store MXDs in shared location (MXD を共有場所に格納する) | | デフォルト動作では、代わりの場所は構成されず、ジョブのマップ ドキュメントは Workflow Manager (Classic) データベースに格納されます。 大きいマップ ドキュメントでは、場合によっては MAXBLOBSIZE SDE 構成設定を調整する必要があります。 マップ ドキュメントを代わりの場所に格納する場合、Workflow Manager (Classic) は、マップ ドキュメントを、データベースではなく代わりの場所に保存します。 |
Use Alternative MXD (別の MXD を使用する) | | デフォルト動作では、ステップは、import/Launch Mapping Items ステップのベースマップ ドキュメントとして、ジョブ タイプのデフォルト マップ ドキュメントを使用します。 このオプションを使用した場合、Workflow Manager (Classic) はマップ ドキュメント、またはその引数用に構成されたテンプレートを読み込みます。 注意:ArcGIS Pro マップ (.mapx) は、ArcGIS Pro 用に構成されたステップの MXD の代わりとして使用できます。 |
Run ArcMap Command | | ArcMap が読み込みを完了すると、指定されたコマンドが実行されます。 |
Load Task Assistant workflow (Task Assistant ワークフローを読み込む) |
| ArcMap が開いた後、Workflow Manager (Classic) はタスク アシスタントで構成されているワークフローを開きます。 渡されるワークフロー名は、Workflow Manager (Classic) システムに格納されているタスク アシスタント ワークフローのエイリアスです。 /taworkflow エントリーを追加するか、引数エディターでワークフローを選択することで、複数のワークフローを渡すことができます。 |
Store Task Assistant History in Job History (Task Assistant の履歴をジョブ履歴に格納する) |
| デフォルトで、タスク アシスタント ワークフローがジョブ履歴に追加されます。 Workflow Manager (Classic) ツールを使用すると、この引数をテキスト ファイルとして添付することができます。 |
Data Reviewer ライブラリ
ライセンス:
Data Reviewer ライブラリは Data Reviewer ライセンスで利用可能です。
Data Reviewer ライブラリには、ワークフローの一部として Data Reviewer 機能を自動的に選択するためのステップが含まれています。 トークンとともにこのステップを使用すると、ジョブのレビューアー セッションの作成と削除、レビューアー バッチ ジョブのワークフローからの直接実行、ジョブのレビュー セッションの自動開始などが可能です。 以下のセクションでは、各ステップ、引数、およびリターン コードについて説明します。
レガシー:
ArcMap ベースのレビューアー ワークフローはまもなく廃止されます。 現在のユーザーは、レビューアー バッチ ジョブから ArcGIS Pro 属性ルールにワークフローを変換することをお勧めします。
Create Reviewer Session ステップ - ProductionMappingSteps.CreateReviewerSession
Create Reviewer Session ステップは、レビューアー セッションを作成してジョブに関連付けます。 Import/Launch Mapping Items ステップは、関連するレビューアー セッションを使用してその操作を行うことができます。 1 つのジョブに対し複数のレビューアー セッションがサポートされます。
引数
下表は、このステップの引数をリスト表記したものです。
| 名前 | 説明 | 引数の例 | 振舞い |
|---|---|---|---|
Results Workspace (必須) | 新しいセッションが作成される結果ワークスペースを指定します。 引数は、次の 3 つの方法で設定できます。
注意:既存のレビューアー ワークスペースが選択されている必要があります。 このステップでは、レビューアー ワークスペースは作成されません。 | /StoreInJobDW | レビューアー ワークスペースは、ジョブのデータ ワークスペースと同じであると見なされます。 このステップを実行すると、ジョブのデータ ワークスペースに新しいレビューアー ワークスペースが作成されます。 この引数ではトークンが使用されます。 |
/RevWSVersion:[JOB:VERSION] | このステップを実行すると、新しいレビューアー セッションは、指定したジオデータベース バージョンに関連付けられます。 デフォルト トークンは [JOB:VERSION] です。 | ||
/WMXDW:Reviewer | レビューアー ワークスペースは、Workflow Manager (Classic) データ ワークスペースと見なされます。 このステップを実行すると、このワークスペースにレビューアー セッションが作成されます。 | ||
/RevWSVersion:DEFAULT | このステップを実行すると、新しいレビューアー セッションは、指定したジオデータベース バージョンに関連付けられます。 | ||
/ReviewWS:"C:\Data\Reviewer.gdb" | レビューアー ワークスペースは、ファイル ジオデータベースまたはパーソナル ジオデータベースと見なされます。 このステップを実行すると、このワークスペースにレビューアー セッションが作成されます。 この引数ではトークンが使用されます。 | ||
Session Properties (セッション プロパティ) (Session Name (セッション名) プロパティのみ必須) | セッション名、作成者、重複チェックの方法、結果のジオメトリを格納するかどうかなどの、セッションのプロパティを指定します。 次のプロパティを設定する必要があります。
| /SessionName:Job[JOB:ID] | このステップを実行すると、この引数に従って、新しいレビューアー セッションの名前が設定されます。 たとえば、レビューアー セッション名は、「Job123」などのジョブ ID に基づいて設定されます。 デフォルト トークンは [JOB:ID] です。 |
/SessionUserName:[JOB_ASSIGNED_TO] | このレビューアー セッションの作成者の名前。 デフォルトは [JOB_ASSIGNED_TO] です。 注意:このフィールドを空のままにすると、[JOB_ASSIGNED_TO] トークンが使用されます。 この引数ではトークンが使用されます。 | ||
/CheckDuplicateResults:SESSION | セッション内で重複する検証結果の処理方法を指定します。
| ||
/DoNotStoreResultsGeometry | 結果に関連するジオメトリを含めるかどうかを指定します。
|
リターン コード
以下のリターン コードがあります。
- 0 = Success (成功)
- 1 = Failure (失敗)
Delete Reviewer Sessions - ProductionMappingSteps.DeleteReviewerSessions
Delete Reviewer Session ステップは、ジョブの処理中に Create Reviewer Session ステップを使用して作成された 1 つ以上のレビューアー セッションを削除します。
ステップの構成中に、削除するレビューアー セッションを決定する引数を指定する必要があります。
引数
下表は、このステップの引数をリスト表記したものです。
| 名前 | 説明 | 引数の例 | 振舞い |
|---|---|---|---|
Session(s) to Delete (削除するセッション) (必須) | 削除するレビューアー セッションを指定します | /sessionsToDelete:all | このステップを実行すると、指定したレビューアー セッションが削除されます。
|
注意:
引数 selected を指定してこのステップを ArcGIS Pro で実行すると、すべてのダイアログ ボックスが非表示になり、最も高い (最も最近の) レビューアー セッション ID が削除されます。
リターン コード
以下のリターン コードがあります。
- 0 = Sessions successfully deleted (セッションの削除が成功)
- 1 = One or more reviewer sessions were not deleted (1 つ以上のレビューアー セッションの削除が完了)
- 2 = Reviewer sessions were deleted, but the job information could not be updated (レビューアー セッションが削除されたが、ジョブ情報を更新できなかった)
Run Reviewer Batch Job - ProductionMappingSteps.RunReviewerBatchJob
Run Reviewer Batch Job ステップは、ワークフローでバッチ ジョブを実行します。
引数を使用して以下を指定できます。
- 実行するバッチ ジョブ
- 検証する空間データ
- 結果を格納するレビューアー ワークスペースとセッション
引数
下表は、このステップの引数をリスト表記したものです。
| 名前 | 説明 | 引数の例 | 振舞い |
|---|---|---|---|
Reviewer Batch Job File (レビューアー バッチ ジョブ ファイル) (必須) | レビューアー バッチ ジョブへのパスを指定します。 | /BatchJobPath:"C:\Data\sample.rbj" | 指定したバッチ ジョブが実行されます。 この引数ではトークンが使用されます。 |
Data Workspace (データ ワークスペース) (オプション) 注意:[Override Batch Job Data Workspace] チェックボックスがオンの場合、これは必須です。 | バッチ ジョブの実行対象のデータ ワークスペースを指定します。 引数は、次の 3 つの方法で設定できます。
| [Override Batch Job Data Workspace] チェックボックスがオンの場合は、/OverrideBatchDataWS などの引数を使用します。 | このステップを実行すると、バッチ ジョブは、ステップ タイプで指定されたデータ ワークスペースに対して実行されます。 代わりのワークスペースおよびバージョンを、Reviewer Batch Job Data Workspace 引数および Reviewer Batch Job Data Version 引数を使用して指定する必要があります。 |
/SameAsJobDW | このステップを実行すると、バッチ ジョブは、ジョブのデータ ワークスペース内のデータを検証します。 | ||
/BatchJobDataVersion:[JOB:VERSION] | このステップを実行すると、バッチ ジョブは、指定したバージョン内のデータを検証します。 デフォルト トークンは [JOB:VERSION] です。 | ||
/BatchJobInWMXDW:Reviewer | このステップを実行すると、バッチ ジョブは、指定された Workflow Manager (Classic) データ ワークスペース内のデータを検証します。 | ||
/BatchJobInWMXDW:DEFAULT | このステップを実行すると、バッチ ジョブは、指定したバージョン内のデータを検証します。 | ||
/BatchJobDataInPersonalFile:"C:\Data\MyData.gdb" | このステップを実行すると、バッチ ジョブは、指定したファイル ジオデータベースまたはパーソナル ジオデータベース内のデータを検証します。 この引数ではトークンが使用されます。 | ||
Results Workspace (必須) | 結果が書き込まれるレビューアー ワークスペースを指定します。 引数は、次の 3 つの方法で設定できます。
注意:既存のレビューアー ワークスペースが選択されている必要があります。 このステップでは、レビューアー ワークスペースは作成されません。 | /RevIsSameAsJobDW | レビューアー ワークスペースは、ジョブのデータ ワークスペースと同じであると見なされます。 このステップを実行すると、ジョブのデータ ワークスペースにレビューアーの結果が書き込まれます。 |
/RevWSVersion:[JOB:VERSION] | このステップを実行すると、指定したバージョンにレビューアーの結果が書き込まれます。 デフォルト トークンは [JOB:VERSION] です。 | ||
/RevInWMXDW:Reviewer | レビューアー ワークスペースは、Workflow Manager (Classic) データ ワークスペースと見なされます。 このステップを実行すると、このデータ ワークスペースにレビューアーの結果が書き込まれます。 | ||
/RevWSVersion:DEFAULT | このステップを実行すると、指定したバージョンにレビューアーの結果が書き込まれます。 | ||
/RevInPersonalFile:"C:\Data\Reviewer.gdb" | レビューアー ワークスペースは、ファイル ジオデータベースまたはパーソナル ジオデータベースと見なされます。 このステップを実行すると、このデータ ワークスペースにレビューアー レコードが書き込まれます。 この引数ではトークンが使用されます。 | ||
Reviewer Session Name (レビューアー セッション名) (必須) | 結果が書き込まれるレビューアー セッションを指定します。 注意:レビューアー セッションは、このステップが実行されるより前に存在している必要があります。 このステップでは、レビューアー セッションは作成されません。 | /RevSessionName:JOB[JOB:ID] | このステップを実行すると、指定したセッションにレビューアー レコードが書き込まれます。 複数のレビューアーセッションの名前が同じ場合、レコードを書き込むレビューアー セッションをいずれか選択するよう求められます。 この引数ではトークンが使用されます。 |
Analysis Area (解析エリア) (必須) | バッチ ジョブが実行される空間範囲を指定します。 | /AreaValidation:FullDB | このステップを実行すると、バッチ ジョブがジオデータベース全体に対して実行されます。 |
/AreaValidation:AOI | このステップを実行すると、バッチ ジョブがジョブの AOI に対して実行されます。 | ||
/AreaValidation:ChangedOnly | このステップを実行すると、バッチ ジョブが、変更されたフィーチャに対してのみ実行されます。 注意:このオプションは、バージョン対応データセットの操作時のみ有効です。 | ||
Result Created By (結果作成者) | レビューアーの結果の作成者の名前を指定します。 | /SessionUserName:[JOB_ASSIGNED_TO] | レビューアーの結果の作成者の名前。 デフォルトは [JOB_ASSIGNED_TO] です。 注意:このフィールドを空のままにすると、[JOB_ASSIGNED_TO] トークンが使用されます。 |
注意:
このステップが ArcGIS Pro で実行されると、すべてのダイアログ ボックスが非表示になり、最も高い (最も最近の) レビューアー セッション ID に書き込まれます。
リターン コード
以下のリターン コードがあります。
- 0 = バッチ ジョブが成功し、結果は返されなかった
- 1 = Batch job executed successfully, and no results were returned (バッチ ジョブが成功し、結果がレビューアー セッションに書き込まれた)
- 2 = Batch job failed to execute (バッチ ジョブの実行が失敗した)
- 3 = Batch job executed successfully with errors or warnings, and no results were returned (バッチ ジョブは成功したが、エラーまたは警告が発生し、結果は返されなかった)
- 4 = Batch job executed successfully with errors or warnings, and results were written to the reviewer session (バッチ ジョブが成功したが、エラーまたは警告が発生し、結果がレビューアー セッションに書き込まれた)