Visual Studio でUKG Pro HCM とチャートをデータバインドする方法

データバインドによって、UI コントロールからデータに接続できます。 CData ADO.NET Provider for API を使って、Visual Studio 上でWindows Forms およびWeb Forms とUKG Pro HCM をデータバインドできます。この記事で、UKG Pro HCM を、ウィザードから変更をリアルタイムで反映するチャートにデータバインドする方法を説明します。 Code Walk-through セクションではチャートはほんの10行のコードで作成します。

チャートへのデータバインド

データバインドは３つのステップから構成されます。コントロールのインスタンス作成、データソースの設定、最後にデータバインドです。

接続を設定してデータベースオブジェクトを選択

下の手続きにより、データソース構成ウィザードを使ってチャートコントロールとUKG Pro HCM との接続を作成します。ウィザード上でデータバインドをするUKG Pro HCM エンティティを使います。

1. Windows Forms プロジェクトでは、チャートコントロールをツールボックスからフォーム上にドラグ＆ドロップします。チャートプロパティのデータセクションで DataSource を選択し、メニューからプロジェクトデータソースの追加を選択します。
2. 出てくるデータソース構成ウィザードでデータベース -> データセットを選択します。
3. データ接続ステップで、「新しい接続」をクリックします。

4. データ接続の選択ダイアログで、「変更」をクリックして、CData UKG Pro HCM のデータソースを選択して、接続プロパティを入力します。下は代表的な接続文字列ですです。:

   Below is a typical connection string:

   Profile=C:\profiles\UKGProHCM.apip;AuthScheme=Basic;User=your_username;Password=your_password;ProfileSettings='Host=yourcompany.ultipro.com;CustomerAPIKey=your_customer_api_key';

   まず、Profile 接続プロパティをディスク上の UKGProHCM プロファイルの場所に設定します（例：C:\profiles\UKGProHCM.apip）。次に、ProfileSettings 接続プロパティを UKGProHCM の接続文字列に設定します（以下を参照）。

   UKGProHCM API プロファイル設定

   UKG Pro HCM では、Basic 認証とカスタマー API キーを組み合わせて API へのアクセスを認可します。接続には、UKG Pro HCM の認証情報と、UKG が発行したカスタマー API キーが必要です。

   認証するには、以下の接続プロパティを設定します。

   • AuthScheme：Basic に設定します。
   • User：UKG Pro HCM のユーザー名に設定します。
   • Password：UKG Pro HCM のパスワードに設定します。
   • ProfileSettings：以下の項目をセミコロン区切りで指定します。
     • Host：UKG Pro HCM テナントのホスト名（例：yourcompany.ultipro.com）。
     • CustomerAPIKey：UKG のカスタマー API キー。各 API 呼び出しで US-CUSTOMER-API-KEY リクエストヘッダーとして渡されます。

   カスタマー API キーの入手方法については、UKG Pro HCM の管理者にお問い合わせいただくか、UKG Developer Portal（https://developer.ukg.com）をご参照ください。


5. 使用するデータソースオブジェクトを選択します。例は UserDetails テーブルです。

DataBind

データソースの追加とデータベースオブジェクトを選択したら、チャートにオブジェクトをバインドします。この例では、X軸に UserId をY軸に UserName を設定します。

1. チャートプロパティで、Series プロパティをクリックし、Series コレクション エディター を開きます。
2. Series プロパティでX軸、Y軸に設定するカラムを選択します：XValueMember および YValueMember プロパティにメニューからカラムを選びます。

チャートはこれでUKG Pro HCM にデータバインドされました。チャートを実行して最新のデータを表示させましょう。

コード Walk-through

UKG Pro HCM へのデータバインドはほんの数行のコードのみが必要で、３つの簡単なステップで完了できます。

1. UKG Pro HCM に接続します。
2. APIDataAdapter を作成して、クエリを作成し、結果を入れるデータセットを作成します。
3. 結果セットとチャートをデータバインドします。

下に完全なコードを示します:

APIConnection conn = new APIConnection("Profile=C:\profiles\UKGProHCM.apip;AuthScheme=Basic;User=your_username;Password=your_password;ProfileSettings='Host=yourcompany.ultipro.com;CustomerAPIKey=your_customer_api_key';");
APICommand comm = new APICommand("SELECT UserId, UserName FROM UserDetails WHERE UserStatus = 'A'", conn);
APIDataAdapter da = new APIDataAdapter(comm);
DataSet dataset = new DataSet();
da.Fill(dataset);

chart1.DataSource = dataset;
chart1.Series[0].XValueMember = "UserId";
chart1.Series[0].YValueMembers = "UserName";
// Insert code for additional chart formatting here.
chart1.DataBind();