フロールーティング設定時のトラブル
ここでは、フロールーティング(APIのURL)の設定に関するトラブルと対処方法について説明します。
Q. フロールーティングを登録できない
A. フロールーティング(APIのURL)を登録できない場合は、以下の内容を確認してください。
- 設定したURLが、すでに登録されている他のフロールーティング定義と重複していないか。
- URLに使用できない文字が含まれていないか。
- フロールーティング定義に必要な項目が正しく設定されているか。
特に、設定したURLが、すでに登録されている他のフロールーティング定義と重複していないか確認してください。同じURLがすでに登録されている場合は、別のURLを設定してください。
- (1) 既存のフロールーティング定義を確認する:「IM-LogicDesigner ユーザ操作ガイド - 5.1.2. フロールーティングを確認する」
Q. フロールーティングを変更したい
A. フロールーティング(APIのURL)は、APIを識別するためのURLとして利用されるため、作成後に変更することはできません。URLを変更したい場合は、既存のフロールーティング定義を削除し、新しいフロールーティング定義を作成してください。また、画面のアクション設定で以下のアイテムを利用している場合は、新しいフロールーティング定義に合わせて設定内容を変更してください。
- 「URL〇にリクエストを送信する」
- 「IM-LogicDesigner フロールーティング○にリクエストを送信する」
画面のアクション設定以外にも、他のロジックフローから呼び出している場合は、影響範囲を確認した上で対応してください。
- (1) 既存のフロールーティング定義を削除する:「ローコード操作マニュアル - フロールーティング定義の削除 > フロールーティング定義を削除する」
- (2) 新しいフロールーティング定義を作成する:「3.5 登録処理のURL設定」
Q. フロールーティングを削除したい
A. フロールーティング定義だけでなく、ロジックフロー自体も削除する場合は、ロジックフローを削除してください。ロジックフローを削除すると、関連付けられているフロールーティング定義もあわせて削除されます。一方、フロールーティング(APIのURL)のみを削除したい場合は、「ロジックフロールーティング定義編集」画面から削除してください。
- (1) フロールーティング定義を削除する:「ローコード操作マニュアル - フロールーティング定義の削除 > 基本操作」
Q. APIのURLはどのような形式か知りたい
A. APIのURLは、次の形式で構成されます。
<SCHEME>://<HOST>(:<PORT>)/<CONTEXT_PATH>/logic/api/${route}フロールーティング定義では、
${route}にあたる部分を設定します。実際のAPIのURLは、設定したルートに対してスキーム(http/https)、ホスト名、ポート番号、コンテキストパスが付与されて生成されます。たとえば、
${route}にtmp_asset/registerを設定した場合、環境に応じて以下のようなURLが生成されます。https://example.com/imart/logic/api/tmp_asset/register各項目の詳細については、「ローコード操作マニュアル」を参照してください。
- (1) URLの形式を確認する:「ローコード操作マニュアル - フロールーティング設定(APIのURL) > フロールーティング定義情報の設定」
Q. HTTPメソッドの種類や用途について知りたい
A. HTTPメソッドは、APIに対するリクエストの種類を表します。APIの処理内容に合わせて選択します。
- GET:データの取得(例:一覧検索、詳細表示)
- POST:データの新規登録(例:登録処理)
- PUT:データの更新(例:更新処理)
- DELETE:データの削除(例:削除処理)
本チュートリアルでは、資産情報を新規登録するため、HTTPメソッドに「POST」を利用しています。各項目の詳細については、「ローコード操作マニュアル」を参照してください。
- (1) HTTPメソッドを確認する:「ローコード操作マニュアル - フロールーティング設定(APIのURL) > フロールーティング定義情報の設定」
Q. どの認証方法を選択すればよいか分からない
A. フロールーティングの認証方式は、利用するシステム環境や公開範囲に応じて選択します。
- IMAuthentication:intra-martが提供する標準の認証方式
- Basic:HTTP標準のシンプルな認証方式
本チュートリアルでは、「IMAuthentication」を利用します。各項目の詳細については、「ローコード操作マニュアル」を参照してください。
- (1) 認証方法を確認する:「ローコード操作マニュアル - フロールーティング設定(APIのURL) > 認証・認可方式とセキュリティ設定」
Q. フロールーティングを設定しても処理が実行されない
A. フロールーティング定義とロジックフローが正しく関連付けられているか、定義情報の対象フローを確認してください。また、フロールーティング定義に設定した認可によっては、URLにアクセスしても処理を実行できない場合があります。認可設定を確認し、必要な権限が付与されていることを確認してください。
- (1) フロールーティングの定義情報と認可設定を確認する:「ローコード操作マニュアル - フロールーティング定義の編集 > 基本操作」