문서 찾는 방법
아래 핵심 계산 경로부터 확인하고, 목적에 맞는 작업 문서를 선택하세요.
큰 그림에서 세부 규격으로 읽기
처음에는 1단계와 2단계만 읽고, 목적이 생기면 다음 단계로 이동하세요.
| 읽는 단계 | 알게 되는 것 | 먼저 볼 문서 |
|---|---|---|
| 1. 시작 화면 고르기 | Report Workbench와 PXFLOW Studio의 역할 | Project Home에서 Report와 Flow 열기 |
| 2. Flow 준비하기 | Node를 연결하고 input과 result를 공개하는 방법 | PXFLOW에서 Flow 만들기 |
| 3. Report와 Flow 연결하기 | 작성값·표 → Flow input, Flow result → Report 위치 | Report와 PXFLOW 연결 |
| 4. 실행하고 결과 확인하기 | Validate·Save·Run과 Result 확인 방법 | Run·Result 화면 |
| 5. Component 추가하기 | 현재 built-in Component 배치와 향후 third-party 설치 계약 | 아래 Components 문서 |
| 6. SDK로 작성·개발하기 | Flow·Report 자동화, Function과 Component 개발 | 아래 개발자 문서 |
사용자 화면을 익힐 때는 1–5단계 사용자 가이드에 집중하세요. 5단계의 설치형 third-party Component는 아직 계획된 V2 계약이며 현재 배치 경로는 built-in Component에 한정됩니다.
목적에 맞는 문서 찾기
처음 시작하기
계산
Report
Components
계획 중인 V2 기능
더 알아보기
개발자
SDK는 Flow와 Report를 Python으로 작성·자동화하고, 재사용 Function과 Component를 개발하는 경로입니다. 화면에서 작성하는 작업은 Report Workbench와 PXFLOW Studio 경로를 따릅니다.
- Python으로 Flow와 Report 함께 만들기
- Flow 코드와 PXFLOW Studio 연결 방식
- Python SDK API reference
- SDK·Component 개발 시작하기
- 첫 Function package 만들기
- Function 만들기
- Flow 구성하기
- Component 만들기와 배포
- 커스텀 Function 배포와 사용
- 개발 CLI 명령
- 제품 연결의 자세한 설명
상황별로 볼 문서
| 지금 하려는 일 | 볼 문서 | 거기서 얻는 것 |
|---|---|---|
| 화면에서 따라 하기 | 사용자 가이드 | 어디를 누르고 무엇을 확인할지 |
| 같은 작업을 Python으로 작성·자동화하기 | Python으로 Flow와 Report 함께 만들기, API reference | 호출할 이름과 인자 |
| 재사용 Function·Component 개발하기 | SDK·Component 개발 시작하기 | package 구조와 배포 절차 |
| 저장 파일·명령·타입의 정확한 규격 확인 | 시스템 모델, SDK 문법 | 반드시 지켜야 하는 조건 |
두 문서의 설명이 서로 달라 보이면 어긋나는 두 페이지를 함께 알려 주세요.
예제에 나오는 <...> 읽기
이 절은 개발자 문서의 명령과 코드를 읽을 때만 필요합니다. 개발자 문서에는 <flow_key>처럼 꺾쇠로 감싼 자리표시자가 나옵니다. 그대로 입력하는 값이 아니라, 꺾쇠를 포함해 지우고 현재 사용하는 값을 넣으라는 표시입니다.
예를 들어 문서에 이렇게 적혀 있으면
pxlab studio open --flow <flow_key>실제로는 자기 Flow의 key를 넣어 이렇게 입력합니다.
pxlab studio open --flow girder_check자주 나오는 자리표시자와 값을 확인하는 위치입니다.
| 자리표시자 | 무엇을 넣나 | 값을 확인하는 곳 |
|---|---|---|
<workspace_key> | 여러 Project를 묶는 Workspace의 key (structural_team) | Workspace 설정, 조직 관리자 |
<project_key> | 작업 중인 Project의 key (bridge_package) | Project settings |
<flow_key> | 이 Flow의 key (girder_utilization_flow) | New Flow의 자동 제안값 |
<file.pxflow> | 저장하거나 읽을 파일 이름 | 직접 정하는 파일 경로 |
자리표시자를 그대로 둔 채 실행하면 명령이 값을 찾지 못하고 실패합니다. 이 표시가 실제로 쓰이는 명령은 개발 CLI 명령에서 확인하세요.
기능 표시·실행 문제 확인
화면에 기능이 보이지 않거나 실행되지 않는다면 먼저 다음을 확인하세요.
- 현재 계정과 Project가 올바른지 확인합니다.
- 필요한 Flow나 문서가 현재 Project에 보이는지 확인합니다.
- Node의 필수 입력과 연결이 빠지지 않았는지 확인합니다.
- 화면에 표시된 권한이나 설치 안내를 확인합니다.
- 오류 문구와 현재 화면을 함께 기록해 도움말로 이동합니다.
Run이 시작되지 않거나 Result가 업데이트되지 않으면 현재 Flow revision, input과 Run 상태를 함께 기록해 도움말에서 문제를 확인하세요.
용어
처음에는 다음 이름만 구분하면 됩니다.
- Project: Report, Flow, Component dependency와 결과를 함께 찾는 작업 공간
- Report: 본문·작성값·표와 Flow 연결, result 표시 위치를 저장하는 문서
- Report Workbench: Report를 작성하고 Flow input·result를 연결하는 화면
- Flow: input을 받아 연결된 Node로 계산하고 result를 만드는 실행 단위
- Component: Components에서 골라 Flow에 배치하는 기능
- Component package: 하나 이상의 Component를 설치·업데이트하는 배포 단위
- Node: Flow에 놓인 한 단계
- Run: 저장된 Flow를 입력값으로 한 번 계산한 실행 기록
- Result: Run이 저장한 계산값과 사용한 Flow·입력값의 근거