API連携機能は、Interstage Information Storageに格納されている大量データの中から目的のデータを抽出するアプリケーションを作成するための機能です。
ここでは、Interstage Information Storageの各機能と、抽出機能およびAPI連携機能との関係を説明します。
抽出機能は、Interstage Information Storageの「ロード機能」を利用してInterstage Information Storageに登録されたデータから、データを抽出します。
抽出を行う際は、格納されているデータの形式を意識する必要があります。これらの情報は、「資源管理データ」を参照して確認します。
Interstage Information Storageでは、多数の抽出クエリーが発生してもレスポンスを安定させるため、抽出依頼を受け付ける「抽出制御サーバ」がいます。APIは、抽出制御機能に抽出を依頼します。
抽出制御サーバから、抽出エンジンである「データ抽出セル」経由で抽出が行われると、「抽出結果情報」が出力されます。この抽出結果情報をAPIが取得し、アプリケーションでの処理を行います。
API連携機能の位置付けを、以下に示します。
図1.1 API連携機能の位置付け
API連携とコマンド実行の違い
抽出方法には、以下の2つがあります。
条件の変更頻度や、抽出結果の編集といった抽出後の処理の必要性を考慮して、API連携機能を使ったデータ抽出を行うか、コマンド実行によるデータ抽出を行うかを選択します。
なお、API連携とコマンド実行で機能的な相違点はありません。
API連携によるデータ抽出
アプリケーション経由で抽出制御機能に抽出を依頼します。
画面からそのつど条件を指定したり、抽出結果を基にさらにデータを絞り込むなど、非定型の条件指定に向いています。
コマンド実行によるデータ抽出
あらかじめ抽出条件を指定した「抽出プロパティファイル」を使用して、抽出コマンドで抽出制御サーバに抽出を依頼します。定型処理に向いています。