안내서 구성

1. 소개

제품에 대한 안내서가 있어도 제품에 대해 여러 가지 안내서가 존재하다 보니 제품을 처음 접하거나 제품에 익숙하지 않은 사용자는 원하는 안내서를 찾는데 문제를 겪을 수 있다.

예를 들어, ProFrame에서 DBIO 모듈을 생성하는 방법에 대한 정보를 얻고자 할 때 정확히 원하는 내용이 ProFrame DBIO 개발 안내서에 기술되어 있는지 아니면 함께 참고해야 할 안내서가 있는지를 파악하고 있어야 한다.

본 장에서는 개발과 관련된 안내서 사용에 있어 개발자의 편의를 돕기 위해 ProFrame 안내서를 어떻게 활용할 수 있는지 기술한다. 즉, ProFrame 개발과 관련된 안내서에는 어떤 것들이 있고, 각 안내서에서 어떤 내용을 기술하고 있으며, 각 안내서가 다른 안내서와 어떻게 연관을 맺고 있는지에 대해 기술한다.

ProFrame 개발과 관련된 안내서를 처음 접하는 개발자는 본 장을 주의 깊게 읽어볼 것을 권장한다. 비록 본 장이 실제 제품 사용법과 직접적인 관련이 있는 것은 아니지만, 안내서 구성을 전체적으로 이해하는데 도움이 되도록 작성하였다.

2. 안내서 구성과 내용

다음은 ProFrame 개발과 관련된 안내서 목록이다.

ProFrame ProFrame 안내서

공통

개발 안내서

스튜디오 안내서

모듈

ProMapper 개발 안내서

FileIO 개발 안내서

DBIO 개발 안내서

EMB 개발 안내서

기타

단위 테스트 안내서

유틸리티 안내서

온라인 프로그래밍 안내서

배치 프로그래밍 안내서

ProFrame은 개발과 관련된 총 10권의 안내서를 제공한다. 각 안내서에 대한 내용은 본 장에 설명되어 있으니 특정한 내용에 대해 빨리 찾기를 원한다면 아래의 내용을 먼저 확인하기 바란다.

  • ProFrame 개발 안내서

    본 안내서이다.

  • ProFrame 스튜디오 안내서

    서비스 또는 업무 모듈 프로그램을 작성하고 배포할 수 있는 GUI 기반 툴인 스튜디오의 사용법에 대해서 상세히 기술한다.

    스튜디오 안내서의 구성은 다음과 같다.

    • 스튜디오 소개 및 화면 구성

    • 스튜디오 실행 방법

    • 스튜디오 환경설정

    • 단축키

  • ProFrame ProMapper 개발 안내서

    스튜디오에 내장된 ProMapper 편집기를 이용하여 애플리케이션 프로그램의 입출력 설계 및 변환 규칙을 생성하는 방법에 대해 기술한다.

    ProMapper 개발 안내서의 구성은 다음과 같다.

    • ProMapper 소개 및 환경설정

    • 리소스 타입별 기본 정보 등록

    • 리소스 타입별 ProMapper 편집기 사용법

      • 구조체 편집기

      • 전문 편집기

      • 맵 편집기

    • 소스생성, 컴파일 및 Dlupdate

    • 생성된 ProMapper 리소스 사용법

    • 가변배열 구조체 사용법 및 사용예제

    • ProMapper 관련 API

    • ProMapper 관련 에러코드

  • ProFrame FileIO 개발 안내서

    스튜디오에 내장된 FileIO 편집기를 이용하여 FileIO 모듈을 생성하는 방법에 대해 기술한다.

    FileIO 개발 안내서의 구성은 다음과 같다.

    • FileIO 소개 및 환경설정

    • FileIO 기본 정보 등록

    • FileIO 편집기 사용법

    • 컴파일 및 Dlupdate

    • 생성된 FileIO 모듈 사용법 및 사용예제

    • FileIO 관련 API

  • ProFrame DBIO 개발 안내서

    스튜디오에 내장된 DBIO 편집기를 이용하여 DBIO 모듈을 생성하는 방법에 대해 기술한다.

    DBIO 개발 안내서의 구성은 다음과 같다.

    • DBIO 소개 및 환경설정

    • DBIO 기본 정보 등록

    • DBIO 편집기 사용법

    • 소스 생성, 컴파일 및 Dlupdate

    • DBIO 부가 기능

    • DWIO 기능 연계

  • ProFrame EMB 개발 안내서

    스튜디오에 내장된 EMB Designer를 이용하여 EMB 모듈을 생성하는 방법에 대해 기술한다.

    EMB 개발 안내서의 구성은 다음과 같다.

    • EMB 소개

    • EMB Designer 소개

      • 환경설정

      • 화면 구성

    • EMB 모듈 생성 절차

      • EMB 모듈 기본 정보 등록

      • 플로우 작성

      • 플로우 편집

    • 컴파일 및 Dlupdate, 단위 테스트

    • EMB 기타 기능 및 소스 바로 가기 버튼 소개

  • ProFrame 단위 테스트 안내서

    스튜디오에서 개발된 서비스 또는 업무 모듈을 단위 테스트 하는 방법에 대해 기술한다.

    단위 테스트 안내서의 구성은 다음과 같다.

    • 테스트 프레임워크 소개

    • 단위 테스트 기능 및 화면 구성

    • 단위 테스트 기능별 테스트 실행 방법

    • 스튜디오에서 테스트 로그 보는 방법

    • 로그 보기 환경설정 방법

    • 단위 테스트 중 문제 해결

  • ProFrame 유틸리티 참조 안내서

    ProFrame가 제공하는 유틸리티에 대하여 기술한다.

    유틸리티 안내서의 구성은 다음과 같다.

    • ProFrame API 소개

    • Date 유틸리티 소개 및 관련 API 설명

    • Number 유틸리티 소개 및 관련 API 설명

    • String 유틸리티 소개 및 관련 API 설명

    • Long 유틸리티 소개 및 관련 API 설명

    • 에러처리 및 디버그 유틸리티 소개 및 관련 API 설명

    • 기타 유틸리티 소개 및 관련 API 설명

    • PfmNumber 활용 방법

  • ProFrame 온라인 프로그래밍 안내서

    ProFrame를 이용하여 온라인 프로그램을 작성하는 방법에 대해 기술한다.

    온라인 프로그래밍 안내서의 구성은 다음과 같다.

    • 온라인 서비스 프로그램 소개

    • 온라인 서비스 프로그램 작성 절차

    • 온라인 서비스 프로그램 작성 방법

    • 서비스 연동 방법

    • 서비스 연동할 때 주의 사항 소개

  • ProFrame 배치 프로그래밍 안내서

    ProFrame를 이용하여 배치 프로그램을 작성하는 방법에 대해 기술한다.

    배치 프로그래밍 안내서의 구성은 다음과 같다.

    • 배치 프레임워크 소개

    • 배치 프레임워크의 종류 소개

      • 일반 배치

      • POD 배치

      • 상주 배치

      • 배치 Job Information

    • 배치 생성 절차 소개

    • 배치 프레임워크의 종류별 배치 생성 방법

    • 배치 파라미터 소개