Versions Compared

Old Version 16

changes.mady.by.user Kanako Higashi

Saved on

compared with

New Version 17

changes.mady.by.user Martin Trgiňa

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Sv translation
language en

Module summary

Sender module is used to read data from receiver and conditionally execute automated actions, usually to route the processed messages to the other systems.

Module lifecycle

Each sender module connected over the Service bus to exactly one Receiver module and follows this process:

  1. Periodically checks new data on Receiver
  2. Read normalized data from Receiver
  3. Evaluate action rules
  4. Trigger one or more automated actions
  5. Delete processed data from Receiver
Tip

See Sender configuration to learn more about all configuration options.

Action rules

Automated actions are executed, only if action rules are met or no rules are defined.

Currently, there is just one type of action rule - filter rule. Filter rule defines set of filter conditions, which are evaluated in a row. Filter rule consist of referrenced field name, operation type (e.g. EQ, GT, NOT_NULL, etc) and values.

Automated actions

There are several automated action type:

  • BellaDati REST API - send data to the BellaDati backend over REST API

  • HTTP request -send data to 3rd party systems using HTTP protocol

  • Email - Send email

  • Save to file - Save data to file

  • MQTT Publish - Publish MQTT messages to the MQTT server

  • Custom - provides custom action implementation

Roles

 This module supports following roles:

ModuleRolePermitted operations
ReceiverVIEWERGET /status

 

Module states

This module can have one of following statuses:

VerticleStatusDescription
ReceiverUPModule is up and running. It operates without any specific limitations.
PAUSEDModule is paused and not processing nor sending data. Request to "GET /" ends with response code 405.

 

API endpoints

This module provides following HTTP endpoints: 

PathMethodDescriptionURL ParametersExample
/GETReturns plain text with ECHO message (should be used in load balancer to detect UP/DOWN status) https://localhost:8101/
/statusGETReturns JSON object that contains internal state of sender https://localhost:8101/status
/configPOSTSets the configuration to the module. ADMIN role is required.
  • POST body content = config in JSON format
https://localhost:8101/config
/reloadPOSTForces reloading configuration of module. ADMIN role is required. https://localhost:8101/reload
/pauseGETSets status PAUSED for sender immediately. Returns response from "GET /status" endpoint (see above) https://localhost:8101/pause
/resumeGETSets status UP for sender immediately. Returns response from "GET /status" endpoint (see above) https://localhost:8101/resume
/logoutGETExecutes logout of currently logged in user https://localhost:8101/logout

On this page

Table of Contents

Sv translation
language ja

モジュールの概要

Senderモジュールは、Receiverからデータを読み取り、条件付きで自動アクションを実行するために使用されます。通常、処理されたメッセージを他のシステムにルーティングします。

モジュールのライフサイクル

各Senderモジュールは、サービスバスを介して1つのSenderモジュールに接続され、次のプロセスに従います:

  1. 定期的にReceiverの新しいデータをチェックします
  2. Receiverから正規化されたデータを読み取ります
  3. アクションルールを評価します
  4. 1つ以上の自動アクションをトリガーします
  5. Receiverから処理済みデータを削除します
Tip

すべての構成オプションについて詳しくは、 Sender configurationを参照してください。

アクションルール

自動アクションは、アクションルールが満たされているか、ルールが定義されていない場合にのみ実行されます。

現在、アクションルールにはフィルタールールの1種類しかありません。フィルタールールは、連続して評価される一連のフィルタ条件を定義します。フィルタルールは、参照されるフィールド名、操作タイプ (EQ、GT、NOT_NULLなど) と値で構成されます。

自動アクション

自動アクションのタイプにはいくつかあります:

  • BellaDati REST API - REST APIを介してBellaDatiバックエンドにデータを送信します

  • HTTP request - HTTPプロトコルを使用して3rdパーティシステムにデータを送信します

  • Email - メールを送ります

  • Save to file - データをファイルに保存します

  • MQTT Publish - MQTTメッセージをMQTTサーバーに発行します

  • Custom - カスタムアクションの実装を提供します

ロール

このモジュールは次の役割をサポートします:

ModuleRole許可された操作
ReceiverVIEWERGET /status

 

モジュールのステータス

このモジュールは、次のいずれかのステータスになります:

VerticleStatus説明
ReceiverUPModule is up and running. It operates without any specific limitations.
PAUSEDModule is paused and not processing nor sending data. Request to "GET /" ends with response code 405.

 

APIエンドポイント

このモジュールは、次のHTTPエンドポイントを提供します:

PathMethod説明URL パラメーター例
/GETReturns plain text with ECHO message (should be used in load balancer to detect UP/DOWN status)
https://localhost:8101/
/statusGETReturns JSON object that contains internal state of sender
https://localhost:8101/status
/configPOSTSets the configuration to the module. ADMIN role is required.
  • POST body content = config in JSON format
https://localhost:8101/config
/reloadPOSTForces reloading configuration of module. ADMIN role is required.
https://localhost:8101/reload
/pauseGETSets status PAUSED for sender immediately. Returns response from "GET /status" endpoint (see above)
https://localhost:8101/pause
/resumeGETSets status UP for sender immediately. Returns response from "GET /status" endpoint (see above)
https://localhost:8101/resume
/logoutGETExecutes logout of currently logged in user
https://localhost:8101/logout


このページでは

Table of Contents