Integration Definition
Integration Definition은 DB 프로시저, DB Function Rest API를 Cals Platz의 화면 또는 기능에서 사용하기 위해 정의하는 항목이다. 이를 정의하기 위해서 먼저 외부와의 Interface할 정보를 생성한다. Integration에서 기본 정보, 프로시저 또는 API 정보 그리고 연동 항목을 정의하는 Parameter 등을 등록한다.
- How-To Create
- Object Explorer의 Integration > Integration Definition 메뉴를 선택한다.
Integration Definition List에서New를 Click하여 신규 Interface 정보를 입력한다.
a. Integration ID: Cals studio에서 인지하는 IO Id로 프로시저, Function, API 명과 상관없이 지정이 가능하다.
b. Method: Rest API, Procedure, Function 지정이 가능하다.(Socket TBD)
c. Integration 정보를 기록하는 용도로 기능을 하지 않는다. 정보로서 대체로 Procedure, Function은 Source, Target 모두 ICIGNAL CALS로 지정 Rest API는 Source: ICIGNAL CALS, Target: External System으로 지정한다.
Note: 위의 표기한 외의 필드는 값 지정
Process Type: Sync (Async TBD)
Integration Type: Out-Bound(In-Bound TBD)
Business Object Group: 미지정(용도 불명)
Log Save Flag: No(TBD)
Integration Definition에서 설정한Method Type에 따라 입력해야 할 항목이 동적으로 변경된다.
[Reat API 인 경우 추가 입력 정보]
a. Target URL: Rest API URL로 동적 환경변수를 지정하여 App, Sandbox, Prod 별 API를 호출한다.
b. Operation: Cals 화면에서 데이터를 조회하여 사용하는 경우 select로 지정하고 그 외 create, update, delete는 API 쪽에서 사용하는 변수이다.
c. Procedure or Function Name: DB에 선언된 실제 이름과 동일 해야 한다.
d. Data Source Name: Procedure나 Function이 선언된 Data Source를 지정한다.
- 마지막으로 Interface에서 사용되는 각각의 Field를 설정하기 위해
Integration Parameter List에서 Type, Data Length, Required Flag 등을 Interface의 Field 별로 생성한다.
a. API, Procedure, Function의 변수 명으로 프로그램에 선언된 명칭과 동일해야 한다.
b. 변수 유형으로 CALS에서 전달하는 변수는 output, 수신 받는 변수는 Input으로 선언한다.
c. Function에서 선언된 파라미터 순서에 따라 지정한다.
d. Required Flag에 “YES”로 지정하면 Validation에 따라 에러 처리가 된다. 에러처리 시 지정된 파라미터의 Name이 그대로 표출되어 에러메시지가 사용자 친화적이지 않다. 따라서 사용자 입력 값 체크 기준으로는 해당 값을 사용하지 않는 것을 권고한다. 실제 필수 값 체크가 필요한 경우 Control의 Required 속성을 사용하거나, Focus와 Alert Action을 사용하도록 한다.