CData BizTalk Adapter for SharePoint Excel Services の Receive Location を構成する

Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
CData BizTalk Adapter for SharePoint Excel Services を使用して、BizTalk でSharePoint Excel Services のデータを取得します。Receive Location を使用して SQL コマンドを実行し、SharePoint Excel Services でのアクションを自動化します。

この記事の手順に従って、SharePoint Excel Services のデータに接続し、Static One-Way Receive Location を構成して、シンプルなテスト(SharePoint Excel Services のデータを取得して XML ファイルに書き込む)を実行できます。

Receive Location は SQL コマンドを実行し、結果を含む BizTalk メッセージを作成できます。Updategram コマンドを実行する場合は、Send Port を使用してください。

Receive Port の作成

アプリケーションに Receive Location を追加するには、まず Receive Port を追加する必要があります。Receive Port は複数の Receive Location からデータを受信できます。

  1. まだ行っていない場合は、BizTalk Administration Console でアプリケーションを開きます。
  2. アプリケーション内で、Receive Ports を右クリックし、New -> Static One-Way Receive Port をクリックします。Receive Port Properties ダイアログが表示されます。
  3. Name メニューで、Receive Port の名前を入力します。

Receive Location の作成

Receive Port を作成したら、Receive Location を作成し、SharePoint Excel Services アダプターをトランスポートタイプとして使用するよう構成します。

  1. Receive Locations を右クリックし、New -> One-Way Receive Location をクリックします。
  2. 新しい Receive Location がメンバーとなる適切な Receive Port を選択します。Receive Location Properties ダイアログが表示されます。
  3. Name メニューで、Receive Location の名前を入力します。
  4. Receive Location プロパティで、Transport Type メニューから CData.ExcelServices を選択します。
  5. Receive pipeline メニューで、デフォルトオプションの PassThruReceive を選択します。

アダプターの構成

Transport Properties ダイアログで、アダプターが実行するコマンドを指定します。

  1. Receive Location プロパティで、Configure をクリックします。アダプターの Transport Properties ダイアログが表示されます。
  2. SQL Command プロパティに、コマンドを入力します。この例では
    SELECT Name, AnnualRevenue FROM Account
    を使用します。
利用可能なアダプター構成プロパティについては、"Adapter Configuration" の章を参照してください。

接続文字列の構成

Connection String Options ダイアログで、認証情報やその他の接続プロパティを設定します。

  1. Receive Location プロパティで、Configure をクリックします。アダプタープロパティダイアログが表示されます。
  2. Connection String プロパティのボタンをクリックします。
  3. Connection String プロパティのボックスをクリックします。Connection String Options ダイアログが表示されます。
  4. 接続プロパティを入力します。一般的な接続文字列は以下のとおりです:
    URL=https://myorg.sharepoint.com;[email protected];Password=password;File=Book1.xlsx;
    

    ワークブックへの接続

    どちらのSharePoint エディションをお使いでも、File を Excel ワークブックに設定してください。このパスは以下のプロパティからの相対パスになります。

    • Library:デフォルトではShared Documents ライブラリが使用されます。このプロパティを使って、組織内の別のドキュメントライブラリを指定してみてください。例えば、OneDrive for Business に接続する場合は、このプロパティを"Documents" に設定します。
    • Folder:このプロパティを使って、ライブラリ内のサブフォルダへのパスを指定できます。パスはLibrary で指定されたライブラリ名に関連します。

    テーブルとしてのスプレッドシートデータへの接続

    CData 製品では、基底API で利用可能なオブジェクトに基づいて、使用可能なテーブルを検出していきます。

    API では異なるAPI オブジェクトを表示します。スプレッドシートの構成とSharePoint のバージョンに基づいてAPI を選択しましょう。

    • OData: OData API を使用すると、Excel で[挿入]->[テーブル]をクリックして作成されたExcel テーブルオブジェクト(範囲やスプレッドシートではありません)から定義されたテーブルにアクセスできます。OData API に接続する際、ワークブックにテーブルオブジェクトが定義されていない場合は、CData 製品がテーブルを返さないことがあります。テーブルとしてスプレッドシートまたは範囲に接続するには、UseRESTAPI をtrue に設定してください。
    • REST: REST API を使用すると、Excel テーブルオブジェクト、範囲、およびスプレッドシートから定義されたテーブルへアクセスできます。これがデフォルトの API です。範囲およびスプレッドシートから多数の行をリクエストすることは REST API によって制限されており、CData 製品では返される行数をデフォルトで 100 に制限しています。また CData 製品では、デフォルトで1行目からカラム名を検出します。これを無効にするには、Header を設定してください。

    DefineTables を追加設定すると、Excel の範囲の構文を使用して、範囲に基づいてテーブルを定義できます。大きすぎる範囲は、API によって制限されます。

    SharePoint オンプレミスへの接続

    URL をサーバー名もしくはIP アドレスに設定しましょう。さらに、SharePointVersion と認証値を設定します。

    SharePoint OnPremises を認証するには、AuthScheme を認証タイプに設定し、必要に応じてUserPassword を設定してください。

    Note:SharePoint On-Premises 2010 に接続する場合は、 UseRESTAPI をtrue に設定する必要があります。

      Windows(NTLM)

      最も一般的な認証タイプです。CData 製品では NTLM をデフォルトとして使用するよう事前設定されています。Windows のUserPassword を設定して接続してください。

      その他の認証方法については、ヘルプドキュメントの「はじめに」をご覧ください。

  5. Test Connection をクリックして、接続値を確認し接続をテストします。

各種プロパティとその機能の説明については、ヘルプドキュメントを参照してください。

Send Port を使用してデータを XML ファイルに書き込む

これで Static One-Way Receive Location を Send Port と共に使用する準備が整いました。Receive Location が作成した BizTalk メッセージには Send Port を関連付ける必要があります。データをファイルに書き込むには、File Send Port を作成します。

  1. BizTalk Administration コンソールで、Send Ports -> New -> Static One-Way Send Port を右クリックします。
  2. 構成ウィンドウの上部に Send Port の名前を入力し、Type メニューから FILE を選択します。

  3. 宛先フォルダを構成します。これがディスク上にファイルが作成される場所になります。
  4. ファイル名には、マクロを使用してファイルが作成された日付を簡単に識別できます。デフォルトでは %MessageId%.xml が使用されます。ただし、これはランダムに生成された BizTalk ID であるため、ユーザーフレンドリーな名前ではありません。Account_yyyy-MM-dd.xml 形式のファイルを作成するには、Account_%Date%.xml と入力します。

    :マクロの詳細については、ヘルプドキュメントの BizTalk Configuration セクションを参照してください。

  5. OK をクリックします。URI フィールドに値が入力されます。
  6. Send Port の構成画面の左側で Filters をクリックします。
  7. 以下のプロパティを設定します:
    Property:メニューから "BTS.InboundTransportLocation" を選択します。
    Operator:メニューから "==" を選択します。
    Value:Receive Location の URI を入力します。URI は Receive Location プロパティに表示されています。

これで、Send Port を使用して Receive Location から送信されたファイルを書き込めます。

Location と Port を Enlist および Enable する

最後のステップは、Send Port を Enlist し、Receive Location を Enable することです。Send Port を右クリックして Enlist をクリックします。次に、Receive Location を右クリックして Enable をクリックします。

:Receive Location は最後に Enable してください。これにより、ファイルが Send Port によって確実に書き込み用にピックアップされます。

トラブルシューティング

エラーが発生しているかどうかを確認するには、Administration Console のナビゲーションツリーで "Event Viewer (Local)" を展開します。Windows Logs を展開し、Applications をクリックします。

ログにはシステム上のすべてのアプリケーションのエラーメッセージが含まれるため、エラーメッセージのソースが "CData BizTalk SharePoint Excel Services Receive Adapter" であることを確認することが重要です。エラーメッセージの詳細から、エラーが発生している理由がわかります。エラーの解決方法については、[email protected]/jp にお問い合わせください。

はじめる準備はできましたか?