外部インタフェース設計書（Excelテンプレート）

外部インタフェースの設計書（基本設計/詳細設計）のエクセルの設計書テンプレートを用意いたしました。

外部インタフェース一覧の設計書が必要な方は以下からダウンロードしてご利用いただけます。

外部インタフェース設計書のサンプル

外部インタフェース処理設計書

【処理概要】

【連携処理フロー図】

【データ連携項目移送表】

テーラリングガイド

【処理概要】

インタフェース処理の処理概要を記述します。

• 処理概要：当該インタフェース連携の処理を概要レベルで記述します。
• 前提条件：インタフェース連携にあたっての前提条件を記述します。
• 処理サイクル・タイミング：連携のサイクルや実行のタイミングを定義します。
• オブジェクト構成：連携処理で利用するテーブル/オブジェクトの一覧とCRUDを定義します。
• 異常終了時処理とリカバリー：ハンドリングする異常終了処理とリカバリー方法を定義します。

【データ連携処理フロー図】

データ連携処理の流れに沿って、フロー図を記述していきます。説明欄には、各処理の内容についての説明や確認事項などを記述しておきましょう。

【データ連携処理詳細設計】

データ連携処理フロー図で定義した内容に基づいて、詳細設計レベルの内容を記述していきます。

データの入出力やSQL/SOQL、APIの詳細仕様（パラメータや戻り値など）もすべて記述します。

【データ連携項目移送表】

データ連携の送信元から受信先のシステムに対しての項目レベルのマッピングを定義します。

連携時に項目レベルのデータ加工を行う場合は、データ編集内容の列に定義します。

【SQL/SOQL】

データベースに対するアクセス処理がある場合には、具体的なSQL/SOQL文を以下のシートに定義して、フロー図や処理詳細設計書には定義したSQL/SOQLのIDを使って表現します。

【データサンプル】

データサンプルシートがありますが、こちらには、連携処理で利用するデータの形式がわかるように連携元システムから提供された

サンプルデータを添付しておくとよいでしょう。

外部インタフェース一覧の（Excel版）のダウンロード

資料のダウンロードおよびご利用に関しては、本サイトのコンテンツ利用規約に同意される場合のみ利用可能となります。

ダウンロード前に利用規約を必ずお読みください。

一般公開資料

update 2022/04/17 直接エクセルファイルをダウンロードするリンクを追加

以下は、スプレッドシートでの表示となります。

関連記事

他にも要件定義で必要となる以下のようなテンプレートなども用意しているのでぜひご利用ください。

チロ

ブログランキングに参加しましたので、ご支援していただけると幸いです。

にほんブログ村