@things-factory/reference-app 6.0.27 → 6.0.28

package/dist-client/helps/board-modeller/styles/line-style.zh.md

@@ -0,0 +1,19 @@
+# 线型
+
+  - 厚度：设置线的厚度。
+  - 颜色：设置线的颜色。
+  - 线的样式：设置线的样式。（直线、虚线等）
+  - 线端的样式：设置线端的样式。（square：方形线端，round：圆形线端）
+  - 连接样式：设置线与线相连接的点的样式。  
+    (锐角相交 : ![miter][miter], 弧形 : ![round][round], 斜角相交 : ![bevel][bevel])
+  - 开始形状：设置线的开始形状。
+  - 开始大小：设置线的开始大小。
+  - 结束形状：设置线的结束形状。
+  - 结束大小：设置线的结束大小。
+
+
+[miter]: ../images/join-type-miter.png
+
+[round]: ../images/join-type-round.png
+
+[bevel]: ../images/join-type-bevel.png

package/dist-client/helps/board-modeller/styles/opacity.ko.md

@@ -0,0 +1,3 @@
+# 투명도
+
+컴포넌트의 투명한 정도를 설정한다. (0 ~ 1, 0 : 안보임, 1 : 보임)

package/dist-client/helps/board-modeller/styles/opacity.md

@@ -0,0 +1,3 @@
+# Opacity
+
+- Set the transparency of component. (0 ~ 1, 0: Invisible, 1: Visible)

package/dist-client/helps/board-modeller/styles/opacity.zh.md

@@ -0,0 +1,3 @@
+# 透明度
+
+设置组件的透明度。（0~1, 0: 透明, 1: 不透明）

package/dist-client/helps/board-modeller/styles/text-style.ko.md

@@ -0,0 +1,8 @@
+# 텍스트 스타일
+
+  - 폰트 : 컴포넌트 텍스트의 폰트를 설정한다.  
+  - 크기 : 컴포넌트 텍스트의 크기를 설정한다.  
+  - 줄간격 : 컴포넌트 텍스트의 줄사이 간격을 설정한다.  
+  - 색상 : 컴포넌트 텍스트의 색상을 설정한다.
+  - 굵기 : 컴포넌트 텍스트를 굵게 설정한다.
+  - 기울기 : 컴포넌트 텍스트를 기울임꼴로 설정한다.

package/dist-client/helps/board-modeller/styles/text-style.md

@@ -0,0 +1,8 @@
+# Text Style
+
+  - Font: Set the font of component text.
+  - Font size: Set the size of component text.
+  - Line spacing: Set the line spacing of component text.
+  - Color: Set the color of component text.
+  - Bold: Set the text of component bold.
+  - Italic: Set the text of component italic.

package/dist-client/helps/board-modeller/styles/text-style.zh.md

@@ -0,0 +1,8 @@
+# 文本样式
+
+  - 字体：设置组件文本的字体。
+  - 字体大小：设置组件文本的大小。
+  - 行间隔：设置组件文本的行间隔。
+  - 颜色：设置组件文本的颜色。
+  - 粗体：加粗组件文本。
+  - 斜体：加斜组件文本。

package/dist-client/helps/components/oops-progress.md

@@ -0,0 +1,73 @@
+# OOPS Progress 컴포넌트
+
+긴 시간 진행되는 작업의 진행 상황을 표현해주기 위해 서버에 진행율을 Subscribe하는 클라이언트 컴포넌트이다.
+이 컴포넌트는 자체적으로 시각적 요소를 포함하지 않지만, 시각적 표현을 위해서 자식 노드(Light DOM)를 포함할 수는 있다.
+
+## properties
+
+- tag: String 서브스크립션 태그이며, 서버의 'publishProgress'의 tag와 일치시키도록 한다.
+- subscription: String (readonly) 이 속성이 값을 가지고 있으면, 서브스크립션 중임을 의미한다.
+
+## methods
+
+- startSubscribe() 진행율 구독을 시작한다.
+- stopSubscribe() 진행율 구독을 종료한다.(서버쪽 작업의 종료를 의미하지 않으며, 클라이언트에서 구독을 종료한다는 의미임.)
+
+## event
+
+- progress(event) 서버로부터 진행율이 Subscribe 되었을 때 발생한다.
+  - event.detail : progress 값을 갖는다.
+- finish(event) 진행율이 100% 도달하면 발생한다.
+
+## 예시
+
+### 클라이언트 사이드
+
+```
+  <oops-progress
+    .tag='progress-pending-job'
+    @progress=${e => {
+      this.progress = e.detail
+    }}
+    @finish=${() => {
+      console.log('complete')
+    }}
+    ?hidden=${progress < 0 || progress > 100}
+  >
+    <div>
+      <mwc-linear-progress .progress=${progress / 100}></mwc-linear-progress>
+      <span>Progress : ${progress} % (${message})</span>
+    </div>
+  </oops-progress>
+
+```
+
+### 서버사이드
+
+```
+import { sleep } from '@things-factory/utils'
+
+...
+
+@Mutation(returns => String, { description: 'To reference of pending job progress' })
+async referencePendingJob(
+  @Root() _,
+  @Ctx() context: any
+) : Promise<string> {
+
+  const { domain } = context.state
+
+  for(var i = 0;i <= 100;i++) {
+    await sleep(100)
+
+    publishProgress({
+      domain,
+      tag: 'progress-pending-job',
+      progress: i,
+      message: `${i * 10} / 1000`
+    })
+  }
+
+  return 'success'
+}
+```

package/dist-client/helps/contact/contact.md

@@ -0,0 +1,160 @@
+# Contact
+
+Paragraphs are separated by a blank line.
+
+2nd paragraph. _Italic_, **bold**, and `monospace`. Itemized lists
+look like:
+
+- this one
+- that one
+- the other one
+
+Note that --- not considering the asterisk --- the actual text
+content starts at 4-columns in.
+
+> Block quotes are
+> written like so.
+>
+> They can span multiple paragraphs,
+> if you like.
+
+Use 3 dashes for an em-dash. Use 2 dashes for ranges (ex., "it's all
+in chapters 12--14"). Three dots ... will be converted to an ellipsis.
+Unicode is supported. ☺
+
+## An h2 header
+
+Here's a numbered list:
+
+1. first item
+2. second item
+3. third item
+
+Note again how the actual text starts at 4 columns in (4 characters
+from the left side). Here's a code sample:
+
+# Let me re-iterate ...
+
+for i in 1 .. 10 { do-something(i) }
+
+As you probably guessed, indented 4 spaces. By the way, instead of
+indenting the block, you can use delimited blocks, if you like:
+
+```
+define foobar() {
+print "Welcome to flavor country!";
+}
+```
+
+(which makes copying & pasting easier). You can optionally mark the
+delimited block for Pandoc to syntax highlight it:
+
+```python
+import time
+# Quick, count to ten!
+for i in range(10):
+# (but not *too* quick)
+time.sleep(0.5)
+print(i)
+```
+
+### An h3 header
+
+Now a nested list:
+
+1. First, get these ingredients:
+
+- carrots
+- celery
+- lentils
+
+2. Boil some water.
+
+3. Dump everything in the pot and follow
+   this algorithm:
+
+find wooden spoon
+uncover pot
+stir
+cover pot
+balance wooden spoon precariously on pot handle
+wait 10 minutes
+goto first step (or shut off burner when done)
+
+Do not bump wooden spoon or it will fall.
+
+Notice again how text always lines up on 4-space indents (including
+that last line which continues item 3 above).
+
+Here's a link to [a website](http://foo.bar), to a [local
+doc](local-doc.html), and to a [section heading in the current
+doc](#an-h2-header). Here's a footnote [^1].
+
+[^1]: Some footnote text.
+
+Tables can look like this:
+
+Name Size Material Color
+
+---
+
+All Business 9 leather brown
+Roundabout 10 hemp canvas natural
+Cinderella 11 glass transparent
+
+Table: Shoes sizes, materials, and colors.
+
+(The above is the caption for the table.) Pandoc also supports
+multi-line tables:
+
+---
+
+Keyword Text
+
+---
+
+red Sunsets, apples, and
+other red or reddish
+things.
+
+green Leaves, grass, frogs
+and other things it's
+not easy being.
+
+---
+
+A horizontal rule follows.
+
+---
+
+Here's a definition list:
+
+apples
+: Good for making applesauce.
+
+oranges
+: Citrus!
+
+tomatoes
+: There's no "e" in tomatoe.
+
+Again, text is indented 4 spaces. (Put a blank line between each
+term and its definition to spread things out more.)
+
+Here's a "line block" (note how whitespace is honored):
+
+| Line one
+| Line too
+| Line tree
+
+and images can be specified like so:
+
+![example image](example-image.jpg 'An exemplary image')
+
+Inline math equation: $\omega = d\phi / dt$. Display
+math should get its own line like so:
+
+$$I = \int \rho R^{2} dV$$
+
+And note that you can backslash-escape any punctuation characters
+which you wish to be displayed literally, ex.: \`foo\`, \*bar\*, etc.

package/dist-client/helps/dataset/data-archive.md

@@ -0,0 +1,9 @@
+# DataArchive
+데이터셋의 원형 데이터(raw data)를 csv.gz 파일로 다운로드할 수 있습니다. <br>
+요청 후 시간이 수 분 소요될 수 있으며, 정상적으로 요청이 수행되면 다운로드 가능한 링크를 알림으로 알려줍니다. 알림의 링크를 클릭하여 파일을 다운로드 할 수 있습니다. <br>
+조회 페이지에서도 다운로드 주소를 확인할 수 있습니다. <br>
+다운로드 링크는 유효기간이 있으며, 만료되면 더 이상 다운로드할 수 없습니다. <br>
+다음의 경우들은 관리자에게 문의하시기 바랍니다.
+- 요청시간 초과(timeout)가 발생
+- 10분 경과 후에도 상태가 requested에서 변경되지 않음
+- 최종 상태가 error로 표기

package/dist-client/helps/dataset/data-entry-list.md

@@ -0,0 +1,2 @@
+# DataEntryList
+데이타 셋에 정의한 입력용 화면을 연결합니다. 데이타 셋에 입력담당 역할이 필요합니다.

package/dist-client/helps/dataset/data-key-set.md

@@ -0,0 +1,10 @@
+# DataKeySet
+데이터 키셋은 데이터샘플 조회에 인덱싱을 하기 위한 장치입니다. 데이터샘플 레코드의 data컬럼에 저장되는 오브젝트 key값을 기준으로 정보를 추가합니다. 데이터 키셋은 데이터셋에 지정할 수 있습니다. <br>
+- 이름: 데이타 키셋 이름을 설정합니다. <br>
+- 설명: 데이타 키셋에 대한 설명을 설정합니다. <br>
+- 활성화: 사용 여부를 설정합니다. <br>
+- 리포트용 화면종류: 
+    - Jasper: Jasper 서버 설정에 따른 jasper 페이지를 렌더링합니다.
+    - Shiny: shiny 서버 설정에 따른 shiny 페이지를 렌더링합니다.
+
+- 리포트용 화면: 리포트용 화면종류에 따른 값을 설정합니다. Jasper나 Shiny의 경우, 해당 서버에서 유효한 suburl이 필요합니다.<br>

package/dist-client/helps/dataset/data-ooc.md

@@ -0,0 +1,11 @@
+# DataOOC
+데이타 이탈 내역을 조회하고 조치합니다. 
+
+- 데이타 이탈점 상세: 데이타 이탈점 상세 팝업 화면을 띄웁니다.
+    - 데이타 셋 아이템 별 CCP, QC 이탈 여부를 조회합니다.
+    - 데이타 이탈점 생성 부터 조치 이력을 조회합니다.
+    - 조치, 조치완료 내용을 입력하고 저장합니다.
+- 상태: 생성, 조치, 조치완료 상태를 보여줍니다.
+- 조치 활동: 조치 내용을 보여줍니다.
+
+나머지는 항목들은 [데이타 샘플 조회](./data-sample.md)와 동일합니다.

package/dist-client/helps/dataset/data-report-list.md

@@ -0,0 +1,4 @@
+# DataReportList
+데이타 리포트 조회가 가능한 목록입니다. 데이타 셋의 리포트용 화면이 설정되어 있어야 합니다.
+- 데이타 셋의 리포트용 화면종류에 따라 해당 페이지로 이동합니다.
+- 데이타 셋의 모니터용 화면종류에 따라 해당 페이지로 이동합니다.

package/dist-client/helps/dataset/data-sample-search.md

@@ -0,0 +1,2 @@
+# DataSampleSearch
+데이타 샘플 검색 페이지입니다. 데이타 키셋에 정의된 데이타키로 데이타 샘플을 조회할 수 있습니다.

package/dist-client/helps/dataset/data-sample.md

@@ -0,0 +1,11 @@
+# DataSample
+데이타 샘플을 조회합니다.
+- 이름: 데이타 샘플이 사용하는 데이타 셋의 이름입니다.
+- 설명: 데이타 샘플이 사용하는 데이타 셋의 설명입니다.
+- 데이타키 #: 데이타 키셋에서 정의한 데이타 키 목록이 순서대로 저장된 값입니다. 데이타 샘플의 data 오브젝트에 해당 키, 값이 포함되어 있어야 합니다.
+- 관리한계 이탈여부: 데이타 샘플이 사용하는 데이타 셋의 항목 중 CCP 명세를 벗어나는 것이 있으면 true로 저장됩니다.
+- 허용한계 이탈여부: 데이타 샘플이 사용하는 데이타 셋의 항목 중 QC 명세를 벗어나는 것이 있으면 true로 저장됩니다.
+- 데이타: 키, 값 쌍으로 된 json형태의 가공된 데이터입니다.
+- 데이타 원본: 가공하기 전, 데이타 원본(Raw Data)이 저장됩니다.
+- 작업기준일: 교대 작업조 기준의 작업일입니다.
+- 교대근무조: 교대 작업조 기준 시간의 작업조 이름입니다.

package/dist-client/helps/dataset/data-sensor.md

@@ -0,0 +1,13 @@
+# DataSensor
+데이타 센서를 등록하고 조회합니다.<br>
+- 이름: 데이타 센서 이름을 설정합니다.<br>
+- 설명: 데이타 센서에 대한 설명을 설정합니다.<br>
+- 활성화: 사용 여부를 설정합니다. 비활성화된 센서 데이타는 데이타 샘플로 저장하지 않습니다.<br>
+- 디바이스 아이디: 유일한 센서의 아이디를 설정합니다 <br>
+- 태그이름: (deprecated 검토 중)<br>
+- 어플라이언스: 데이타 등록 권한을 가진 어플라이언스를 설정합니다.<br>
+- 데이터셋: 해당 센서 데이터에 반영할 데이터셋을 설정합니다. <br>
+- 모델: 센서 모델 정보를 설정합니다.<br>
+- 브랜드: 센서 브랜드를 설정합니다.<br>
+- 시리얼번호: 센서 시리얼번호를 설정합니다.<br>
+- 네트워크마스크: netmask 정보를 설정합니다.<br>

package/dist-client/helps/dataset/data-set.md

@@ -0,0 +1,28 @@
+# DataSet
+데이타 셋을 정의합니다.<br>
+- [`데이타 아이템 등록 및 조회`](./ui/data-key-item-list.md): 데이타 아이템 화면을 팝업으로 띄웁니다.
+- 데이타 입력: 데이타 입력 화면을 팝업으로 띄웁니다.
+- 이름: 데이터셋 이름을 설정합니다.<br>
+- 설명: 데이터셋에 대한 설명을 설정합니다.<br>
+- 유형: 데이터셋 유형을 설정합니다.<br>
+    - 수동 수집: 사용자가 입력하는 데이터셋인 경우 
+    - 자동 수집: 센서처럼 자동으로 입력되는 데이터셋인 경우
+- 데이타 키셋: 데이타 키셋 마스터 페이지에서 등록한 항목을 적용합니다.<br>
+- 파티션 키: (deprecated 예정)<br>
+- 스케줄: 입력 주기를 설정합니다.<br>
+- 타임존: 수집일 타임존을 설정합니다.<br>
+- 관리자 역할: 데이터셋 관리자 역할을 설정합니다.<br>
+- 입력담당 역할: 입력 권한을 부여할 역할을 설정합니다.<br>
+- 입력용 화면종류: 입력 화면종류를 설정합니다. 주로 Board가 사용됩니다.<br>
+    - Generated: 구현된 화면을 사용합니다.
+    - Board: Board 화면을 사용합니다.
+    - Page: 구현된 페이지로 이동합니다. suburl이 필요합니다.
+    - External URL: 외부 페이지로 이동합니다. 전체 Url이 필요합니다.
+- 입력용 화면: 화면 종류에 따른 값을 설정합니다. Board 화면 종류는 Board를 선택할 수 있습니다.<br>
+- 모니터용 화면종류: 모니터용 화면종류를 설정합니다. 선택 목록은 입력용 화면종류와 동일합니다.<br>
+- 모니터용 화면: 모니터용 화면종류에 해당하는 값을 설정합니다. <br>
+- 리포트용 화면종류: 리포트용 화면종류를 설정합니다. 선택 목록은 입력용 화면종류에 두 종류가 더 있습니다.
+    - Jasper: Jasper 서버 설정에 따른 jasper 페이지를 렌더링합니다.
+    - Shiny: shiny 서버 설정에 따른 shiny 페이지를 렌더링합니다.
+- 리포트용 화면: 리포트용 화면종류에 맞는 값을 설정합니다. Jasper나 Shiny의 경우, 해당 서버에서 유효한 suburl이 필요합니다. <br>
+- 리포트용 템플릿: 리포트용 화면에 필요한 템플릿 파일을 업로드합니다.

package/dist-client/helps/dataset/ui/data-item-list.md

@@ -0,0 +1,19 @@
+# DataItemList
+데이타 셋의 아이템 목록을 등록합니다.
+- 이름: 데이타 셋 아이템 이름입니다.
+- 설명: 데이타 셋 아아템 설명입니다.
+- 활성화: 사용 여부를 설정합니다.
+- 숨기기: 레포트 등 2차 가공 데이터로 사용시, 사용자에게 보여줄 지 여부를 설정합니다.
+- 태그이름: 오브젝트 키를 설정합니다.
+- 유형: 데이타 셋 아이템 값의 데이타 타입 입니다.
+    - number
+    - text
+    - select
+    - boolean
+    - file
+- Options: select 유형인 경우, name과 value 쌍을 추가로 설정합니다.
+- 단위: kg, cm, 등 의 입력 단위를 설정합니다.
+- 샘플수: 해당 아이템 값을 몇 개 입력받을지 설정합니다.
+- 명세: 명세를 정의하면 이탈값이 OOC 데이터로 추가됩니다. 또한 해당 데이터샘플에 이탈여부가 기록됩니다.
+    - CCP: Critical Control Point Data Spec을 정의합니다.
+    - QC: Quality Contol Data Spec을 정의합니다.

package/dist-client/helps/dataset/ui/data-key-item-list.md

@@ -0,0 +1,2 @@
+# DataKeyItemList
+데이타 키 상세에서는 데이터샘플에 저장되는 data컬럼의 key정보를 지정합니다. '번역 키'를 deprecated 시킬 예정이오니, '이름'을 활용해주세요. 데이터 키에는 data컬럼에 저장되는 오브젝트 key값을 지정해야 합니다.

package/dist-client/helps/index.md

@@ -0,0 +1 @@
+# help

package/dist-client/helps/integration/concept/connection.md

@@ -0,0 +1,27 @@
+# Connection
+
+외부 시스템을 연결하기 위해 제공되는 기능을 Connector라고 하며, Connector를 작동시키기 위한 설정 정보가 Connection 이다.
+한 종류의 Connector는 여러 Connection을 가질 수 있다.
+
+외부 시스템을 연결하기 위해서는 외부 시스템에 연결하기 위한 연결 정보와 프로토콜을 정의해야 하며,
+커넥션은 외부 시스템 연결 정보를 의미한다.
+
+외부 시스템은 대표적으로 데이타베이스, 메시지 브로커 등의 서비스를 제공하는 네트워크 기반의 시스템이 될 수도 있고,
+때로는 카메라, 프린터, 스캐너 같은 디바이스를 직접 연결하는 USB 포트 등이 될 수 있다.
+그 밖에 가상의 오브젝트가 될 수도 있다.
+
+시나리오는 태스크의 시리즈로 정의된다. 일부 태스크는 커넥션에 기반한 태스크들이 될 수 있다.
+예를 들면, 데이타베이스 커넥션에 기반한 태스크로는 데이타베이스 쿼리가 될 수 있으며,
+메시지 브로커를 기반한 태스크로는 메시지 서브스크라이브나 메시지 퍼블리시 같은 태스크들이 있을 수 있다.
+
+## endpoint
+
+- 외부 시스템의 연결 정보를 설정한다.
+- 네트워크 기반 커넥션의 엔드포인트는 보통 protocol과 host, service port 그리고 path 정보로 구성된다.
+- USB 디바이스에 대한 커넥션의 엔드포인트는 USB 포트번호가 될 수 있다.
+- 각 커넥터별 엔드포인트 설정 방법은 커넥터의 구현에 따른다. 커넥터의 도움말 기능을 통해서 엔드포인트 설정 방법을 가이드한다.
+
+## parameters
+
+- Connector를 동작시키기 위한 속성을 설정한다.
+- Connector 구현에 따라서 속성들은 정의된다.

package/dist-client/helps/integration/concept/data-accessor.ko.md

@@ -0,0 +1,11 @@
+# 데이터 접근자(data accessor)
+
+- 태스크의 속성으로 [시나리오 컨텍스트](./scenario-context.md) 내의 Data 중에서 필요한 value를 한정하고자 할 때 사용된다
+- 컨텍스트의 데이타는 각 스텝의 이름을 Key로 가지며, 스텝의 결과값을 Value로 유지하는 오브젝트이다.
+- 따라서 accessor는 항상 스텝의 이름으로 시작되며, 그 값 아래로도 더 한정하고 싶은 경우에는 자바스크립트 오브젝트의 Value를 지정하는 표현을 사용할 수 있다.
+- 또한, 데이터를 변환한 결과를 사용할 수도 있다.
+- 데이터 접근자(data accessor)를 설정하는 방법은 [JSONATA Document](http://docs.jsonata.org/overview)의 명세를 따른다.
+- 예시
+  - `stepname`
+  - `stepname.property`
+  - `stepname.property.property. ...`

package/dist-client/helps/integration/concept/data-accessor.md

@@ -0,0 +1,11 @@
+# data accessor
+
+- As a property of the task, it is used to limit the required value among the data in [scenario context](./scenario-context.md).
+- Context data is an object that has the name of each step as a Key and maintains the result value of the step as a Value.
+- Therefore, the accessor always starts with the name of the step, and if you want to further limit the value below that value, you can use an expression that specifies the value of the JavaScript object.
+- You can also use the result of data transformation.
+- How to set data accessor follows the specification of [JSONATA Document](http://docs.jsonata.org/overview).
+- example
+  - `stepname`
+  - `stepname.property`
+  - `stepname.property.property. ...`

package/dist-client/helps/integration/concept/data-accessor.zh.md

@@ -0,0 +1,11 @@
+# 数据访问器
+
+- 作为任务的一个属性，用于限制[scenario context](./scenario-context.md) 中数据中所需的值。
+- 上下文数据是将每个步骤的名称作为 Key，并将步骤的结果值作为 Value 来维护的对象。
+- 因此，访问器总是以步骤名称开头，如果您想进一步限制低于该值的值，您可以使用指定 JavaScript 对象值的表达式。
+- 您还可以使用数据转换的结果。
+- 如何设置数据访问器遵循 [JSONATA Document](http://docs.jsonata.org/overview) 的规范。
+- 例子
+  - `stepname`
+  - `stepname.property`
+  - `stepname.property.property。 ...`

package/dist-client/helps/integration/concept/pending-queue.md

@@ -0,0 +1,32 @@
+# Pending Scenario Queue
+
+일정 시간 이후에 실행될 지연 예약된 시나리오를 등록할 수 있도록 제공되는 장치이다.
+
+## Operation
+
+- 지연 큐는 [book-up-scenario](../task/book-up-scenario.md) 태스크에 의해서 일정 시간 후에 실행될 시나리오를 등록할 수 있는 대기 큐이다.
+- 지연 큐에 보관된 지연 시나리오는 지연 시간이 만료되면 [pick-pending-scenario](../task/pick-pending-scenario.md) 태스크에 의해서 꺼내져서 실행되게 된다.
+- 지연 큐는 reset-pending-queue 태스크에 의해서 클리어될 수 있다.
+
+### 태그 tag
+
+- 지연된 시나리오는 'tag' 속성으로 카테고리화 될 수 있다. 즉, book-up 시에는 지연 시나리오에 'tag'를 부여할 수 있으며, [pick-pending-scenario](../task/pick-pending-scenario.md) 시에는 특정 'tag'가 부여된 시나리오 중에서 지연시간이 만료된 시나리오를 실행할 수 있다.
+
+### 시나리오 우선 순위 priority
+
+- 지연 큐에 [book-up-scenario](../task/book-up-scenario.md)되는 시나리오는 우선순위 priority 를 속성으로 가질 수 있다.
+- 지연 만료된 시나리오 중에서 [pick-pending-scenario](../task/pick-pending-scenario.md)에 의해서 시나리오가 선택될 때, 우선 순위가 높은 것이 최우선으로 선택되며, 동일 우선순위의 시나리오 중에서는 만료시간이 가장 오래된 시나리오가 선택된다.
+
+## 활용
+
+### long 시나리오 구현에 활용
+
+- 여러 단계의 다양한 서브 시나리오들로 구성된 긴 시나리오를 이해하고 관리하는 것은 쉽지 않다.
+- 이련 경우에 여러개의 단위 시나리오를 정의하고, 지연 큐를 활용해서 단위 시나리오들을 순차적으로 작동시키는 방법으로 재구성할 수 있다.
+
+### 유한 자원의 시나리오 실행 쓰로틀링 throttling 에 활용
+
+- [pick-pending-scenario](../task/pick-pending-scenario.md) 태스크는 지연만료된 시나리오를 지연 큐에서 꺼내서 실행 run 하는 태스크이다.
+- 유한 자원을 가진 경우, 동시에 자원 이상의 시나리오를 실행하지 못하게 컨트롤 하고자 하는 경우에 유용하게 응용할 수 있다.
+- 예를 들어, 하나의 로봇암 A는 한 시점에 하나의 시나리오만을 수행해야 하는 경우가 있다고 가정하면, 로봇암 A가 주로 실행하는 시나리오들을 'RA'라는 태그를 붙여서 지연 큐에 [book-up-scenario](../task/book-up-scenario.md)한다.
+  그리고, 로봇암 A를 위해서 무한 반복하는 하나의 시나리오를 만들고, 그 시나리오에 [pick-pending-scenario](../task/pick-pending-scenario.md) 태스크를 이용해서, 'RA' 태그가 붙여진 지연 만료된 시나리오를 하나씩 꺼내서 순차적으로 실행한다.

package/dist-client/helps/integration/concept/scenario-context.md

@@ -0,0 +1,83 @@
+# context
+
+시나리오 엔진은 시나리오를 구성하는 태스크를 순차적으로 실행하게 되는데, 각 태스크가 자신의 구현에 집중할 수 있도록 컨텍스트를 통해서 여러가지 기능과 데이타를 태스크에 제공하게 된다.
+
+## 기능
+
+- logger
+  - 태스크 수행 중에 로그를 남겨야 할 필요가 있을 때, 컨텍스트로 제공된 logger를 사용할 수 있다.
+
+```
+  logger.info('...')
+  logger.warn('...')
+  logger.error('...')
+```
+
+- publish
+  - 태스크 수행 중에 데이타를 브로드캐스트할 경우에 사용할 수 있다.
+
+```
+  publish('tag', data)
+```
+
+- load
+  - 태스크 수행 중에 다른 시나리오를 실행할 경우에 사용한다.
+  - 이 때 새로 만들어지는 시나리오 인스턴스를 서브시나리오라고 한다.
+  - 서브시나리오는 동기 개념으로 실행되어야 한다. 즉, load에 의해 시작된 시나리오 인스턴스가 완료될 때까지 기다린다.
+
+```
+load(instanceName, scenarioConfig, context)
+```
+
+- client
+  - 서버에 내장된 GraphQL API를 호출할 때 사용한다.
+  - client는 현재 시나리오가 실행되는 프로세스의 API를 호출할 수 있도록 바인드된 graphql client 객체이다.
+
+```
+client.query(...)
+client.mutate(...)
+```
+
+- closures
+  - 태스크는 보통 실행 시작 시점에 필요한 리소스를 할당하고, 종료하기 전에 리소스를 해제하도록 권장된다.
+  - 하지만, 어떤 경우에는 태스크는 효율을 위해서 최초 시작 시점에 필요한 리소스를 할당하고, 시나리오 인스턴스가 종료되는 시점에 리소스를 해제하고자 할 수 있다.
+  - 이 때에 closuers 에 리소스 해제를 위한 함수를 등록해 놓으면, 시나리오 인스턴스가 종료되는 시점에 자동으로 호출되어 리소스 해제의 기회를 얻을 수 있다.
+- checkState
+  - 현재 시나리오의 상태가 어떤 상태인지를 확인하는 함수이다.
+
+```
+if(checkState(ScenarioInstanceStatus.STARTED)) {
+  ...
+}
+```
+
+## 데이타
+
+- domain
+  - 시나리오의 도메인 정보
+  - 도메인은 시나리오가 정의 및 실행되는 경계가 된다.
+- variables
+  - 시나리오가 시작될 때, 넘겨진 입력변수 오브젝트
+  - 시나리오를 실행하는 여러가지 방법에는 일반적으로 입력변수를 제공하는 기능이 제공된다.
+- data
+  - 시나리오가 진행되면서 수행된 각 스텝의 반환값을 유지하는 오브젝트이다.
+  - 각 스텝의 이름을 Key로 하며, 그 결과 값을 Value로 유지하는 오브젝트이다.
+  - 서브시나리오 스텝의 결과 값은 해당 서브시나리오의 스텝의 반환값을 모두 포함한다.
+  - 주의. 시나리오에서 하나의 스텝이 여러번 실행되는 경우 마지막 결과값만 유지한다.
+- state
+  - 현재 시나리오의 상태값을 유지한다.
+  - 시나리오의 상태 정의는 다음과 같다.
+
+```
+enum ScenarioInstanceStatus {
+  READY,
+  STARTED,
+  STOPPED,
+  HALTED,
+  UNLOADED
+}
+```
+
+- root
+  - 시나리오는 스텝으로 다른 시나리오를 가질 수 있으며, 이 경우 스텝으로 정의된 시나리오를 서브시나리오라고 한다.
+  - root 는 최상위 부모 시나리오를 가리킨다.

package/dist-client/helps/integration/concept/scenario-engine.md

@@ -0,0 +1,10 @@
+# Scenario Engine
+
+사전에 정의된 시나리오를 구동시키는 엔진을 의미한다.
+시나리오 인스턴스들의 라이프사이클을 관리하며, 시나리오의 스텝을 구성하는 태스크를 수행하는 역할을 한다.
+
+시나리오를 시작시키는 방법은 다음과 같다.
+
+- 스케쥴에 의한 시나리오 시작
+- 시나리오 관리 페이지를 통한 시나리오 시작
+- 시나리오 컨트롤 API를 통한 시나리오 시작

package/dist-client/helps/integration/concept/scenario.md

@@ -0,0 +1,4 @@
+# scenario
+
+- 시나리오는 순차적으로 실행되는 [태스크](./task.md)의 시리즈이다.
+- 시나리오를 구성하는 각 단계의 태스크를 스텝이라고 한다.