📌 인터페이스 설계 - 시스템 인터페이스 설계서 작성

 

 

목차

 

시스템 인터페이스 설계서의 개요

📌 시스템 인터페이스 설계서는 시스템의 인터페이스 현황을 확인하기 위해 시스템이 갖는 인터페이스 목록과 각 인터페이스의 상세 데이터 명세를 정의한 문서이다.

 

• 시스템 인터페이스 설계서는 시스템 인터페이스 목록과 시스템 인터페이스 정의서로 구성된다.
• 시스템 인터페이스 설계서는 인터페이스 송, 수신 방법과 인터페이스 송, 수신 데이터 명세화 과정에서 작성한 산출물을 기반으로 작성 한다.
• 시스템 인터페이스 설계서를 작성한 후에는 시스템 인터페이스 목록에 있는 각각의 인터페이스를 시스템 인터페이스 정의서의 내용과 비교하여 누락되거나 보완이 필요한 경우 내용을 수정한다.
• 시스템 인터페이스 설계서는 내, 외부 모듈 간 공통적으로 제공되는 기능과 각 데이터의 인터페이스를 확인하는데 사용된다.

💡 송, 수신 기관 : 내부 시스템이 송 수신하는 인터페이스인 경우 송, 수신 기관은 '당사'로 기재한다.

💡 대, 내외 구분 : 인터페이스가 기업 내부 시스템 간 발생하는 경우 '대내', 내 외부 시스템 간에 발생하는 경우 '대외'로 구분한다.

💡 데이터 형식(포맷) : 고정길이 XML등 인터페이스 항목의 데이터 형식(포맷)을 기재한다.

💡 요구사항 ID : 해당 인터페이스와 관련된 요구사항 분석 단계에서 작성한 인터페이스 정의서의 요구사항 ID를 기재한다.

 

 

 

시스템 인터페이스 목록 작성

📌 시스템 인터페이스 목록은 업무 시스템과 내, 외부 시스템 간 데이터를 주고받는 경우에 사용하는 인터페이스에 대해 기술한 것이다.

 

• 시스템 인터페이스 목록에는 연계 업무와 연계에 참여하는 송, 수신 시스템의 정보, 연계 방식과 통신 유형 등에 대한 정보를 기록한다.

 

업무 구분

경영 관리

업무 대분류

기획 총괄

작성일

작성자

홍길동

인터페이스 ID

인터페 이스명

송신 기관

송신 시스템

수신 기관

수신 시스템

대내외 구분

연계 방식

통신 유형

처리 형태

연계 주기

데이터 형식

담당자

요구 사항 ID

IFID-001

지급 정보 전송

당사

회계

토스 뱅크

수신

대외

EAI

요청/ 응답

실시간

매일

고정 길이

홍길동

IRE-001

IFID-004

예금주 조회

당사

회계

토스 뱅크

수신

대외

Socket

요청/ 응답

실시간

수시

고정 길이

김지영

IRE-004

IFID-006

고객 로그인

당사

홈페이지

당사

고객

대내

EAI

단방향

배치

매일

박봄

IRE-006

IFID-007

고객 계약 조회

당사

홈페이지

당사

고객

대내

DB Link

단방향

배치

매일

김채원

IRE-007

 

 

 

시스템 인터페이스 정의서 작성

📌 시스템 인터페이스 정의서는 인터페이스 별로 시스템 간의 연계를 위해 필요한 데이터 항목 및 구현요건 등을 기술하는 것이다.

 

• 시스템 인터페이스 정의서에는 데이터 송, 수신 시스템 간 데이터 저장소와 속성 등 상세 정보를 기록한다.
  1. 인터페이스 ID, 인터페이스명, 처리 유형, 통신 유형, 주기, 인터페이스 구분, 데이터 포맷은 인터페이스 목록을 참고하여 기재한다.
  2. 인터페이스 송, 수신 데이터 명세를 참조하여 기재한다.
  3. 코드 매핑 규칙을 작성한다. 매핑 규칙은 송, 수신 시스템의 항목이 단순 1:1이 아니기 때문에 병합, 변환 등 별도의 처리 로직이 필요한 경우의 규칙을 기재한다.