Kaonavi(メンバー)
「kaonavi（メンバー）」の業務アセットについて
「kaonavi（メンバー）」業務アセットでは、kaonaviのタレント情報を管理できます。
「メンバー」と「ユーザー」の違いについては下記を参照
業務アセット固有の特徴
他の業務アセットと特に異なる特徴として以下のようなものがあります。
- 削除タスク実行時の挙動
- タスクの対象となるメンバーに退職日を設定し、退職者という扱いに変更します。 メンバーの情報は削除されずkaonavi上に残ったままになります。
- パスワードを持たない
- kaonaviのメンバーはログインに使用するものではないため、パスワードが発行されません。
- 一部属性の属性式の設定が必須
- 入社日・退職日属性は利用者による属性マッピングの設定が必須です。 （デフォルトのマッピングが設定されていないが、未設定だとタスクが失敗する）
- タスクの実行に時間がかかる
- kaonaviメンバー業務アセットのタスクは実行開始から終了までが他のコネクタより時間がかかります。（kaonaviのAPIがリクエストを送ってから完了するまで時間がかかるため）
所用時間は早い場合で約10秒、遅い場合で約1~2分になります。
（kaonavi側の負荷状況によって異なる）
- 一括実行に対応
- 複数件のアカウント作成タスク、もしくは複数件のアカウント削除タスクにチェックに入れてまとめて実行すると、チェックを入れたすべてのタスクを1~2回のAPIリクエストにまとめて実行します。
- 上述のとおりタスク実行に時間がかかるため、各タスクを単体で実行するとすべて完了するのに時間がかかってしまいますが、複数件まとめて実行することで全体の所要時間の短縮が見込めます。
- APIは初期状態ではメンバー情報を操作する権限が与えられていません。 管理画面の「公開API v2 情報」から、更新する権限を与えてください。
接続画面に入力する情報
APIリクエストに必要なConsumer Key・Consumer Secretを入力してください。
割当種別
割当種別はありません。メンバーの有無のみを管理できます。
アカウント作成タスク
YESODのメンバーに対応するkaonaviのメンバーを作成します。
kaonavi上に同一の社員番号のメンバーが存在するかに応じて以下のような挙動になります。
| 同一社員番号で退職日が設定されている メンバーがkaonaviに存在する場合 | そのメンバーの退職日属性を空にして 情報を更新する |
|---|---|
| 同一社員番号で退職日が設定されていない メンバーがkaonaviに存在する場合 | そのメンバーの情報を更新する |
| 同一社員番号のメンバーが kaonaviに存在しない場合 | メンバーを新規作成する |
kaonaviメンバーの属性のうち、属性マッピングを使って値を設定できるものは以下の通りです。
- 社員番号・入社日は指定しないと作成タスクが失敗します。
- 退職日は指定した上で「同期のタイミング」を「アカウント作成時・値の変更時」にしないと削除タスクが失敗します。
- 入社日・退職日はデフォルト値が存在しないため、業務アセット作成後のマッピング設定が必須です。
| 属性の概要 | 属性式におけるKey | 属性式未設定時のデフォルト値 | 備考 |
|---|---|---|---|
| 社員番号 （属性式指定必須） | • 属性式が設定されていない場合、作成タスクは失敗します。 • 複数の会社に所属する場合、どの会社の社員番号を使うかは属性式によって利用者で設定してもらう想定です。 | ||
| 氏名 | |||
| フリガナ | 指定なし | ||
| メールアドレス | |||
| 入社日 （属性式指定必須） | 指定なし | 形式の文字列を指定してください。マッピング設定されていない場合、作成タスクは失敗します。 以下の属性式を使い、どの会社の入社日を反映させるかを利用者に指定してもらう運用を想定しています。 | |
| 退職日 （属性式指定必須） | 指定なし | • 形式の文字列を指定してください。マッピングが設定されていない場合、削除タスクは失敗します。（ のような属性式を使い、どの会社の退職日を反映させるかを利用者に指定してもらう運用を想定しています。） • 削除タスク実行時は「同期のタイミング」を「アカウント作成時・値の変更時」にする必要があります。「アカウント作成時のみ」の場合、タスクが失敗します。 | |
| 性別 | 指定なし | ||
| 生年月日 | 指定なし | ||
| 主務情報 | 指定なし | kaonaviにおける組織のIDを以下のような形で指定します。 | |
| 兼務情報 | 指定なし | kaonaviにおける組織のIDを以下のような形で指定します。複数指定可能です。
| |
| その他カスタムフィールド | 指定なし | 上記以外の属性に値を設定するときに使用します。設定できる属性は一部のみです。 項目を特定するIDと実際の値をそれぞれ設定してください。 例：役職を設定する場合 user.custom_fields[0].id = 14 user.custom_fields[0].values[0] = "取締役” |
主務情報・兼務情報の指定方法
主務情報・兼務情報を設定するには、属性マッピングで以下のように設定を追加します。
APIを使った組織IDの確認方法
1. APIトークンの取得
以下のようなレスポンスが返ってきます。これの がAPIトークンです。
2. 組織情報の取得 取得したAPIトークンを使って以下のようなリクエストを送ってください。
以下のようなレスポンスが返ってきます。これの フィールドが組織IDになります。
カスタムフィールドの指定方法および制約
属性マッピングの「その他カスタムフィールド」（ ）では属性マッピングの表に記載された属性以外の一部属性（基本情報と兼務情報）を更新できます。
それ以外の属性の更新はkaoanviのAPI仕様的に不可能というわけではなく、YESOD側の実装で顧客要望がある場合は今後対応することは可能です。
属性をマッピングするには、以下のようにIDと値のマッピング設定を追加します。
- にはマッピング先となるkaonaviの属性のIDを指定します。
APIを使った属性IDの確認方法
APIを実行するためにはまずAPIトークンを取得する必要があります。
kaonaviの設定画面から取得できるconsumer_keyとconsumer_secretを使って以下のようなリクエストを送ってください。
以下のようなレスポンスが返ってきます。これの がAPIトークンです。
取得したAPIトークンを使って以下のようなリクエストを送ってください。
以下のようなレスポンスが返ってきます。これの に含まれているものが各属性に相当し、 フィールドが属性IDになります。
- にはマッピングする値を指定します。 1つしか指定しない場合でも配列の形式で指定する必要があります。
補足
- 取得・更新・登録・削除の制御
- API経由でのシートの取得・更新・登録・削除は制御されているため、管理画面で実行許可を出す必要がある
- カスタムフィールドの制約
- メンバー登録時に指定できるのは、基本情報・兼務情報のみ
- 基本情報・兼務情報とその他のシートで更新で使用するAPIが異なる
- 基本情報・兼務情報：メンバー情報 部分更新
- その他のシート：シート情報 部分更新
- 「シート情報 部分更新」で基本情報のidを指定してもエラーになるため、2つを使い分けるしかない
- API連携で使用可能なカスタムフィールドの調べ方
- 基本情報・兼務情報：メンバー情報レイアウト設定 取得
- その他のシート：シート情報 取得
アカウント削除タスク
kaoanviのメンバーの退職日属性に日付を設定します。（メンバーの完全削除ではありません）
設定される日付は属性マッピングの が参照されます。
退職日を設定するとkaonavi上では「退職者」というタグが付与されて退職者という扱いになります。イエソド的にはアカウント削除（権限剥奪）が必ずしも退職を意味するとは限りませんが、kaonaviの用途的にアカウント削除をするようなユースケースは退職時以外考えづらいと判断し、この仕様としています。
以下の場合、削除タスクは失敗します。
- に対するマッピングが設定されていない
- に対するマッピングが設定されているが、「同期のタイミング」を「アカウント作成時」になっている
その他注意事項
- この業務アセットで取り込まれるのは、現在日付時点で退職していないタレント情報のみです。退職日に過去の日付が入っているタレント情報は取り込みの対象外です。
そのため、属性同期で退職日に過去に日付を反映させた場合、次にアカウント取り込みを行った際にアカウントの紐付けが外れます。