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

加藤龍彦
デジタルマーケティング

Report Wizard と標準のADO.NET を使用して最新のSAP SuccessFactors のデータを使用したレポートを作成。

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

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

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

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

SAP SuccessFactors に接続する

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

SAP SuccessFactorsへの接続

それでは、SAP SuccessFactors に接続していきましょう。CData 製品は、デフォルトで有効になっているOData API を介してSAP SuccessFactors と通信します。追加の権限が必要な場合は、SAP サポートサイトをご確認ください。

認証方法として、Azure AD 認証、SAP IAS 認証、OAuth 認証（推奨）、Basic 認証（非推奨）のいずれかを使用してSAP SuccessFactors に認証できます。

必要な接続プロパティ

選択したAuthScheme に関わらず、SAP SuccessFactors 環境を識別するために以下の接続プロパティを設定しましょう。

URL：SuccessFactors をホストするサーバーのURL
CompanyId：SAP SuccessFactors テナントに割り当てられた一意の識別子。この値はAPI 認証に必要で、組織固有のものです

OAuth 認証

SAP SuccessFactors では、OAuth 認証を2種類のグラント種別でサポートしています。

SAP SuccessFactors LMS インスタンスのクライアントグラント種別
SAML-2 Bearer グラント種別

OAuth 認証を有効にするには、すべてのOAuth フローでカスタムOAuth アプリケーションを作成し、適切なプロパティを設定する必要があります。

デスクトップアプリケーションでカスタムOAuth アプリケーションの資格情報を使用して認証するには、OAuth アクセストークンを取得し、更新する必要があります。これらを設定すると、接続の準備が整います。

OAuth アクセストークンの取得およびリフレッシュ

以下のプロパティを設定してください。

InitiateOAuth：GETANDREFRESH。OAuthAccessToken を自動的に取得およびリフレッシュするために使用します
OAuthClientId：アプリケーションの登録時に割り当てられたクライアントId
CallbackURL：カスタムOAuth アプリケーションの登録時に定義されたリダイレクトURI
OAuthClientSecret （クライアントグラント種別のみ）：アプリケーションの登録時に割り当てられたクライアントシークレット
PrivateKey （SAML-2 Bearer グラント種別のみ）：カスタムOAuth アプリケーションの作成時にダウンロードした秘密鍵証明書のパス、またはその証明書のbase64 でエンコードされた内容

接続すると、CData 製品がデフォルトブラウザでSAP SuccessFactors のOAuth エンドポイントを開きます。ログインして、アプリケーションにアクセス許可を与えてください。

アプリケーションにアクセス許可を与えると、CData 製品がOAuth プロセスを完了します。

CData 製品がSAP SuccessFactors からアクセストークンを取得し、それを使ってデータをリクエストします
OAuth 値はOAuthSettingsLocation で指定されたパスに保存されます。これらの値は接続間で永続化されます

アクセストークンの期限が切れた際は、CData 製品が自動でアクセストークンをリフレッシュします。

カスタムOAuth アプリケーションの作成やその他の認証方法については、 href="/kb/help/" target="_blank">ヘルプドキュメントの「はじめに」をご確認ください。

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

DataSet を作成する

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

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

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

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

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

DataSet columns in a report.(Salesforce is shown.)

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

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

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

Window.xaml.cs ファイルに以下の参照を追加します。

using System.Configuration;
using CrystalDecisions.CrystalReports.Engine;
using CrystalDecisions.Shared;
using System.Data.CData.SAPSuccessFactors;
using System.Data;

以下の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 (SAPSuccessFactorsConnection connection = new SAPSuccessFactorsConnection(connectionString)) {
    SAPSuccessFactorsDataAdapter dataAdapter = new SAPSuccessFactorsDataAdapter(
    "SELECT address1, zipCode FROM ExtAddressInfo WHERE city = 'Springfield'", connection);
     DataSet set = new DataSet("_set");
     DataTable table = set.Tables.Add("_table");
     dataAdapter.Fill(table);
     report.SetDataSource(table);
  }
  reportViewer.ViewerCore.ReportSource = report;
}

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>

レポートを実行します。レポートが読み込まれると、プロバイダはクエリを実行して現在のデータを取得します。

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

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

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

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

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