고급: Apex 클래스를 활용해 다양한 방식으로 데이터 가져오기

외부 API 서버에서 데이터를 조회하거나, 데이터 조회 및 결합 시 복잡한 로직이 요구되는 경우에 사용됩니다. 데이터소스 고급을 설정하려면 Apex 클래스를 작성해야 합니다. Apex 클래스를 사용해 구현하므로, 데이터소스 기본보다 데이터를 더 자유롭게 가져올 수 있다는 장점이 있습니다.

---

설정 과정

1

Apex 클래스 작성

Apex 클래스를 작성할 때, SmallBuilder에서 제공하는 인터페이스를 구현해야 합니다.

2

데이터소스 고급 설정

Apex 클래스 구현이 완료되면, 빌더에서 데이터소스 고급 설정을 진행합니다.

STEP 1: 데이터소스에 사용할 Apex 클래스를 작성하기 위한 인터페이스 구현

데이터소스 고급 설정에서 사용할 Apex 클래스를 작성하려면 반드시 SBLI.DataSourceService.Fetchable 인터페이스를 구현해야 합니다.

이 인터페이스에는 execute 메서드가 포함되어 있으며, 해당 메서드에 데이터 처리를 위한 로직 구현 후 처리된 데이터와 조회 또는 라인 아이템 간의 매핑 정보를 담은 SBLI.DataSourceService.Result 객체를 반환해야 합니다.

예시 코드

해당 예시 코드는 외부 API를 호출하여 제품 코드별 재고 수량을 가져온 후, 조회 또는 라인 아이템의 재고 필드(Inventory__c)에 매핑한다고 가정하였습니다.

SBLI.DataSourceService.Fetchable 인터페이스는 패키지에서 제공되는 인터페이스이므로, 패키지 외부에서 접근하려면 Apex 클래스와 제공되는 메서드 모두 global로 선언해야 합니다.

global class DataSourceInventory implements SBLI.DataSourceService.Fetchable {
    global SBLI.DataSourceService.Result execute(SBLI.DataSourceService.Parameter params) {
        // 부모 레코드 가져오기
        SObject parentRecord = params.getParentRecord();

        // 조회 개체 레코드 가져오기
        List<SObject> lookupRecords = params.getLookupRecords();
        
        // 외부 API를 호출하여 데이터소스 값 가져오기 (예: 재고 정보)
        // 키: 제품 코드, 값: 재고 수량
        Map<String, Integer> inventoryData = new Map<String, Integer>(); 
        inventoryData.put('Product001', 10);
        inventoryData.put('Product002', 20);

        // 결과 객체 생성
        SBLI.DataSourceService.Result result = new SBLI.DataSourceService.Result();

        // 조회/라인 아이템 개체와 데이터소스 매핑
        for (String productCode : inventoryData.keySet()) {
            SBLI.DataSourceService.Action action = new SBLI.DataSourceService.Action();
            action.setKeyValue(productCode); // 조회/라인 아이템 레코드와 매핑할 Key 값 설정
            action.putSourceToTargetField(
                inventoryData.get(productCode), // 데이터소스 값: 재고 정보
                'Inventory__c'                 // 조회/라인 아이템 필드 API명
            );
            result.addAction(action); // Action 추가
        }
        
        return result; // 결과 반환
    }
}

1

부모 레코드 및 조회 레코드 가져오기

• params.getParentRecord(): 부모 개체의 레코드를 가져옵니다.

• params.getLookupRecords(): 조회 개체의 레코드 목록을 가져옵니다.

// 부모 레코드 가져오기
SObject parentRecord = params.getParentRecord();
// 조회 개체 레코드 가져오기
List<SObject> lookupRecords = params.getLookupRecords();

SBLI.DataSourceService.Parameter 참고 >

2

데이터소스 값 준비

• 외부 API 서버에서 데이터를 호출하여 재고 정보를 가져온다고 가정합니다.

• 예시에서는 제품 코드(ProductCode)를 기반으로 재고 정보를 매핑합니다.

Map<String, Integer> inventoryData = new Map<String, Integer>(); 
inventoryData.put('Product001', 10);
inventoryData.put('Product002', 20);

3

결과 생성

• SBLI.DataSourceService.Action 객체를 생성하여 데이터소스 값(재고 정보)과 조회 필드(Inventory__c)를 매핑합니다.

• 생성된 Action 객체를 SBLI.DataSourceService.Result에 추가합니다.

// 결과 객체 생성
SBLI.DataSourceService.Result result = new SBLI.DataSourceService.Result();

// 조회/라인 아이템 개체와 데이터소스 매핑
for (String productCode : inventoryData.keySet()) {
    SBLI.DataSourceService.Action action = new SBLI.DataSourceService.Action();
    action.setKeyValue(productCode); // 조회/라인 아이템 레코드와 매핑할 Key 값 설정
    action.putSourceToTargetField(
        inventoryData.get(productCode), // 데이터소스 값: 재고 정보
        'Inventory__c'                 // 조회/라인 아이템 필드 API명
    );
    result.addAction(action); // Action 추가
}

4

반환

매핑된 결과를 담은 Result 객체를 반환하여, 편집기에 매핑 정보를 전달합니다.

SBLI.DataSourceService.Parameter

빌더에서 설정한 부모와 조회 파라미터 정보를 가진 객체입니다.

예시 코드

DataSourceInventory.cls

global SBLI.DataSourceService.Result execute(SBLI.DataSourceService.Parameter params) {
    SObject parentRecord = params.getParentRecord();
    List<SObject> lookupRecords = params.getLookupRecords();
    ...
}

Methods

SObject getParentRecord()

부모 레코드를 반환합니다. 빌더에서 추가한 부모 파라미터가 없는 경우, 값은 비어 있습니다.

List<SObject> getLookupRecords()

조회 레코드를 반환합니다. 빌더에서 추가한 조회 파라미터가 없는 경우, 값은 비어 있습니다.

SBLI.DataSourceService.Result

조회 또는 라인 아이템과 데이터소스 간의 모든 매핑 정보를 담아 편집기로 반환하는 객체입니다. 매핑 정보는 SBLI.DataSourceService.Action 객체에 저장한 뒤, SBLI.DataSourceService.Result 객체에 추가하여 반환합니다.

예시 코드

DataSourceInventory.cls

SBLI.DataSourceService.Result result = new SBLI.DataSourceService.Result();
for(String productCode : inventoryData.keySet()) {
    // SBLI.DataSourceService.Action 객체에 매핑 정보 저장
    SBLI.DataSourceService.Action action = new SBLI.DataSourceService.Action();
    action.setKayValue(productCode);
    action.putSourceToTargetField(
        inventoryData.get(productCode),
        'Inventory__c'
    );
    result.addAction(action); // 매핑 정보가 담긴 Action을 Result에 추가
}
return result;

Methods

addAction(SBLI.DataSourceService.Action action)

매핑 정보가 담긴 Action 객체를 Result 객체에 추가합니다.

매개변수	유형	값
action	SBLI.DataSourceService.Action	조회 또는 라인 아이템과 데이터소스 값을 매핑한 정보를 담은 객체입니다.

SBLI.DataSourceService.Action

조회 또는 라인 아이템과 데이터소스 값을 매핑한 정보를 담은 객체입니다.

예시 코드

DataSourceInventory.cls

SBLI.DataSourceService.Result result = new SBLI.DataSourceService.Result();
// 데이터소스에서 각 제품코드와 재고 정보를 반복 처리
for(String productCode : inventoryData.keySet()) {
    SBLI.DataSourceService.Action action = new SBLI.DataSourceService.Action();
    // 제품코드를 Key 값으로 설정하여 조회/라인 아이템과 매핑
    action.setKayValue(productCode);
    
    // 재고 정보를 조회/라인 아이템의 Inventory__c 필드에 매핑 
    action.putSourceToTargetField(
        inventoryData.get(productCode),    // 데이터소스 값: 재고
        'Inventory__c'                                // 필드 API명
    );
    result.addAction(action); // 매핑 정보 추가
}
return result; // 최종 결과 반환

Methods

setKeyValue(Object keyValue)

조회 또는 라인 아이템의 Key와 일치하는 데이터소스의 Key 값을 설정합니다.

매개변수	유형	값
keyValue	Object	데이터소스의 Key 값입니다.

putSourceToTargetField(Object sourceValue, String targetFieldApiName)

데이터소스 값을 원하는 조회 또는 라인 아이템 필드에 할당합니다.

매개변수	유형	값
sourceValue	Object	데이터소스 값입니다.
targetFieldApiName	String	조회 또는 라인 아이템의 필드 API명입니다.

STEP 2: 데이터소스 고급 설정

Apex 클래스를 선택한 후, 클래스에서 부모와 조회 정보가 필요한 경우 파라미터로 전달할 필드들을 선택합니다.

데이터소스를 설정하기 전에 Apex 클래스를 먼저 작성하세요.

항목	설명	필수
Apex Class	데이터소스에 사용할 Apex 클래스를 선택합니다.	✔
Key 필드	데이터소스를 통해 가져온 데이터를 조회 또는 라인 아이템 레코드에 매핑하기 위해 Key 필드를 설정합니다. Key 필드는 조회 개체의 필드를 사용합니다. 💁 라인 아이템에서 조회 개체의 필드를 Key로 사용하는 이유는, 라인 아이템이 저장되지 않은 레코드일 수도 있어 유일한 Key 값을 판단하기 어렵기 때문입니다.	✔
파라미터 - 부모 개체 필드	데이터소스를 구현한 Apex 클래스에서 필요한 부모 개체의 필드 값이 있는 경우, 해당 필드를 파라미터로 추가합니다.
파라미터 - 조회 개체 필드	데이터소스를 구현한 Apex 클래스에서 필요한 조회 개체의 필드 값이 있는 경우, 해당 필드를 파라미터로 추가합니다.
평가 이벤트	데이터소스의 실행 시점을 설정합니다. 초기화 시(On Initialization): 라인 아이템 레코드가 새로 추가될 때 실행됩니다. 로딩 시(On Loading): 라인 아이템 화면이 로드될 때마다 실행됩니다. 저장 전(Before Save): 라인 아이템 레코드가 저장되기 전에 실행됩니다. ❗ 라인 아이템에서만 제공되는 설정입니다.
활성화	데이터소스를 활성화합니다. 활성화되지 않으면 작동하지 않습니다.	✔