SFTPでデータを出力したい
回答
本記事では、b→dashからSFTPでデータを出力する方法について紹介しています。
SFTP連携でデータを出力するには下記の2つのパターンがあり、それぞれで設定方法が異なります。下記の俯瞰図と概要を参考に、貴社の環境に合ったパターンを選択してください。
1. b→dashが貴社のサーバーへファイルを送付するパターン: b→dashから貴社サーバーへ向けてデータファイルを送付する方式
2. 貴社のサーバーがb→dashへファイルを取りに行くパターン: b→dash側の中間サーバーに出力したファイルを、貴社サーバーが取得しに行く方式
各パターンの詳細な設定手順は、以下をご参照ください。なお、b→dashから貴社システムへの出力履歴を確認したい場合は、末尾の「[参考] 出力履歴を確認する」をご参照ください。
1. b→dashが貴社のサーバーへファイルを送付するパターン
b→dashから貴社サーバーへ向けてデータファイルを送付する方式です。b→dash側でSSH公開鍵を発行し、貴社サーバーに登録することで連携を行います。
出力先を設定する
1.「データパレット」>「データを連携」>「出力先」をクリックします
2.「新規追加」をクリックします
3.「SFTP」を選択し、「適用」をクリックします
4.「b→dashが貴社のサーバーへファイルを送付する」をクリックします
5.「ホスト名」「ポート番号」「ユーザー名」「ディレクトリパス」を入力します
6.「SSH公開鍵」をコピーし、貴社サーバーへ登録します
7.「名前」を入力し、「保存」をクリックします
8. 新規作成した連携が画面に表示されたら、ステータスを確認します
※ 連携のステータスは、画面に表示されるアイコンで把握することができます
各ステータスアイコンの意味は、下記のステータス一覧画像をご参照ください
※ セキュリティ上の理由で接続できるサーバーを制御する必要がある場合は、b→dashのIPアドレスのみ貴社のサーバーが接続できるよう設定をお願いします
b→dashが使用しているIPアドレスについては、「取込/出力で設定するIPアドレスを知りたい」をご参照ください
ステータスが「接続完了」にならない場合、設定に誤りがある可能性があります。下記の表に該当しないかをご確認ください。
考えられる原因 |
改善策 |
| SSH公開鍵が誤っている | 「データパレット」>「データを連携」>「出力先」を開き、対象SFTPエリアをクリックして「編集」を選択。表示されている公開鍵をコピーし、b→dashがアクセス予定のサーバーへ再設定します |
| SFTP出力先設定にて入力している接続先情報に誤りがある | 同じく出力先設定の編集画面から、入力されている接続先情報(ホスト名・ポート番号・ユーザー名・ディレクトリパス)が出力したいSFTP接続先のものになっているかを確認します |
| b→dashに登録したSSH公開鍵が途中で改行されている | SSH公開鍵は改行コードを含まない1行の文字列である必要があります。発行環境やテキストエディタの仕様で改行コードが含まれる場合は、改行を除いてb→dashに登録してください |
| SSH公開鍵を設定したサーバーに誤りがある | 正しい鍵を設定していても、b→dashがアクセスするサーバーに公開鍵が設定されていない場合は接続できません。アクセス先サーバーに公開鍵が設定されているかをご確認ください |
| ファイル出力設定が完了していない | 対象SFTPエリア内に「ファイルアイコン」があるかを確認します。アイコンがない場合は、後述の「出力するファイルを設定する」手順を実施してください |
| ファイル出力設定の連携タイミングが想定と異なっている | 対象SFTPエリア内のファイルアイコンをダブルクリックし、出力タイミング設定が想定通りか確認します |
出力するファイルを設定する
SFTP連携の設定が完了したら、出力するファイルを設定します。
1.「データパレット」>「データを確認」をクリックします
2. 出力したい「データ」をクリックします
3.「データ出力」>「外部システム出力」をクリックします
4. 先ほど作成した「連携先システム」を選択し、「適用」をクリックします
5.「出力する列」を指定します
6.「出力タイミング」を「単発」「繰り返し」のどちらかに設定します(繰り返しの場合、連携頻度と時間を設定して「追加」をクリック)
7. 出力時の「ファイル名」「ファイル形式」「文字コード」「改行コード」を選択します
8. 任意で「ヘッダーも出力する」「個人情報をマスキングする」「タイムスタンプをつける」にチェックを入れ、「適用」をクリックします
9. 出力設定したデータが画面に表示されます
※「データファイル更新時に出力する」にチェックを入れると、ファイルが更新されるごとにデータが出力されます
時間指定と併用することも、時間指定なしで「データファイル更新時に出力する」のみチェックを入れることも可能です
※「個人情報をマスキングする」にチェックを入れた場合、個人情報のカラムは「*(アスタリスク)」で表示されます
どのカラムを個人情報カラムに設定するかはデータ取込時に設定します。詳しくは「データを取り込みたい」をご参照ください
※「タイムスタンプをつける」にチェックを入れると、出力時のファイル名の末尾に『年月日時分秒』が自動で付与されます(出力ファイル名のプレビューで確認可能)
2. 貴社のサーバーがb→dashへファイルを取りに行くパターン
b→dash側の中間サーバーに出力したファイルを、貴社サーバーが取得しに行く方式です。貴社環境で「SSH公開鍵の作成」と「疎通確認」を行い、その公開鍵をb→dashに登録します。
出力先を設定する
1.「データパレット」>「データを連携」>「出力先」をクリックします
2.「新規追加」をクリックします
3.「SFTP」を選択し、「適用」をクリックします
4.「貴社のサーバーがb→dashへファイルを取りに行く」をクリックします
5. 貴社環境で作成した「SSH公開鍵」を入力します
6. b→dashの画面に表示される「ホスト名」「ポート番号」「ユーザー名」を中間サーバーに登録します
7.「名前」を入力し、「保存」をクリックします
8. 新規作成した連携が画面に表示されたら、ステータスを確認します
※ 上記のホスト名に接続するとホームディレクトリ直下に「output」ディレクトリがあるので、そこにあるファイルを取得してください
※ 連携のステータスは、画面に表示されるアイコンで把握することができます
各ステータスアイコンの意味は、下記のステータス一覧画像をご参照ください
※ セキュリティ上の理由で接続できるサーバーを制御する必要がある場合は、b→dashのIPアドレスのみ貴社のサーバーが接続できるよう設定をお願いします
b→dashが使用しているIPアドレスについては、「取込/出力で設定するIPアドレスを知りたい」をご参照ください
SSH公開鍵の作成方法
貴社環境の中間サーバーによって「SSH公開鍵の作成」の方法は異なります。ここでは「Unix/Linux環境」と「Windows環境(WinSCP利用)」の2つを例に、それぞれの方法を説明します。
1. サーバーにログインし、任意のユーザーで以下のコマンドを入力します
ssh-keygen -t rsa
実行中は3回のプロンプトが表示されますが、いずれも「Enter」キーを押下します(保存先の指定、パスフレーズの入力、パスフレーズの再入力)
2. 以下のコマンドで、公開鍵ファイル(id_rsa.pub)と秘密鍵ファイル(id_rsa)が生成されていることを確認します
ls -ltr ~/.ssh
3. 以下のコマンドで、公開鍵ファイルの中身を表示します
cat ~/.ssh/id_rsa.pub
4. 表示された「ssh-rsa」から始まる文字列をb→dashの画面に入力します
※「ssh-rsa」から始まる文字列の最初から最後の文字までを全てコピーしてください
また、途中で改行が入らないように注意してください
1.「WinSCP Download」にアクセスして「WinSCP」をダウンロードし、サーバーにインストールします
2.「WinSCP」を開き、画面左下の「ツール」から「PuTTYgenを実行」を選択します
3.「Parameters」から「RSA」を選択し、「Generate」をクリックします
4.「Public key for pasting into OpenSSH authorized_keys file」に公開鍵が表示されます
5.「Save private key」を選択し、任意のファイル名を付けて、ファイルをローカルに保存します
※「ssh-rsa」から始まる文字列の最初から最後の文字までを全てコピーしてb→dashの画面に入力してください
また、途中で改行が入らないように注意してください
※ 秘密鍵保存時に「Are you sure you want to save this key without a passphrase to protect it?」という警告が表示されることがありますが、「はい」をクリックしてください
保存に成功すると、拡張子「.ppk」のファイルが作成されます
疎通確認の方法
貴社環境の中間サーバーとb→dashの中間サーバー間で疎通ができていることを確認します。ここでは「Unix/Linux環境」と「Windows環境(WinSCP利用)」の2つを例に、それぞれの方法を説明します。
1. 以下のコマンドで、b→dashに連携するファイルがあることを確認します
ls -ltr
2. 以下のコマンドでSFTP接続を実行します
sftp -oPort=10222 -i ~/.ssh/id_rsa management_console_XXXXX_XX@sftp.smart-bdash.com:input/
3.「Connected to sftp.smart-bdash.com.」のカーソルが表示されたら疎通確認は完了です
※ コマンド中の「management_console_XXXXX_XX」の部分はb→dashアカウントに応じて変わります
b→dashの接続情報に記載されている『ユーザー名』を参照してください
1.「PuTTY Key Generator」をクローズし、WinSCPのログイン画面で「設定」を選択します
2. 左フレームから「認証」を選択し、秘密鍵に先ほど保存した「.ppk」ファイルを選択して「OK」をクリックします
3. b→dashの接続情報を参照し、「ホスト名」「ポート番号」「ユーザー名」を入力したうえで、ログインを実行します
4. WinSCP画面の右フレームに「input」「output」ディレクトリが表示されれば疎通は成功です
出力するファイルを設定する
SFTP連携の設定が完了したら、出力するファイルを設定します。基本的な手順は「1. b→dashが貴社のサーバーへファイルを送付するパターン」の「出力するファイルを設定する」と同じです。
1.「データパレット」>「データを確認」をクリックします
2. 出力したい「データ」をクリックします
3.「データ出力」>「外部システム出力」をクリックします
4. 先ほど作成した「連携先システム」を選択し、「適用」をクリックします
5.「出力する列」を指定します
6.「出力タイミング」を「単発」「繰り返し」のどちらかに設定します(繰り返しの場合、連携頻度と時間を設定して「追加」をクリック)
7. 出力時の「ファイル名」「ファイル形式」「文字コード」「改行コード」を選択します
8. 任意で「ヘッダーも出力する」「個人情報をマスキングする」「タイムスタンプをつける」にチェックを入れ、「適用」をクリックします
※ 各オプション(データファイル更新時の出力、個人情報マスキング、タイムスタンプ)の挙動は「1. b→dashが貴社のサーバーへファイルを送付するパターン」の「出力するファイルを設定する」の※書きと同じです
[参考] 出力履歴を確認する
b→dashから貴社システムにデータファイルを出力した履歴を確認する方法です。
1. 出力履歴を確認したい「データファイル」を選択します
2.「処理実行履歴」をクリックします
3. 処理分類が「出力」のレコードを確認します
