Contents
HRBrain の給与連携機能概要
HRBrain は、給与情報を CSV バッチ/手動アップロード と API 連携 の 2 系統で外部システムとやり取りできます。加えて、CSV を利用した 送信予約 機能により、明細配布の自動化も可能です。本セクションでは、各方式の特徴と導入時の選択指針を示します。
連携方式の種類と特徴
| 方式 | 主な利用シーン | メリット | 注意点 |
|---|---|---|---|
| CSV バッチ | 大量データの定期投入(月次給与、賞与) | 導入コストが低く、既存の帳票出力とそのまま流用できる | リアルタイム性はなく、投入タイミングに遅れが生じやすい |
| CSV 手動アップロード | 緊急修正や臨時項目(手当・ボーナス) | UI から即座に投入可能で、テスト環境でも手軽に利用できる | 手作業になるためヒューマンエラーのリスクがある |
| API 連携 | リアルタイム更新や双方向同期が必要なケース | 項目マッピングが柔軟で、給与計算システムと即時連携できる | 初期設定に開発リソースが必要。認証方式は公式ドキュメントを参照のこと |
| 送信予約(CSV 利用) | 明細配布タイミングの自動化 | CSV 投入後に自動でメール/Web 明細を配信でき、業務負荷を削減 | 送信テンプレートは事前に作成しておく必要がある |
導入時の選択指針
- データ量と更新頻度
- 月次・年次で大量データのみなら CSV バッチがシンプル。
-
途中追加やリアルタイム反映が求められる場合は API を併用。
-
社内リソース
-
開発担当者が少ない部署はまず CSV で導入し、後段階で API 移行を検討。
-
運用体制
- バッチ処理の監視・ログ保管が可能な環境かどうかで、バッチ vs 手動の比重を決める。
CSV 連携の設定と操作手順
CSV を利用した給与データ連携は、フォーマット遵守とジョブ設定が鍵となります。以下では、ファイル定義から実際のバッチ・手動アップロードまでを順に解説します。
ファイルフォーマットと必須項目
HRBrain が受け付ける CSV の列名・データ型は公式ドキュメントで固定されています。正しい形式で作成しないと取り込みエラーになるため、まずは以下の表を参照してください。
| 列名 (ヘッダー) | データ型 | 説明 | 例 |
|---|---|---|---|
| employee_id | 文字列 | 社員番号(HRBrain の社員コード) | A00123 |
| pay_month | 日付(YYYYMM) | 給与対象月 | 202607 |
| base_salary | 数値 (円) | 基本給 | 250000 |
| allowance_total | 数値 (円) | 手当合計(税引前) | 50000 |
| tax_amount | 数値 (円) | 所得税額 | 30000 |
| net_payment | 数値 (円) | 支給総額(手取り) | 270000 |
任意項目 として部門コードやカスタム項目を追加できますが、事前に HRBrain の管理画面で 個別追加項目 を登録しておく必要があります。
バッチジョブの作成手順
バッチ処理は自動化の中心です。以下の流れでジョブを構築してください。
- CSV 作成
給与システムから上記フォーマットで CSV をエクスポートし、UTF‑8・LF 改行に統一します。 - ジョブ定義(HRBrain 管理画面 → データ連携 → バッチ)
- ジョブ名:例
salary_monthly_202607 - 実行頻度:cron 表記で指定(例
0 2 1 * *=毎月 1 日 02:00) - 入力フォルダ:SFTP 推奨の
/upload/salary/batch/を設定 - テスト実行
「テスト実行」ボタンでサンプル CSV を投入し、エラーログを確認します。 - 本番運用開始
テストが成功したらスケジュールを有効化し、以降は自動でバッチが走ります。
手動アップロードのポイント
緊急対応や少数データの投入時に利用します。画面上の操作注意点を表にまとめました。
| 操作項目 | 注意点 |
|---|---|
| ファイル選択 | 文字コードは必ず UTF‑8、改行は LF に統一 |
| 取り込みオプション | 「上書き」か「追加」を明示。重複防止のため基本は「上書き」推奨 |
| エラーログ表示 | 行番号とエラー内容が即時に表示されるので、必ず確認して再アップロード |
Web給与明細での CSV 取り込みと送信予約設定
CSV を利用した明細作成と配布は、Web 給与明細 メニューから行えます。ここでは、取り込み手順と送信予約機能の設定ポイントを解説します。
CSV 取り込みフロー
- メニュー移動:管理画面 → 給与明細 → CSV 取込
- ファイル選択:作成した給与 CSV をアップロード
- 自動明細生成の有効化:オプションで「自動明細生成」をオンにすると、行データを元に PDF 明細が即座に作成されます。
- 取り込み完了確認:
明細一覧に新規レコードが表示され、従業員ごとに閲覧リンクが付与されます
この流れの中で「送信予約」も同時設定できるため、給与計算完了後の通知作業を自動化できます(公式ページ参照)。
送信予約機能の設定項目
| 手順 | 内容 |
|---|---|
| 1. テンプレート選択 | 「月次給与通知」など事前に作成したメールテンプレートを指定。変数 {employee_name} 等で個別情報を差し込めます。 |
| 2. 予約日時設定 | 給与計算完了翌営業日 09:00 に予約すると、従業員は出社後すぐに明細を確認可能です。 |
| 3. 対象者絞り込み | 部門・雇用形態でフィルタリングし、特定グループだけ別送信設定も可能です。 |
| 4. 確認・保存 | 「予約内容プレビュー」でメール本文と添付明細を確認後、保存してジョブを有効化します。 |
ベストプラクティス:バッチ処理完了直後に送信予約ジョブが走るよう、HRBrain の ワークフロー連携機能(公式サポートのみ)でトリガー設定すると運用負荷がさらに低減します。
PCAクラウド 給与との API 連携手順
PCAクラウド給与と HRBrain を API で接続することで、給与計算結果をリアルタイムに同期できます。公式ドキュメントに基づく設定手順を示します。
認証方式とエンドポイント設定
- OAuth2.0 クライアント登録(PCAクラウド側)
- 管理画面で
client_idとclient_secretを取得。 - アクセストークン取得リクエスト(POST)
|
1 2 3 |
curl -X POST https://api.pca.jp/oauth/token \ -d "grant_type=client_credentials&client_id={YOUR_CLIENT_ID}&client_secret={YOUR_CLIENT_SECRET}" |
成功時は { "access_token": "...", "expires_in": 3600 } が返ります。
- HRBrain 側エンドポイント登録(管理画面 → API 連携)
- ベースURL:
https://api.pca.jp/v1/salary -
ヘッダー:
Authorization: Bearer {access_token}を設定 -
接続テスト
「API 接続テスト」ボタンで 200 OK が返れば設定完了です。
現時点(2024 年版)では、トークンの自動更新機能は公式には提供されていません。アクセストークン有効期限切れの場合は、上記手順を再実行して新しいトークンを取得してください。
項目マッピングとカスタム項目同期方法
| PCA 側項目 | HRBrain 側項目 | 備考 |
|---|---|---|
| employee_id | employee_id | 主キーは必ず一致させる |
| salary_base | base_salary | 金額は円単位で送信 |
| allowance_total | allowance_total | 手当は事前に集約して送付 |
| custom_1 | extra_allowance | HRBrain 側で「個別追加項目」extra_allowance を作成要 |
| tax_amount | tax_amount | 必須項目 |
設定手順
- HRBrain にカスタム項目作成(管理画面 → 設定 → 個別追加項目)で
extra_allowanceを登録。 - PCAクラウド側で同名カスタム項目を有効化(API ドキュメント参照)。
- マッピング画面に上表の対応関係を入力し、保存。
この設定により、給与計算結果が API 経由で HRBrain に即時反映され、Web 給与明細へ自動的に表示されます。
運用・トラブル対策ベストプラクティス
安定した給与連携を実現するためには、移行計画から日常運用まで一貫したプロセスが重要です。本節では、具体的なチェックリストとエラー対応フローをご紹介します。
データ移行計画と二重入力防止策
| フェーズ | 実施項目 |
|---|---|
| 1. 方針決定 | CSV と API の主利用方式を明確化(例:過去データは CSV、当月以降は API) |
| 2. データクレンジング | 社員番号の重複・欠損チェック、金額フォーマット統一 |
| 3. 移行テスト | テスト環境でサンプル 100 件を両方式で投入し、結果を比較 |
| 4. 本番切替 | CSV バッチは月末に停止、API にスイッチオーバー。切替後 1 週間は手動チェック併用 |
| 5. 二重入力防止設定 | HRBrain の「データ受信履歴」画面で同一 pay_month・employee_id が既に存在する場合、API はエラーを返すよう設定 |
エラー例と対応手順
| エラーコード | 発生シーン | 主な原因 | 推奨対策 |
|---|---|---|---|
| ERR001 | CSV バッチ取込 | 必須項目 employee_id が欠損 |
CSV を再生成し、全行に社員番号を付与 |
| ERR014 | API 呼び出し | アクセストークン期限切れ | 新しいトークンを取得し、設定画面で更新 |
| ERR020 | 送信予約実行 | SMTP サーバー接続タイムアウト | ネットワークとメールサーバの応答時間を確認 |
| ERR035 | カスタム項目マッピング | マッピング先が未登録 | HRBrain の個別追加項目画面で対象項目を作成 |
エラーは HRBrain 管理画面 → ログ > 連携ログ に詳細が出力されます。まずはここから原因箇所を特定し、上表の対策を実施してください。
バッチスケジュールとログ管理のポイント
- バッチスケジュール例
salary_monthly_batch:毎月 1 日 02:00(CSV)-
api_sync_incremental:平日 09:30、12:30、16:30(API) -
ログ保存ポリシー
- 連携ログは最低 90 日保持し、月次で CSV エクスポートして監査資料とする。
-
異常検知の閾値は「エラー件数 > 5 件/日」。超過時は Slack(公式連携)またはメールで担当者にアラートを送信。
-
定期レビュー
- 月初に前月分のバッチ実行結果とエラーレポートを確認し、必要に応じてジョブ設定やマッピングを修正する。
まとめ
HRBrain の給与連携は CSV バッチ/手動アップロード と API 連携 を組み合わせることで、導入コストとリアルタイム性のバランスを最適化できます。
- 小規模・定期的なデータ投入は CSV バッチが簡便。
- 変更頻度が高く即時反映が必要な項目は API を活用。
- 送信予約機能により、明細配布を自動化し業務負荷を軽減できる。
本稿で示した設定手順・運用チェックリスト・エラーハンドリングを参考にすれば、給与情報の正確性とシステム間同期の安定稼働が実現します。ぜひ自社の業務フローに合わせて段階的に導入をご検討ください。