設定
本章では、一括伝送インターフェースの登録手順について説明する。
機関とファイルを送受信するためには、機関との間で使用する、一括伝送プロトコル情報、送受信ファイル情報、機関別の送受信ファイルに対する一括伝送インターフェース情報を定義する必要がある。 また、ファイルを指定された時間帯、およびファイルを繰り返し受信するためのスケジューラー情報を登録できる。 そして最後に、機関で受信したファイルを業務システムに転送、または読み込むためのFTP情報を登録する。
1. 一括伝送プロトコルの登録
一括伝送プロトコルの登録は、上記で説明した金融決済院のCMSプロトコル、銀行連合会プロトコル、およびその他のプロトコルに対する基本情報と、プロトコルで使用する電文に対する情報を登録する。
一括伝送プロトコル情報は、基本ルーターとプロトコルでファイルを伝送するために使用される電文種類と、電文のレイアウト情報で構成される。
Batch Management > File Transmission Protocol Information画面で登録する。BXIが提供する一括伝送プロトコルは予め登録されている。
構成項目
☑ 基本情報
- Batch Protocol ID : 一括伝送プロトコルを識別するためのIDであり、任意のルールに従って入力する。
- Batch Protocol Name : 一括伝送プロトコル名称を入力する。
- Protocol Router : 一括伝送プロトコルの最初の進入ポイントに使用されるルーターを選択する。 プロトコルルーターは、BXIで提供するルーター内からのみ選択できる。
- Common Header Layout : 一括伝送プロトコルの共通部に使用する電文レイアウトを選択する。
- Common Header Creation Program ID : 共通ヘッダーを作成するユーザー定義プログラムを選択する。
- DB Creation Program ID : ファイルを送信するためにファイルデータをDBに保存するユーザー定義プログラムを選択する。登録しない場合、BXIで提供する基本DB作成プログラムを使用する。
- File Creation Program ID : 受信したファイルを業務システムに転送するために、DBに保存されたデータをファイルで作成するユーザー定義プログラムを選択する。 登録しない場合、BXIで提供する基本ファイル作成プログラムを使用する。
☑ 共通ヘッダーの電文情報
共通ヘッダーレイアウトとして登録したレイアウトの各項目の意味を定義する。 BXIは、当該情報を利用して送信する電文を作成したり、受信された電文の意味を把握するために使用する。 もし電文情報に登録された情報で電文を作成できない場合は、「共通ヘッダー作成プログラム」に登録されているユーザー定義プログラムを呼び出して作成する。
- No : 共通ヘッダーレイアウトを登録する時、与えられた番号が自動に出力される。
- Field Name : 共通ヘッダーレイアウトに登録されているフィールド名が自動的に出力される。
- Description : 共通ヘッダーレイアウトに登録されているフィールド説明が自動的に出力される。
- Keyword Field Name : 当該フィールドがどのようなフィールドなのかをキーワード表から選択する。 このキーワードを利用して当該フィールドの意味を把握し、電文作成時に関連データを作成する。 キーワードに関する詳しい説明は以下のキーワード表を参照する。
- Default Value : 電文を作成する際に、使用するデフォルト値を入力する。デフォルト値は電文の種類に関係なく、常に固定された値の場合に登録する。
ファイルID、日付、時刻を表すキーワードの場合、フォーマットを使用して自動的に生成できる。
- ファイルIDキーワード
キーワードフィールド名がファイルIDの場合にファイル名のフォーマットをデフォルト値項目に使用できる。 ファイル名が8桁で、ファイルID+日付(MMdd)形式の場合、ファイル名からファイルIDだけを抽出するようにファイル名のフォーマットを使用しなければならない。
例) ${FILE_ID:4}+${MMdd:4}
上記のように、ファイル名フォーマットを登録する理由は、一括伝送ファイル情報には送受信ファイル名ではなくファイルIDを基準に情報を登録するため、送受信電文からファイルIDだけを抽出しなければならない。 一括伝送の送受信ファイル名とファイルIDが同じであれば、登録する必要はない。
- 日付、または時間キーワード
日付または時間が含まれたキーワード(電文伝送日時、伝送日付など)の場合、日付フォーマットをデフォルト値項目に登録することができる。 日付フォーマットを登録すると、自動的にシステム日付や時間を求めて、入力されたフォーマットに変更して電文を作成する。 システム日付や時間を使わずに、業務で提供する日付や時間の場合には使用できない。 日付形式は、送受信する電文の日付や時間または日時形式に合わせて登録することができる。
例) ${MMddHHmmss}
☑ キーワード
一括伝送電文レイアウトの意味を把握するために選択できるキーワードは、下記のとおりである。
| キーワード | 説明 |
|---|---|
| Business Division Code | JSONやXML電文で使用するフィールドのエレメント名を意味する。入力しない場合、フィールド名がエレメント名になる。 |
| Institutions Code | 当該フィールドが機関コードフィールドであることを意味する。 |
| Myself Institutions Code | 当該フィールドが自身の機関コードフィールドであることを意味する。 |
| Message Classification Code | 当該フィールドが電文の種別コードフィールドであることを意味する。 |
| File ID | 当該フィールドが一括伝送ファイルIDであることを意味する。当該フィールドがファイルIDの場合には、デフォルト値に送受信するファイル名のフォーマットを登録して使用できる。 |
| Send and Receive Flag | 当該フィールドが送受信FLAGフィールドであることを意味する。 |
| Response Code | 当該フィールドが応答コードフィールドであることを意味する。 |
| Base Date | 当該フィールドが基準日付フィールドであることを意味する。 |
| Message Send Time | 当該フィールドが出sンそう日時(mmddHHmmss)フィールドであることを意味する。 |
| Send Date | 当該フィールドが伝送日付(yyyyMMdd)フィールドであることを意味する。 |
| Send Time | 当該フィールドが伝送時刻(HHmmss)フィールドであることを意味する。 |
| Message Trace No | 当該フィールドが電文追跡番号フィールドであることを意味する。 |
| Send and Receive Business Division Code | 当該フィールドがファイルの送受信区分フィールドであることを意味する。 |
| Block No | 当該フィールドがブロック番号フィールドであることを意味する。 |
| Sequence No | 当該フィールドが一連番号フィールドであることを意味する。 |
| Number of Records | 当該フィールドがレコード数を示すフィールドであることを意味する。 |
| Number of Missing Count | 当該フィールドが欠番数を示すフィールドであることを意味する。 |
| Missing Confirmation | 当該フィールドが欠番情報を示すフィールドであることを意味する。 |
| Business Manage Info | 当該フィールドが電文を識別する業務管理情報フィールドであることを意味する。 |
| Sender Name | 当該フィールドが送信者名フィールドであることを意味する。 |
| Sender Password | 当該フィールドが送信者パスワードフィールドであることを意味する。 |
| Length of Records | 当該フィールドがレコード長を示すフィールドであることを意味する。 |
| Data Length | 当該フィールドが一度に伝送するデータの長さを示すフィールドであることを意味する。 |
| File Size | 当該フィールドがファイルのサイズを示すフィールドであることを意味する。 |
| Message Send Time | 当該フィールドが一度に伝送するTCPフレームの長さを示すフィールドであることを意味する。 |
| Total Number of Records | 当該フィールドがファイル全体のレコード数を示すフィールドであることを意味する。 |
| Batch Data | 当該フィールドがファイルのデータフィールドであることを意味する。 |
電文情報
一括伝送プロトコルの基本情報を登録した後に、プロトコルで使用するそれぞれの電文についての情報を登録する。
プロトコル電文登録は、画面のツリーで登録しようとするプロトコルにマウスを置いて、右クリックで表示されるメニューからAdd Protocol Layoutを選択して登録する。
☑ 基本情報
- Layout Classification Code : 一括伝送プロトコル電文を識別できる種別コードを登録する。
- Layout : 一括伝送プロトコル電文で使用する電文レイアウトを選択する。
☑ 電文情報
一括伝送プロトコルの電文情報は、一括伝送プロトコル情報で登録した共通ヘッダー電文情報登録方法と同じである。
2. 一括伝送ファイルの登録
一括伝送ファイルは、機関と送受信するファイルに対する共通情報として、ファイルID、伝送データ長、レコード長、レコード区切り文字などの情報を登録する。 ファイル情報がないと一括伝送処理ができないので、機関と送受信するファイルの場合は登録する必要がある。 ファイルIDはプロトコル電文上の毎日変更されるファイル名ではなく、一括伝送ファイルを区別するためのIDである。
構成項目
☑ 基本情報
- Batch Transfer File ID : 一括伝送ファイルを識別するファイルのIDを入力する。ファイルIDは、機関とファイル別に決められた名前である。
- Batch Transfer File Name : 一括伝送ファイルの日本語名を入力する。
- Apply Date : 一括伝送ファイルを送受信する適用日付を入力する。入力された日付以降から、当該ファイルを処理できる。 そのため、当日ファイルを適用するためには、前日の日付を入力する必要がある。
- Data Transfer Length : 送受信時、一度に伝送するデータの長さを入力する。 同じファイルであるが、機関業務ごとにデータ伝送長が異なる場合には、一括伝送インターフェース定義時に再定義することができる。
- Record Length : 一括伝送ファイル別に１つのレコード長を入力する。
- Record Delimiter Code : 一括伝送ファイルがシステムファイルに保存する際に、レコードを区分するための値を選択する。
- Send/Receive Interval Code : 一括伝送ファイルの送受信周期を選択する。単純に情報としてのみ使用する。
3. 一括伝送インターフェースの登録
一括伝送インターフェースでは、２つの情報を登録する。１つは、一括伝送業務を処理する機関業務情報を登録するもので、プロトコル情報から登録したプロトコルを割り当てる作業である。 一括伝送プロトコル情報で登録した、共通ヘッダーレイアウトやプロトコル電文のレイアウトは再定義できる。 もう１つは、一括伝送ファイル情報で登録した一括伝送ファイルを、送受信する機関業務に割り当てる作業である。 このような方法で割り当てられたファイルは、登録されたプロトコルを利用して当該機関と送受信する。
機関業務
機関と一括伝送業務を処理する情報を登録する。 機関業務情報登録時に、当該一括伝送ファイルを送受信する際に、使用する一括伝送プロトコルを指定する。 一括伝送プロトコル情報で登録した、プロトコルの共通ヘッダーレイアウトや、それぞれの電文レイアウトが登録する機関業務で使用するレイアウトと異なる場合は、再定義できる。
☑ 基本情報
- Business Code : 一括伝送を処理する業務で、業務情報画面で登録したバッチ業務の中から選択する。
- Apply Date : 機関業務を適用する適用日付を入力する。入力された日付以降から業務が処理される。 そのため、当日業務を適用するためには、前日の日付を入力する必要がある。
- Message Character Set : 対外機関と電文送受信時にエンコーディングおよびデコーディングに使用するキャラクターセットを選択する。
- Batch Protocol ID : 一括伝送プロトコル情報で登録したプロトコルの中から、該当機関と一括伝送ファイルを送受信するために使用するプロトコルを選択する。
- Common Header Layout : 一括伝送プロトコルを選択すると、自動的に一括伝送プロトコル登録時に登録した共通ヘッダーレイアウトが出力される。 もし、同じプロトコルを使用するが、共通ヘッダーレイアウトが異なる場合、共通ヘッダーレイアウトを再定義することができる。
- Multi Channel Transfer Y/N : 要求と応答を分けて、別のチャネルを使用するかどうかを選択する。
一般的に、一括伝送で１つのファイルをすべて送受信するまで、要求と応答電文を１つのチャネルを使用して送受信する。 これを単一チャネル伝送という。 特定機関では、要求と応答を区別して別のチャネルを使用することもあり、このような方式をマルチチャネル伝送方式という。
単一チャネル伝送方式でファイルを送受信する場合に接続されたチャネルが複数の場合、同時に複数のファイルを送受信することができる。 しかし、マルチチャネル伝送方式は、2つのファイルを同時に送受信する場合、技術的にどのファイルのデータなのか区分できないため、1回に1つのファイルのみを処理することができる。
☑ 伝送者情報
一括伝送プロトコルに従って、伝送者情報を使用する機関は、伝送者情報を登録する必要がある。伝送者情報は、業務開始電文から使用する。
- Sender Name : 伝送者の名称を入力する。
- Password : 伝送者のパスワードを入力する。 パスワードは暗号化してDBに保存される。
- Sender Verification Y/N : 一括伝送電文を受信する際に、伝送者情報を検証するかどうかを登録する。
特定の暗号・復号化方式で伝送者パスワードの暗号・復号化が必要な場合、伝送者情報を使用する電文の電文作成プログラム(bxi.api.BatchMessageProcess)を作成する必要がある。 例えば、CMSプロトコルで使用する暗号・復号化はbxi.parser.security.CmsSecurityUtilクラスで提供する。
☑ スケジュール情報
スケジュール情報は、機関からGET方式でファイルを受信する時のみ登録する。 機関にファイルを送信する際は、業務システムで送信ディレクトリにファイルを保存すると自動的にファイルを送信するので、スケジューラー登録を不要である。 しかし、GET方式でファイルを受信する場合には、当該機関からいつファイルを送信できるのか分からないため、一定間隔で開始電文を持続的に送信してファイルを要求するようにスケジュールを登録する。 登録方法は、スケジュール情報を参照する。
☑ 電文情報
電文情報は一括伝送プロトコルで定義した一括伝送プロトコルの電文情報を出力する。当該機関業務で電文の種類は同じだが、電文のレイアウトが異なる場合には電文のレイアウトを再定義することができる。
ファイル情報
機関業務で送受信するファイルを、一括伝送ファイル情報で登録したファイルの中から選択する。当該ファイルは、機関業務に登録されたプロトコルを利用して、該当機関に送受信する。
☑ ファイル情報
- Batch Transfer File ID : 一括伝送ファイル情報で登録したファイルの中から選択する。
- Apply Date : 一括伝送ファイルを送受信する適用日付を入力する。 入力された日付以降から、当該ファイルを処理できる。そのため、当日ファイルを適用するためには、前日の日付を入力する必要がある。
- Send/Receive Type Code : 送信ファイルなのか受信ファイルなのか区分を選択する。
- File Duplication Y/N : ファイルを重複して送受信できるかどうかを選択する。
- Data Wait Time(ms) : 一括伝送プロトコルで１つの電文を伝送後、次の電文を伝送するまでの待機時間を間を入力する。 これは、機関ごとに送受信時間が異なり、短時間にあまりにも多くのデータを伝送することにより発生する電文の損失を防止するためである。
- Message Open Stat Type Code : 一括伝送ファイルを送受信するために、開始電文をどちらが先に伝送するかを選択する。
- Automatically transfer file Y/N : 一括伝送送信ファイルの場合、伝送準備が完了したら自動伝送するか、または管理者が手動伝送するかを選択する。
- Data Transfer Length : 一括伝送ファイル情報で登録したデータ伝送長と同じ意味で、一括伝送ファイル情報で定義したデータ伝送長を機関別に再定義することができる。 登録しない場合、一括伝送ファイル情報で登録した伝送長を使用する。
- Record Length : 一括伝送ファイル別の１つのレコード長で、一括伝送ファイル情報で定義したレコード長を機関別に再定義することができる。 登録しない場合、一括伝送ファイル情報で登録したレコード長を使用する。
☑ FTP情報
対外機関に送信するファイルの場合に、FTP情報を登録すれば、業務システムからFTPにファイルを読み込んで送信し、受信するファイルの場合には、FTP情報を登録すれば、対外機関からファイル受信が完了するとファイルを作成して業務システムのFTPに送信する。 特に、送信ファイルにFTP情報を登録すると、業務システムからFTPでファイルを読み込まなければならないため、スケジュール情報も一緒に登録する必要がある。 いつ業務システムからファイルを読み込んで送信するかが分からないため、必ずスケジュール情報も登録しなければならない。
- FTP ID : FTP情報で登録した情報の中から選択する。
- FTP File Name : FTPに読み込むファイル名を入力する。
- Schedule Information : FTPに読み込むスケジュールを登録するものでスケジュール情報を参照する。
4. FTP情報
FTP情報とし、一括伝送で送信するファイルを業務システムから読み込んだり、受信したファイルを業務システムに転送する際に、使用する情報を登録する。 または、一括伝送電文方式でファイルを伝送せずに、ファイルを１つのシステムから他のシステムにFTPで転送したり、対内システムファイルを対外システムに送信する際に、使用するFTPを登録する。
構成項目
☑ 基本情報
- FTP ID : FTPを識別するためのIDを入力する。
- FTP Name : FTPの名称を入力する。
- Protocol : FTPプロトコルを選択する。プロトコルは、一般FTPとSFTPに対応している。
- Port No. : FTPのポート番号を入力する。
- FTP IP : FTPの接続IPを入力する。
- User ID : FTPユーザーIDを入力する。
- Password : ユーザーのパスワードを入力する。パスワードは暗号化されてDBに保存される。
5. スケジュール情報
スケジュール情報は、ユーザーが一定間隔、または特定の時間帯に処理するスケジュールを登録および管理する。 スケジュールは、スケジュールの束であるスケジュールグループとそれぞれのスケジュールに分かれている。
構成項目
☑ 基本情報
- Schedule ID : スケジュールを識別するためのIDで任意のルールに従って入力する。
- Schedule Name : スケジュールの名称を入力する。
- Processing Program ID : スケジュールによって実行されるプログラムを選択する。処理プログラムは、プログラムの情報画面で登録する必要がある。
- Schedule Type : スケジュールの種類には「Interval」と「Cron」方式の中から選択する。
- Interval : 処理間隔(秒)ごとにスケジュールを繰り返し実行する方式である。
- Cron : 月日時分など入力した値に従ってスケジュールを実行する方式である。
- Schedule Start Time(HH:MM) : スケジュールは、スケジュールの種類によって時間に関係なく一日中実行される。 ただし、スケジュールによっては、開始時間と終了時間を設定し、その時間にのみスケジュールを実行することができる。 スケジュール開始時間は1日のうち、いつからスケジュールを実行するのか開始時間を登録する。 開始時間前にスケジュールが実行されると、処理プログラムは実行されない。
- Schedule End Time(HH:MM) : スケジュール開始時間と同様で、スケジュールをいつまで実行するか終了時間を登録する。終了時間を過ぎたスケジュールを設定しても、処理プログラムは実行されない。
一括伝送の手動処理
一括伝送の手動処理は、ファイルを自動的に送受信する方法ではなく、ユーザーが手動で送受信する方式である。 または、ファイル伝送を自動的に設定していた場合でも、該当機関へのファイル伝送で障害が発生し、障害発生後ファイル伝送できなかった場合には、伝送準備が完了したファイルに対して再処理できる。
手動処理
Execution Management > File Transmission Request画面で手動処理できる。手動処理は送信と受信に区分される。
☑ 手動送信
送信準備が完了したファイルに対して送信処理を開始する。
☑ 手動受信
GET方式プロトコルでファイルを受信するために開始電文を手動で要求する。
再処理
Status Monitoring > File Transmission Processing Status画面で連携される画面のFile Transmission Processing Details画面で再処理できる。
☑ 再送信
当日送信するファイルの処理中にエラーが発生した場合、または、完了したファイルに対する一括伝送インターフェースに「File Duplication Y/N」が許可に設定されている場合は、再送信処理が可能である。 再送信項目が表示されない場合は、当該ファイルは再送信できないことを意味する。
☑ 業務再送信
受信したファイルは、受信が完了すると自動で業務システムに伝達される。しかし、業務チームでファイル処理中にエラーが発生して再送信を要求する場合、当日ファイルに限り業務システムに再送信できる。 当日受信が完了したファイルに対してのみ業務再送信が可能であり、項目が表示されなければ当該ファイルは業務システムに再送信できない。