플랫폼에서 Functions 사용하기

이 섹션에서는 Foundry 플랫폼 전체에서 Functions를 사용하는 다양한 방법에 대해 문서화합니다. 이 목록은 대부분 최신 상태로 유지되지만, 여기에 포착되지 않은 추가적인 Functions 사용 방법이 있을 수 있습니다.

Workshop

Workshop은 다양한 방식으로 Functions와 통합을 지원하여, Workshop에서 빌드된 모듈 전체에서 커스텀 로직을 사용할 수 있게 합니다.

변수

대부분의 Workshop 변수는 Function-backed이 될 수 있어, 애플리케이션 빌더가 Functions를 이용해 값을 계산하고 그 값을 Workshop 전체에서 사용할 수 있습니다. 기본적으로 변수의 값은 그것이 의존하는 다른 변수가 업데이트될 때 재계산됩니다. 이는 사용자 피드백에 대한 값의 유연한 재계산을 가능하게 합니다. 예를 들어, 사용자가 입력 컴포넌트를 편집하면, 의존하는 Function-backed 오브젝트셋 변수가 자동으로 재계산됩니다.

자세한 내용은 Workshop 변수에 Functions를 백업하는 방법에 대한 튜토리얼을 살펴보세요.

아래는 Workshop 변수 유형과 TypeScript에서의 동등한 유형 사이의 매핑입니다. 각 주어진 유형의 Workshop 변수는 나열된 유효 유형 중 하나를 반환하는 Function에 의해 백업될 수 있습니다. 사용 가능한 Function 유형에 대해 자세히 알아보세요.

• Boolean: boolean
• String: string
• Numeric: Integer, Long, Float, Double
• Date: LocalDate
• Timestamp: Timestamp
• Array: BaseType[] 또는 Set<BaseType>
• Object Set: ObjectSet<ObjectType> (권장), ObjectType[], 또는 Set<ObjectType>

Object Table: 파생 속성

Workshop의 Object Table 위젯은 사용자 입력에 기반한 업데이트가 가능하며, 최종 사용자가 테이블을 스크롤하면서 실시간으로 재계산되는 Function-backed 열을 계산하도록 설정할 수 있습니다. 이 기능을 사용하는 방법에 대한 전체 튜토리얼을 확인할 수 있습니다.

Chart: 파생 집계

Workshop의 Chart: XY 위젯은 Function-backed 집계를 사용하여 요구에 따라 집계된 값을 파생하는 것을 지원합니다. 이는 집계 데이터가 사용자 선택에 기반해야하는 경우 유용할 수 있습니다. 차트 위젯에서 Functions를 사용하려면, 차트 레이어를 설정하려고 클릭하고 Function 집계를 선택하면 됩니다.

집계 API에 대한 참조가 제공됩니다. 더 고급 사용 사례의 경우, 커스텀 집계를 계산하는 방법에 대한 문서를 읽어보는 것이 좋습니다.

Actions

액션 유형은 애플리케이션에서 Foundry 온톨로지의 오브젝트를 변경하고, 유연하고 안전한 방식으로 외부 알림과 사이드 이펙트를 발송할 수 있게 합니다. Actions 내에서, Functions는 코드 작성자가 오브젝트가 어떻게 업데이트되어야 하는지 또는 사이드 이펙트가 어떻게 구성되어야 하는지 정의할 수 있도록 완전한 유연성을 제공합니다.

Function-backed Actions

Function-backed Actions는 온톨로지 편집 API를 사용하여 오브젝트가 어떻게 업데이트되어야 하는지에 대한 로직을 정의합니다. 이를 통해 코드에서 복잡한 편집을 표현할 수 있습니다. 예를 들어, 어떤 시작 오브젝트에 링크된 모든 오브젝트를 업데이트합니다. Function-backed Actions를 end-to-end로 사용하는 방법에 대한 튜토리얼을 확인하세요.

Side effects: 알림

액션은 특정 사용자에게 알림을 보내도록 설정될 수 있습니다. Functions를 사용하여 알림을 받아야 하는 사용자와 알림의 내용을 계산할 수 있습니다. 이는 오브젝트 내에 저장된 수신자 사용자 ID를 로드하거나, 오브젝트 데이터를 기반으로 이메일 내용을 렌더링하는 등의 유연성을 제공합니다. 자세한 내용은 알림에 대한 전체 문서와 알림을 설정하기 위해 Functions를 사용하는 방법에 대한 가이드를 참조하세요.

Side effects: 웹훅

액션은 적용될 때 웹훅을 트리거하도록 설정될 수도 있습니다. 웹훅은 Foundry와 다른 시스템의 통합을 가능하게 하며, 사용자가 적용한 액션을 Foundry 외부의 API로 되돌리는 것을 가능하게 합니다. Functions를 사용하여 실행될 웹훅으로 보내야 할 파라미터를 계산할 수 있습니다. 이는 오브젝트 데이터를 기반으로 웹훅 파라미터를 채우는 등의 워크플로를 가능하게 합니다. 웹훅에 대한 전체 문서를 확인하세요.

Slate

Slate는 Platform 탭 내에서 Functions를 찾아 사용하는 기본 지원을 포함하고 있습니다. Slate 문서를 편집할 때 Platform 탭을 열고 하단 왼쪽에 Foundry Function을 추가하세요. 이제 Function을 검색하고, 파라미터를 설정하고, Slate 문서에서 결과를 사용할 수 있습니다.

역사적인 이유로, Slate 제품은 자체적으로 "Functions"라는 개념을 가지고 있으며, 이는 각 Slate 문서 내에 위치한 JavaScript 로직의 스니펫입니다. 이것이 Functions 제품이 "Foundry Functions"라고 불리며 Platform 탭 아래에 위치해 있는 이유입니다. Slate의 Functions 기능은 문서 내에서 빠르고 쉽게 데이터를 조작할 수 있게 하지만, 오브젝트에 대한 기본 지원은 없습니다.

Slate의 Functions와 Foundry Functions를 서로 조합하여 사용할 수 있습니다. 예를 들어, Foundry Function에서 데이터를 반환하고 그것을 Slate Function에서 조작하거나, Foundry Function으로 전달해야 할 파라미터를 계산하기 위해 Slate Function을 사용할 수 있습니다.

Quiver

Quiver의 오브젝트셋 플롯은 Workshop의 Chart: XY 위젯과 동일한 기본 구성 요소를 사용합니다. 따라서, Quiver 분석에서도 Function-backed 집계를 사용할 수 있습니다.