@fmsim/fmsim-restful 1.0.14 → 1.0.16

package/dist-app/helps/integration/task/local-graphql-query.zh.md

@@ -0,0 +1,40 @@
+# local-graphql-query
+
+这是调用服务器提供的GraphQL query API的任务。在构建查询时，变量处理可以通过两种方式进行，建议使用方法2。
+
+方法1：利用[脚本内部变量](../concept/script-internal-variables.md)，例如在场景上下文中的数据和变量。此方法适用于应用字符串变量。
+
+```graphql
+query {
+  fetchWorkOrderHistory(fromDate: "${this.variables.fromDate}", toDate: "${this.variables.toDate}") {
+    ...
+  }
+
+  searchObjectWithTag(tag: "${this.data.tag}") {
+    ...
+  }
+}
+```
+
+方法2：在`variables`中指定要使用的变量，并使用GraphQL变量处理方法。变量的值可以指定为场景上下文的数据访问器。此方法适用于应用对象类型变量。
+
+```graphql
+query($filters: [Filter!], $sortings: [Sorting!], $pagination: Pagination, tag: String!) {
+  boards(filters: $filters, sortings: $sortings, pagination: $pagination) {
+    ...
+  }
+
+  searchObjectWithTag(tag: $tag) {
+    ...
+  }
+}
+```
+
+## 参数
+
+- query
+  - 输入GraphQL查询。
+
+- variables
+  - 定义在GraphQL查询中使用的变量。
+  - 键是变量的名称，值是与变量值相对应的数据访问器。

package/dist-app/helps/integration/task/log.ja.md

@@ -0,0 +1,17 @@
+# log
+
+ログタスクは、シナリオの状態の変更を監視するためのログを出力するために使用されます。これらのログはアプリケーションの「logs」フォルダに保存され、ログファイルは「scenario-ScenarioName」で始まります。
+
+## パラメータ
+
+- メッセージ
+  - 特定のメッセージをログとして記録する必要がある場合は、このパラメータを使用します。メッセージログを有効にするには、アクセサが空である必要があります。
+  - 構成されたメッセージはログに記録されます。
+  - [テンプレートリテラル](../concept/template-literal.md)が適用されているため、データ、変数、ドメイン、ユーザー、lng などの変数を活用できます。
+    - [スクリプト内部変数](../concept/script-internal-variables.md)
+- アクセサ [accessor](../concept/data-accessor.md)
+  - シナリオ内の特定のステップの結果値を出力したい場合は、アクセサを使用します。
+  - このアクセサの結果はログに記録されます。
+- レベル
+
+  - ログメッセージのレベルを「info」、「warn」、「error」のいずれかに設定できます。

package/dist-app/helps/integration/task/log.ko.md

@@ -0,0 +1,17 @@
+# log
+
+시나리오의 상태가 값의 변화를 확인하기 위해서 로그를 출력하는 기능이다.
+해당 로그는 어플리케이션의 logs 폴더에 저장되며 'scenario-시나리오명'으로 시작하는 로그 파일에 저장된다.
+
+## parameters
+
+- 메시지
+  - 특정한 메시지를 로그로 남겨둘 필요가 있을 경우 사용하며 메시지의 로그가 유효하기 위해서는 접근자가 빈 상태로 있어야 한다.
+  - 설정된 메시지는 로그의 내용에 남겨진다.
+  - [템플릿 리터럴](../concept/template-literal.md)이 적용되므로, data, variables, domain, user, lng 등의 변수를 활용할 수 있다.
+    - [스크립트 내장변수](../concept/script-internal-variables.md)
+- 접근자 [accessor](../concept/data-accessor.md)
+  - 시나리오 내의 하나의 스텝이름으로, 해당 스텝의 결과 값을 출력하고자 할 경우에 접근자를 사용한다.
+  - 이 접근자 결과는 로그에 남겨진다.
+- 레벨
+  - 로그 메시지의 레벨을 설정할 수 있다. 레벨은 'info', 'warn', 'error' 중에 하나를 선택할 수 있다.

package/dist-app/helps/integration/task/log.md

@@ -0,0 +1,16 @@
+# log
+
+The Log Task is used to output logs for monitoring changes in scenario states. These logs are stored in the application's "logs" folder and are saved in a log file that starts with "scenario-ScenarioName."
+
+## Parameters
+
+- Message
+  - If you need to log a specific message, use this parameter. To make the message log effective, the accessor should be empty.
+  - The configured message will be recorded in the log.
+  - Since [template literals](../concept/template-literal.md) are applied, you can utilize variables such as data, variables, domain, user, lng, and more.
+    - [Script Built-in Variables](../concept/script-internal-variables.md)
+- Accessor [accessor](../concept/data-accessor.md)
+  - Use an accessor when you want to output the result value of a specific step within the scenario.
+  - The result of this accessor will be recorded in the log.
+- Level
+  - You can set the log message level to 'info,' 'warn,' or 'error.'

package/dist-app/helps/integration/task/log.ms.md

@@ -0,0 +1,17 @@
+# log
+
+Tugas Log digunakan untuk menghasilkan log bagi memantau perubahan dalam keadaan senario. Log ini disimpan dalam folder "logs" aplikasi dan disimpan dalam fail log yang bermula dengan "scenario-ScenarioName."
+
+## Parameter
+
+- Mesej
+  - Jika anda perlu mencatat mesej tertentu, gunakan parameter ini. Untuk membuat log mesej berkesan, aksesori harus kosong.
+  - Mesej yang dikonfigurasi akan direkodkan dalam log.
+  - Oleh kerana [literal templat](../concept/template-literal.md) digunakan, anda boleh menggunakan pembolehubah seperti data, pembolehubah, domain, pengguna, lng, dan lain-lain.
+    - [Pembolehubah Terbina Dalam Skrip](../concept/script-internal-variables.md)
+- Aksesori [accessor](../concept/data-accessor.md)
+  - Gunakan aksesori apabila anda ingin menghasilkan hasil nilai langkah tertentu dalam senario.
+  - Hasil aksesori ini akan direkodkan dalam log.
+- Tahap
+
+  - Anda boleh menetapkan tahap mesej log kepada 'info,' 'warn,' atau 'error.'

package/dist-app/helps/integration/task/log.zh.md

@@ -0,0 +1,16 @@
+# log
+
+记录任务用于输出日志，以监视场景状态的变化。这些日志存储在应用程序的“logs”文件夹中，并保存在以“scenario-ScenarioName”开头的日志文件中。
+
+## 参数
+
+- 消息
+  - 如果需要记录特定消息，请使用此参数。为了使消息记录生效，访问者应为空。
+  - 配置的消息将记录在日志中。
+  - 由于应用了[模板文字](../concept/template-literal.md)，您可以利用诸如数据、变量、域、用户、lng 等变量。
+    - [脚本内置变量](../concept/script-internal-variables.md)
+- 访问者 [accessor](../concept/data-accessor.md)
+  - 当您希望输出场景内特定步骤的结果值时，请使用访问者。
+  - 此访问者的结果将记录在日志中。
+- 级别
+  - 您可以将日志消息级别设置为“info”，“warn”或“error”。

package/dist-app/helps/integration/task/mqtt-publish.ja.md

@@ -0,0 +1,10 @@
+# mqtt-publish
+
+このタスクは、MQTTブローカーに設定されたタグを使用してアクセサのデータを送信するものです。
+
+## パラメータ
+
+- トピック
+  - ブローカーに送信するメッセージのタグを指定します。
+- [アクセサ](../concept/data-accessor.md)
+  - ブローカーに送信するメッセージデータのアクセサを指定します。

package/dist-app/helps/integration/task/mqtt-publish.ko.md

@@ -0,0 +1,10 @@
+# mqtt-publish
+
+MQTT 브로커에 설정된 tag를 붙여 accessor의 데이타를 송신하는 태스크이다.
+
+## parameters
+
+- topic
+  - 브로커로 보낼 메시지의 tag를 지정한다.
+- [accessor](../concept/data-accessor.md)
+  - 브로커로 보낼 메시지 data의 접근자를 지정한다.

package/dist-app/helps/integration/task/mqtt-publish.md

@@ -0,0 +1,10 @@
+# mqtt-publish
+
+This task is responsible for transmitting the data of the accessor using the tag configured in the MQTT broker.
+
+## Parameters
+
+- Topic
+  - Specify the tag of the message to be sent to the broker.
+- [Accessor](../concept/data-accessor.md)
+  - Specify the accessor of the message data to be sent to the broker.

package/dist-app/helps/integration/task/mqtt-publish.ms.md

@@ -0,0 +1,10 @@
+# mqtt-publish
+
+Tugasan ini bertanggung jawab untuk menghantar data accessor menggunakan tag yang dikonfigurasi dalam broker MQTT.
+
+## Parameter
+
+- Topik
+  - Tetapkan tag mesej yang akan dihantar ke broker.
+- [Accessor](../concept/data-accessor.md)
+  - Tetapkan accessor data mesej yang akan dihantar ke broker.

package/dist-app/helps/integration/task/mqtt-publish.zh.md

@@ -0,0 +1,10 @@
+# mqtt-publish
+
+此任务负责使用在MQTT代理中配置的标签传输访问器的数据。
+
+## 参数
+
+- 主题
+  - 指定要发送到代理的消息的标签。
+- [访问器](../concept/data-accessor.md)
+  - 指定要发送到代理的消息数据的访问器。

package/dist-app/helps/integration/task/mqtt-subscribe.ja.md

@@ -0,0 +1,15 @@
+# mqtt-subscribe
+
+これは、MQTTブローカーからメッセージを受信し、データとして返すタスクです。
+指定されたタグに一致するメッセージを引き続きMQTTブローカーから受信し、最後のメッセージを保存して、このタスクが実行されるときに返します。
+もし、タスクが実行される時点まで新しいメッセージがない場合、新しいメッセージが届くまで待機します。
+
+## パラメータ
+
+- トピック
+  - 受信するメッセージのタグをブローカーに指定します。
+- データ形式
+  - 受信したメッセージの形式を指定します。
+  - フォーマット
+    - プレーンテキスト：受信したメッセージを文字列として解釈してデータとして返します。
+    - JSON：受信したメッセージをオブジェクト形式にパースしてデータとして返します。

package/dist-app/helps/integration/task/mqtt-subscribe.ko.md

@@ -0,0 +1,15 @@
+# mqtt-subscribe
+
+MQTT 브로커로부터 메시지를 수신하여 data로 리턴하는 태스크이다.
+MQTT 브로커로부터 지정된 태그에 해당하는 메시지를 계속 수신해서 마지막 메시지를 보관하고 있다가, 이 태스크가 실행되는 시점에 리턴한다.
+만일, 태스크 실행 시점까지 새로 받은 메시지가 없다면, 새로운 메시지를 받을 때까지 기다린다.
+
+## parameters
+
+- topic
+  - 브로커로부터 받을 메시지의 tag를 지정한다.
+- data format
+  - MQTT 브로커로부터 받은 메시지의 형식을 지정한다.
+  - formats
+    - Plain Text : 수신한 메시지를 문자열로 해석하여 data로 리턴한다.
+    - JSON : 수신한 메시지를 Object 형식으로 파싱하여 data로 리턴한다.

package/dist-app/helps/integration/task/mqtt-subscribe.md

@@ -0,0 +1,15 @@
+# mqtt-subscribe
+
+This is a task that receives messages from an MQTT broker and returns them as data.
+It continues to receive messages from the MQTT broker that match the specified tag, stores the last message, and returns it when this task is executed.
+If there are no new messages until the task execution, it waits until a new message is received.
+
+## Parameters
+
+- Topic
+  - Specifies the tag of the message to be received from the broker.
+- Data Format
+  - Specifies the format of the message received from the MQTT broker.
+  - Formats
+    - Plain Text: Interprets the received message as a string and returns it as data.
+    - JSON: Parses the received message into an object format and returns it as data.

package/dist-app/helps/integration/task/mqtt-subscribe.ms.md

@@ -0,0 +1,15 @@
+# mqtt-subscribe
+
+Ini adalah tugas yang menerima mesej dari broker MQTT dan mengembalikannya sebagai data.
+Ia terus menerima mesej dari broker MQTT yang sepadan dengan tag yang ditetapkan, menyimpan mesej terakhir, dan mengembalikannya apabila tugas ini dijalankan.
+Jika tiada mesej baru sehingga waktu pelaksanaan tugas, ia menunggu sehingga mesej baru diterima.
+
+## Parameter
+
+- Topik
+  - Menetapkan tag mesej yang akan diterima dari broker.
+- Format Data
+  - Menetapkan format mesej yang diterima dari broker MQTT.
+  - Format
+    - Teks Biasa: Menafsirkan mesej yang diterima sebagai rentetan dan mengembalikannya sebagai data.
+    - JSON: Mengurai mesej yang diterima ke dalam format objek dan mengembalikkannya sebagai data.

package/dist-app/helps/integration/task/mqtt-subscribe.zh.md

@@ -0,0 +1,15 @@
+# mqtt-subscribe
+
+这是一个从MQTT代理接收消息并将其返回为数据的任务。
+它继续从MQTT代理接收与指定标签匹配的消息，存储最后一条消息，并在执行此任务时返回它。
+如果直到任务执行时没有新消息，它将等待直到收到新消息。
+
+## 参数
+
+- 主题
+  - 指定从代理接收的消息的标签。
+- 数据格式
+  - 指定从MQTT代理接收的消息的格式。
+  - 格式
+    - 纯文本：将接收的消息解释为字符串并将其作为数据返回。
+    - JSON：将接收的消息解析为对象格式并将其作为数据返回。

package/dist-app/helps/integration/task/oracle-procedure.ja.md

@@ -0,0 +1,139 @@
+# oracle-procedure
+
+このタスクは、Oracle データベースに格納されているプロシージャを呼び出すもので、個々のデータ型に応じてデータのリストまたは特定のデータ型の値を返します。
+
+## パラメータ
+
+### プロシージャ コード
+
+- プロシージャ コードは、*プロシージャ名*と*パラメータ*に基づいて自動生成されるコードで、ユーザーが手動で入力する必要はありません。
+- たとえば、プロシージャの名前が*mcs.myproc*で、パラメータが*id*と*out_name*で構成されている場合、次のように表現されます：
+
+```text
+mcs.myproc(:id, :out_name);
+```
+
+### プロシージャ名
+
+- プロシージャの名前を指定します。
+- プロシージャがパッケージまたはユーザー名で区別される必要がある場合は、ピリオド(.)を使用してそれらを区別します。
+- 例：
+
+```text
+mcs.myproc
+```
+
+### パラメータ
+
+- パラメータは次の要素で構成されています。
+  - パラメータ名
+  - ディレクション: IN、INOUT、OUT
+  - データ型: String、Number、Date、Cursor
+  - 値: 入力変数の場合、対応する値
+  - 最大サイズ: String または Buffer データ型の場合、変数の最大サイズを指定します。
+
+#### パラメータ名
+
+パラメータ名は、プロシージャで使用されるパラメータの名前を指定します。前述の例では、'id'と'out_name'がパラメータ名です。
+
+### ディレクション
+
+変数が入力(IN)または出力(OUT)変数かを指定します。
+
+### データ型
+
+パラメータのデータ型を指定します。データ型は、プロシージャを作成する際に指定された名前と完全に一致するように指定する必要があります。
+
+たとえば、プロシージャが次のように実装されている場合：
+
+```sql
+CREATE OR REPLACE NONEDITIONABLE PROCEDURE myproc (in_id IN VARCHAR2, out_name OUT VARCHAR2) AS
+BEGIN
+    SELECT name INTO out_name FROM MCS.FMB_USERS WHERE id = in_id ;
+END;
+```
+
+最初のパラメータと 2 番目のパラメータはどちらも VARCHAR2 型です。
+
+このようなプロシージャを呼び出す場合、パラメータのタイプは両方とも String として指定し、出力の場合は最大サイズも指定する必要があります。
+
+ここに指定方法の例があります：
+
+![procedure example1](./assets/../../../../assets/images/oracle-procedure-example1.png 'procedure example1')
+
+### アクセサー
+
+設定は[JSONATA のドキュメント](http://docs.jsonata.org/overview.html)に従います。
+
+「アクセサー」が指定されている場合、そのアクセサーで構成された値がパラメータの値として使用されます。アクセサー操作から結
+
+果が生成されない場合、
+「値（val）」設定で指定された値が使用されます。
+
+### 値(val)
+
+パラメータが入力(IN)の場合、このフィールドに値を指定します。このフィールドには「定数」値を直接入力します。
+
+前述の例では、'id'パラメータの入力値として'ID'が指定されている場合、ID タスクから返された値を入力値として使用する必要があります。
+
+「アクセサー」設定から結果が生成されない場合、この値が使用されます。
+
+### 最大サイズ
+
+String または Buffer データ型のパラメータの場合、最大サイズを指定します。他のデータ型に対してはこの値を指定しないでください。
+
+## タスクの結果
+
+プロシージャを呼び出した結果は、オブジェクト形式で返され、出力として指定されたパラメータ名がキーとなり、それに対応する値が返されます。
+
+例えば、上記のタスクでは、結果の値は以下のようになります：
+
+```javascript
+{
+  out_name: 'Admin'
+}
+```
+
+## 別の例（カーソル）
+
+### プロシージャの実装例
+
+```sql
+CREATE OR REPLACE NONEDITIONABLE PROCEDURE PROCEDURE1(out_cursor OUT SYS_REFCURSOR) AS
+BEGIN
+    BEGIN
+        OPEN out_cursor FOR
+            SELECT * FROM FARMWEATHER WHERE rownum <= 1000;
+    END;
+END PROCEDURE1;
+```
+
+### プロシージャの呼び出し例
+
+![procedure example2](./assets/../../../../assets/images/oracle-procedure-example2.png 'procedure example2')
+
+### プロシージャ呼び出しのタスク結果
+
+```javascript
+{
+  "out_cursor": [
+    {
+      "FARMDATE": "2006-01-07T15:00:00.000Z",
+      "MAXT": 29.5,
+      "MINT": 21.8,
+      "WINDSPEED": 1.6,
+      "FARMHUM": 70.2,
+      "PRECIPITATION": 0
+    },
+    {
+      "FARMDATE": "2006-01-08T15:00:00.000Z",
+      "MAXT": 30.1,
+      "MINT": 21,
+      "WINDSPEED": 1.6,
+      "FARMHUM": 67.4,
+      "PRECIPITATION": 0
+    },
+    ..
+  ]
+}
+```

package/dist-app/helps/integration/task/oracle-procedure.ko.md

@@ -0,0 +1,149 @@
+# oracle-procedure
+
+Oracle 데이터베이스에 저장되어 있는 프로시저를 호출하는 태스크이며,
+개별 데이터 타입에 따라서 데이터의 리스트 혹은 특정 데이터 타입의 값을 반환한다.
+
+## Parameters
+
+### 프로시저 코드
+
+- 프로시저 코드는 *프로시저 이름*과 *파라미터*에 의해서 자동으로 생성되는 코드로서, 별도로 사용자가 입력할 필요는 없다.
+- 만약, 프로시저의 이름이 *mcs.myproc*이고, 파라미터가 *id*와 *out_name*으로 구성된다면, 다음과 같이 표현된다.
+  ```text
+  mcs.myproc(:id, :out_name);
+  ```
+
+### 프로시저 이름
+
+- 프로시저의 이름을 지정한다.
+- 프로시저가 패키지나 사용자 이름등으로 구분이 필요할 경우 '.'을 통해서 구분한다.
+- 사용 예.
+  ```text
+  mcs.myproc
+  ```
+
+### 파라미터
+
+- 파라미터는 다음과 같은 요소로 구성되어 있다.
+  - 파라미터 이름
+  - 입출력 지정: IN, INOUT, OUT
+  - 파라미터 타입: String, Number, Date, Cursor
+  - 값: 해당 변수가 입력일 경우, 해당 입력에 대한 값
+  - 최대크기: 해당 변수타입이 String이나 Buffer일 경우, 변수의 최대 크기를 지정.
+
+#### 파라미터 이름
+
+파라미터 이름은 프로시저 작성에 사용된 파라미터의 이름을 지정한다.
+앞의 예의 경우,
+
+```sql
+mcs.myproc(:id, :out_name);
+```
+
+id와 out_name이 각각 파라미터 이름이다.
+
+### 입출력 지정
+
+해당 변수가 입력(IN) 혹은 출력(OUT) 여부를 지정한다.
+
+### 파라미터 타입
+
+파라미터 타입을 지정한다. 타입은 실제 프로시저 생성 시에 지정되어 있는 이름과 동일하게 지정되어야 한다.
+
+프로시저가 다음과 같이 구현되어 있다면,
+
+```sql
+CREATE OR REPLACE NONEDITIONABLE PROCEDURE myproc (in_id IN VARCHAR2, out_name OUT VARCHAR2) AS
+BEGIN
+    SELECT name INTO out_name FROM MCS.FMB_USERS WHERE id = in_id ;
+END;
+```
+
+첫번째 파라미터와 두번째 파라미터 모두 VARCHAR2로 지정되어 있으며,
+
+이러한 프로시저를 호출해야 할 경우 파라미터 타입은 모두 String을 지정해야 하고,
+출력의 경우, 최대 크기까지 지정해야 한다.
+
+호출 지정 예는 다음과 같다.
+
+![procedure example1](./assets/../../../../assets/images/oracle-procedure-example1.png 'procedure example1')
+
+### 접근자 [accessor](../concept/data-accessor.md)
+
+설정 방법은 [JSONATA 도큐먼트](http://docs.jsonata.org/overview.html)를 따른다.
+
+'접근자'가 지정되면, 해당 접근자로 조성된 값이 프로시져의 파라미터로 사용된다.
+
+아래 '값' 설정이 '상수'라면, 접근자 설정은 '변수'라고 할 수 있다.
+
+접근자 설정은 다음의 '값' 설정에 우선순위이다. 즉, 만약에 이 '접근자'가 설정되어있으면, '값(val)' 설정에 우선하여 '접근자' 연산의 결과가 프로시져 파라미터 값이 된다.
+결과 값이 없으면, '값'에 설정된 값이 사용된다.
+
+### 값(val)
+
+파라미터가 입력(IN)일 경우, 해당 값을 지정한다.
+해당 값에 바로 "상수" 값을 입력한다.
+
+위의 예어서 id의 입력 값을 ID라고 지정되어 있다면, ID 태스크에서 반환되는 값을 입력 값으로 지정한다.
+
+이 값은 위 '접근자' 설정에 따른 결과가 없는 경우에 이 '값'이 사용된다.
+
+### 최대 크기
+
+파라미터 타입이 String이나 Buffer 일 경우, 최대 크기를 지정한다. 다른 타입의 경우 값을 지정하지 않고 무시한다.
+
+## 태스크 결과
+
+프로시저 호출에 대한 결과는 Object 형태로 반환되며, 파라미터 중에서 출력으로 지정된 파라미터 이름이 키가 되어 값을 반환한다.
+
+만약, 위에서 소개된 태스크의 경우 다음과 같은 결과 값을 반환한다.
+
+```javascript
+{
+  out_name: 'Admin'
+}
+```
+
+## 다른 사용 예(커서)
+
+### 프로시저 작성 예
+
+```sql
+CREATE OR REPLACDE NONEDITIONABLE PROCEDURE PROCEDURE1(out_cursor OUT SYS_REFCURSOR) AS
+BEGIN
+    BEGIN
+        OPEN out_cursor FOR
+            SELECT * FROM FARMWEATHER WHERE rownum <= 1000;
+    END;
+END PROCEDURE1;
+```
+
+### 프로시저 호출 예
+
+![procedure example2](./assets/../../../../assets/images/oracle-procedure-example2.png 'procedure example2')
+
+### 프로시저 태스크 호출 결과
+
+```javascript
+{
+  "out_cursor": [
+    {
+      "FARMDATE": "2006-01-07T15:00:00.000Z",
+      "MAXT": 29.5,
+      "MINT": 21.8,
+      "WINDSPEED": 1.6,
+      "FARMHUM": 70.2,
+      "PRECIPITATION": 0
+    },
+    {
+      "FARMDATE": "2006-01-08T15:00:00.000Z",
+      "MAXT": 30.1,
+      "MINT": 21,
+      "WINDSPEED": 1.6,
+      "FARMHUM": 67.4,
+      "PRECIPITATION": 0
+    },
+    ..
+  ]
+}
+```