本レシピはStandardプラン以上の有償プランでご利用いただけます。ご利用をご希望の場合は下記よりお問い合わせください。
お問い合わせ | ActRecipe
SmartHRのWebhookを利用して、従業員情報の項目の値が更新等されたら、別の項目にもその値をアップデートするレシピの設定方法を解説します。
レシピを使用するには事前にSmartHRの利用契約が必要になります。
■はじめに
ActRecipeではSmartHRを便利に活用する様々な機能をご提供しております。
主な特徴を動画にまとめておりますのでご覧ください。
0.事前準備
- 「SmartHRデータアップデート」レシピを使用するには、事前にSmartHR Plusでのアプリの登録が必要となります。
-
以下のSmartHR Plusにアクセスし、画面右上の「ログイン」ボタンよりSmartHRへログインします。
https://www.smarthr.plus/apps/actrecipe - 続いて「連携をはじめる」ボタン(青色)を押下しますアプリのインストール確認画面にて「連携をはじめる」ボタンを押下します
- アプリの連携が完了しますと上記「2」のボタンが「アプリを開く」に変わりますので、同ボタンを押下します。
-
以下の確認画面が表示されますので「連携を許可」を押下します。
(※)連携するユーザはSmartHRの「管理者」権限を保持している必要があります。
※
ActRecipeのアカウントを保持しておりActRecipeにログインしていない場合にはログインをしてください。
ActRecipeのアカウントが未作成の場合は「無料ではじめる」ボタンよりアカウントを作成し、通知メールに従ってください。
1.マイレシピへの登録
メニューの「シェアレシピ」から、「SmartHRデータアップデート」にチェックを入れ、画面下にある登録ボタンを押下します。シェアレシピの画面に「SmartHRデータアップデート」が表示されない場合はSmartHR Plusの画面からやり直してください。
続いて「マイレシピ」から、レシピ名をクリックするか操作メニューより「編集」を選択します。
参考:シェアレシピ・マイレシピとはなんですか?
ヘッダーでは、レシピ名とレシピ説明を変更することができます。
参考:レシピヘッダーでは何を設定すれば良いですか?
2.SmartHR連携設定
「SmartHR 認証」を押下し、設定を展開します。
本タスクでは、以下の設定を行います。
- サブドメイン(自動入力):SmartHRにとの連携ができていれば自動的にサブドメイン名がセットされます。
- 家族情報を含める(オプション):事前にActRecipe内のデータベースにSmartHRのデータを保存する必要があります。家族情報を連携したい場合にはチェックを付けます。
- 従業員情報を取得する:ボタンを押下するとSmartHRから従業員情報が取得され、ActRecipeの内部データベースに保存されます。この処理には数十分かかることがあります。
- SMARTHR WEBHOOK URLを生成:SmartHRからデータ取得が完了するとWebhook URLの生成が可能となります。
-
SmartHR Webhook URL:生成したURLは以下のページより設定します。
https://[お客様ドメイン].smarthr.jp/admin/webhooks
SmartHRのWebhook設定は下記ページをご確認ください。
https://support.smarthr.jp/ja/help/articles/5260914962073/ - シークレットトークン(オプション):SmartHR上で指定したシークレットトークンを設定することができます。本レシピでの設定は表です。
-
対象項目:任意の項目の更新等にのみレシピを実行させる場合にご利用できます。
任意のSmartHR上の項目名をカンマ区切りで入力します。例えば、住所項目の更新だけをトリガーにしたいような場合には以下のように設定します。(Webhookのトリガーを「従業員の更新」に設定済み)
【 現住所(郵便番号),現住所(都道府県),現住所(市区町村),現住所(丁目・番地),現住所(建物名・部屋番号)】
「対象項目」の値が更新された場合にタスク2のデータコンバートを実行します。
本項目がブランクの場合は、どの項目更新においても、レシピ実行のトリガーとなります。
項目名については以下を参照ください。
SmartHR - エクスポート用JSONファイル(論理名)v2.0
SmartHR - エクスポート用JSONファイル(家族情報-論理名)v1.0
3.データコンバート
「データコンバート」を押下し、設定を展開します。
本タスクでは、SmartHRから取得した項目を別の項目にアップデートする設定をします。例えば以下の設定例では、「社員番号」の値を「カスタム従業員項目名」というカスタムグループの配下にある「項目名」という項目にコピーする設定となります。
設定内容はJSONファイルとしてダウンロードまたはアップロードができます。検証等で設定変更を繰り返したい場合にはダウンロードアイコンから設定ファイルをバックアップしてください。
上記の「出力指定」で指定可能な項目名は以下の資料をご確認ください。
SmartHR - エクスポート用JSONファイル(論理名)v2.0
SmartHR - エクスポート用JSONファイル(家族情報-論理名)v1.0
※ ActRecipeのコンバート処理は、設定画面の定義順(上から順番)にデータを上書き更新しながら実行されます。
予期せぬエラーやデータ不整合を防ぐため、設定の際は必ず以下の2点をご遵守ください。
■1. 項目名の重複禁止
同じ項目名を複数作ると、すべて同じ値に上書きされます。
・NG例
以下のように全ての項目名を同一名で定義
➔ 最後の#(部署3)により上書きされ、全ての部署が同一名として出力されます。・OK例
出力項目名をすべて「一意(ユニーク)」に定義
➔ それぞれの#(部署〇)が出力されます。■2. 項目名に「元データの項目名」を使用
連携元データのヘッダーの項目名をそのままに、値だけ変換し、以下のように#(項目名)を指定すると、連携元データの項目名の値ではなく、変換後の項目名の値を参照してしまい、後続の計算や変換で「#ERROR!」や変換不具合が発生します。
・NG例
1. 「入社年月日」を和暦(2019年11月07日)に変換し、出力項目名も「入社年月日」にして上書きする。
➔ 元データ(2019-11-07)が消え、ただの「文字列」に変わる。
2. 後続の「入社年数(DATEDIF)」で #(入社年月日) を参照する。
➔ 文字列を計算しようとするため計算エラー(#ERROR!)になる。
・OK例①
出力項目名(ヘッダー名)を変更する。
変換後の出力項目名を「入社日」や「生年月日_変換後」などの「別名」に指定します。
➔ 元データが上書きされずに残るため、すべての計算や変換が正常に動作します。
・OK例②:コンバート設定の順番を入れ替える
計算(DATEDIF等)を行う項目を、上書き変換(和暦変換等)を行う項目よりも「上(前)」に配置してください。
コンバート機能の詳細や出力指定のサンプルは下記ページをご覧ください。
コンバートの設定方法を教えてください
出力指定の条件指定方法のサポートは有償プランにて承っております。詳しくはお問い合わせください。
4.SmartHRのデータ更新
タスク1の「SmartHR 認証」と同じサブドメインが表示されていることを確認します。異なるサブドメインが表示されている場合は「テナントの変更・解除」より修正してください。
本レシピでは同一テナント間の連携にのみ対応しております。
レシピを実行する
このレシピは手動または自動でのレシピ実行は不要です。
SmartHR上で指定したWebhookのトリガーに該当する処理が実行されるとレシピが自動実行されます。
レシピの実行に成功すると、「データコンバート」で指定した内容が処理されます。
Freeプランについて
このレシピはActRecipeのFreeプランでご利用いただけます。Freeプランの制約事項や有償プランへの移行は下記をご覧ください。