CData PowerShell Cmdlets for SharePoint Excel Services はじめに：インストールから接続まで

Somya Sharma
Somya Sharma
Technical Marketing Engineer
Excel SharePoint Services PowerShell Cmdlets のインストール、ライセンス認証、接続設定の完全ガイドです。

このガイドでは、Excel SharePoint Services PowerShell Cmdlets の使い方を詳しく解説します。Cmdlet のインストール、初回接続の設定、クエリの実行、そして PowerShell で SharePoint Excel Services のデータ を操作するための次のステップをご紹介します。

インストールとライセンス認証

システム要件

CData PowerShell Cmdlets は、PowerShell が動作するあらゆる環境で実行できます。

Windows

  • Windows 10/11
  • Windows Server 2016 以降
  • PowerShell 5.1 または PowerShell 7 以降

macOS / Linux

  • PowerShell 7 以降
  • 追加のシステムライブラリは不要
  • アーキテクチャ固有のインストーラーは不要

Cmdlet のインストール

CData Cmdlets は PowerShell Gallery から配布されており、プラットフォーム間で簡単かつ一貫したインストールプロセスを実現しています。

インストール手順

  1. 管理者モードで PowerShell を開きます
  2. 以下のコマンドを実行して Cmdlet モジュールをインストールします： 
    Install-Module ExcelServicesCmdlets -Repository PSGallery -Force

    このコマンドは：

    • 公式の PowerShell Gallery からモジュールをダウンロードします
    • PowerShell 環境にインストールします
    • すべての Cmdlet をすぐに使用できるように登録します

モジュールの確認

インストールを確認するには： 

Get-Module -ListAvailable "*ExcelServices*"

ライセンス認証

Cmdlets は試用版と正規ライセンスの両方の認証に対応しています。

試用版ライセンス

試用版の認証は自動的に行われ、キーは不要です。インストール後すぐに Cmdlet を使用できます。

正規ライセンスの認証

正規ライセンスを購入された場合、CData Orders チームからプロダクトキーを受け取ります。

ライセンスの認証

以下のコマンドを実行します：

Set-ModuleLicense ""

認証が成功すると、確認メッセージが表示されます。

ライセンスに関するよくある質問

ライセンスは複数のマシンで使用できますか？

サブスクリプションプランによります。注文確認メールを確認するか、[email protected] までお問い合わせください。

ライセンスキーを紛失しました。どうすればよいですか？

注文番号を添えて [email protected] までメールでお問い合わせください。

ライセンスを別のマシンに移行できますか？

以下のリンクからライセンス移行リクエストを送信してください：https://www.cdata.com/lic/transfer/

ライセンスはどこで管理できますか？

CData カスタマーポータルにアクセスしてください：https://portal.cdata.com/

接続設定

モジュールがインストールされ、ライセンスが認証されたら、

Connect-SharePoint Excel Services cmdlet
を使用して SharePoint Excel Services への接続を確立できます。

必要な接続プロパティを取得したら、PowerShell で SharePoint Excel Services のデータ にアクセスしてレプリケーションを準備するには、基本的に 4 つのステップがあります。

ワークブックへの接続

どちらの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 を認証タイプに設定し、必要に応じてUser と Password を設定してください。

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

    Windows（NTLM）

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

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

    SharePoint Excel Services のデータ の取得

    1. モジュールをインストールします： 

      Install-Module ExcelServicesCmdlets

    2. SharePoint Excel Services に接続します： 

        $excelservices = Connect-ExcelServices  -URL $URL -User $User -Password $Password -File $File

    PowerShell での SharePoint Excel Services のデータ のクエリ

    接続後、標準 SQL のようなコマンドを使用してデータをクエリできます。

    クエリ例：

    $results = Select-ExcelServices `
    -Connection $conn `
    -Table "Account" `
    -Columns "Name,AnnualRevenue" `
    -Where "Name != ''"

    結果を表示します：

    $results

    これで PowerShell から SharePoint Excel Services のデータ にアクセスできるようになりました。

    よくある問題

    認証エラー

    解決策： ユーザー名、パスワード、セキュリティトークンを確認してください。OAuth アプリケーションの場合、アプリケーションのセキュリティ設定で CData を認可する必要がある場合があります。認可のサポートについては [email protected] までお問い合わせください。

    ネットワークまたはプロキシの問題

    解決策： ファイアウォール設定とアウトバウンドアクセスを確認してください。ほとんどのクラウドアプリケーションはポート 443 を使用します。

    Cmdlet が見つからない

    解決策： モジュールがインストールされていることを確認してください - 

    Get-Module -ListAvailable "*SharePoint Excel Services*"

    クエリが遅い

    解決策：

    • フィルターを追加してデータセットのサイズを削減してください
    • サポートされている場合は $Limit または $Top プロパティを使用してください
    • 最適化のサポートについては [email protected] までお問い合わせください

    接続に関するその他のトラブルシューティングについては、具体的なエラーメッセージを添えて [email protected] までお問い合わせください。

    次のステップ

    PowerShell Cmdlets のインストール、ライセンス認証、接続設定が完了しました。以下のシナリオを参考に、さらに活用してみてください：

    PowerShell記事タイトル
    Piping CmdletsPowerShell で SharePoint Excel Services のデータ を CSV にパイプする方法
    ReplicationPowerShell スクリプトで SharePoint Excel Services のデータ を MySQL にレプリケートする

    サポート

    ご不明な点がございましたら、お気軽にお問い合わせください：

    FAQ（PowerShell Cmdlets）

    インストールとライセンス

    • Cmdlet のインストールには管理者権限が必要ですか？

      • 必ずしも必要ではありません。

      • Windows PowerShell 5.1（Windows）：管理者権限が推奨されます。特にすべてのユーザー向けにモジュールをインストールする場合に必要です。
      • PowerShell 7 以降（Windows、macOS、Linux）：以下のコマンドを使用することで、管理者権限なしで現在のユーザー向けに Cmdlet をインストールできます： 
        Install-Module ExcelServicesCmdlets -Scope CurrentUser
    • インストーラーをダウンロードする必要がありますか？

      • CData PowerShell Cmdlets は PowerShell Gallery から配布されています。インストールは以下のコマンドで実行します：

      Install-Module ExcelServicesCmdlets -Repository PSGallery -Force

    接続

    • 同じデータソースの複数のアカウントに接続するにはどうすればよいですか？

      • 異なる認証プロパティを持つ個別の接続オブジェクトを作成します：

      $conn1 = Connect-ExcelServices -User User1 -Password Pwd1
      $conn2 = Connect-ExcelServices -User User2 -Password Pwd2
    • PowerShell Cmdlets には DSN が必要ですか？

      • Cmdlet は ODBC DSN を使用しません。すべての接続プロパティは 

      Connect-SharePoint Excel Services
      で直接渡されます。

    • プロキシサーバー経由で接続できますか？

      • 多くの Cmdlet は以下のようなプロキシプロパティをサポートしています：

      • ProxyServer
      • ProxyPort
      • ProxyUser
      • ProxyPassword

      データソース固有のヘルプドキュメントを参照してください。

    パフォーマンスとトラブルシューティング

    • クエリが遅いのはなぜですか？

      • よくある原因：

      • フィルターがない（WHERE 句がない）
      • 大量の結果セットを取得している
      • クラウド API からのレイテンシ
      • 増分戦略を使用していない

      以下をお試しください：

      • データをフィルタリングする（-Where パラメータ）
      • 必要なカラムのみを選択する
      • データソースの API スロットリング制限を確認する

      クエリ最適化のサポートについては [email protected] までお問い合わせください。

    • ログを有効にするにはどうすればよいですか？

      • 以下のコマンドでモジュールのログを有効にします：

      Set-ModuleLogging -Path "C:\logs\cdata.log" -Verbosity 3
      CData サポートと連携する際は、ログファイルを安全にアップロードしてください。

    • どのポートを開放する必要がありますか？

      • ほとんどのクラウドアプリケーション（Salesforce、HubSpot、Dynamics、Google API など）は HTTPS（443）を使用します。

      ソースが追加のポートを必要とする場合は、固有のドキュメントを確認するか、[email protected] までお問い合わせください。

    • コンテナ（Docker、Kubernetes）で Cmdlet を使用できますか？

      • コンテナに PowerShell 7 をインストールし、モジュールをインストールします：

      pwsh -Command "Install-Module ExcelServicesCmdlets -Force"
      その後、通常どおり認証を行います。

    一般

    • サポートされているすべての SQL/コマンド操作はどこで確認できますか？

      • 各 Cmdlet にはローカルにインストールされたヘルプドキュメントが含まれており、オンラインでも参照可能です：https://www.cdata.com/powershell/

    • PowerShell Cmdlets はどのくらいの頻度で更新されますか？

      • CData はメジャーアップデートを年次でリリースし、年間を通じて増分アップデートを行います。バージョンの入手可能性については、カスタマーポータルを確認するか、[email protected] までお問い合わせください。

    • コード例はどこで確認できますか？

      • すべての Cmdlet にはヘルプドキュメントに例が含まれており、多くのサービスのオンライン例も提供されています：https://www.cdata.com/powershell/ 例には以下が含まれます：

      • 基本的なクエリ
      • Insert/Update/Delete
      • OAuth フロー
      • ファイル操作
      • API 連携

    この FAQ で解決しない場合は、[email protected] までお問い合わせください。

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

SharePoint Excel Services Cmdlets の無料トライアルをダウンロードしてお試しください：

 ダウンロード

詳細：

SharePoint Excel Services Icon SharePoint Excel Services Cmdlets お問い合わせ

PowerShell Cmdlets は、SharePoint Excel Services へのリアルタイム連携機能を提供します。Cmdlets を使って、データに直接連携しDB と同感覚で扱うことができます。

この記事の内容

関連記事