Microsoft Dynamics 365 Online July 2017 Update: 新しい開発者ガイドの紹介
みなさん、こんにちは。
今回は、最新の Microsoft Dynamics 365 Online July 2017 Update (version 9.0) から提供されることになった
新しい開発者向けドキュメントについて紹介します。本記事の内容は、弊社が提供しているブログ Microsoft Dynamics 365 Team blog の記事を翻訳したものです。
情報元: What’s new for Customer Engagement developer documentation in version 9.0
====================================================
Dynamics 365(オンライン)、バージョン 9.0 のリリースでは、開発者のドキュメントに多くの変更があります。
- 新しい場所: https://docs.microsoft.com/dynamics365/customer-engagement/developer/
- 新しい名前: 開発者ガイド (Developer Guide)
- SDK ダウンロードは不要
- 概念と参照コンテンツの融合
- Client API ドキュメント
- エンティティの詳細ドキュメント
新しい名前: 開発者ガイド (Developer Guide)
ソフトウェア開発キット(SDK)は、開発者がソフトウェアを構築するために使用するドキュメントとリソースの組み合わせです。 これまでは、「SDK」という用語を使用して Dynamics 365 Customer Engagement 開発者向けドキュメント、アセンブリ、ツール、およびオフライン(CHM)版のドキュメントを含むダウンロードパッケージを参照していました。このたび、すべてのドキュメントで使用する用語と一致するように、開発者向けドキュメントを開発者ガイドとして参照します。 これは、使用可能な API を使用してソフトウェアを作成する際に開発者をサポートするコンテンツのよりわかりやすい名前です。
SDK ダウンロードは不要
おそらく最大の変更点は、すべてのドキュメント、ツール、サンプルコードに対して、単一のダウンロードパッケージを提供していないことです。
今後は、すべてのパッケージを単一のパッケージで出荷するのではなく、必要に応じて個別のものをダウンロードできるように、選択するアプローチを提供していきます。
- 必要なアセンブリとツールを入手してください。 SDK アセンブリとツールは、NuGet を介してのみ配布されます。 NuGet からアセンブリとツールをダウンロードできるスクリプトを提供します。 NuGet SDKパッケージの場所とNuGetのダウンロードツールを参照してください。
- オフラインコンテンツのセルフサービスを提供します。 新しい docs.microsoft.com サイトでは、私たちのコンテンツを PDF 形式でダウンロードできるので、オフラインでドキュメントを読んで検索することができます。
- サンプルコードの可用性 サンプルコードはすべて msdn.microsoft.com またはGitHubで入手できます。code.msdn.microsoft.com サイトはサンプルコード用に設計されており、優れた使用方法を提供するとともに、使用法に関するより良い指標を提供しています。
- 必要な部分だけをダウンロードしてください。 ダウンロードパッケージに含まれているさまざまな資産は、個別のダウンロードとして入手できます。 このように、資産の 1 つを更新する必要がある場合、SDK パッケージ全体をリリースすることなく更新することができます。
概念と参照コンテンツの融合
以前のバージョンのドキュメンテーションでは、概念的な内容が最初に来て、続いてプログラミングの参考トピック(Microsoft Dynamics 365 プログラミング リファレンス)が続きました。 関連するリファレンスページにリンクされている概念的なページの間、あなたが読んでいたページのコンテキストを失う原因となりました。
docs.microsoft.com のすばらしい機能の1つは、参照コンテンツと概念コンテンツを一緒に表示する機能です。 これにより、関連概念コンテンツを最も関連性の高い参照コンテンツと結びつける機会が提供されます。 これにより、特定の API セットの概念情報と参照情報の融合が可能になります。
プログラミングリファレンスへのリンクは次のとおりです。
- Client API
- Deployment Service
- Online Admin API
- Organization Service
- Outlook Client
- Package Deployer
- Virtual Entities
- Web API
- Workflow
- Xrm.Tooling
Client API ドキュメント
クライアントスクリプトまたはクライアント API は、もともと CRM 2011 で導入されて以来、大きく成長しました。このリリースでは、各 API に専用のページを提供することで、個々の API の検索結果を向上させるためにコンテンツを再構成しました。 これは、発見可能性を向上させ、サンプルや新しい API が登場するにつれて、より多くの領域を拡大するのに役立ちます。
新しいドキュメントはこちら: Client scripting in Customer Engagement using JavaScript
開始に役立つ新しい情報が追加されました: Walkthrough: Write your first client script.
エンティティの詳細ドキュメント
長い間、選択されたエンティティに関する個々のトピックを記述しました。サポートされているメッセージのリストとともにエンティティと関係の概要を提供します。 しかし詳細については、別のツールを使用して組織のメタデータをブラウズするか、SDK パッケージの Excel スプレッドシートを参照するように言及しました。
このリリースでは、エンティティメタデータを活用して、システム内のほとんどのエンティティの参照ドキュメントと、すべてのプロパティ、属性、および関係の完全なリストを生成しています。 新しいエンティティリファレンスを参照してください。 これはまだ存在する Web API EntityType Reference に似ていますが、新しいエンティティリファレンスには、SDK アセンブリでプログラミングする際に使用される構造も反映されています。
エンティティ操作
エンティティ参照には、各エンティティに対して利用可能なすべての操作が一覧表示されます。 Web API または SDK アセンブリを使用して実行できる操作を説明するリンクがあります。 ここでは、Accountエンティティメッセージの例を見ることができます。
共通ソリューションのエンティティ
このエンティティ参照には、システム内にあるカスタムエンティティを含めることはできません。 しかし、Dynamics 365 で利用可能な以下の一般的なアドオンソリューションによって追加されたエンティティ、属性、および関係が含まれています。
- Connected Field Service for Microsoft Dynamics 365
- Field Service
- IoT Connector for Microsoft Dynamics 365
- Project Service Automation
- Unified Resource Scheduling
これらのソリューションには、名前が msdyn_ で始まるエンティティがあります。 たとえば、msdyn_approvalエンティティ は Project Service Automation Solution によって追加されます。
これらの変更が役に立つものになると幸いです。ご意見をお聞きしたいと思います。 問題が見つかった場合や、開発者ガイドの改善のアイデアがある場合は、各ページの下部にあるコメント機能を使用してお知らせください。 Dynamics 365 の機能に関するフィードバックを提供するには、https://ideas.dynamics.com/ideas/ でアイデアを追加または投票してください。
====================================================
まとめ
いかがでしょうか。新しい開発者ガイドをお使い皆様のご意見をhttps://ideas.dynamics.com/ideas/ へ送信ください。
本記事の中で出てきた、新しいアセンブリやツールの取得方法、開発者ガイドのダウンロード方法、およびサンプルコードの取得方法については別の記事で紹介したいと思います。
- プレミアフィールドエンジニアリング 河野 高也
※本情報の内容(添付文書、リンク先などを含む)は、作成日時点でのものであり、予告なく変更される場合があります