本レシピはFreeプランにて無料でご利用いただけます。アカウント登録が完了されていない場合は下記よりご登録ください。
ActRecipe Freeプラン | 無料で始めるiPaaS | ActRecipe
SmartHRのカスタム従業員項目を含む任意の従業員情報をCSVファイルに出力する方法を解説します。
レシピを使用するには事前にSmartHRの利用契約が必要になります。
0.事前準備
- 「SmartHR - CSVファイル出力 (カスタム従業員項目対応)」レシピを使用するには、事前にSmartHR Plusでのアプリの登録が必要となります。
- 以下のSmartHR Plusにアクセスし、画面右上の「ログイン」ボタンよりSmartHRへログインします
https://www.smarthr.plus/apps/actrecipe - 続いて「連携をはじめる」ボタン(青色)をクリックします
- アプリのインストール確認画面にて「連携をはじめる」ボタンをクリックします
- アプリの連携が完了しますと上記「2」のボタンが「アプリを開く」に変わりますので、同ボタンをクリックします
- 以下の確認画面が表示されますので「連携を許可」をクリックします(※)
連携するユーザはSmartHRの「管理者」権限を保持している必要があります。
※
ActRecipeのアカウントを保持しておりActRecipeにログインしていない場合にはログインをしてください。
ActRecipeのアカウントが未作成の場合は「無料ではじめる」ボタンよりアカウントを作成し、通知メールに従ってください。
1.マイレシピへの登録
メニューの「シェアレシピ」から、「SmartHR - CSVファイル出力 (カスタム従業員項目対応)」にチェックを入れ、画面下にある登録ボタンを押下します。シェアレシピの画面に「SmartHR - CSVファイル出力 (カスタム従業員項目対応)」が表示されない場合はSmartHR Plusの画面からやり直してください。
続いて「マイレシピ」から、操作メニューより「編集」を選択します。
参考:シェアレシピ・マイレシピとはなんですか?
ヘッダーでは、レシピ名とレシピ説明を変更することができます。
参考:レシピヘッダーでは何を設定すれば良いですか?
2.SmartHRの認証情報設定
「SmartHR 社員情報取得 (カスタム従業員項目対応)」を押下し、設定を展開します。
本タスクでは、以下の項目を設定します。
-
ヘッダーの種類:取得するヘッダーの種類を選択します。
- 物理名:SmartHRのシステム上設定されている項目名が取得されます。例えば、社員番号は「emp_code」と出力されます。
-
論理名:SmartHRの画面上で表示される項目名が取得されます。例えば、社員番号は「社員番号」と出力されます。後述しますマッピング出力をされる場合には必ず論理名をご指定ください。
-
取得データの種類:
- 物理名:システム上設定されている項目名が取得されます。例えば、性別項目の値は「male」「female」となります。
- 論理名:画面に表示される項目名が取得されます。例えば、性別項目の値は「男性」「女性」となります。
-
フリーワード検索
SmartHRからの取得データ件数が多い場合にはレシピ実行がタイムアウトエラー(サーバー応答コード: 202)となる可能性があります。そのような場合に、取得データを絞り込んでデータを取得できるオプションです。例えば、社員番号の「0001」を指定しますと「00001」および「00010〜00019」が取得対象となります。他にも氏名、ビジネスネーム、部署名、役職名、事業所でも絞り込むことができます。従業員数が数千名を超えるような場合にはレシピを複数作成していただいた上で、本フリーワード検索にて部署名や事業所名によって対象データの絞り込みをお願いします。本項目に値がある場合には下記の「詳細検索」の設定が無効となりますのでご留意ください。 - 詳細検索 (オプション):フリーワード検索よりも細かな条件で対象データを絞り込むことができます。条件指定は最大10件まで行うことができます。
[社員番号, ユーザーID, 従業員のID, 戸籍上の性別, 雇用形態, 在籍状況, 入社年月日-開始日, 入社年月日-終了日, 部署ID, フリーワード検索]
SmartHRとのOAuth接続を切断する場合は「OAuthを切断する」をクリックし、下記の確認画面より右下の削除アイコンをクリックします。
3.SmartHRとCSVファイルのマッピング出力設定
本タスク設定はIT担当者向けの内容となりますので、SmartHRからの取得情報をカスタマイズせずにCSVファイルに出力されたい場合や設定内容がご不明な場合はスキップしてください。
「SmartHR - Convert crews data」タスクでは、SmartHRの項目のうちどの項目をCSVファイルへ出力するかを設定することができます。
はじめに以下の手順で設定ファイルを適用します。
- 以下のファイルをローカルPC環境等に保存します。
SmartHR - エクスポート用JSONファイル(論理名)v1.2 - レシピの編集画面より、アップロードアイコンから上記のJSONファイルをアップロードします。JSONファイルが未設定の場合にはSmartHRから取得した全ての項目がCSVファイルに保存されます。
デフォルトの出力項目は以下の通りです。
「ヘッダーの種類」が物理名の場合:
user_id,emp_code,last_name,first_name,biz_establishment.name,department1,department2,department3,employment_type.name,last_name_yomi,first_name_yomi,business_last_name,business_first_name,business_last_name_yomi,business_first_name_yomi,birth_at,gender,email,tel_number,address.zip_code,address.pref,address.city,address.street,address.building,address.literal_yomi,address.country_number,address_head_of_family,address_relation_name,emergency_relation_name,emergency_last_name,emergency_first_name,emergency_last_name_yomi,emergency_first_name_yomi,emergency_tel_number,emergency_address.zip_code,emergency_address.pref,emergency_address.city,emergency_address.street,emergency_address.building,emergency_address.literal_yomi,emergency_address.country_number,resident_card_address.zip_code,resident_card_address.pref,resident_card_address.city,resident_card_address.street,resident_card_address.building,resident_card_address.literal_yomi,resident_card_address_head_of_family,resident_card_address_relation_name,position,position1,position2,position3,occupation,emp_status,entered_at,resigned_at,resigned_reason,emp_ins_insured_person_number,emp_ins_qualified_at,emp_ins_disqualified_at,soc_ins_insured_person_number,hel_ins_insured_person_number,basic_pension_number,soc_ins_qualified_at,soc_ins_disqualified_at,monthly_income_currency,monthly_income_goods,monthly_standard_income_updated_at,monthly_standard_income_hel,monthly_standard_income_pns,payment_period.name,having_spouse,spouse_yearly_income,nearest_station_and_line,commutation_1_expenses,commutation_1_period,commutation_1_single_fare,commutation_2_expenses,commutation_2_period,commutation_2_single_fare,foreign_resident_last_name,foreign_resident_first_name,foreign_resident_middle_name,foreign_resident_card_number,nationality_code,resident_status_type,resident_status_other_reason,resident_end_at,having_ex_activity_permission,other_be_workable_type,contract_type,contract_start_on,contract_end_on,contract_renewal_type,handicapped_type,handicapped_note_type,handicapped_note_delivery_at,working_student_flag,school_name,enrolled_at,working_student_income,employment_income_flag,business_income_flag,devidend_income_flag,estate_income_flag,widow_type,widow_reason_type,widow_memo,tax_cd,bank_account1.name,bank_account1.bank_code,bank_account1.bank_branch_code,bank_account1.account_type,bank_account1.account_number,bank_account1.account_holder_name,bank_account2.name,bank_account2.bank_code,bank_account2.bank_branch_code,bank_account2.account_type,bank_account2.account_number,bank_account2.account_holder_name,bank_account3.name,bank_account3.bank_code,bank_account3.bank_branch_code,bank_account3.account_type,bank_account3.account_number,bank_account3.account_holder_name,bank_account4.name,bank_account4.bank_code,bank_account4.bank_branch_code,bank_account4.account_type,bank_account4.account_number,bank_account4.account_holder_name
「ヘッダーの種類」が論理名の場合:
ユーザーID,社員番号,姓,名,事業所名,部署1 部署,部署2 部署,部署3 部署,雇用形態,姓(ヨミガナ),名(ヨミガナ),ビジネスネーム:姓,ビジネスネーム:名,ビジネスネーム:姓(ヨミガナ),ビジネスネーム:名(ヨミガナ),生年月日,戸籍上の性別,メールアドレス,電話番号,現住所(郵便番号),現住所(都道府県),現住所(市区町村),現住所(丁目・番地),現住所(建物名・部屋番号),現住所(ヨミガナ),現住所(国コード),現住所の世帯主,現住所の世帯主の続柄,緊急連絡先の続柄,緊急連絡先の姓,緊急連絡先の名,緊急連絡先の姓(ヨミガナ),緊急連絡先の名(ヨミガナ),緊急連絡先の電話番号,緊急連絡先の住所(郵便番号),緊急連絡先の住所(都道府県),緊急連絡先の住所(市区町村),緊急連絡先の住所(丁目・番地),緊急連絡先の住所(建物名・部屋番号),緊急連絡先の住所(ヨミガナ),緊急連絡先の住所(国コード),住民票住所(郵便番号),住民票住所(都道府県),住民票住所(市区町村),住民票住所(丁目・番地),住民票住所(建物名・部屋番号),住民票住所(ヨミガナ),住民票住所の世帯主,住民票住所の世帯主の続柄,役職,部署1 役職,部署2 役職,部署3 役職,業務内容,在籍状況,入社年月日,退職年月日,退職事由,雇用保険の被保険者番号,雇用保険の資格取得年月日,雇用保険の資格喪失年月日,厚生年金保険の被保険者整理番号,健康保険の被保険者整理番号,基礎年金番号,社会保険の資格取得年月日,社会保険の資格喪失年月日,報酬月額(通貨),報酬月額(現物),標準報酬月額の改定年月日,健康保険の標準報酬月額,厚生年金の標準報酬月額,給与支給形態,配偶者の有無,配偶者の年収,通勤経路,通勤手当1の定期券代,通勤手当1の期間,通勤手当1の片道運賃,通勤手当2の定期券代,通勤手当2の期間,通勤手当2の片道運賃,在留資格認定証明書:姓,在留資格認定証明書:名,在留資格認定証明書:ミドルネーム,在留カード番号,国籍コード,在留資格,在留資格不明理由,在留期日,資格外活動許可の有無,派遣・請負就労区分,契約種別,契約開始日,契約終了日,契約更新の有無,障害者区分,障害者手帳の種類,障害者手帳の交付年月日,勤労学生フラグ,勤労学生:学校名,勤労学生:入学年月日,勤労学生:所得の見積額,勤労学生:給与所得フラグ,勤労学生:事業所得フラグ,勤労学生:配当所得フラグ,勤労学生:不動産所得フラグ,寡婦・ひとり親,寡婦・ひとり親の理由,寡婦・ひとり親の備考,課税区分,給与振込口座1 口座情報の名称,給与振込口座1 銀行コード,給与振込口座1 支店コード,給与振込口座1 預金種別,給与振込口座1 口座番号,給与振込口座1 名義(カタカナ),給与振込口座2 口座情報の名称,給与振込口座2 銀行コード,給与振込口座2 支店コード,給与振込口座2 預金種別,給与振込口座2 口座番号,給与振込口座2 名義(カタカナ),給与振込口座3 口座情報の名称,給与振込口座3 銀行コード,給与振込口座3 支店コード,給与振込口座3 預金種別,給与振込口座3 口座番号,給与振込口座3 名義(カタカナ),給与振込口座4 口座情報の名称,給与振込口座4 銀行コード,給与振込口座4 支店コード,給与振込口座4 預金種別,給与振込口座4 口座番号,給与振込口座4 名義(カタカナ)
JSONファイルはSmartHRとCSVファイルのマッピング設定をまとめたものとなりますので、検証等で設定変更を繰り返したい場合にはダウンロードアイコンから設定ファイルをバックアップしてください。
続いて、「SmartHR - Convert crews data」タスクの画面について説明します。
下図の「項目名」はCSVファイルのヘッダーを指しており、「出力指定」はSmartHRの項目を指しております。SmartHRの項目とその説明、ActRecipeのJSON項目名は以下の資料をご確認ください。
「出力指定」には上記ファイルの「SmartHR項目説明 (論理名)」または「ActRecipeのJSON項目名」のみ指定可能です。設定値は「SmartHR 社員情報取得 (カスタム従業員項目対応)」タスクの「ヘッダーの種類」に依存しますので、以下の組み合わせとなるようご対応ください。
- 「出力指定」に「SmartHR項目説明 (論理名)」を使用する場合:「ヘッダーの種類」からは「論理名」を指定します。
- 「出力指定」に「ActRecipeのJSON項目名」を使用する場合:「ヘッダーの種類」からは「物理名」を指定します。物理名を指定した場合もカスタム従業員項目はSmartHRの論理名が出力されますので、カスタム従業員項目を出力される場合は「ヘッダーの種類」を「論理名」としていただくことを推奨します。
「型」や「桁数」や「出力区分」は任意の設定を行なっていただくことができます。
「出力指定」ではExcelとほぼ同様の関数指定を行うことができます。例えば、SmartHRの「姓」と「名」を1つのフィールドに出力したい場合は、出力区分および出力指定を以下のように指定します。
出力区分:計算式
出力指定:#(姓)&#(名)
給与ソフト等に合わせた各種テンプレートは下記ページをご覧ください。
SmartHR用インポート・エクスポートテンプレート
出力指定の条件指定方法のサポートは有償プランにて承っております。詳しくはお問い合わせください。
レシピを実行する (自動実行はこちら)
マイレシピの操作メニューより「実行」を選択することでレシピを実行できます。
画面イメージや履歴の確認方法は以下をご参照ください。
レシピの実行に成功すると、SmartHR上の指定した項目および値がCSVファイルに出力されます。
【注意事項】SmartHR - CSVファイル出力 で取得可能な従業員情報の取扱いについて
- 取得できる従業員の範囲・項目は、設定時に利用したSmartHRのアカウントの権限設定を反映します。目的と用途に応じた権限のSmartHRのアカウントを使って設定を行なってください。
詳しくは、*従業員関連の閲覧・作成・更新・削除の権限を設定する* を参照してください。
https://support.smarthr.jp/ja/help/articles/1500001368101/
Freeプランについて
このレシピはActRecipeのFreeプランでご利用いただけます。Freeプランの制約事項や有償プランへの移行は下記をご覧ください。
このレシピで連携できるSaaSについて
その他のSmartHR連携ができるレシピ