HiBobをデータパイプラインソースとして設定
HiBobをデータパイプラインソースとして設定し、従業員データ、過去の人事レコード、休暇、報酬、カスタムテーブルオブジェクトを抽出して送信先に取り込みます。 このガイドを使用して、サポートされる機能の確認、前提条件の完了、HiBobのWorkatoへの接続、パイプラインの設定、既知の制限事項の理解を行います。
サポートされている機能
HiBobをパイプラインソースとして使用する場合、次の機能がサポートされます。
- クラウド接続: HiBobはクラウド専用のSaaSです。 Workatoは
https://api.hibob.com/経由で接続するため、オンプレミスエージェントは不要です。 - 同期モード: ほとんどのオブジェクトではフルリフレッシュ、
time_off_requestsとout_of_officeではインクリメンタル同期です。 詳細は同期モードを参照してください。 - オブジェクトレベルの選択: 各パイプラインに含めるHiBobオブジェクトを選択します。
- 削除追跡:
employeesオブジェクトのソフトデリート追跡は、internal.statusライフサイクルフィールドを通じて表示されます。 - スキーマドリフト検出: テナントごとのオブジェクトを設定して新しいフィールドを自動同期するか、パイプラインの開始後にスキーマをロックします。
- 設定可能な同期頻度: 最小同期間隔は
15分です。
前提条件
HiBobをデータパイプラインソースとして接続する前に、次の要件を満たしてください。
- 管理者アクセス権を持つHiBobアカウント、またはサービスユーザーを作成するためのFeatures > Integrations > Automation > Create/update/delete the integration権限を持つユーザー。
- 選択した認証方法の認証情報:
- サービスユーザー認証情報: HiBobサービスユーザーのIDとToken。 設定手順については、HiBobサービスユーザーIDとトークンの生成を参照してください。
必要な権限
同期する予定のHiBobリソースへの読み取りアクセスを許可する権限グループをサービスユーザーに割り当てます。 パイプラインに必要な権限のみを付与します。 詳細については、サービスユーザー権限に関するHiBobドキュメントを参照してください。
HiBobサービスユーザーIDとトークンの生成
Workatoの接続に使用するサービスユーザーIDとトークンを生成するには、HiBobで次の手順を完了します。
管理者としてHiBobにサインインし、Bob products > System settingsに移動します。
サイドナビゲーションメニューでIntegrations（連携）を選択します。
All categories（すべてのカテゴリー）ドロップダウンメニューを使用して、Automation（自動化）を選択します。
Service users（サービスユーザー）タイルに移動し、Manage（管理）をクリックします。
+ New service user（+新規サービスユーザー）をクリックします。
Display name（表示名）フィールドに名前を入力し、必要に応じてDescription（説明）フィールドに説明を入力します。
次へをクリックします。 HiBobにサービスユーザーのIDとトークンが表示されます。
Credentials（認証情報）に移動し、IDとToken（トークン）の値をコピーします。 値を安全な場所に保存します。
Permissions > permission groups（権限＞権限グループ）に移動して、サービスユーザー権限グループを作成し、前の手順で作成したサービスユーザーに割り当てます。
完了をクリックします。
HIBOB管理者アクセス
直接アクセスできない場合は、Bob管理者に認証情報の生成を依頼してください。
サポートされるコネクションタイプ
HiBobデータパイプラインでは、1つの認証方法がサポートされます。
- サービスユーザー認証情報: HiBobで生成されたサービスユーザーIDとトークンのペア。 Workatoは、すべてのAPIリクエストでこれらをHTTP Basic認証として適用します。 設定手順については、HiBobサービスユーザーIDとトークンの生成を参照してください。
HiBobへの接続
次の手順を完了して、HiBobをデータパイプラインソースとして接続します。
HiBobへの接続
作成 > コネクションを選択するか、Cを2回押します。
New connectionページでHiBobを検索し、選択します。
コネクション名フィールドに名前を入力します。
ロケーションドロップダウンメニューを使用して、コネクションを保存するプロジェクトを選択します。
HiBobからコピーしたIDをService user IDフィールドに入力します。
HiBobからコピーしたトークンをService user tokenフィールドに入力します。
Environmentドロップダウンメニューを使用して、HiBobアカウントのEnvironmentを選択します。
任意です。 HiBob Partnerアカウントをお持ちの場合は、Partner tokenフィールドにPartner tokenを入力します。 Partner tokenを取得するには、Partner Stackアカウントにログインし、HiBob Programに移動してMy Profileを選択し、Partner-Tokenフィールドを見つけます。
接続を選択して、コネクションを検証して保存します。 コネクションが確立されると、Workatoに成功メッセージが表示されます。
パイプラインの設定
HiBobをデータパイプラインソースとして設定するには、次の手順を完了します。
作成 > データパイプラインを選択するか、C+Iを押します。
データパイプライン名フィールドにデータパイプラインの名前を入力します。
データパイプライン設定
ロケーションドロップダウンメニューを使用して、データパイプラインを保存するプロジェクトを選択します。
ビルドを開始をクリックします。
ソースアプリから新規/更新済みレコードを抽出トリガーをクリックします。 このトリガーは、パイプラインがHiBobからデータを取得する方法を定義します。
ソースアプリから新規/更新済みレコードを抽出トリガーを設定
Your Connected Source Appsドロップダウンメニューを使用して、HiBobを選択します。
このパイプラインで使用するHiBobコネクションを選択します。 または、+ 新規コネクションをクリックして新しいコネクションを作成します。
オブジェクトを追加をクリックして、新しいオブジェクトを追加パネルを開きます。
オブジェクトを追加
使用可能なHiBobオブジェクトのリストを検索または参照し、同期するオブジェクトを選択してAddをクリックします。
選択した各オブジェクトのスキーマを確認してカスタマイズします。 オブジェクトを選択すると、パイプラインはそのスキーマを自動的に取得し、宛先がソースと一致するようにします。
任意のオブジェクトを展開して、そのフィールドを表示します。 使用可能なすべてのデータを抽出するにはすべてのフィールドを選択したままにし、データ抽出とスキーマレプリケーションから除外するには特定のフィールドの選択を解除します。
任意です。 オブジェクトを展開し、各フィールドの処理方法を選択して、フィールドレベルのデータ保護を設定します。
- そのまま複製: ソースのデータ値が宛先に同一に複製されます。
- ハッシュ: 宛先に同期する前に、フィールド内の機密データ値をハッシュ化します。 Workatoでは、個人を特定できる情報（PII）やその他の機密フィールドをハッシュ化することを推奨します。 PIIが一般的に含まれるフィールドのリストについては、機密データの処理を参照してください。
さらにオブジェクトを追加するには、もう一度オブジェクトを追加をクリックします。 この手順を繰り返して、パイプラインにHiBobオブジェクトを追加します。
スキーマ変更の処理方法を選択ドロップダウンメニューを使用して、スキーマドリフトの処理オプションを選択します。
- 新しいフィールドを自動同期: ソースに追加された新しいフィールドを自動的に検出して同期します。 これは、
employeesやワークスペースで検出されたカスタムテーブルなど、テナントごとのスキーマを持つオブジェクトに適用されます。 - 新しいフィールドをブロック: パイプラインの開始後、スキーマを固定します。 新しいフィールドは手動で追加する必要があります。
任意です。 同時実行操作に上限を設定するには、Concurrency limitフィールドに値を入力します。 最大値は100です。
Frequencyフィールドで、パイプラインがHiBobから送信先にデータを同期する頻度を設定します。 標準の時間ベースのスケジュールを選択するか、カスタムcron式を定義します。
サポートされるオブジェクト
パイプラインは、キュレーションされたHiBobオブジェクトのセットに加えて、ワークスペースで定義されたカスタムテーブルをサポートします。 employeesのカスタムフィールドとカスタムテーブルは、オブジェクトウィザードで使用可能なオブジェクトとスキーマを読み込むときに、パイプラインの設定時に検出されます。 その他のすべてのオブジェクトには固定スキーマがあります。
想定しているオブジェクトのデータが表示されない場合は、サービスユーザーの権限グループが基になるHiBobリソースへのアクセスを許可していることを確認します。
次の表は、サポートされているオブジェクトをカテゴリ別に示しています。 各オブジェクトは、宛先内の個別のテーブルとして同期されます。
従業員データ
| オブジェクト | 同期モード | 増分メカニズム | 削除追跡 |
|---|---|---|---|
employees | 完全更新 | 該当なし | はい（ソフト、internal.status経由） |
employee_fields | 完全更新 | 該当なし | いいえ |
employeesオブジェクトには、従業員ごとに1つの包括的な行が含まれます。個人情報、雇用の詳細、勤務地、インラインのカスタムフィールド値が含まれます。 退職済みおよび非アクティブな従業員は常に含まれます。ライフサイクル状態はinternal.statusフィールドで公開されます。
employee_fieldsオブジェクトは、HiBobテナントのカスタムフィールド定義（id、name、type、category、description）を公開します。 ダウンストリームでカスタムフィールドをマッピングする際のスキーマ検出に使用します。
履歴テーブル
履歴テーブルは、有効日を持つ追記専用レコードです。 各行は、従業員の履歴内の1つのイベントを表します。
| オブジェクト | 同期モード | 増分メカニズム | 削除追跡 |
|---|---|---|---|
lifecycle_history | 完全更新 | 該当なし | いいえ |
salary_history | 完全更新 | 該当なし | いいえ |
employment_history | 完全更新 | 該当なし | いいえ |
work_history | 完全更新 | 該当なし | いいえ |
HiBobの一括エンドポイントは、従業員ごとにグループ化された履歴データを返します。 Workatoはレスポンスをフラット化し、各送信先行が1つのエントリを表すようにします。
休暇
| オブジェクト | 同期モード | 増分メカニズム | 削除追跡 |
|---|---|---|---|
out_of_office | 完全更新、増分 | from日付パラメーター | いいえ |
time_off_requests | 完全更新、増分 | createdOnタイムスタンプ | いいえ |
time_off_requestsオブジェクトは、変更イベント（作成、更新、またはキャンセル）ごとに1行を記録します。 同じリクエストが複数の行を生成する場合があるため、主キーはemployeeId、requestId、createdOnの組み合わせです。
報酬
| オブジェクト | 同期モード | 増分メカニズム | 削除追跡 |
|---|---|---|---|
variable_payments | 完全更新 | 該当なし | いいえ |
equity_grants | 完全更新 | 該当なし | いいえ |
HiBobは一括エンドポイントを提供していないため、equity_grantsオブジェクトは従業員ごとに取得されます。 スループットへの影響については、従業員ごとの同期オーバーヘッドを参照してください。
会社参照
| オブジェクト | 同期モード | 増分メカニズム | 削除追跡 |
|---|---|---|---|
named_lists | 完全更新 | 該当なし | いいえ |
named_listsオブジェクトは、HiBobの会社リスト（部署、役職、サイトなど）を、list_id、list_name、item_id、item_name列を持つリスト項目ごとに1行へフラット化します。
ワークフローとレコード
| オブジェクト | 同期モード | 増分メカニズム | 削除追跡 |
|---|---|---|---|
タスク | 完全更新 | 該当なし | いいえ |
training | 完全更新 | 該当なし | いいえ |
documents | 完全更新 | 該当なし | いいえ |
tasksオブジェクトは未完了のタスクのみを返します。 過去に完了したタスクはHiBob API経由では使用できません。 trainingオブジェクトとdocumentsオブジェクトは従業員ごとに取得されます。documentsはメタデータのみを同期し、ファイル内容は同期しません。
カスタムテーブル
HiBobワークスペースでカスタムテーブル（緊急連絡先や認定資格など）が定義されている場合、Workatoは実行時にGET /v1/people/custom-tables/metadataを通じてそれらを検出し、従業員ごとにデータを同期します。 カスタムテーブルとその列の正確なセットはHiBobの設定によって異なるため、カスタムテーブルは前述のテーブルに一覧表示されるのではなく、動的に登録されます。
同期モード
HiBobデータパイプラインは、フルリフレッシュとインクリメンタル同期をサポートします。 同期モードは、HiBob APIがサポートする内容に基づいてオブジェクトごとに決定されます。
完全更新
フルリフレッシュは、同期のたびに送信先テーブルを置き換えます。 HiBob APIは基になるエンドポイントでmodified_sinceフィルターを公開していないため、ほとんどのHiBobオブジェクトはフルリフレッシュモードで実行されます。 履歴テーブル（lifecycle_history、salary_history、employment_history、work_history）は本質的に追記専用であるため、フルリフレッシュでは実行ごとに完全な履歴が返されます。
増分同期
2つのHiBobオブジェクトがインクリメンタル同期をサポートします。
time_off_requests: Workatoは最後に成功した同期時刻をcreatedOnの下限として渡し、そのタイムスタンプ以降に作成された変更イベントのみをリクエストします。out_of_office: Workatoは最後に成功した同期時刻をfrom日付パラメーターとして渡します。
削除追跡
employeesオブジェクトはソフトデリート追跡をサポートします。 Workatoは常にshowInactive: trueを指定してHiBobにリクエストするため、退職済みおよび非アクティブな従業員が送信先テーブルに残り、internal.statusフィールドでライフサイクル状態が示されます。 ダウンストリームの利用者はinternal.statusでフィルタリングして、非アクティブまたは退職済みの従業員を特定できます。
削除追跡をサポートする他のHiBobオブジェクトはありません。
機密データの処理
HiBobオブジェクトには、個人を特定できる情報（PII）と報酬データが含まれる場合があります。 次のオブジェクトには通常、機密フィールドが含まれます。 HiBobワークスペースで定義されたカスタムフィールドには、設定に応じて追加のPIIが含まれる場合があります。
| オブジェクト | 機密フィールド |
|---|---|
employees | 個人情報（氏名、連絡先詳細、自宅住所、識別子）、雇用の詳細、およびPIIを含むカスタムフィールド |
salary_history | base_value、base_currency、および追加の報酬フィールド |
variable_payments | amount、currency |
PIIが送信先に到達する前に保護するには、パイプライン設定中にフィールドレベルのデータ保護でHashオプションを使用します。 詳細については、パイプラインを構成手順を参照してください。
制限事項
HiBobをデータパイプラインソースとして使用する場合、次の制限事項が適用されます。
従業員ごとの同期オーバーヘッド
HiBobは、equity_grants、training、documents、またはカスタムテーブルの一括エンドポイントを提供していません。 Workatoはこれらのオブジェクトに対して従業員ごとに1つのリクエストを発行するため、同期時間は従業員数に応じて増加します。
タスクオブジェクトの範囲
tasksオブジェクトは未完了のタスクのみを返します。 HiBobは、過去に完了したタスクをAPI経由で公開していません。
最終更新日: