本レシピはStandardプラン以上の有償プランでご利用いただけます。ご利用をご希望の場合は下記よりお問い合わせください。
お問い合わせ | ActRecipe
SmartHRの従業員情報をX-point Cloudへ連携しユーザーの作成や更新を行う方法を解説します。
レシピを使用するには事前にSmartHRおよびX-point Cloudの利用契約が必要になります。
0.事前準備
- 「SmartHR - X-point Cloudユーザー作成」レシピを使用するには、事前にSmartHR Plusでのアプリの登録が必要となります。
- 以下のSmartHR Plusにアクセスし、画面右上の「ログイン」ボタンよりSmartHRへログインします
https://www.smarthr.plus/apps/actrecipe - 続いて「連携をはじめる」ボタン(青色)をクリックします
- アプリのインストール確認画面にて「連携をはじめる」ボタンをクリックします
- アプリの連携が完了しますと上記「2」のボタンが「アプリを開く」に変わりますので、同ボタンをクリックします
- 以下の確認画面が表示されますので「連携を許可」をクリックします(※)
連携するユーザはSmartHRの「管理者」権限を保持している必要があります。
※
ActRecipeのアカウントを保持しておりActRecipeにログインしていない場合にはログインをしてください。
ActRecipeのアカウントが未作成の場合は「無料ではじめる」ボタンよりアカウントを作成し、通知メールに従ってください。
1.マイレシピへの登録
メニューの「シェアレシピ」から、「SmartHR - X-point Cloudユーザー作成・更新」にチェックを入れ、画面下にある登録ボタンを押下します。
続いて「マイレシピ」から、操作メニューより「編集」を選択します。
参考:シェアレシピ・マイレシピとはなんですか?
ヘッダーでは、レシピ名とレシピ説明を変更することができます。
参考:レシピヘッダーでは何を設定すれば良いですか?
2.SmartHRの認証情報設定
「SmartHR 従業員情報」を押下し、設定を展開します。
本タスクでは、以下の項目を設定します。
- ヘッダーの種類:「論理名」を指定します。
- 取得データの種類:「論理名」を指定します。
-
フリーワード検索:
SmartHRからの取得データ件数が多い場合にはレシピ実行がタイムアウトエラー(サーバー応答コード: 202)となる可能性があります。そのような場合に、取得データを絞り込んでデータを取得できるオプションです。例えば、社員番号の「0001」を指定しますと「00001」および「00010〜00019」が取得対象となります。他にも氏名、ビジネスネーム、部署名、役職名、事業所でも絞り込むことができます。従業員数が数千名を超えるような場合にはレシピを複数作成していただいた上で、本フリーワード検索にて部署名や事業所名によって対象データの絞り込みをお願いします。本項目に値がある場合には下記の「詳細検索」の設定が無効となりますのでご留意ください。 - カスタム従業員項目を含める:チェック不要です。
-
詳細検索 (オプション):フリーワード検索よりも細かな条件で対象データを絞り込むことができます。条件指定は最大10件まで行うことができます。
[社員番号, ユーザーID, 従業員のID, 戸籍上の性別, 雇用形態, 在籍状況, 入社年月日-開始日, 入社年月日-終了日, 部署ID, フリーワード検索]
例えば任意の日付以降に入社した従業員データのみを対象とする場合には、検索項目から「入社年月日-開始日」を選択し、値では日付を指定します。
SmartHRとのOAuth接続を切断する場合は「テナントの変更・解除」をクリックし、続いて「接続解除」をクリックします。
3.連携項目のマッピング設定
本タスク設定はIT担当者向けの内容となりますので、内容をカスタマイズせずにX-point Cloud連携をされたい場合は下記の「SmartHR - X-point Cloudユーザー作成・更新JSONファイル(論理名)v1.0」をご使用ください。
「SmartHR - Convert crews data」タスクでは、SmartHRの項目をどのようにX-point Cloudへ連携するかを設定することができます。
【連携項目】
SmartHRから取得可能な項目は以下の通りです。このうち部署および役職は3種類以上の連携も可能です。
社員番号,姓,名,部署1 部署,部署2 部署,役職,部署1 役職,部署2 役職,メールアドレス
標準内容で連携する場合には以下の手順で設定ファイルを適用します。
-
以下のファイルをローカルPC環境等に保存します。
SmartHR - X-point Cloudユーザー作成・更新JSONファイル(論理名)v1.0 - レシピの編集画面より、アップロードアイコンから上記のJSONファイルをアップロードします。
JSONファイルはSmartHRとX-point Cloudの項目のマッピングをしたものとなりますので、検証等で設定変更を繰り返したい場合にはダウンロードアイコンから設定ファイルをバックアップしてください。
続いて、「SmartHR - Convert crews data」タスクの画面について説明します。
【入力設定】
- 文字コード:入力ファイル(変換元ファイル)の文字コードを選択します。
-
ヘッダーあり/なし:入力ファイルにヘッダーが含まれる場合は「ヘッダーあり」、ヘッダーが含まれない場合は「ヘッダーなし」にします。
※本レシピにおいては、変更不要です。 - 区切り文字:入力ファイルの区切り文字を入力します。デフォルトはカンマ(,)です。
【入力フィルター】
入力フィルタでは、SmartHRから取得する従業員情報を任意の条件に基づいて絞り込むことが可能になります。フィルタ項目の増減は下部の「(+)」アイコン、または、右側の「(-)」アイコンより行っていただけます。
-
入力項目: SmartHR上の項目名を入力します。SmartHRの項目名とその説明は以下の資料をご確認ください。
SmartHR統合連携項目v1.5 -
条件:以下の条件の内いずれかを指定します。
- 次に等しい:入力項目で指定した項目が、以下の”値”にて指定した値と等しい場合に出力します。
- 次に等しくない:入力項目で指定した項目が、以下の”値”にて指定した値と等しくない場合に出力します。
- が空:入力項目で指定した項目が、空欄である場合に出力します。
- が空ではない:入力項目で指定した項目が、空欄ではない場合に出力します。
-
値:絞り込みたい条件に基づき値を入力します。
「XXXX, YYYY」のようにカンマ区切りで入力することで、複数の値を一括で指定することも可能です。 -
AND・OR:複数の条件を「かつ(AND)」「または(OR)」で組み合わせることができます。
条件行の左右に「( 」および「 ) 」のプルダウンから条件のグルーピングもでき、「(A かつ B) または (C かつ D)」といった、特定の条件をグループ化して優先させる複雑な絞り込みも可能です。
※対応可能なネストは1階層(括弧は一重)までです。
( ) によるグルーピングは可能ですが、(( )) のように括弧を二重に設定することには対応しておりませんのでご注意ください。
【出力設定】
- 出力ファイル種別:出力ファイルの種類を「CSV」または「TEXT」から選択します。
- ヘッダー出力する/しない:出力ファイルのヘッダーの有無を選択します。
- 文字コード:出力ファイルの文字コードを「UTF-8」「SHIFT_JIS」「SHIFT_JIS (CP932)」から選択します。
- 区切り文字:出力ファイルの区切り文字を設定します。
- クォート:出力ファイルデータについて「"文字列"」のようにクォートを付与する対象を選択します。
- 桁数を超える処理:下記の「出力フォーマット」において、指定した桁数を超過した場合の処理を選択します。
【出力フォーマット】
出力フォーマットでは、入力ファイルを用いてどのようなアウトプットとするかを決定します。マッピング項目の増減は下部の「(+)」アイコン、または、右側の「(-)」アイコンより行っていただけます。
下図の「項目名」はX-point Cloudの項目名を指しており、「出力指定」はSmartHRの項目を指しております。SmartHRの項目とその説明、ActRecipeのJSON項目名は以下の資料をご確認ください。このうち連携可能な項目は上記の【連携項目】をご覧ください。
「出力指定」には上記ファイルの「SmartHR項目説明 (論理名)」の指定が可能です。物理名はご指定いただけません。
「型」や「桁数」や「出力区分」は任意の設定を行っていただくことができます。
「出力指定」ではExcelとほぼ同様の関数指定を行うことができます。例えば、SmartHRの「姓」と「名」を1つのフィールドに出力したい場合は、出力区分および出力指定を以下のように指定します。
出力区分:計算式
出力指定:#(姓)&#(名)
【出力フィルター】
出力フィルターでは、出力フォーマットによって出力されたファイルを任意の条件に基づいて絞り込むことが可能になります。フィルタ項目の増減は下部の「(+)」アイコン、または、右側の「(-)」アイコンより行っていただけます。
-
括弧 ( ):複数の条件をグループ化して優先順位を指定できます。各条件行の左端に開始括弧「(」、右端に終了括弧「)」を設定できます。
※ 対応可能なネストは1階層(括弧は一重)までです。( ) によるグルーピングは可能ですが、(( )) のように括弧を二重に設定することはできません。 - 出力項目:出力フォーマットにて、設定した項目を指定します。
-
条件:以下の条件の内いずれかを指定します。
- 次に等しい:出力項目で指定した項目が、以下の”値”にて指定した値と等しい場合に出力します。
- 次に等しくない:出力項目で指定した項目が、以下の”値”にて指定した値と等しくない場合に出力します。
- が空:出力項目で指定した項目が、空欄である場合に出力します。
- が空ではない:出力項目で指定した項目が、空欄ではない場合に出力します。
-
値:絞り込みたい条件に基づき値を入力します。
「営業部, 開発部」のようにカンマ区切りで入力することで、複数の値を一括で指定することも可能です。 -
AND・OR:複数の条件を「かつ(AND)」「または(OR)」で組み合わせることができます。
複数の条件を設定した場合、上から順番に1つずつ評価(直列評価)されます。
例:条件A AND 条件B OR 条件C は、(条件A かつ 条件B) または 条件C として処理されます。【例】
-
条件A AND ( 条件B OR 条件C )
→ 条件Aを満たし、かつ「条件Bまたは条件Cのどちらか」を満たすデータを出力します。 -
( 条件A AND 条件B ) OR ( 条件C AND 条件D )
→ 「条件AとBの両方」を満たす、または「条件CとDの両方」を満たすデータを出力します。
コンバート機能の詳細や出力指定のサンプルは下記ページをご覧ください。
コンバートの設定方法を教えてください
出力指定の条件指定方法のサポートは有償プランにて承っております。詳しくはお問い合わせください。
4.X-pointの接続設定
「X-point Cloud - ユーザー作成」を押下し、設定を展開します。
本タスクでは、以下の項目を設定します。
- X-point Cloudアクセストークン:X-point Cloudの「X-point アクセストークン」を入力します。(「APIトークン」ではありません)
- X-point Cloudサブドメイン:X-point Cloudのサブドメインを入力します。例えば「https://xxxx.atledcloud.jp/」の場合は「xxxx」のみを入力します。
- ドメインコード:X-point Cloudのドメインコードを入力します。
- 更新データも連携する(オプション):デフォルトではX-point Cloudに対して新規のユーザー作成しか行われません。既存データの更新も行う場合にはこの項目にチェックを付けます。
- 部署と役職も連携する(オプション):部署や役職の情報も登録する場合にはチェックを付けます。チェックがない場合には「連携項目のマッピング設定」に設定項目が含まれていても無視されます。
レシピを実行する (自動実行はこちら)
マイレシピの操作メニューより「実行」を選択することでレシピを実行できます。
画面イメージや履歴の確認方法は以下をご参照ください。
レシピの実行に成功すると、SmartHR上の指定した従業員がX-point Cloudのユーザーとして作成されます。ユーザーが作成・更新されると下記のフォーマットで実行ログに記録されます。
[メールアドレス:社員番号]
また、作成・更新ができないレコードは不足情報が記録されます。
X-point Cloudのユーザー作成や更新に必要なキーは「ユーザーコード」となります。パターン別の処理内容は下記の通りです。
X-point Cloudへ連携する「ユーザーコード」および「ログインID」が存在しない:新規ユーザーが作成されます。
X-point Cloudへ連携する「ユーザーコード」が存在し「ログインID」が存在しない:既存のユーザーが更新されます。
X-point Cloudへ連携する「ユーザーコード」が存在せず「ログインID」が存在する:何も更新せず処理をスキップします。
【注意事項】SmartHR - X-point Cloudユーザー作成・更新 で取得可能な従業員情報の取扱いについて
- 取得できる従業員の範囲・項目は、設定時に利用したSmartHRのアカウントの権限設定を反映します。目的と用途に応じた権限のSmartHRのアカウントを使って設定を行ってください。
詳しくは、*従業員関連の閲覧・作成・更新・削除の権限を設定する* を参照してください。
https://support.smarthr.jp/ja/help/articles/1500001368101/
FAQ
Q.「SmartHR Plus上でActRecipeのアプリをインストールしてレシピを再実行してください。」と表示されますがどのようにすれば良いですか?
A.何らかの原因でSmartHR Plusの接続が切断されてしまった場合に表示されるメッセージです。以下の手順でSmartHR Plusとの再接続をお願いします。
・SmartHR Plusへアクセスし、アプリをアンインストールします。操作方法はこちら。
・続いてアプリの「追加」および「許可」をクリックしてください。操作方法はこちら。
Freeプランについて
このレシピはActRecipeのFreeプランでご利用いただけます。Freeプランの制約事項や有償プランへの移行は下記をご覧ください。
このレシピで連携できるSaaSについて
その他のSmartHR連携ができるレシピ