ProConcepts Migrating to ArcGIS Pro - kataya/arcgis-pro-sdk GitHub Wiki

このドキュメントは、ArcGIS Pro SDK for Microsoft .NET を使用して ArcMap のカスタマイズを ArcGIS Pro に移行する際のアプローチ、ベストプラクティス、および実装上の考慮事項の概要を説明しています。

    Language:      C#
    Subject:       Framework
    Contributor:   ArcGIS Pro SDK Team <[email protected]>
    Organization:  Esri, http://www.esri.com
    Date:          11/24/2020 
    ArcGIS Pro:    2.7  
    Visual Studio: 2017, 2019

• 概要
• カスタマイズ パターン
  • アドイン パターン
  • アドイン と 構成 の比較
  • ライセンスの実装
• プログラミング パターン
  • WPF と MVVM
  • デスクトップ アプリケーション マークアップ言語, DAML
  • 非同期プログラミング
  • スタイル
• ArcGIS Pro への移行
  • ArcGIS Pro SDKの習得
  • User Feedback
  • The ArcGIS Marketplace

このドキュメントでは、ArcGIS Pro SDK を初めて使用し、初期戦略, アーキテクチャ, およびアプリケーション設計の決定に取りかかる開発者や管理者のために、従来のデスクトップのカスタマイズを移行するための一般的なハイレベルなアプローチについて説明しています。

ArcGIS Pro SDK は、ArcGIS Pro の新しいリリースごとにリリースされます。Pro SDK は、ArcGIS 10.0 で初めて導入されたアドイン 拡張パターンに基づいており、最新の Microsoft .NET の機能とパターンを活用しています。"アドイン" として知られるこれらのカスタマイズは、1 つの圧縮された zip ファイルにパッケージ化されており、簡単に共有してインストールすることができます。アドインは柔軟性があり、ArcGIS Pro を特定のユーザのニーズに合わせ、複雑な編集ワーク フローのための新しいカスタム Pro ツールセットを提供したり、カスタム空間解析処理ルーチンを提供したり、というようなさまざまなレベルのカスタマイズを提供することができます。

このドキュメントは4つのセクションに分かれています。

• Customization Patterns – ArcGIS Pro をカスタマイズするための一般的なパターン。 アドイン や ソリューション構成 を使用するタイミングなど、アプローチや考慮すべき点が含まれています。

• Programming Patterns – WPF、MVVM、非同期プログラミングなど、Pro SDKでプログラミングする際に使用する主なパターンを紹介します。

• Learning ArcGIS Pro – カスタマイズ作業には、Pro とその新しい機能を十分に理解しておくことが不可欠であるため、ArcGIS Pro を学習するための ティップス や リソース を紹介しています。

• Learning the ArcGIS Pro SDK – 始める際に注目すべきキーコンセプトを提案している、Pro SDK を学習するための ティップス や リソース を紹介しています。

ArcGIS Pro のカスタマイズに取りかかる際には、必要な拡張性のレベルを考慮すると役に立ちます。 以下に、ArcGIS Pro を拡張するための 3 つのアプローチを、難易度の低いものから高いものまで順に示します。

• 設定によるUI の構成とタスク によるワークフローの実現 この複雑さの少ないアプローチは、必要な機能が既存のProツールや機能でカバーされており、Pro プロジェクトやワークフローを整理したい場合に最適です。この場合は、Customizing the Pro ribbonのように、UI に若干の変更を加える必要があるかもしれません。また、Pro の Tasksを使用して、繰り返し可能なワークフローを設定したり、Pro のツールやジオプロセシングツール、独自のジオプロセシングモデル を埋め込むこともできます。

• ジオプロセシング とPython を使って自動化 次のアプローチは、ModelBuilderでジオプロセシングモデルを作成し、ArcPyを使ってPython スクリプトを開発する方法です。このアプローチでは、一般的なタスクや操作を自動化するための強力で再現性の高いスクリプトを作成することができます。

• Pro SDK を使用して、独自のカスタム ツール や ソリューションで拡張 最も高度なアプローチは、Pro SDK を使用して独自のアドイン を開発することです。Microsoft Visual Studio と .NET を使用して、ツールやワークフローを直接Pro UI に統合し、シームレスなユーザーエクスペリエンスを提供する洗練されたPro アドイン を開発することができます。また、開発者は、より高度なアドインの形態であるソリューション 構成を構築することができ、組織や業界に合わせたカスタム起動エクスペリエンスをユーザーに提供することができます。

これらのオプションを評価する際には、それぞれの実装上のトレードオフがあります。例えば、複雑さの低い「構成（設定）」によるオプションは、タスクの使用など、いくつかの設定ステップを伴うコアのすぐに使えるツールを活用します。このアプローチは、実装と保守がより簡単かつ迅速になります。場合によっては、タスク内の一連のステップで構成されたコア ツールのセットを使用するだけで十分な場合もあります。プロジェクトの観点から見ると、このアプローチは通常、（3つのアプローチの中で）実装と保守が最も簡単です。プログラミングや開発に時間をかける必要がなく、カスタムコードの変更を考慮する必要がないため、将来的にPro をアップグレードする際に手直しをする必要がありません。

また、設定は少人数のチームがすぐに始められ、ワークフローのステップや情報製品がソリューションに本当に必要なものかどうかを確認し、後から改善を検討するための、簡単な方法かもしれません。しかし、ワークフローが頻繁に使用されたり、複雑なステップが多数含まれていたりすると、ユーザーにとっては扱いにくいものになる可能性があります。ユーザーは、より迅速に、より自動化された方法でタスクを完了できるような、よりカスタマイズされたソリューションを好むかもしれません。これは、アプローチを進化させ、Python やジオプロセシング でステップを自動化したり、Pro SDKを使ったカスタム アドインの開発を検討する良い機会です。

開発者、アナリスト、管理者は、最小限の開発で必要な効率と機能をユーザーに提供するリーン開発の手法を選択することをお勧めします。場合によっては、3つのアプローチをすべて組み合わせたものが適切な選択肢となることもあります。例えば、単一チームのプロジェクトでデータ管理機能を備えた合理化されたUI が必要な場合、アドイン や ソリューション構成 の開発に手間取るよりも、共有プロジェクトの一部として Customizing the Pro ribbon と Geoprocessing tool in the Pro favorites を提供するだけの方が、実行可能なアプローチになる可能性があります。

それでも、マップやシーンなどとの対話的な操作を伴う新しいPro ツールが必要で、基本的な設定や自動化を超えている場合や、Pro UI のカスタマイズが必要な場合は、Pro SDK を使用したアドイン の開発を検討する必要があります。SDK を使用してアドイン を開発することは、精度と生産性の面で優れた選択となります。また、Pro UI を一貫して改良または合理化し、新しくユニークで時間を節約できる機能を提供したい場合にも、アドイン は非常に有益なものとなります。

Pro アドインのカスタマイズ パターンは3つあります。

• 従来のアドイン (.esriAddinX ファイル) – 豊富なPro のカスタマイズ機能を提供します

• ソリューション構成 (.proConfigX ファイル) – 従来のアドイン機能に加え、カスタムブランディング、UI、ユーザーエクスペリエンスのための、追加のスタートアップ機能を提供します。

• Plugin データソース (.esriPlugin) - 開発者に（サポートされていない）カスタムデータソースをラップして、Proで使用できるようにする特殊なアドイン のパターンを提供します。詳細については、ProConcepts Geodatabase と ProGuide Plugin Datasource を参照してください。

従来のアドインの開発については、新規開発者のための基礎的な概念が ProConcepts Framework のドキュメントで説明されています。

ソリューション構成については、ProConcepts Configurations のドキュメントで詳しく説明されており、次が提供されています。

• Solution branding of the Pro UI – カスタムのスプラッシュ画面、スタートアップページ、アプリケーション アイコンなどを使用して、高度にカスタマイズされたUI とPro のスタートアップ ユーザー エクスペリエンスを作成することができます。

• Conditional / role-based customization – Pro の起動時のエクスペリエンスにロジックを組み込み、状態やログインなどに基づいて Pro UI リボンを合わせることができます。

• Add-in capabilities – 構成は、アドインの標準的なカスタマイズ機能を提供します。

• Control over add-ins – どのアドインをどのようにロードするかを選択することができます。

次のスクリーンショットは、合理化された UI とワークフローを持つ ソリューション構成 の例を示しています。これは、開発者がビルドして利用できる多くの Pro SDK community samples の中の 1 つである ConfigWithMap solution configuration community sample です。

アドインや設定の機能を簡単に比較すると以下のようになります。

• 共通点

  • Pro SDK プロジェクトテンプレートからビルド
  • Pro UI のカスタマイズを可能にする
  • 標準のダブルクリック インストールでコンパイルと配置

• 相違点

  • アドイン:

    • Pro のセッションごとに複数のアドインを許可

  • 構成:

    • Pro のセッションごとに1つの構成（設定）
    • カスタム起動のエクスペリエンス - スプラッシュ画面と起動ページ、条件付き起動ロジック（ユーザーロールなど）。

構成は、完全な「ソリューション」エクスペリエンスを提供したい開発者のためのものです（複数のユーザーロールをサポートしているかどうかは別として）。アドインよりもはるかに広範囲のカスタマイズ作業が必要となります。アドインは、特定のツールやツール セット、カスタム UI、特定のカスタムワークフローなど、より焦点を絞った機能を提供することを目的としています。

1つのPro セッションにつき 1つのソリューション構成 しか使用できませんが、同じPro セッションには複数のアドインを含めることができます。 これにより、Pro セッション内でより柔軟な拡張性のオプションを提供することができます。また、ソリューション構成 では、アドインの読み込み順序を定義できるため、Pro UI 内でアドインがどのように使用され、どのように表示されるかを制御することができます。

これは、既存のアドインの機能を強化するために、あるいはアドインのセットにまたがって機能を段階的にリリースするために、複数のアドインを使用してソリューションを実装する方法についての話題が出てきます。 これについては、ProConcepts Advanced Topics のドキュメントで説明されています。

アドイン や ソリューション構成 にライセンスを実装するための主なアプローチとしては、以下の2つがあります。

• アドイン を有効にするためにPro SDK を使用します
• 既存の ArcMap ソリューションのライセンス プロセスを活用

ArcGIS Pro 専用のアドイン ライセンス手順を作成する場合は、以下のオプションを使用できます。

• アドイン: IExtensionConfig インターフェイスを使用
  • リソース: ProGuide: License Your Add-In と Licensing Community Sample
• ソリューション構成: ConfigurationManager クラスの OnValidateLicense メソッドを使用

ArcGIS Pro アドインを使用して ArcMap のカスタマイズをパッケージ化して展開する予定がある場合や、ArcMap のカスタマイズのためのライセンスアプローチを既に開発している場合、 新しいProアドインを有効にするために、このライセンスアプローチを取り入れて活用することができるかもしれません。

このセクションでは、開発者がPro アドインを書く際に使用する主要なプログラミング パターンについて一般的な情報を提供します。

ArcGIS Pro SDK は Microsoft .NET 上に構築されています。開発は、Microsoft Visual Studio 統合開発環境 (IDE) で行います。Visual Studio 内では、開発者は、最新のデスクトップ アプリケーション開発のための主要な機能を提供する Windows Presentation Foundation (WPF) を使用してデスクトップ アプリケーションを作成します。

Pro SDK は、MVVM (Model-View-ViewModel) と同様に WPF を活用しています。これらのパターンは、Pro SDK のドキュメントやサンプルで実装されているのを確認できます。

MVVMは、XAMLベースの開発でよく使われるデザインパターンで、アドインのUIコンポーネントをデータ および ビジネスロジック コンポーネントから分離します。Pro SDK では MVVM を使用して、カスタム ペイン、ドックペイン、ダイアログ、プロパティシート、および埋め込みコントロールを実装します。ArcGIS Pro SDK のアイテム テンプレートは、MVVM パターンに必要なボイラープレートコードの多くを生成します。この Microsoft document には、MVVM を使用することで、アプリケーションのテストやメンテナンスが容易になり、コードの再利用機会が向上することが説明されています。MVVM パターンに関する他の良い情報源はウェブ上にあり、ProConcept Frameworkのドキュメントは、SDK のための重要な考慮事項をいくつか提供しています。

デスクトップ アプリケーション マークアップ言語（DAML）については、ProConcepts Framework のドキュメントで詳しく紹介されています。DAML はアドインプロジェクトの Config.daml ファイルで定義されます。これは、アドイン に含まれるボタン、ツール、メニュー、ドックペイン、タブなどを宣言するために使用され、Pro UI をカスタマイズするために使用されます。これらの実装は、Pro SDK アイテム テンプレートによってプロジェクトに自動的に追加される別個の「コードバインディング」ファイルにあります。

Config.daml を使用すると、State と Conditions を使用して Pro UI のコンテキスト動作を開発することもできます。これらについては、ProConcepts Framework のドキュメントで独自のセクションで紹介されており、ProGuide Code Your Own States and Conditions でウォークスルーが提供されています。

Pro SDK の主な機能の1つに非同期開発があります。 このパターンは、多くのGIS開発者にとってまだ新しいものです。 これは、Pro の機能を学ぶ上で、どのようにして応答性の高いUIを維持し、優れたユーザーエクスペリエンスを構築するかを学ぶ上で重要な箇所です。

最良のリソースは、ProConcepts Framework ドキュメントの Working with Multithreading in ArcGIS Pro のセクションです。QueuedTask class の使用に慣れておくことが重要です。 カスタム コードのほとんどは QueuedTask を使用して実行され、バックグラウンド / ワーカー スレッドとも呼ばれる Pro のメイン CIM スレッド (MCT) 上でバックグラウンドで実行されます。QueuedTask を使用して実行される機能は、「キューイング」され、sequentially (ただし、バックグラウンドでは UI が応答性を維持したまま) で実行されます。QueuedTask上で実行されているものは何であれ、QueuedTask上の他の何かを実行する前に完了しなければなりません。言い換えれば、機能は非同期的に実行されますが、予測可能なシーケンシャルな順序で実行されます。

Microsoftには、非同期プログラミングに関する this article などのリソースがあります。

Pro SDK には、カスタム UI で使用できる多数のスタイル、ブラシ、およびカラーが用意されています。アドインが Pro に溶け込むように、可能な限り WPF UI 要素に ArcGIS Pro SDK のスタイルを使用してください。Pro の対応するライトまたはダークのテーマを変更すると、Pro スタイルは自動的に正しい配色に切り替わります。以下のリソースでは、カスタム UI でメインの WPF コントロールを Pro スタイルでスタイリングする際に考慮すべき詳細を説明しています。

• ProGuide Style Guide – このProGuide では、異なるWPF UI コントロールのそれぞれのスタイリングに関する考慮事項を説明しています。

• Esri Brushes – このページでは、Esri XAML ブラシの一覧を表示します。

• Esri Colors – このページでは、 Esri XAML カラーの一覧を表示します。

• ProGuide – Applying Custom Styles – このProGuide では、ライトとダークの両方のテーマをサポートするカスタムスタイリングのウォークスルーを提供しています。

• Custom Styling community sample – このコミュニティ サンプルでは、ライトとダークの両方のテーマをサポートするようにスタイリングされたカスタム Pro ユーザー コントロールを備えたドックペインを提供しています。

移行の計画を立てる際には、既存のソリューション（タスク、3Dシーンなど）を強化できるProの機能をどのように活用するかを検討する必要があります。また、必要に応じて、すぐに使えるコア機能を使ってワークフローにどのように対応するかを考える必要があります。例えば、ユーザーがPro とどのように対話的に操作するか、コンテキスト リボンUI によってUI の実装方法がどのように変わるかを検討します。アドインの設計に踏み込む前に、Pro アプリケーションをしっかりと理解しておきましょう。

新しいPro UI 要素と用語に慣れるために、Pro のトレーニング、ドキュメント、クイックスタートガイドのリソースの包括的なセットがあります。

• ArcGIS Pro Training Catalog – Choose from the many Pro training courses

• ArcGIS Pro Resources – Leverage quick-start tutorials and migration guides

• Migrating to ArcGIS Pro – Find migration information and videos

• ArcGIS Pro Documentation – Get access to all the documentation

• ArcGIS Pro Terminology Guide – Learn Pro terminology

• Esri Press – Find books on learning ArcGIS Pro

ArcObjects からカスタマイズを移行する場合、ArcObjects コードは、Pro SDK を使用するために書き換える必要があります。ここでは、Pro SDK の学習を開始する際の一般的なヒントと、最初のプログラミング作業について説明します。

• Your UIs will be written using WPF and XAML, not Windows Forms. The primary pattern to become familiar with is MVVM.

• The Pro SDK is an asynchronous API. This will be new to many desktop developers. Consult the Microsoft documentation on asynchronous programming and the Pro SDK documentation on the use of QueuedTask.

• Leverage the Pro SDK community samples for a view of best practices, and integrate the code as needed.

• Leverage the Pro Concepts, Pro Guides, and Pro Snippets for step-by-step "how to's" as well as code snippets of many common tasks. Tip: Start with the "Framework" topic found on the margin of the SDK wiki page and work your way through these ProConcepts documents first.

• Use the GeoNet ArcGIS Pro SDK Group for both questions on SDK functionality and best practices as well as requests for new feature functions. -->

• Pro SDK のドキュメント、コミュニティサンプル、スニペットはC#で書かれています。

• あなたのUI は、Windows Forms ではなく、WPF とXAML を使って書かれます。慣れるべき主要なパターンはMVVM です。

• Pro SDKは非同期APIです。これは多くのデスクトップ開発者にとっては初めてのことでしょう。Microsoftの documentation on asynchronous programming や Pro SDKの use of QueuedTask を参照してください。

• Pro SDK community samples を活用してベストプラクティスを確認し、必要に応じてコードを統合します。

• Pro Concepts、Pro Guides、Pro Snippetsを活用して、ステップ バイ ステップの「ハウツー」や、多くの一般的なタスクのコードスニペットを作成できます。
  ヒント: SDK wiki ページの余白にある "Framework" トピックから始めて、最初にこれらの ProConcepts ドキュメントに沿って作業してください。

• SDK の機能やベスト プラクティスに関する質問や新機能の要望は、GeoNet ArcGIS Pro SDK Group をご利用ください。

主なPro SDK の学習リソースは以下の通りです。

• Pro SDK Documentation - これは、あなたが現在ご覧になっているサイトです。目次(TOC)を参照して、多くの ProConcept および ProGuide の基礎となるドキュメント、コードスニペット、リソースリンクを参照してください

• Pro SDK Tutorials - Pro SDK のチュートリアルでは、コードサンプルを使ってアドインの構築を始めるための簡単なウォークスルー形式を提供しています。

• Community Samples – サンプルは、フレームワーク、コンテンツ、編集、ジオデータベース、地図探索など、Pro の機能領域ごとに分類されています。また、サンプルで使用するためのsample dataset もダウンロードしてください。サンプルを使い始める際の参考になるガイドがあります here。

• Pro SDK Snippets – これはPro の機能領域でもあるコードスニペット（現在のgithub wikiでは）の完全なリストです。

• FAQ – “Migration from 10x” を必ず確認してください。

• GeoNet ArcGIS Pro SDK Group – ここは、GeoNet の Pro SDK 開発者コミュニティスペースです。 以前の投稿から質問に対する回答を検索したり、ご自身の質問をここに投稿したりすることができます。

• API Reference – 完全な ArcGIS Pro API リファレンス。

• Videos – Esri Developer Summit および User Conference で行われた Pro SDK のテクニカル セッションの録画はすべて、Esri Events チャンネルの YouTube で公開されています。

• Formal Training – インストラクターによるトレーニングは、3 日間の Esri コース「Extending ArcGIS Pro with Add-Ins」で受けることができます。

• Blog posts – 上記の ArcGIS ブログと GeoNet グループには、有用な更新情報とリソースリンクが含まれています。

一般的には、上記の各サイトに詳しくなる時間を費やすことで、必要な具体的な情報を見つけることができるのに役立ちます。

ArcGIS Pro のトライアルが必要な場合は、free trial here で登録してから始めることができます。

フィードバックを提供する重要な機会は、Pro SDK で重要なプロトタイピングを実施した後です。 多くの SDK と同様に、ArcGIS Pro チームでは、ニーズや要件に関するお客様からのご意見に基づいて Pro SDK の開発を進めています。フィードバックは、ArcGIS Pro SDK Group on GeoNet を介して投稿してください。 また、Esri のアカウント マネージャに連絡してフィードバックを共有することもできます。

ArcGIS ソリューションを検索できる ArcGIS Marketplace についての最後のメモ。 このサイトでは、ArcGIS Pro アドイン のリスト、および プロバイダになる とリストの作成に関する役立つ情報が提供されるようになりました。Esri パートナーで、Pro アドインを ArcGIS Marketplace に掲載することに興味がある場合は、Esri パートナー マネージャに連絡して詳細を確認してください。