アクション設定でビジネスロジックと連携したい 

この記事では、IM-BloomMakerのアクション設定から、IM-LogicDesignerで作成したビジネスロジックと連携する方法について紹介します。

IM-BloomMakerでは、エレメントにアクションを設定することで、IM-LogicDesignerで作成したビジネスロジックを呼び出せます。たとえば、画面から入力したデータを登録したり、データベースから取得したデータを画面に表示したりできます。

画面とビジネスロジックを連携するには、IM-BloomMaker(クライアントサイド)とIM-LogicDesigner(サーバーサイド)のそれぞれで設定が必要です。この記事では、両者の設定内容とデータの受け渡しについて、具体的な操作を確認していきます。

ビジネスロジックを呼び出すアクション

IM-BloomMakerには、REST APIを利用してIM-LogicDesignerで作成したビジネスロジックを呼び出すためのアクションが用意されています。

  • 「IM-LogicDesigner フロールーティング〇にリクエストを送信する」
  • 「URL〇にリクエストを送信する」

「IM-LogicDesigner フロールーティング〇にリクエストを送信する」は、IM-LogicDesignerで作成したロジックフローを呼び出すためのアクションです。「URL〇にリクエストを送信する」は、IM-LogicDesignerのロジックフローだけでなく、Web API Makerで作成したAPIや外部APIなど、任意のURLにリクエストを送信できます。

ここでは、それぞれのアクションの特徴と、クライアントサイド・サーバーサイドで必要な設定について説明します。

「IM-LogicDesigner フロールーティング〇にリクエストを送信する」

「IM-LogicDesigner フロールーティング〇にリクエストを送信する」は、IM-LogicDesignerで作成したロジックフローを呼び出すためのアクションです。[アクション]タブでは、[IM-LogicDesigner]部品に含まれています。

IM-LogicDesigner側(サーバーサイド)では、呼び出したいロジックフローにフロールーティング定義情報を設定します。フロールーティング定義情報には、ルーティングやHTTPメソッド、認可URIなどを設定します。HTTPメソッドには、GET・POST・PUT・DELETEなどを指定できます。使用するHTTPメソッドは、ロジックフローで行う処理に合わせて設定します。

IM-BloomMaker側(クライアントサイド)では、「IM-LogicDesigner フロールーティング〇にリクエストを送信する」アクションを配置し、呼び出したいロジックフローのルーティングを指定します。フロールーティング定義でHTTPメソッドを設定しているため、IM-BloomMaker側ではHTTPメソッドを設定する必要はありません。また、ロジックフローに渡すデータや、ロジックフローから受け取るデータがある場合は、それぞれ変数を設定します。

「URL〇にリクエストを送信する」

「URL〇にリクエストを送信する」は、指定したURLにREST APIのリクエストを送信するための汎用的なアクションです。[アクション]タブでは、[標準]部品に含まれています。

サーバーサイドでは、IM-LogicDesignerで作成したロジックフローだけでなく、Web API Makerで作成したAPIや外部APIなどにも利用できます。

クライアントサイドでは、IM-BloomMakerで「URL〇にリクエストを送信する」というアクションを配置し、リクエストを送信するURL、HTTPメソッド、リクエストに渡すデータ、レスポンスを格納する変数などを設定します。HTTPメソッドには、GET・POST・PUT・DELETE・HEADを指定できます。指定できるHTTPメソッドや必要なパラメータは、呼び出すAPIの仕様に合わせて設定してください。

IM-LogicDesignerで作成したロジックフローを呼び出す場合も、「URL〇にリクエストを送信する」を利用できます。ただし、「IM-LogicDesigner フロールーティング〇にリクエストを送信する」を使用すれば、フロールーティングを選択するだけで呼び出し先を指定できるため、設定を簡略化できます。

画面とビジネスロジックの連携方法(操作手順)

ここでは、「IM-LogicDesigner フロールーティング〇にリクエストを送信する」というアクションを使用して、IM-BloomMakerで作成した画面とIM-LogicDesignerで作成したビジネスロジックを連携する方法について説明します。

  IM-LogicDesignerの操作

IM-LogicDesignerで作成したロジックフローをREST APIから呼び出せるようにするため、フロールーティング定義情報を設定します。フロールーティング定義情報を設定した後、アプリケーションの利用者がビジネスロジックを実行できるように認可設定を行います。

ビジネスロジックの作成と入出力値の設定

画面と連携させるビジネスロジックを準備します。新規にロジックフローを作成する場合だけでなく、既存のロジックフローを使用する場合も連携できます。入出力値は、IM-BloomMaker側の変数設定と対応するため、この段階でデータ構造を整理しておくことをおすすめします。

フロールーティング定義情報を設定する

作成したロジックフローをREST APIから呼び出せるようにするため、フロールーティング定義情報を設定します。フロールーティング定義情報では、ルーティング、HTTPメソッド、ルーティングの認証方法、認可URI、レスポンスなどを設定します。

設定するHTTPメソッドや認証方法によっては、IM-BloomMaker側でリクエストパラメータなどを適切に設定する必要があります。呼び出し元となる画面側の設定も考慮して、フロールーティングを設定しましょう。

フロールーティングの認可設定を行う

ビジネスロジックを画面から実行できるようにするため、フロールーティングの認可設定を行います。フロールーティングの認可設定では、ルーティング定義情報に登録したURLに対するアクセス権限を設定します。アプリケーションの利用者に必要な権限が付与されていることを確認してください。

❑ 操作に関連した資料


上記で説明したフロールーティング定義情報の設定について、詳しくはローコード操作マニュアルまたはIM-LogicDesigner仕様書で確認できます。ローコード操作マニュアルで設定手順を確認し、仕様書で各設定項目や動作仕様を確認すると、フロールーティングの仕組みをより理解しやすくなります。

IM-BloomMakerの操作

IM-BloomMakerでアプリケーション画面を作成し、IM-LogicDesignerでフロールーティングを設定したビジネスロジックとデータを受け渡すため、変数とアクションを設定します。

基本情報を設定し、画面コンテンツを作成する

ビジネスロジックと連携する画面コンテンツを準備します。新規に画面を作成する場合だけでなく、既存の画面を使用する場合も連携できます。

REST APIに関する変数を設定する

アプリケーション画面からREST APIを通してビジネスロジックを呼び出す場合は、リクエストやレスポンスで受け渡すデータに対応する変数を設定します。IM-BloomMaker側の変数は、IM-LogicDesigner側の入力値・出力値とデータ構造を合わせて設定することが重要です。データ型や配列の次元数などが一致していない場合、意図したデータを受け渡せないことがあります。

リクエスト送信時のデータを変数として設定する

クライアントサイドからリクエストを送信するときに使用する変数を設定します。IM-BloomMakerの変数は、IM-LogicDesignerの入力値と同じデータ構造にします。データ型や配列の次元数などを揃えておくことで、ロジックフローに必要なデータを正しく渡すことができます。

レスポンス返却時のデータを変数として設定する

ロジックフローから返却されたデータを格納する変数を設定します。IM-BloomMakerの変数は、IM-LogicDesignerの出力値と同じデータ構造にします。データ型や配列の次元数などを揃えておくことで、ロジックフローから返却されたデータを正しく受け取ることができます。

❑ 操作に関連した資料


上記で説明した変数の設定方法について、詳しくはローコード操作マニュアルで確認できます。IM-BloomMakerでは、JSONエディタを使用して複数の変数をまとめて設定することもできます。また、入力内容に応じてデータ型が自動的に変換される場合があるため、REST APIでデータを受け渡す場合は、意図したデータ型になっているか確認してください。

リクエスト送信に関するアクションを設定する

変数を準備したら、画面にアクションを設定します。ここでは、フロールーティング定義情報を設定したビジネスロジックと連携するため、「IM-LogicDesigner フロールーティング〇にリクエストを送信する」アクションを使用します。〇には、フロールーティング定義情報で設定したルーティングを指定します。

リクエスト送信時の変数を設定する

リクエストに含めるデータを、リクエストパラメータとして設定します。これにより、IM-BloomMakerからIM-LogicDesignerのロジックフローに入力データを渡せます。IM-BloomMakerの変数をIM-LogicDesignerの入力値と同じデータ構造にしているため、ロジックフローで必要なデータを受け取ることができます。

❑ 操作に関連した資料


上記で説明したIM-BloomMaker側の変数設定と、IM-LogicDesigner側で受け取る入力データの関係について、仕様書で確認できます。IM-BloomMakerとIM-LogicDesignerの両方の仕様を理解しておくことで、REST API実行時のエラー発生を防ぐことができます。

レスポンス返却時の変数を設定する

ロジックフローから返却されるデータを格納する変数を、レスポンスデータとして設定します。これにより、IM-LogicDesignerのロジックフローからIM-BloomMakerの画面へ出力データを渡せます。IM-BloomMakerの変数をIM-LogicDesignerの出力値と同じデータ構造にしているため、ロジックフローの実行結果を受け取ることができます。

❑ 操作に関連した資料


上記で説明したIM-BloomMaker側のレスポンスデータと、IM-LogicDesigner側から返却される出力データの関係について、仕様書で確認できます。IM-BloomMakerとIM-LogicDesignerの両方の仕様を理解しておくことで、REST API実行時のエラー発生を防ぐことができます。

画面とビジネスロジックの連携例

画面とビジネスロジックの基本的な連携方法を確認したところで、実際にアプリケーションを作成してみましょう。ここでは、「IM-LogicDesigner フロールーティング〇にリクエストを送信する」アクションを使用した連携例を紹介します。CookBookを参考に、IM-BloomMakerとIM-LogicDesignerの設定を一通り確認できます。

まとめ

IM-BloomMakerでは、エレメントにアクションを設定することで、intra-martのさまざまなツールや機能と連携できます。IM-LogicDesignerで作成したビジネスロジックと連携する場合は、フロールーティングの設定や認可設定に加えて、IM-BloomMaker側でリクエスト・レスポンスに使用する変数とアクションを設定します。特に、IM-BloomMakerの変数とIM-LogicDesignerの入出力値のデータ構造を合わせることが、REST APIでデータを受け渡す際の重要なポイントです。

画面側とビジネスロジック側のそれぞれの役割を理解し、必要な設定を順番に確認しながら、アプリケーションを作成してみましょう。

intra-martでは、IM-BloomMakerをもっと知っていただくために、マニュアルやコンテンツなどを豊富にご用意しています。IM-BloomMakerの機能を最大限に発揮させるためにも、ぜひご活用ください。