おしらせ
2023/10/31 ヘルプページを一部修正
目次
1.アプリ概要
様々なCSVフォーマットに併せてSmartHRの項目とマッピング設定しておくことで、SmartHRに従業員情報及び家族情報を登録/更新することができます。
本サービスは有料でご提供しております。
ご契約いただくと、以下のサービス・機能をご利用いただけます。
- 様々なCSVフォーマットに併せてマッピング設定が可能(上限なし)
- 従業員情報だけでなく家族情報も登録可能
- アプリに関するサポート(セキュリティーチェック対応等)
本ページでは「SmartHR from CSV」の使い方を説明します。
▼動画
2.アプリとSmartHRを接続する方法(初回のみ)
SmartHRと連携をするためには、「SmartHR from CSV」を「SmartHRに接続」する必要があります。
下記のページの「連携手順」をご一読いただき、利用したい企業アカウントにログインの上、「連携をはじめる」→「SmartHRへの接続を許可」を実行してください。
https://www.smarthr.plus/apps/smarthr-from-csv/manual
2.1.SaaStainerアカウントに登録する
▼利用するにはSaaStainerアカウントが必要です。
※ご利用にあたっての注意
利用したい企業アカウントの数だけSaaStainerアカウント登録が必要となります。
それぞれの企業アカウントでの「SmartHR from CSV」上で承認をしていただく事が必要となります。
OAuth認証画面の「アカウントの新規登録」もしくは下記リンクからご登録ください
2.2.「SmartHR from CSV」を購入する
ご利用を希望されるお客様は「アプリに関するお問い合わせはこちら」からご連絡下さい。
- トライアルあり
- 最大31日間(トライアル申込み月の月末まで)
- SmartHRとの契約期間と合わせて利用可能です
※「アプリに関するお問い合わせはこちら」から、メッセージ欄に以下2点を入力のうえお問い合わせください。
1.SmartHR本体の利用開始月
2.「SmartHRとの契約期間を合わせたい」と記載
3.アプリの起動方法
(トライアル利用できる状態の後)下記どちらかでもアクセスいただけます。
- SaaStainer TOPでログイン後、マイアプリ>「SmartHR from CSV」ページにある[アプリを開く]をクリックしてください。
- SmartHR Plus→SmartHR from CSV→「アプリを開く」をクリックしてください。https://www.smarthr.plus/apps/smarthr-from-csv
4.連携するCSVフォーマットをマッピングする方法
4.1.SmartHRとの連携を認証する
[連携する]ボタンをクリックしてください。
4.2.SmartHRにログインする
連携したいSmartHRテナントにログインします。
※ログイン済みの場合は省略されます。
4.3.連携を許可する
[連携を許可]を選択します。
※1回目のみ表示される画面です。2回目以降は表示されません。
4.4.マッピングを新規作成する
[新規作成]を選択します。
[>新規作成]を選択します。
以下のようなマッピング画面が表示されます。
4.5.マッピングの接続情報を設定する
CSVフォーマットに併せて複数のマッピングを設定することができます。
接続情報はどのマッピングかを識別する情報です。
-
-
ラベル
マッピング名称となる値です。半角英数字で任意の文字列を設定できます。
-
シークレット
マッピングを識別するシークレットキーです。ランダムで発行されます。
-
ラベルに任意の名称を入力してください。
シークレットは特に入力する必要はありません。更新したい場合のみ更新ボタンをクリックしてください。
4.6.マッピングの接続対象を設定する
下記いずれかのCSVフォーマットのマッピングを設定することができます。
-
-
従業員
従業員情報のみ記載あるCSVフォーマットを設定する場合に選択してください。
※従業員を識別するキーは社員番号となります。
CSVファイルに必ず社員番号に当たる項目を含めてください。
※キーに一致する従業員がSmartHRに存在している場合は更新、存在していない場合は新規登録となります。 -
家族情報
社員番号+従業員の家族情報のみ記載あるCSVフォーマットを設定する場合に選択してください。
※従業員を識別するキーは社員番号+家族コードとなります。
CSVファイルに必ず社員番号に当たる項目と、家族コードに当たる項目を含めてください。
※家族を識別するキーに一致する家族がSmartHRに存在している場合は更新、存在していない場合は新規登録となります。SmartHRの家族コードは外部連携を利用する場合に必要な値で、初めて家族情報を外部連携する場合は家族コードが未登録のケースがございます。未登録の場合は新規登録となるため、上書き更新をしたい場合は事前に家族コードをSmartHR側で登録の上、CSVファイルに家族コードを入力ください。
※CSVファイルの家族情報は必ず縦並びで記載してください。
-
設定したいCSVフォーマットに併せて連携対象を選択してください。
4.7.マッピングのマッピング項目を設定する
CSVフォーマットの項目と連携するSmartHRの項目をマッピングします。
設定するCSVフォーマットを用意してください。
※SmartHRが用意するサンプルのCSVフォーマット以外でも設定可能です。
ただしSmartHR側に連携できない項目が含まれないCSVに限ります。
(例:SmartHR→姓 名 が分かれている
CSVフォーマット→氏名が1つの項目になっている場合
⇒氏と名をわけて1つの項目になるよう加工してください)
CSVフォーマットの一番左のカラムに併せてSmartHRの項目を選択してください。
CSVフォーマットに存在するカラムの中で連携不要のカラムがある場合は「連携しない」を選択してください。
※文字を入力すると項目を検索することができます。
※キー項目(社員番号 or 社員番号+家族コード)に当たる項目は「連携しない」を選択しないようにご注意ください。
[+]ボタンをクリックするとマッピング項目を追加できます。
全てのカラムをマッピングしてください。
※各セルに入力可能な文字列は下記となります。リンク先を確認してください。
-
-
従業員情報を連携する場合
下記URLの***部分をサブドメインに変更すると表示することが可能です。
※従業員の新規登録で入力可能な文字列
(https://***.smarthr.jp/crews/bulk_inserter)
※従業員の更新で入力可能な文字列
(https://***.smarthr.jp/crews/bulk_updater?import_model=crew)
※「配偶者:無」として更新の場合、「配偶者の年収」ヘッダを用意した上で値を空にして取り込み用CSVファイルを作成してください。
-
-
-
家族情報を連携する場合
下記URLの***部分をサブドメインに変更すると表示することが可能です。
(https://***.smarthr.jp/crews/bulk_updater?import_model=dependent)
-
※CSVファイル形式の文字コードは下記を推奨しております。
-
- UTF-8
※BOM付きは不可となります。 - 半角カンマ区切り
※値を囲み文字(" ")で囲うとカラム不一致となるため不可となります。
- UTF-8
SJISやUTF-16等でも連携できますが、エラー詳細や結果概要が文字化けしていたり正常に連携できずエラーが発生する場合はUTF-8形式のファイルに変更して連携してください。
※連携対象「家族情報」を選択している場合の注意点
マッピング項目に表示される項目は家族情報の項目となります。(従業員 社員番号を除く)
CSVフォーマット内に従業員情報が存在している場合は「連携しない」を選択してください。
(例:CSVフォーマットに「従業員 姓」「従業員 名」が存在している場合)
4.8.マッピング設定を保存する
マッピング項目の選択が完了したら、[保存]をクリックします。
5.CSVファイルをアップロードする方法
下記いずれかのアップロード方法でアップロードすることができます。
- アプリ画面内からアップロードする方法
- お客様のサーバー上で操作を行いアップロードする方法(システム管理部門等サーバー管理をされている方の対応が必要)
※注意事項
- 1回あたりのアップロード件数は以下の範囲内で実行をお願い致します。
- 件数が多くなる場合は複数回に分けてアップロードをお願い致します。
- 従業員情報:1アップロードあたり500件
- 家族情報:1アップロードあたり10000件
※目安:1時間あたり1〜2回程度までのアップロードが可能です
- 仕様上、下記タイミングでシステムデータベースに「従業員番号」と「固有ID」を保存し処理負荷を下げております。
- 初回実行時
- 前回のアップロード実行完了時間から24時間以上経過した状態でCSVファイルをアップロード時
※前回のCSVアップロード実行完了時間から24時間以内且つ新規追加ユーザーを含むCSVファイルをアップロードした場合、新規登録は可能ですが、続けて同一の新規登録ユーザーを含むCSVファイルをアップロードすると重複エラーが発生する場合があります。1日程経過すると重複エラーは発生しなくなります。
※従業員番号を再利用する場合、前回のCSVアップロード実行完了時間から1日程経過するとエラーが発生しなくなります。
※(従業員アップロードに関して)
●SmartHRに従業員情報が15万件以上登録ある場合、上記アップロード件数範囲内でも登録処理が正常に行われない可能性があります。
※(家族情報アップロードに関して)
●CSV内の値が空の項目は、SmartHR側の値も空となります。空で上書き更新したくない場合はCSV内に値を入力してください。
●SmartHRに従業員情報が7万件以上登録ある場合、上記アップロード件数範囲内でも登録処理が正常に行われない可能性があります。
●アプリ画面内からアップロードする方法
5.1.1.[CSVアップロード]する
「CSVアップロード」をクリックし、ラベルで使用するラベルを選択してください。
5.1.2.アップロードするCSVファイルを登録する
[ファイルアップロード]にアップロードするCSVファイルをドラッグアンドドロップ、またはクリックをしてファイルを追加します。
●お客様のサーバー上で操作を行いアップロードする方法
※この方法で実行する場合は、必ずシステム管理部門等サーバー管理をされている方が操作を行ってください。
※サンプルコードをもとにコマンドプロンプトで実行する場合の方法を記載しています。実行したい環境や内容に合わせて変更してください。
※サンプルコード
curl -H "Content-Type: multipart/form-data" -H "Authorization: bearer {シークレットキー}" -F "file=@{ファイル名}" "{バッチ処理用のURLをコピーでコピーしたURL}"
5.2.1.コマンド用の必要情報をコピーする(画面から)
①[シークレット]のコピーボタン、②[バッチ処理用のURLをコピー]ボタンをクリックしてコピーし、メモなどに控えておいてください。
5.2.2.コマンド用の必要情報をコピーする(CSVファイル名)
③[実行するファイル名]をコピーしてメモなどに控えておいてください。
5.2.3.コマンドを実行しCSVファイルをアップロードする
コピーした必要情報を含めたコードをコマンドプロンプトに貼り付け、実行してください。
"status":"success"と表示されたらアップロード完了です。
※従業員情報や家族情報がSmartHRに取り込みが完了した訳ではありません。
6.アップロード結果を確認する方法
「連携ログ」から確認できます。
連携ログは、保持期間は1ヶ月かつ表示件数は最大1000件です。
6.1.連携ログ一覧を表示する
「連携ログ」をクリックし連携ログ一覧を表示します。
下記連携結果ステータスがあります。
-
-
実行中
CSVファイルがアップロードされ、実行中
-
完了
全件連携が成功
-
完了(エラーあり)
CSVファイルはアップロードされているが一部エラーあり
-
失敗
CSVファイルが何かしらの理由でアップロードできない
-
6.2.結果概要を表示する
[結果概要]をクリックすると、タスクの詳細が表示されます。
下記状態があります。
-
-
完了
バックグラウンド処理が完了
-
失敗
バックグラウンド処理が失敗
-
完了(エラーあり)
バックグラウンド処理は完了したが、一部の項目でエラーが発生
-
実行中
バックグラウンド処理が実行中
-
6.3.1.【従業員情報を連携した場合】連携結果を確認する(SmartHRのバックグラウンド処理詳細)
[処理名]をクリックするとSmartHRのバックグラウンド処理詳細をすることができます。
表示されたバックグラウンド処理詳細を確認し、必要に応じてCSVファイルの値やマッピング設定等の追加・修正等を行ってください。
6.3.2.【家族情報を連携した場合】連携結果を確認する(連携アプリ内)
家族情報はSmartHRのバックグラウンド処理機能を使って連携は行っていないため、SmartHRのバックグラウンド処理詳細には表示されません。
タスクの詳細に記載ある結果概要を確認し、必要に応じてCSVファイルの値やマッピング設定等の追加・修正等を行ってください。
成功した処理の[処理名]をクリックすると該当の家族情報ページを表示することができます。
7.解約方法
SaaStainerの「SmartHR from CSV」ページより解約を行ってください。
解約方法は下記リンクからご確認いただけます。
8.FAQ
- データ連携のキーとなる値は何になりますか
-
従業員を連携する場合
従業員を識別するキーは社員番号となります。
CSVファイルに必ず社員番号に当たる項目を含めてください。
※キーに一致する従業員がSmartHRに存在している場合は更新、存在していない場合は新規登録となります。
※キーが未入力の場合は新規登録となります。 -
家族情報を連携する場合
従業員を識別するキーは社員番号+家族コードとなります。
CSVファイルに必ず社員番号に当たる項目と、家族コードに当たる項目を含めてください。
※家族を識別するキーに一致する家族がSmartHRに存在している場合は更新、存在していない場合は新規登録となります。
※キーが未入力の場合は新規登録となります。
※CSVファイルの家族情報は必ず縦並びで記載してください。
-
- よくある連携エラーはどのようなケースが多いか
CSVファイル形式の文字コードがUTF-8でない場合
アプリ側では文字コードの制限は特に設けておりませんが、文字コードによってはCSVファイル自体の文字化けが発生して正常に連携できない場合があるため、下記を推奨しております。
・UTF-8 ※BOM付きは不可となります。
・半角カンマ区切り ※値を囲み文字(" ")で囲うとカラム不一致となるため不可となります。
※SJISやUTF-16等でも連携できますが、エラー詳細や結果概要が文字化けしていたり正常に連携できずエラーが発生する場合はUTF-8形式のファイルに変更して連携してください。
複数のマッピング設定の連携を実行した場合
複数のマッピング設定を同時に実行した場合、CSVファイルの処理の優先順位によっては処理を受け付けない場合があります。同時に実行せず、1CSVファイルずつ実行するようお願いします。
キーとなる値(社員番号or社員番号+家族コード)が未入力の場合
キーが未入力の場合は新規登録となります。既にある情報を更新したい場合は必ずキーとなる値が入力されている状態でCSVファイルを作成してください。
連携対象「家族情報」を選択している際、必須項目が未入力の場合
新規登録する際、必須項目が未入力の場合はエラーとなります。
必須項目はCSVファイルに含め、値が入力されている状態にしてください。
-
-
- 続柄
- 姓
- 名
- 生年月日
- 性別
-
また、家族の新規登録を行なう際、下記項目が未入力の場合は「扶養する」として登録されます。
-
-
- 社会保険の扶養状況
- 税法上の扶養状況
-
「扶養する」以外で登録したい場合は下記URLの***部分をサブドメインに変更して入力方法を確認して値を入力してください。
(https://***.smarthr.jp/crews/bulk_updater?import_model=dependent)
- 出力エラーについてはどのような対応が必要か
出力エラーが「アップロードされたファイルはCSVファイルではありません。」の場合
再度CSVファイルをアップロードしてください。
出力エラーが「CSVファイルのカラム数とマッピング設定のマッピング項目数が一致しません。」の場合
CSVファイルのカラム数を確認の上、マッピング項目を修正し、再度CSVファイルをアップロードしてください。
出力エラーが下記いずれかの場合
-
-
- 「"-H ""Authorization: bearer {シークレットキー}""にマッピング設定画面該当ラベルのシークレットキーを設定して送信してください。"」
- 「シークレットキーが不正です。マッピング設定画面該当ラベルのシークレットキーシークレットキーをご確認ください。」
- 「認証に失敗しました。マッピング設定画面該当ラベルのシークレットキーシークレットキーをご確認ください。」
-
アプリ内の該当ラベルの接続情報に記載あるシークレットキーを画面から正しくコピーしてコードを修正し、再度CSVファイルをアップロードしてください。。
出力エラーが下記いずれかの場合
-
-
- 「バッチ処理URLのUIDを入力して送信してください。」
- 「該当するラベルがありません。マッピング設定画面をご確認ください。」
-
アプリ内の該当ラベルの接続情報にある「バッチ処理用のURLをコピー」を正しくコピーしてコードを修正し、再度CSVファイルをアップロードしてください。
出力エラーが「CSVファイルが存在しません。送信内容をご確認下さい。」の場合
実行するフォルダにCSVファイルが格納されているか今一度ご確認の上、再度CSVファイルをアップロードしてください。
- 既に登録した従業員の社員番号や家族コードを変更したい
本アプリ経由で変更することはできません。
SmartHR側で該当従業員の社員番号または家族コードを手作業で変更するか、該当従業員や家族情報を削除してからCSVファイルの連携を実行してください。 - CSVファイルをアップロードしたのに連携ログ一覧に表示されない
実行してから数分は連携ログ一覧に表示されません。しばらくたってから更新ボタンをクリックしてください。 - タスクが終了しない
1000件ずつタスクが処理されるため、終了するまでお待ちいただくようお願いいたします。(取り込みデータ量に応じて終了時間が変わります)
▼SaaStainerへ戻る
SaaStainerサイトページ |
▼本アプリに関する不明点は下記お問い合わせフォームからご連絡ください
お問い合わせフォーム |