@things-factory/integration-base 9.0.5 → 9.0.6

package/helps/integration/task/publish.ja.md

@@ -1,16 +1,54 @@
 # publish
 
-これはsubscription APIを介して要求されたすべてのSubscriberにデータをブロードキャストするタスクです。
+subscription APIを介して要求されたすべてのSubscriberにデータをブロードキャストするタスクです。
 
-クライアントアプリケーションでデータサブスクリプションを要求する方法は以下の通りです。
+クライアントアプリケーションでデータサブスクリプションを要求する方法は以下の通りです：
 
-- ボードUIを介してSubscriberを通じて要求できます。
-- wss://[server host:port]/subscription APIを介してsubscribeを要求できます。
+- Board UIでsubscriberを通じて要求できます。
+- wss://[server host:port]/subscription APIを介してsubscribe要求できます。
 
-## パラメータ
+## パラメーター
 
-- [アクセサ](../concept/data-accessor.md)
-  - シナリオ内のステップ名で、ブロードキャストしたいデータを指定します。
-- タグ
+- tag
   - データをブロードキャストする際には、タグを付けて送る必要があります。
   - Subscriberもデータをsubscribeする際には、受け取りたいタグを設定して、該当のタグが付いたブロードキャストだけを受信できます。
+  - **動的サポート**: 以下のパターンを使用した動的置換をサポートします:
+    - `#{user.id}_status` - #{...} パターン使用
+    - `${user.role}_prefs` - ${...} パターン使用
+    - `{{domain.name}}_data` - {{...}} パターン使用
+    - `static_name` - 静的名前 (置換なし)
+
+## 使用例
+
+### 静的使用
+
+```json
+{
+  "task": "publish",
+  "params": {
+    "tag": "machine"
+  }
+}
+```
+
+### 動的使用
+
+```json
+{
+  "task": "publish",
+  "params": {
+    "tag": "#{machine.code}"
+  }
+}
+```
+
+### 混合使用
+
+```json
+{
+  "task": "publish",
+  "params": {
+    "tag": "#{machine.code}_${sensor.code}"
+  }
+}
+```

package/helps/integration/task/publish.ko.md

@@ -9,8 +9,46 @@ subscription API를 통해서 요청된 모든 Subscriber에게 데이타를 브
 
 ## parameters
 
-- [accessor](../concept/data-accessor.md)
-  - 시나리오 내의 하나의 스텝이름으로, 브로드캐스트하고자 하는 데이타를 지정한다.
 - tag
   - 데이타를 브로드캐스트할 때 태그를 부여해서 보내야한다.
   - subscriber들도 data를 subscribe할 때, 받고자 하는 테그를 설정하여, 해당 태그가 부여된 브로드캐스트만 받을 수 있다.
+    - **동적 지원**: 다음 패턴을 사용한 동적 치환을 지원합니다:
+    - `#{user.id}_status` - #{...} 패턴 사용
+    - `${user.role}_prefs` - ${...} 패턴 사용
+    - `{{domain.name}}_data` - {{...}} 패턴 사용
+    - `static_name` - 정적 이름 (치환 없음)
+
+## 사용 예시
+
+### 정적 사용
+
+```json
+{
+  "task": "publish",
+  "params": {
+    "tag": "machine"
+  }
+}
+```
+
+### 동적 사용
+
+```json
+{
+  "task": "publish",
+  "params": {
+    "tag": "#{machine.code}"
+  }
+}
+```
+
+### 혼합 사용
+
+```json
+{
+  "task": "publish",
+  "params": {
+    "tag": "#{machine.code}_${sensor.code}"
+  }
+}
+```

package/helps/integration/task/publish.md

@@ -7,10 +7,48 @@ Ways to request data subscription in client applications include:
 - It can be requested through the Board UI via subscribers.
 - Subscription requests can be made through the wss://[server host:port]/subscription API.
 
-## Parameters
+## parameters
 
-- [Accessor](../concept/data-accessor.md)
-  - As a step name within the scenario, specifies the data to be broadcast.
-- Tag
+- tag
   - When broadcasting data, it is necessary to attach a tag.
   - When subscribers subscribe to data, they can receive only broadcasts with the specified tag.
+  - **Dynamic Support**: Supports dynamic substitution using the following patterns:
+    - `#{user.id}_status` - Using #{...} pattern
+    - `${user.role}_prefs` - Using ${...} pattern
+    - `{{domain.name}}_data` - Using {{...}} pattern
+    - `static_name` - Static name (no substitution)
+
+## Usage Examples
+
+### Static Usage
+
+```json
+{
+  "task": "publish",
+  "params": {
+    "tag": "machine"
+  }
+}
+```
+
+### Dynamic Usage
+
+```json
+{
+  "task": "publish",
+  "params": {
+    "tag": "#{machine.code}"
+  }
+}
+```
+
+### Mixed Usage
+
+```json
+{
+  "task": "publish",
+  "params": {
+    "tag": "#{machine.code}_${sensor.code}"
+  }
+}
+```

package/helps/integration/task/publish.ms.md

@@ -7,10 +7,48 @@ Cara untuk meminta langganan data dalam aplikasi klien termasuk:
 - Ini dapat diminta melalui Board UI melalui subscriber.
 - Permintaan langganan dapat dilakukan melalui wss://[server host:port]/subscription API.
 
-## Parameter
+## parameter
 
-- [Aksesori](../concept/data-accessor.md)
-  - Sebagai nama langkah dalam skenario, menentukan data yang akan disiarkan.
-- Tag
+- tag
   - Ketika menyiarkan data, perlu melampirkan tag.
   - Ketika subscriber berlangganan data, mereka hanya dapat menerima siaran dengan tag yang ditentukan.
+  - **Sokongan Dinamik**: Menyokong penggantian dinamik menggunakan corak:
+    - `#{user.id}_status` - Menggunakan corak #{...}
+    - `${user.role}_prefs` - Menggunakan corak ${...}
+    - `{{domain.name}}_data` - Menggunakan corak {{...}}
+    - `static_name` - Nama statik (tiada penggantian)
+
+## Contoh Penggunaan
+
+### Penggunaan Statik
+
+```json
+{
+  "task": "publish",
+  "params": {
+    "tag": "machine"
+  }
+}
+```
+
+### Penggunaan Dinamik
+
+```json
+{
+  "task": "publish",
+  "params": {
+    "tag": "#{machine.code}"
+  }
+}
+```
+
+### Penggunaan Campuran
+
+```json
+{
+  "task": "publish",
+  "params": {
+    "tag": "#{machine.code}_${sensor.code}"
+  }
+}
+```

package/helps/integration/task/publish.zh.md

@@ -4,13 +4,54 @@
 
 客户端应用程序请求数据订阅的方式包括：
 
-- 可以通过Board UI通过订阅者请求。
+- 可以通过Board UI通过subscriber请求。
 - 可以通过wss://[server host:port]/subscription API进行订阅请求。
 
 ## 参数
 
+- tag
+  - 广播数据时，需要附加标签。
+  - 当订阅者订阅数据时，他们只能接收带有指定标签的广播。
+  - **动态支持**: 支持使用以下模式的动态替换:
+    - `#{user.id}_status` - 使用 #{...} 模式
+    - `${user.role}_prefs` - 使用 ${...} 模式
+    - `{{domain.name}}_data` - 使用 {{...}} 模式
+    - `static_name` - 静态名称 (无替换)
+
+## 使用示例
+
+### 静态使用
+
+```json
+{
+  "task": "publish",
+  "params": {
+    "tag": "machine"
+  }
+}
+```
+
+### 动态使用
+
+```json
+{
+  "task": "publish",
+  "params": {
+    "tag": "#{machine.code}"
+  }
+}
+```
+
+### 混合使用
+
+```json
+{
+  "task": "publish",
+  "params": {
+    "tag": "#{machine.code}_${sensor.code}"
+  }
+}
+```
+
 - [存取器](../concept/data-accessor.md)
   - 作为场景中的步骤名称，指定要广播的数据。
-- 标签
-  - 在广播数据时，需要附加标签。
-  - 当订阅者订阅数据时，他们只能接收具有指定标签的广播。

package/helps/integration/task/state-read.ja.md

@@ -1,8 +1,48 @@
 # state-read
 
-[状態登録簿(state-register)](../concept/state-register.md)で定義されている状態の値を読み取るタスクです。
+[状態登録簿(state-register)](../concept/state-register.md)に定義された一つの状態から値を読み取るタスクです。
 
 ## パラメーター
 
 - 名前
-  - 取得する状態の「名前」を指定します
+  - 読み取りたい対象状態の「名前」を指定します
+  - **動的サポート**: 以下のパターンを使用した動的置換をサポートします:
+    - `#{user.id}_status` - #{...} パターン使用
+    - `${user.role}_prefs` - ${...} パターン使用
+    - `{{domain.name}}_data` - {{...}} パターン使用
+    - `static_name` - 静的名前 (置換なし)
+
+## 使用例
+
+### 静的使用
+
+```json
+{
+  "task": "state-read",
+  "params": {
+    "name": "machine-10"
+  }
+}
+```
+
+### 動的使用
+
+```json
+{
+  "task": "state-read",
+  "params": {
+    "name": "#{machine.code}"
+  }
+}
+```
+
+### 混合使用
+
+```json
+{
+  "task": "state-read",
+  "params": {
+    "name": "#{machine.code}_${sensor.code}"
+  }
+}
+```

package/helps/integration/task/state-read.ko.md

@@ -1,8 +1,48 @@
 # state-read
 
-[상태등록부(state-register)](../concept/state-register.md)에 정의된 하나의 상태의 값을 읽어오는 태스크이다.
+[상태등록부(state-register)](../concept/state-register.md)에 정의된 하나의 상태에 값을 읽는 태스크이다.
 
 ## parameters
 
 - name
-  - 가져올 상태 "이름"을 지정한다
+  - 읽고자 하는 대상 상태 "이름"을 지정한다
+  - **동적 지원**: 다음 패턴을 사용한 동적 치환을 지원합니다:
+    - `#{user.id}_status` - #{...} 패턴 사용
+    - `${user.role}_prefs` - ${...} 패턴 사용
+    - `{{domain.name}}_data` - {{...}} 패턴 사용
+    - `static_name` - 정적 이름 (치환 없음)
+
+## 사용 예시
+
+### 정적 사용
+
+```json
+{
+  "task": "state-read",
+  "params": {
+    "name": "machine-10"
+  }
+}
+```
+
+### 동적 사용
+
+```json
+{
+  "task": "state-read",
+  "params": {
+    "name": "#{machine.code}"
+  }
+}
+```
+
+### 혼합 사용
+
+```json
+{
+  "task": "state-read",
+  "params": {
+    "name": "#{machine.code}_${sensor.code}"
+  }
+}
+```

package/helps/integration/task/state-read.md

@@ -1,8 +1,48 @@
 # state-read
 
-[State Register](../concept/state-register.md) defines a task to read the value of a state.
+[State Register](../concept/state-register.md) defines a task to read values from one state.
 
 ## parameters
 
 - name
-  - Specifies the "name" of the state to be retrieved
+  - Specifies the "name" of the target state to be read
+  - **Dynamic Support**: Supports dynamic substitution using the following patterns:
+    - `#{user.id}_status` - Using #{...} pattern
+    - `${user.role}_prefs` - Using ${...} pattern
+    - `{{domain.name}}_data` - Using {{...}} pattern
+    - `static_name` - Static name (no substitution)
+
+## Usage Examples
+
+### Static Usage
+
+```json
+{
+  "task": "state-read",
+  "params": {
+    "name": "machine-10"
+  }
+}
+```
+
+### Dynamic Usage
+
+```json
+{
+  "task": "state-read",
+  "params": {
+    "name": "#{machine.code}"
+  }
+}
+```
+
+### Mixed Usage
+
+```json
+{
+  "task": "state-read",
+  "params": {
+    "name": "#{machine.code}_${sensor.code}"
+  }
+}
+```

package/helps/integration/task/state-read.ms.md

@@ -1,8 +1,48 @@
 # state-read
 
-[Daftar keadaan(state-register)](../concept/state-register.md) mendefinisikan tugas untuk membaca nilai suatu keadaan.
+[Daftar keadaan(state-register)](../concept/state-register.md) mendefinisikan tugas untuk membaca nilai dari satu keadaan.
 
 ## parameter
 
 - nama
-  - Menentukan "nama" keadaan yang hendak diambil
+  - Menentukan "nama" keadaan sasaran yang ingin dibaca
+  - **Sokongan Dinamik**: Menyokong penggantian dinamik menggunakan corak:
+    - `#{user.id}_status` - Menggunakan corak #{...}
+    - `${user.role}_prefs` - Menggunakan corak ${...}
+    - `{{domain.name}}_data` - Menggunakan corak {{...}}
+    - `static_name` - Nama statik (tiada penggantian)
+
+## Contoh Penggunaan
+
+### Penggunaan Statik
+
+```json
+{
+  "task": "state-read",
+  "params": {
+    "name": "machine-10"
+  }
+}
+```
+
+### Penggunaan Dinamik
+
+```json
+{
+  "task": "state-read",
+  "params": {
+    "name": "#{machine.code}"
+  }
+}
+```
+
+### Penggunaan Campuran
+
+```json
+{
+  "task": "state-read",
+  "params": {
+    "name": "#{machine.code}_${sensor.code}"
+  }
+}
+```

package/helps/integration/task/state-read.zh.md

@@ -1,8 +1,48 @@
 # state-read
 
-[状态登记册(state-register)](../concept/state-register.md)中定义了一个状态值的读取任务。
+[状态登记册(state-register)](../concept/state-register.md)中定义了从一个状态读取值的任务。
 
 ## 参数
 
 - 名称
-  - 指定要获取的状态的“名称”
+  - 指定要读取的目标状态的"名称"
+  - **动态支持**: 支持使用以下模式的动态替换:
+    - `#{user.id}_status` - 使用 #{...} 模式
+    - `${user.role}_prefs` - 使用 ${...} 模式
+    - `{{domain.name}}_data` - 使用 {{...}} 模式
+    - `static_name` - 静态名称 (无替换)
+
+## 使用示例
+
+### 静态使用
+
+```json
+{
+  "task": "state-read",
+  "params": {
+    "name": "machine-10"
+  }
+}
+```
+
+### 动态使用
+
+```json
+{
+  "task": "state-read",
+  "params": {
+    "name": "#{machine.code}"
+  }
+}
+```
+
+### 混合使用
+
+```json
+{
+  "task": "state-read",
+  "params": {
+    "name": "#{machine.code}_${sensor.code}"
+  }
+}
+```

package/helps/integration/task/state-write.ja.md

@@ -8,5 +8,48 @@
 
 - 名前
   - 書き込みたい対象状態の「名前」を指定します
+  - **動的サポート**: 以下のパターンを使用した動的置換をサポートします:
+    - `#{user.id}_status` - #{...} パターン使用
+    - `${user.role}_prefs` - ${...} パターン使用
+    - `{{domain.name}}_data` - {{...}} パターン使用
+    - `static_name` - 静的名前 (置換なし)
 - [アクセサ](../concept/data-accessor.md)
   - シナリオ内のステップ名で、書き込みたいデータを指定します。
+
+## 使用例
+
+### 静的使用
+
+```json
+{
+  "task": "state-write",
+  "params": {
+    "name": "user_status",
+    "accessor": "machine-10"
+  }
+}
+```
+
+### 動的使用
+
+```json
+{
+  "task": "state-write",
+  "params": {
+    "name": "#{machine.code}",
+    "accessor": "result.status"
+  }
+}
+```
+
+### 混合使用
+
+```json
+{
+  "task": "state-write",
+  "params": {
+    "name": "#{machine.code}_${sensor.code}",
+    "accessor": "user.preferences"
+  }
+}
+```

package/helps/integration/task/state-write.ko.md

@@ -8,5 +8,48 @@
 
 - name
   - 쓰고자 하는 대상 상태 "이름"을 지정한다
+  - **동적 지원**: 다음 패턴을 사용한 동적 치환을 지원합니다:
+    - `#{user.id}_status` - #{...} 패턴 사용
+    - `${user.role}_prefs` - ${...} 패턴 사용
+    - `{{domain.name}}_data` - {{...}} 패턴 사용
+    - `static_name` - 정적 이름 (치환 없음)
 - [accessor](../concept/data-accessor.md)
   - 시나리오 내의 하나의 스텝이름으로, 쓰고자 하는 데이타를 지정한다.
+
+## 사용 예시
+
+### 정적 사용
+
+```json
+{
+  "task": "state-write",
+  "params": {
+    "name": "user_status",
+    "accessor": "machine-10"
+  }
+}
+```
+
+### 동적 사용
+
+```json
+{
+  "task": "state-write",
+  "params": {
+    "name": "#{machine.code}",
+    "accessor": "result.status"
+  }
+}
+```
+
+### 혼합 사용
+
+```json
+{
+  "task": "state-write",
+  "params": {
+    "name": "#{machine.code}_${sensor.code}",
+    "accessor": "user.preferences"
+  }
+}
+```

package/helps/integration/task/state-write.md

@@ -1,12 +1,55 @@
 # state-write
 
-[State Register](../concept/state-register.md) defines a task for writing a value to a state.
+[State Register](../concept/state-register.md) defines a task to write values to one state.
 
-> ⚠️ If the StateRegister with the specified name has autoPublish enabled, writing a value will automatically trigger a data publish event.
+> ⚠️ If autoPublish is set to true in the StateRegister with the specified name, data publish will automatically occur when writing values.
 
 ## parameters
 
 - name
   - Specifies the "name" of the target state to be written
+  - **Dynamic Support**: Supports dynamic substitution using the following patterns:
+    - `#{user.id}_status` - Using #{...} pattern
+    - `${user.role}_prefs` - Using ${...} pattern
+    - `{{domain.name}}_data` - Using {{...}} pattern
+    - `static_name` - Static name (no substitution)
 - [accessor](../concept/data-accessor.md)
-  - A step name within the scenario, specifying the data to be written.
+  - As a step name within the scenario, specifies the data to be written.
+
+## Usage Examples
+
+### Static Usage
+
+```json
+{
+  "task": "state-write",
+  "params": {
+    "name": "user_status",
+    "accessor": "machine-10"
+  }
+}
+```
+
+### Dynamic Usage
+
+```json
+{
+  "task": "state-write",
+  "params": {
+    "name": "#{machine.code}",
+    "accessor": "result.status"
+  }
+}
+```
+
+### Mixed Usage
+
+```json
+{
+  "task": "state-write",
+  "params": {
+    "name": "#{machine.code}_${sensor.code}",
+    "accessor": "user.preferences"
+  }
+}
+```