Business Connectivity Services を使用して Outlook 中間宣言型ソリューションを作成する

[アーティクル]
09/18/2014

最終更新日: 2011年8月22日

適用対象: SharePoint Server 2010

この記事の内容
シンプルと宣言型の Outlook ソリューションの機能
実行できるカスタマイズの種類
中級の宣言型 Outlook ソリューションの作成方法
中級の宣言型 Outlook ソリューションのしくみ
中級の宣言型 Outlook ソリューションのコンポーネント
推奨する宣言型 Outlook ソリューションの作成方法
中級の宣言型 Outlook ソリューションを作成するためのツール

Microsoft Business Connectivity Services (BCS) を使用すれば、インフォメーションワーカーは、外部リストをオフラインにすることによって、Microsoft Outlook 2010 内の外部コンテンツタイプ (顧客、従業員、注文など) を標準の Outlook アイテムの種類 (連絡先アイテム、タスク、投稿、予定など) として表示できます。このようなソリューションは、シンプルソリューションと呼ばれ、シンプルソリューションは、Microsoft Office 2010 と Microsoft SharePoint 2010 の標準機能に依存します。

ただし、シンプルソリューションには、カスタマイズのサポートがほとんどないか、まったくありません。また、Business Connectivity Services には、シンプルソリューション用の拡張可能なプログラミングモデルが用意されていません。ただし、Outlook でカスタマイズしたソリューションを作成する必要がある場合は、中級の宣言型 Outlook ソリューションを作成できます。この種類のソリューションは、このリリースの Business Connectivity Services の Outlook 2010 に固有のソリューションです。

シンプルと宣言型の Outlook ソリューションの機能

次の表に、シンプルと中級の宣言型の Outlook ソリューションの機能を示します。

表 1. シンプルと宣言型の Outlook ソリューション

機能	シンプル Outlook ソリューション	中級の宣言型 Outlook ソリューション
ソリューション内の外部コンテンツタイプの数	1 つ。	複数の外部コンテンツタイプを入れることができます。
アクションとリボン	Business Connectivity Services によって提供される既定のリボンとアクション。	カスタムリボンとアクションを入れることができます。
関連する外部コンテンツタイプの表示	作業ウィンドウに外部コンテンツタイプの関連情報を表示する方法はありません。ただし、関連付けを定義した場合、Business Connectivity Services は、接続先の外部コンテンツタイプにあるソース外部アイテムをユーザーが選択できる外部アイテムピッカーを表示します。	カスタムリボンと作業ウィンドウを定義すれば、関連情報を表示できます。
Outlook のビューのカスタマイズ	ユーザーは、Outlook のビューをカスタマイズして、ビュー定義をエクスポートできます。	開発者は、カスタムビュー定義をソリューションに追加して、そのソリューションをインストールしたすべてのユーザーについて、既定で外部データがカスタマイズしたビューに表示されるようにすることができます。
フォーム領域のカスタマイズ	Business Connectivity Services によって提供される既定のフォーム領域には、Outlook コントロールしか入れることができません。このフォーム領域をカスタマイズして、Outlook で外部データを表示するための外部データパーツを入れることはできません。	Outlook で外部データを表示するための外部データパーツを含んだフォーム領域を作成し、カスタマイズできます。

実行できるカスタマイズの種類

中級の宣言型 Outlook ソリューションを使用すると、次の操作を実行できます。

Outlook の作業ウィンドウに標準またはカスタム外部データパーツを表示 作業ウィンドウで、外部データパーツ (Business Connectivity Services によって提供される外部データパーツ、または開発者が作成したカスタム外部データパーツ) をホストすることによって、カスタム作業ウィンドウを定義して、外部データをユーザーに表示できます。
カスタムリボンとアクションを追加 リボンファイルを定義し、リボンに、または、コードをトリガーするか、パラメーターとして Business Data Connectivity (BDC) service フィールドを取ることができる指定した URL を参照するブラウザーを起動する外部データパーツに表示されるカスタムアクションを定義できます。アクションは、URL ベースにするか、開発者が作成したコードアクションを参照できます。
Outlook のカスタムビュー定義を作成 基本の Outlook 要素をはじめとして、外部データのフォルダーに対して表示されるビューをカスタマイズできます。Business Connectivity Services には、カスタマイズしたビューを Outlook View Definition (.ovd) ファイルとして保存するためのコマンドが用意されているので、宣言型ソリューションをインストールしたユーザーはカスタマイズしたビューを使用できます。
Outlook で外部データを表示するための Outlook フォーム領域をカスタマイズ Outlook で新しいフォーム領域を設計することによって、外部データを表示するためのカスタマイズした Outlook フォーム領域を作成できます。

中級の宣言型 Outlook ソリューションの作成方法

中間宣言型 Outlook ソリューションを作成するには、BDC モデル、ソリューションマニフェスト (OIR.config)、各外部コンテンツタイプのサブスクリプションを作成し、必要に応じてカスタムリボン、1 つ以上の作業ウィンドウレイアウト、カスタムフォーム領域、カスタム Outlook ビュー定義を作成します。その後、BCS ソリューションパッケージツール (英語)を使用して、これらのソリューションアーティファクトを 1 つの Visual Studio 2010 の Office 開発ツール ClickOnce パッケージにパッケージ化できます。ソリューションアーティファクトをパッケージ化すると、ユーザーはそのパッケージを Outlook にインストールできるようになります。

また、最初に BDC モデルを作成し、次に BCS Artifact Generator ツール (英語)を使用して、BDC モデルに基づくアーティファクトファイルを生成できます。アーティファクトを生成したら、BDC ソリューションパッケージツール (英語)を使用して、ソリューションを Visual Studio 2010 の Office 開発ツール ClickOnce パッケージにパッケージ化します。

中級の宣言型 Outlook ソリューションのしくみ

中級の宣言型 Outlook ソリューションは、Business Connectivity Services Client Runtime を利用して、ソリューションアーティファクトを解釈し、表示する外部データ、外部データを表示する場所、表示方法、およびユーザーが実行できる外部データの操作をランタイムに指示します。クライアント上の Business Connectivity Services クライアントキャッシュでは、メタデータと、ユーザーに関係するキャッシュに格納された外部コンテンツタイプを管理します。宣言型ソリューションでは、実行時に Outlook 内でソリューションアーティファクトに定義されている要素を表す標準の Business Connectivity ServicesOutlook アドインを使用します。このアーキテクチャにより、経験豊かなユーザーと開発者は、一般的なタスクと繰り返し行うタスクを実行するために Outlook と Business Connectivity Services API を対話操作するという複雑な作業を管理せずに、ビジネスニーズの解決に集中できます。

中級の宣言型 Outlook ソリューションのコンポーネント

表 2 では、中級の宣言型 Outlook ソリューションの典型的なコンポーネント、ソリューションで使用できる各コンポーネントの数、および各コンポーネントの内容を説明します。

表 2. 中級の宣言型 Outlook ソリューションのコンポーネント

コンポーネント	ファイル名	使用できる数	説明
BDC モデル	名前は metadata.bdcm または metadata.xml にする必要があります。	ソリューションごとに 1 つ。必須。	すべての外部コンテンツタイプとその関連付けを定義します。
キャッシュサブスクリプションファイル	名前は Subscription.xml にする必要があります。たとえば、「CustomerSubscription.xml、OrderSubscription.xml*」という名前を付けます。	ソリューションの各外部コンテンツタイプに 1 つ。必須。	Business Connectivity Services クライアントキャッシュを設定する方法を定義します。
Outlook View Definition ファイル	*.ovd	ゼロ以上。	Outlook のカスタムビューを定義します。
Outlook Form Storage ファイル	*.ofs	ゼロ以上。	Outlook フォーム領域ファイル。
フォーム領域マニフェスト	*.manifest.xml	ゼロ以上。ただし、フォーム領域 (*.ofs) が存在する場合は必須。	読み込むフォーム領域ファイルを Outlook に指示するマニフェストファイル。
ソリューションマニフェスト	OIR.config にする必要があります。	ソリューションごとに 1 つ。必須。	ソリューションを説明するソリューションマニフェスト。
リボンファイル	*.xml	ソリューションごとに 1 つ。	Outlook のリボンファイル。
レイアウトファイル	*.xml	ゼロ以上。作業ウィンドウごとに 1 つ。	作業ウィンドウに表示するコントロール、コントロールに設定する必要がある外部コンテンツタイプ、およびコントロールが表示するその他のカスタムプロパティを定義します。
カスタムアセンブリ	*.dll	ゼロ以上。	ソリューションで、カスタムコードアクション、カスタム外部データパーツ、カスタムリボンマネージャーなど、再利用可能な Business Connectivity Services コードコンポーネントを参照している場合。
アイコン	.ico または .png、*.jpg など、グラフィックファイル形式	ゼロ以上。	Outlook ユーザーインターフェイスに表示されます。
InfoPath フォーム	*.xsn	ゼロ以上。	Microsoft InfoPath フォームに外部データを表示するために使用されます。

推奨する宣言型 Outlook ソリューションの作成方法

中間宣言型 Outlook ソリューションを作成するときは、必要なソリューションアーティファクトファイルを生成し、アーティファクトを ClickOnce パッケージにパッケージ化します。以下の方法で、ソリューションアーティファクトファイルを作成できます。

ツールを使用する方法 - BCS Artifact Generator ツール (英語)を使用して、XML アーティファクトファイルを生成できます。このツールでは、最初に SharePoint Designer または XML エディターを使用して作成した BDC モデルファイルが必要です。
手動による方法 - XML エディターを使用して、XML アーティファクトファイルを手動で作成できます。

次の方法では、Business Connectivity Services を使用して中級の宣言型 Outlook ソリューションを作成します。

ソリューションで使用する外部コンテンツタイプとその関連付けを定義する BDC モデルを作成し、metadata.bdcm として保存します (「手順 1: BDC モデルの作成 (Metadata.bdcm)」を参照してください)。ここでは、すべての XML を最初から記述しなくてもソリューションの BDC モデルを作成できる方法についても説明します。
この SDK に用意されているテンプレートを使用して、ソリューションの各外部コンテンツタイプのキャッシュサブスクリプションを作成し、たとえば、OrderSubscription.xml、CustomerSubscription.xml のように "<ExternalContentTypeName>Subscription.xml" の形式で XML ファイルとして保存します。「手順 2: キャッシュサブスクリプションの作成 (*Subscription.xml)」を参照してください。
BCS Artifact Generator ツール (英語)、またはこの SDK に用意されているテンプレートを使用して、一般的なソリューションの設定、Outlook フォルダーの情報、およびプロパティマッピングを提供するソリューションマニフェスト (OIR.config) を作成します。Business Connectivity Services によって、Outlook プロパティにマッピングできないプロパティを表示するためのフォーム領域が自動生成されます。「手順 3: ソリューションマニフェストファイル (Oir.config) を作成する」を参照してください。
BCS ソリューションパッケージツール (英語)を使用してアーティファクトを 1 つの ClickOnce パッケージにパッケージ化します。そのパッケージを Outlook にインストールし、ソリューションをテストします。「手順 4: 宣言型 Outlook ソリューションをパッケージ化して展開する」を参照してください。
基本機能が予想どおりに動作する場合は、必要に応じて次の 1 つ以上のカスタマイズを使用してソリューションを拡張します。
1. カスタム Outlook フォーム領域 (*.ofs) を作成します。「手順 5 (オプション): Outlook フォーム領域 (*.ofs) とフォーム領域マニフェスト (FormRegionManifest.xml) を作成する」を参照してください。
2. カスタム Outlook View Definition (*.ovd) を作成します。「手順 6 (オプション): ユーザー設定の Outlook ビュー定義 (*.ovd) を作成する」を参照してください。
3. 作業ウィンドウのレイアウト (*.xml) を作成します。「手順 7 (オプション): Outlook 作業ウィンドウ (Layout.xml) で外部データパーツを表示する」を参照してください。
4. カスタムリボンとアクション (ribbon.xml、OIR.config) を定義します。「手順 8 (オプション): リボンおよびアクションを定義する (Ribbon.xml)」を参照してください。
アーティファクトをパッケージ化し、そのパッケージを Outlook に展開し、ソリューションを再テストします。

中級の宣言型 Outlook ソリューションを作成するためのツール

SharePoint Designer (BDC モデル用)、Outlook (カスタマイズしたフォーム領域とビュー定義用) など、さまざまなツールを使用して中間宣言型 Outlook ソリューションをビルドできます。Outlook 宣言型ソリューションに必要な XML ファイルを作成するときは、XML エディターを使用できます。Visual Studio では IntelliSense を使用できます。これは、XML ファイルを作成するときに役立ちます。手始めとして、サンプルとテンプレートがこのチュートリアルに用意されています。BCS Artifact Generator ツール (英語) を使用して、SharePoint Designer または XML エディターを使用して作成した BDC モデル以外の XML アーティファクトを生成することもできます。

BCS ソリューションパッケージツール (英語)を使用して、Outlook 宣言型ソリューションの ClickOnce パッケージを生成できます。