Shopify のデータを使ったCrystal Reports を発行

加藤龍彦
加藤龍彦
デジタルマーケティング
Report Wizard と標準のADO.NET を使用して最新のShopify のデータを使用したレポートを作成。

CData ADO.NET Provider for Shopify は、Crystal Reports for Visual Studio 開発環境に統合されています。標準のADO.NET コンポーネントを使用して、SQL Server と同じようにレポートを作成でき、さらにShopify とリアルタイムで連携できます。この記事では、開いたときに更新されるレポートにShopify のデータを追加するために必要な3つのステップを完了する方法を説明します。

Note:このチュートリアルを実行するには、Crystal Reports とVisual Studio のデベロッパーバージョンをインストールしてください。

Crystal Reports アプリケーションを作成する

この記事を実行するにはVisual Studio Crystal Reports プロジェクトが必要になります。この記事では、WPF アプリケーションにレポートを追加します。「File」->「New Project」とクリックし、Crystal Reports WPF Application テンプレートを選択することで、作成できます。表示されるウィザードで空のレポートを作成するオプションを選択します。

Shopify に接続する

Server Explorer からShopify のADO.NET データソースを作成すると、Crystal Reports ウィザードおよびCrystal Reports Designer で使用できるDataSet を簡単に作成できます。Server Explorer でShopify のデータを操作するためのガイドは、ヘルプドキュメントの「はじめに」の章を参照してください。

それでは、Shopify への接続・認証について説明していきましょう。Shopify では、アクセストークンとOAuth の2つの接続方法をサポートしています。

アクセストークンによる接続

アクセストークン経由の接続には、以下の2つのステップが必要です。

  1. Shopify の管理画面でアクセストークンを作成
  2. アクセストークンを使用して認証

アクセストークンの作成

まず、アプリを登録してアクセストークンを取得してみましょう。手順は以下のとおりです。

  1. 管理画面からShopify にログインし、AppsApps and sales channels に進みます
  2. Develop apps をクリックしてCreate an app を選択します
  3. Overview タブのConfiguration で、Admin API integration をクリックし、アプリに許可するストアのアクセス権を選択してください。CData製品が必要とするAdmin API 権限については、 href="/kb/help/" target="_blank">ヘルプドキュメントの「はじめに」セクションをご確認ください
  4. Save をクリックします
  5. Overview タブのConfiguration で、Storefront API integration をクリックし、アプリに許可するストアのアクセス権を選択します。CData製品が必要とするStorefront API 権限は以下のとおりです:
    • unauthenticated_read_content
  6. Save をクリックします
  7. API Credentials を選択します
  8. "Access tokens" の下でInstall app をクリックします。これでアクセストークンが作成されます
  9. Admin API Access token のアクセストークンをコピーします。注意:トークンの公開およびコピーは1回のみ可能ですので、必ず保存してください

アクセストークンによる認証

続いて、アクセストークンで認証するには、以下のプロパティを設定してください。

  • AuthSchemeAccessToken に設定
  • AccessToken:カスタムアプリからコピーしたアクセストークンの値に設定

OAuth 認証を介した接続については、ヘルプドキュメントの「OAuth 認証の使用」をご確認ください。

接続を構成する際に、Max Rows 接続プロパティも設定できます。これにより返される行数が制限されるため、レポートやビジュアライゼーションをデザインするときのパフォーマンスを向上させることができます。

DataSet を作成する

以下のステップに従ってVisual Studio ADO.NET DataSet Designer を使用し、ADO.NET DataSet オブジェクトを作成します。Crystal Reports はShopify テーブルのメタデータを含むDataSet オブジェクトにバインドします。またこのアプローチでは、App.config に接続文字列が追加されることに注意してください。後にこの接続文字列を使用してデータをレポートにロードします。

  1. Solution Explorer でプロジェクトを右クリックし、「Add」->「New Item」をクリックします。
  2. DataSet を選択します。DataSet Designer が表示されます。
  3. Server Explorer からDataSet Designer にテーブルをドラッグ & ドロップします。この記事ではCustomers テーブルを使用します。

Shopify フィールドをレポートに追加する

以下のステップに従って、DataSet からレポートにカラムを追加します。

  1. Solution Explorer で.rpt ファイルをダブルクリックし、Crystal Reports Designer を開きます。
  2. デザイナーを右クリックし、「Database」->「Database Expert」と進みます。
  3. Project Folder とADO.NET DataSets ノードを展開し、作成したDataSet を「Selected Tables」ボックスにドラッグします。これで、Field Explorer からフィールドにアクセスできます。
  4. Field Explorer からレポートの「Details」セクションまたは別のセクションにフィールドをドラッグ & ドロップします。
DataSet columns in a report.(Salesforce is shown.)

レポートにデータをロードする

メタデータのみを含むDataSet を作成したら、実際のデータを含むDataTable を作成する必要があります。ShopifyDataAdapter を使用して、SQL クエリの結果をDataTable に入力できます。

  1. System.Configuration.dll への参照をプロジェクトに追加して、App.config から接続文字列を使用できるようにします。
  2. App.config で.NET 4.0 を使用する場合にCrystal Reports との互換性を保つため、次のコードを設定ノードに追加します。
    
      <startup useLegacyV2RuntimeActivationPolicy="true">
        <supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.0"/>
      </startup>
    
  3. Window.xaml.cs ファイルに以下の参照を追加します。

    using System.Configuration;
    using CrystalDecisions.CrystalReports.Engine;
    using CrystalDecisions.Shared;
    using System.Data.CData.Shopify;
    using System.Data;
    
  4. 以下のWindow_Loaded メソッドをWindow.xaml.cs に追加し、DataTable を返すSQL クエリを実行します。最低でも、レポートで使用されているカラムと同じカラムは選択する必要があることに注意してください。

    private void Window_Loaded(object sender, RoutedEventArgs e) {
      ReportDocument report = new ReportDocument();
      report.Load("../../CrystalReport1.rpt");
     var connectionString = ConfigurationManager.ConnectionStrings["MyAppConfigConnectionStringName"].ConnectionString;
      using (ShopifyConnection connection = new ShopifyConnection(connectionString)) {
        ShopifyDataAdapter dataAdapter = new ShopifyDataAdapter(
        "SELECT FirstName, Id FROM Customers", connection);
         DataSet set = new DataSet("_set");
         DataTable table = set.Tables.Add("_table");
         dataAdapter.Fill(table);
         report.SetDataSource(table);
      }
      reportViewer.ViewerCore.ReportSource = report;
    }
    
  5. Window.xaml ファイルでLoaded イベントを追加し、Window タグを以下のようにします。

    
    <Window x:Class="CrystalReportWpfApplication4.Window1"
            xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
            xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
            xmlns:cr="clr-namespace:SAPBusinessObjects.WPF.Viewer;assembly=SAPBusinessObjects.WPF.Viewer"
            alt="WPF Crystal Report Viewer" Height="600" Width="800" Loaded="Window_Loaded">
            ...
    </Window>
    
  6. レポートを実行します。レポートが読み込まれると、プロバイダはクエリを実行して現在のデータを取得します。 A report that loads the current data when opened.(Salesforce is shown.)

Shopify のデータのチャートを作成する

Chart Expert などのエキスパートとともにDataSet を使用することもできます。

  1. Crystal Reports Designer を右クリックして「Insert」->「Chart」とクリックします。
  2. 「Report Header」または「Report Footer」セクションを選択します。Chart Expert が表示されます。
  3. 「Type」タブでチャートタイプを選択します。この記事では、サイドバイサイドの棒グラフを使用します。
  4. 「Data」タブでx 軸のカラムと条件を選択します。例えば、DataSet ノードのFirstName カラムを「On Change Of」メニューの下のボックスにドラッグします。
  5. x 軸のカラムを選択し、「TopN」ボタンと「Order」ボタンをクリックして並べ替えと制限を構成します。
  6. y 軸のカラムとサマリー操作を選択します。例えば、DataSet ノードのId カラムを「Show Values」ボックスにドラッグします。
  7. レポートを実行します。

Crystal Reports は、Shopify API などに対してGROUP BY を実行する代わりに、DataTable にロード済みのデータに対して集計を実行することに注意してください。これは、レポート作成ウィザードにも当てはまります。

別のDataSet を作成し、他のクエリを入力することで、Shopify に対して実行されるクエリをより細かく制御できます。ドライバのSQL エンジンの詳細については、ヘルプドキュメントを参照してください。

DataSet columns to be added to a chart.(Salesforce is shown.)

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

Shopify Data Provider の無料トライアルをダウンロードしてお試しください:

 ダウンロード

詳細:

Shopify Icon Shopify ADO.NET Provider お問い合わせ

Shopify EC データに連携する.NET アプリケーションを素早く、簡単に開発できる便利なドライバー。