# ルール
EMQXは強力かつ効率的な組み込みデータ処理機能であるルールエンジンを提供します。SQLライクな構文を活用することで、ユーザーはさまざまなソースからデータを簡単に抽出、変換、拡充できます。処理されたデータは、ルールによってトリガーされるアクション（組み込みアクションやSink/Sourceを含む）を通じて外部システムに配信または統合できます。また、処理済みデータをMQTTクライアントやデバイスに再パブリッシュすることも可能です。
ルールエンジンはEMQXのデータ統合機能の中核コンポーネントです。データ統合を活用した柔軟なビジネス統合ソリューションを提供し、ビジネス開発プロセスを簡素化し、ユーザーの利便性を向上させ、ビジネスシステムとEMQX間の結合度を低減します。詳細については[ルールエンジン](../data-integration/rules.md)をご覧ください。
ルールの作成および管理は、左メニューの**Integration** -> **Rules**をクリックして**Rules**ページにアクセスします。
## ルールの作成
ルールを作成するには、Rulesページの右上にある**Create**をクリックします。また、Connectorページの既存コネクターの**Action**列にある**Create Rule**をクリックして、ルールを素早く作成することも可能です。
### SQLエディター
Create RuleページにはSQLエディターがあり、SQL文を使ってルールロジックを定義できます。これにより、クライアントやシステム間で交換されるデータのリアルタイムな操作（クエリ、フィルタリング、変換、拡充）が可能です。
ルールを識別・整理するために、ルールIDと任意のノートを入力します。ルールIDは自動で一意に生成されますが、任意で指定することもできます。ノート欄にはルールの目的を明確にする簡単な説明を記入できます。
SQLエディター下の**SQL Examples**をクリックすると、右側に一般的なSQL例が表示されます。以下のSQL例を参考にして素早くルールを作成できます。
デフォルトのSQL文は `SELECT * FROM "t/#"` で、これはクライアントがトピック`t/#`にメッセージをパブリッシュした際に、ルールエンジンがそのイベント下のすべてのデータを取得することを意味します。
`SELECT`キーワードはメッセージ内のすべてのフィールドを取得できます。例えば、現在のメッセージの`Payload`だけを取得したい場合は、`SELECT payload from "t/#"`に変更します。データは[組み込み関数](../data-integration/rule-sql-builtin-functions.md)を使って処理・変換可能です。
`FROM`キーワードの後には1つ以上のデータソースが続きます。利用可能なイベントトピックを確認するには、SQLエディター下の**Try It Out**エリアでオプションのデータソースイベントを閲覧できます。`WHERE`キーワードを使うと条件付きフィルタリングを追加可能です。詳細なSQL構文の使い方は[SQL構文と例](./../data-integration/rule-sql-syntax.md)をご参照ください。
### Try It Out
SQL文が完成したら、ページ下部の**Try It Out**トグルスイッチをオンにして、このエリアでルールのテストを実行できます。
SQLテストでは、**Data Source**ドロップダウンからイベントまたはデータソースを選択し、シミュレーション用のテストデータを入力後、**Run Test**をクリックすると、右側の**Output Result**に実行結果が表示されます。
SQL文を変更するたびにSQLテストでルールの出力データを確認し、ルールの正確性を保証できます。
::: tip
SQL実行時に`412`エラーコードが表示された場合、テストデータとの不一致が原因の可能性があります。データソースがSQL文と一致しない場合、対応するイベントやデータソースの選択を促されます。更新されたデータソースイベントに応じてテストデータも自動で更新されます。
:::
シミュレーション用データソースは実際のシナリオと同様で、一部MQTTイベントを含みます。メッセージ部分では、以下の異なるメッセージイベントを選択してデータをシミュレートできます。
- メッセージパブリッシュ（mqtt topic）
- メッセージ配信済み（$events/message/delivered）
- メッセージアック済み（$events/message/acked）
- メッセージドロップ（$events/message/dropped）
その他のイベントでは、以下のクライアントおよびセッションイベントを選択してデータをシミュレート可能です。
- クライアント接続済み（$events/client/connected）
- クライアント切断済み（$events/client/disconnected）
- クライアントconnack（$events/client/connack）
- クライアント認可チェック完了（$events/auth/check_authz_complete）
- クライアント認証チェック完了（$events/auth/check_authn_complete）
- サブスクライブ済み（$events/session/subscribed）
- サブスクライブ解除済み（$events/session/unsubscribed）
対応するデータソースはSQLエディター内のSQL文と一致している必要があります。メッセージイベントを使ってデータを取得する場合は、`FROM`キーワードの後に対応するイベントトピック（括弧内の内容）をSQL文に記入してください。ルールは複数イベントの利用もサポートします。データソースやイベントの詳細については[SQLデータソースとフィールド](../data-integration/rule-sql-events-and-fields.md)をご覧ください。
テストエリアでルールをテストすることも可能です。詳細なテスト手順は[Test Rule](../data-integration/rule-get-started.md#test-rule)をご参照ください。
### アクション出力
SQL文の編集とルールのデバッグが完了し、要件を満たす出力データが得られたら、ページ右側の**Action Outputs**タブでルールトリガー後に実行するアクションを選択できます。**Add Action**ボタンをクリックすると、2つの組み込みアクションおよび各種Sink/Sourceからアクションタイプを選択し、ルールの出力データをさらに処理できます。アクション作成の詳細は[アクションの追加](../data-integration/rule-get-started.md#add-action)をご覧ください。
## ルールの閲覧
ルール作成後は、ルール一覧でルールの基本情報を確認できます。ルールID、ルールがアクセスするデータのソース（イベント、トピック、データブリッジなど）、ルールノート、有効状態、作成日時が表示されます。ルールは設定、削除、有効化、無効化などの操作が可能です。また、ルールの複製と修正もアクションバーから行え、ルールの再利用性を高められます。
一覧上部には検索バーがあり、ルールID、トピック、有効状態、ノートを複数条件で検索できます。これにより条件に合うルールを素早く見つけて閲覧・設定できます。なお、ルールIDとノートはあいまい検索、トピックはワイルドカード検索に対応しています。
## ルール実行統計
ルール一覧ページでルールIDをクリックすると、ルール概要ページに素早く遷移します。ルール概要ページにはルールの基本的なデータ統計が含まれ、ルールの実行統計や当該ルール下のアクション実行統計が表示されます。例えば、マッチ数、通過数、失敗数、ルールの実行率、アクションの成功・失敗実行数などです。右上の`Refresh`ボタンをクリックすると、現在のルールのリアルタイム実行データ統計を確認できます。
## 設定
ルール一覧の**Action**列にある**Settings**タブまたは**Settings**ボタンをクリックすると設定ページに入れます。このページはルール作成ページと同様の基本情報を表示し、ルールの修正やデバッグが可能です。例えば、現在のルール下の実行アクションの変更、ルールノートの修正、SQL文の再編集などが行えます。
