RabbitMQ のデータを帳票ツールbiz-Stream で連携利用する方法
biz-Stream は、多様な表現が可能なWeb 帳票ソリューションです。
この記事では、biz-Stream からCData JDBC ドライバ経由でRabbitMQ のデータにリアルタイムで連携接続して帳票から利用する方法を紹介します。CData Drivers を使うことで、RDB のようにbiz-Stream 内でRabbitMQ のデータを扱うことができるようになります。
biz-Stream へのRabbitMQ JDBC ドライバーの配置
デフォルトの内容でインストールした場合、以下のパスに jar ファイルが配置されますので、その jar ファイルを biz-Stream の所定のパスにコピーします。
- cdata.jdbc.api.jar
- cdata.jdbc.api.lic (試用版では.lic ファイルは不要)
- コピー元:C:\Program Files\CData\CData JDBC Driver for API 20xxJ\lib
- コピー先:C:\Program Files (x86)\brainsellers\biz-Stream レイアウト・デザイナ\lib_jdbc
biz-Stream からRabbitMQ への接続設定
レイアウトデザイナを起動後、リソース定義にて RabbitMQ への接続設定を行います。ドライバー選択のプルダウンに CData API JDBC Driver が表示されますので選択します。
RabbitMQ Management HTTP API について
RabbitMQ は、複数のメッセージングプロトコルをサポートするオープンソースのメッセージブローカーです。RabbitMQ Management HTTP API は、RabbitMQ サーバーの管理データと監視データに HTTP 経由でアクセスする手段を提供します。この API では、仮想ホスト、エクスチェンジ、キュー、バインディング、コネクション、チャネル、コンシューマー、ユーザー、権限、ポリシー、クラスター全体の統計情報を取得できます。
HTTP API を利用するには、RabbitMQ サーバーで Management プラグインを有効化する必要があります。デフォルトでは、管理インターフェースはポート 15672 でリッスンします。
Basic 認証の設定
RabbitMQ Management HTTP API は HTTP Basic 認証を使用します。RabbitMQ 管理ユーザーのユーザー名とパスワードを指定する必要があります。
管理 API へのアクセスを有効にするには、以下のステップで進めます:
- サーバーで RabbitMQ Management プラグインが有効になっていることを確認します(rabbitmq-plugins enable rabbitmq_management)。
- 既存の管理ユーザーを使用するか、適切な管理タグ(management、policymaker、monitoring、または administrator)を持つユーザーを作成します。
- RabbitMQ Management HTTP API の完全なベース URL を控えておきます(例:http://localhost:15672)。
RabbitMQ サーバーを設定したら、以下の接続プロパティを設定して接続します:
- AuthScheme:Basic に設定します。
- URL:RabbitMQ Management HTTP API のベース URL に設定します(例:http://localhost:15672)。
- User:RabbitMQ の管理ユーザー名に設定します(例:guest)。
- Password:RabbitMQ の管理パスワードに設定します。
接続文字列の例:
Profile=C:\profiles\RabbitMQ.apip;AuthScheme=Basic;URL=http://localhost:15672;User=guest;Password=guest;
利用可能なテーブル
RabbitMQ プロファイルでは、以下のテーブルにアクセスできます:
- Overview - クラスター全体の統計情報と RabbitMQ ノードに関する情報
- Nodes - RabbitMQ クラスター内の個々のノードに関する情報
- NodeMemory - 特定のクラスターノードの詳細なメモリ使用状況の内訳
- Connections - ブローカーへのすべてのオープンな AMQP コネクションの一覧
- Channels - すべてのコネクションにわたるオープンな AMQP チャネルの一覧
- Consumers - すべてのキューに登録されたコンシューマーの一覧
- Exchanges - すべての仮想ホストで宣言されたエクスチェンジの一覧
- Queues - すべての仮想ホストで宣言されたキューの一覧
- Bindings - エクスチェンジとキュー間のすべてのバインディングの一覧
- VirtualHosts - ブローカーに設定された仮想ホストの一覧
- VhostPermissions - 特定の仮想ホスト内のユーザー権限
- Users - すべての RabbitMQ ユーザーの一覧
- Permissions - すべての仮想ホストにわたる全ユーザーの権限レコード
- TopicPermissions - 全ユーザーのトピックレベルの権限レコード
- Policies - 仮想ホスト内のキューおよびエクスチェンジに適用されたポリシーの一覧
- OperatorPolicies - 仮想ホスト内のキューに適用されたオペレーターポリシーの一覧
- Parameters - 仮想ホストごとのコンポーネントパラメータ(例:federation、shovel)の一覧
- GlobalParameters - すべての仮想ホストに適用されるグローバルパラメータの一覧
- VhostLimits - 特定の仮想ホストに設定されたリソース制限
- UserLimits - 特定のユーザーに設定されたリソース制限
- FeatureFlags - フィーチャーフラグの一覧と、ノード上での有効/無効の状態
- DeprecatedFeatures - 非推奨機能の一覧と、その使用状態
- AuthAttempts - ノードの認証試行統計
- ClusterName - RabbitMQ クラスターの名前
- WhoAmI - 現在認証されている管理ユーザーに関する情報
- ExchangeBindingsSource - 特定のエクスチェンジがソースとなっているバインディング
- ExchangeBindingsDestination - 特定のエクスチェンジが宛先となっているバインディング
- QueueBindings - 仮想ホスト内の特定のキューのバインディング
サーバURLは以下の形式で入力します。
URL:
jdbc:api:Profile=C:\profiles\\RabbitMQ.apip;AuthScheme=Basic;URL=http://localhost:15672;User=guest;Password=guest;
JDBC Driver の接続文字列デザイナーを使う
JDBC 接続文字列を作るには、RabbitMQ JDBC Driver のビルトイン接続文字列デザイナーを使う方法があります。ドライバーの.jar ファイルをダブルクリックするか、コマンドラインから.jar ファイルを実行します。
Windows:
java -jar 'C:\Program Files\CData\CData JDBC Driver for API 20xxJ\lib\cdata.jdbc.api.jar'
MacOS:
java -jar cdata.jdbc.api.jar
接続プロパティに値を入力して、生成される接続文字列をクリップボードにコピーします。
次にデータ取得条件を設定します。SQL 定義から定義名を設定し、編集ボタンをクリックします。
上のグレーエリアで右クリック → テーブルリストと選択しますと、RabbitMQ のオブジェクトがリストで表示されます。使用するテーブルを選択します。
ここでは取得対象の項目や条件などを設定することができます。対象項目や条件を指定できたらOKボタンをクリックし、戻った画面で追加ボタンをクリックします。
最後にデータソース設定を行います。データソース定義名に先ほど設定したものを選択し、画面下部にある追加ボタンをクリックします。これでbiz-Stream でRabbitMQ のデータを利用する準備ができました。
RabbitMQ のデータをリアルタイムで参照するbiz-Stream 帳票のデザイン
用紙設定を行います。今回は A4 設定にしました。設定後は画面下部にある追加ボタンをクリックします。
ページ設定では新規ボタンをクリックします。
ここではレイアウトデザイナが帳票テンプレートを xml で保存しますので、ファイル名を設定します。
レイアウトにはさまざまなメニューがありますが、今回は表を使用します。表を設定後、RabbitMQ から取得したデータをセットするエリアを作成します。各セルにテキストボックスを挿入し、そのテキストボックス自体に RabbitMQ の項目を紐づけします。
※ヘッダーにもそれぞれテキストボックスを追加します。
レイアウト作成画面を閉じた後、ページ設定の画面に戻りますので、画面下部にある追加ボタン(一度作成している場合は適用)をクリックし、レイアウトの作成が完了となります。
レイアウトデザイナーのトップ画面のヘッダーメニューからプレビューアイコンをクリックします。先ほど作成したレイアウトで RabbitMQ のデータを表示させることができます。
このようにCData JDBC ドライバをアップロードすることで、簡単にbiz-Stream でRabbitMQ のデータをリアルタイムに参照する帳票をノーコードで連携して作成することができます。
ぜひ、CData JDBC Driver for API 30日の無償評価版 をダウンロードして、お試しください。