[SAP] Service Layer API 확장 개발 가이드

Service Layer API 확장 개발 가이드

Service Layer를 사용하면 사용자가 서버 측에 JavaScript를 포함하여 자체 확장 API를 개발할 수 있습니다.

이 페이지는 Service Layer API 확장 개발을 위한 가이드입니다.

1. 작동 원리

Service Layer 에는 Javascript SDK 등 개발을 위한 키트와 Javascript 엔진이 작동되고 있습니다.

따라서, 파트너 개발자가 스크립트를 작성하고 그걸 업로드하면 동작 할 수 있습니다.

2. 개발 가이드

2-1. Http 요청 기능

http 요청 기능은 HttpModule.js 모듈에 패키징되어 있습니다.

http 요청을 처리하기 위해 필요한 필수 모듈입니다.

2-2. Query 기능

CRUD 를 처리하기 위한 Query 기능은 ServiceLayerContext.js 모듈에 패키징되어 있습니다.

2-3. 샘플 구문

다음은 BP마스터에 조건을 넣어 데이터를 가져오는 Service Layer API 샘플 코드입니다.

var ServiceLayerContext = require('ServiceLayerContext.js');
var http = require('HttpModule.js');
function GET() {
    var queryOption = "$select=CardName, CardCode & $top=5 & $orderby=CardCode";
    var slContext = new ServiceLayerContext();
    var retCaseSensitive = slContext.BusinessPartners.query(queryOption);
    var retCaseInsensitive = slContext.query("BusinessPartners", queryOption, true);
    http.response.setStatus(http.HttpStatus.HTTP_OK);
    http.response.setContent({ "CaseSensitive": retCaseSensitive.toArray(), "CaseInsensitive": retCaseInsensitive.toArray() });
    http.response.send();
}

필요한 모듈을 가져옵니다.

함수명은 GET, POST, PUT 등 HTTP 메서드 명으로 작성합니다.

작성한 함수명이 HTTP 메서드가 됩니다.

쿼리문을 작성하고, http 요청문을 추가합니다.

3. 배포 가이드

3-1. .ard 파일

개발한 Service Layer은 SLD에 배포됩니다.

배포를 위해선 .ard 파일을 추가해야합니다.

.ard 파일 내용이 API Url을 결정하게 됩니다.

다음은 파일 작성 예시문입니다.

<AddOnRegData xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
  SlientInstallation="" SlientUpgrade="" Partnernmsp="mtcsysnm" SchemaVersion="3.0"
  Type="ServiceLayerScript" OnDemand="" OnPremise="" ExtName="ItemsExt"
  ExtVersion="1.00" Contdata="sa" Partner="mtcsys" DBType="HANA" ClientType="S">
  <ServiceLayerScripts>
  <Script Name="bpmasters" FileName="BpMaster.js"></Script>
  </ServiceLayerScripts>
  <XApps>
  <XApp Name="" Path="" FileName="" />
  </XApps>
</AddOnRegData>

ServiceLayerSciprts 안에 작성한 자바스크립트 파일명을 입력(FileName)하고 이름(Name)을 지정하고 저장합니다.

.ard 파일과 자바스크립트 파일을 함께 압축합니다.

3-2. Extension Import Wizard 업로드

 Default 주소는 https://::40000/ExtensionManager/ 입니다.

그 다음 Company Assignment 에서 원하는 회사에 Extension을 할당합니다.

GET /b1s/v1/script/mtcsys/bpmasters URL로 통신하면 됩니다.

참고 자료

https://www.youtube.com/watch?v=O5mOGA1ezpY