4.19. ルーティングの作成¶

4.19.3.1. ルーティングのクエリ設定¶

1. ルーティング情報の対象クエリの「検索」アイコンをクリックすると、「クエリ検索」画面が表示されます。

   

   図：「クエリ検索」画面

   項目名	説明
   クエリ名検索	一覧に表示するクエリを、クエリ名で絞り込めます。
   決定	設定するクエリを決定します。 一覧でクエリが選択されていない場合は、クリックできません。

   コラム

   クエリ一覧のページ毎の表示件数の選択候補は、設定ファイルの「query-list-settingsタグ」で設定できます。

   設定方法については「intra-mart Accel Platform 設定ファイルリファレンス」の「クエリ一覧のリスト設定」を参照してください。

2. クエリを選択して「決定」をクリックすることで、ルーティング定義一覧画面のルーティング情報に反映されます。

   

   図：「クエリ検索」画面 - クエリ選択

4.19.3.2. ルーティングの認証方式¶

ルーティングの認証方式により、認証処理を行います。認証方式は以下が存在します。

• IMAuthentication
• OAuth
• Basic

GET /<resource_path> HTTP/1.1
Host: localhost
Authorization: Bearer <access_token>

4.19.3.3. ルーティングの OAuth スコープ設定¶

1. ルーティング情報の OAuth スコープの「検索」アイコンをクリックすると、「スコープ検索」画面が表示されます。

   

   図：ルーティング情報 - OAuth スコープ

   

   図：「スコープ検索」画面

2. OAuth スコープを選択して「決定」をクリックすることで、ルーティング定義一覧画面のルーティング情報に反映されます。

   

   図：「スコープ検索」画面 - スコープ選択

4.19.3.4. ルーティングの認可設定¶

1. 認可設定をするルーティングをルーティングツリーから選択します。

2. 「認可URI」の「認可設定」アイコンをクリックします。

   

   図：「認可URI」 - 「認可設定」アイコン

3. 「認可設定」画面が表示されます。

   

   図：「認可設定」画面

4. 認可設定を行います。認可の設定方法は「intra-mart Accel Platform 認可仕様書」の「認可設定画面」を参照してください。

   注意

   認可処理を行う権限を持たないユーザが「認可」アイコンをクリックした場合、警告メッセージが表示されます。

   メッセージが表示された場合、操作したユーザに対して適切な権限が付与されているか確認してください。

4.19.3.5. ルーティングの実行確認¶

• ルーティング定義一覧画面では、ルーティング定義をもとに、OpenAPI上で対象のルーティングを実行するためのページへのリンクを提供します。

  

  図：「ルーティング定義一覧」画面 - OpenAPIを開く

  

  図：OpenAPI REST APIビューア

  

  図：REST API実行 - クエリのメタ情報取得

  

  図：REST API実行 - クエリの実行結果取得

4.19.4.1. セッション管理¶

• セッション管理

4.19.4.2. リクエストパラメータ¶

4.19.4.3. レスポンスヘッダ¶

4.19.4.4. レスポンスボディ¶

• JSONに変換して返却

  
  

  レスポンスボディにはJSON形式のデータが格納されます。

  {
    "data": [
      {
        "fieldName1": "field1Value1",
        "fieldName2": "field2Value1",
        "fieldName3": "field3Value1"
      },
      {
        "fieldName1": "field1Value2",
        "fieldName2": "field2Value2",
        "fieldName3": "field3Value2"
      }
    ],
    "totalCount": 2
  }
  

  data	実行結果の一覧です。 レコードを表すオブジェクトの配列で構成されます。
  totalCount	実行結果の総件数です。 レスポンスヘッダに格納される x-jp-co-intra-mart-viewcreator-total-count パラメータと同じ値が格納されます。

• CSVとして返却

  
  

  レスポンスボディにはCSV形式のデータが格納されます。

  １行目にはCSVヘッダ、２行目以降はレコードデータが格納されます。

  fieldName1,fieldName2,fieldName3
  field1Value1,field2Value1,field3Value1
  field1Value2,field2Value2,field3Value2
  

  コラム

  CSV形式では、データがnull値の場合は空文字を出力します。

• メタ情報の返却

  
  

  クエリ定義のメタ情報を取得した場合は、レスポンスボディにJSON形式のメタ情報が格納されます。

  {
    "columns": [
      {
        "code": "string",
        "name": "string",
        "type": "STRING",
        "caption": "string"
      }
    ],
    "conditions": [
      {
        "key": "string",
        "type": "STRING"
      }
    ]
  }
  

  columns	クエリ定義に含まれるカラム情報の一覧です。 code ccd + 5桁の連番で採番された、クエリ定義内においてユニークなコードです。 name DDL上で定義されたフィールドの物理名です。 type カラムのデータ型です。 “STRING”, “NUMBER”, “DATE”, “TIMESTAMP”, “BOOLEAN”のいずれかが格納されます。 caption 「クエリ編集」画面で設定したキャプションです。
  conditions	クエリ定義に含まれるリクエストパラメータの動的抽出条件（<%REQUEST_PARAMETER(KEY_NAME)%>）の一覧です。 key パラメータ名（KEY_NAME）が格納されます。 type 抽出条件が設定されているカラムのデータ型です。 “STRING”, “NUMBER”, “DATE”, “TIMESTAMP”, “BOOLEAN”のいずれかが格納されます。

4.19.4.5. REST APIの仕様確認¶

4.19.5.1. 実行するクエリの作成¶

1. 「サイトマップ」→「ViewCreator」→「クエリ一覧」から、「クエリ一覧」画面を表示します。

2. 一覧の「日本のデータ」にチェックを付け、「クエリ一覧」画面上部の「コピー」をクリックします。

   

   図：「クエリ一覧」画面 - クエリのコピー

3. 一覧からコピーしたクエリ「コピー～日本のデータ」をクリックし、「クエリ編集」画面を表示します。

   

   図：「クエリ一覧」画面 - 「コピー～日本のデータ」

4. 「クエリ編集」画面下部の「カラム一覧」タブの「キャプション」を以下のように編集します。

   テーブル/ビュー/リソース	カラム/フィールド	キャプション
   sample_population	year	year
   sample_region	name	regionName
   sample_prefecture	name	prefectureName
   sample_age	age	age
   sample_prefecture_area	area	area
   sample_population	population	population

   

   図：「クエリ一覧」画面 - キャプション設定

5. 「クエリ編集」画面下部の「抽出条件一覧」タブをクリックします。
   

   図：「クエリ編集」画面 - 「抽出条件一覧」タブ

6. 「クエリ編集」画面のデザイナで「sample_population」テーブルの「year」フィールドをダブルクリックします（「抽出条件一覧」タブにカラムが追加されます）。
   

   図：「クエリ編集」画面 - 抽出条件追加

7. 追加した抽出条件を以下のとおりに設定します。
   • 抽出方法 : 「以上」
   • 条件値 : <%REQUEST_PARAMETER(minimumYearParameter)%>
   

   図：「クエリ編集」画面 - 抽出条件設定

8. 同様に、以下のとおりに抽出条件を追加します。
   • テーブル/ビュー/リソース : sample_population
   • カラム/フィールド : year
   • 抽出方法 : 「以下」
   • 条件値 : <%REQUEST_PARAMETER(maxYearParameter)%>
   
   
   • テーブル/ビュー/リソース : sample_region
   • カラム/フィールド : name
   • 抽出方法 : 「部分一致」
   • 条件値 : <%REQUEST_PARAMETER(regionNameParameter)%>
   

   図：「クエリ編集」画面 - 抽出条件追加設定

9. 「クエリ編集」画面上部の「保存」ボタンをクリックします。

10. 「確認」ダイアログでクエリ名を「query_issue_32032」に変更して「決定」をクリックします。

    

    図：「クエリ編集」画面 - クエリ保存

4.19.5.2. ルーティング定義の作成¶

1. 「サイトマップ」→「ViewCreator」→「ルーティング定義一覧」から、「ルーティング定義一覧」画面を表示します。

2. 追加先のルーティングカテゴリをルーティングツリーから選択し、「ルーティング定義一覧」画面左上の「ルーティング新規作成」をクリックします。

   ルーティングカテゴリ未作成の場合は、「ルーティングカテゴリの作成」の説明を参考にルーティングカテゴリを作成してください。
   

   図：「ルーティング定義一覧」画面 - 「ルーティング新規作成」

3. ルーティング情報の各項目を以下のとおりに設定します。

   • ルーティングID : routing_issue_32032
   • ルーティングURL : viewcreator/sample/routes/api/get
   • 対象クエリ : 「実行するクエリの作成」で作成したクエリ定義
   • メソッド : 「GET」
   • 認証方式 : 「IMAuthentication」
   • レスポンス種別 : 「JSONに変換して返却」
   • ルーティング名 : SampleRouting(issue32032)
   

   図：「ルーティング定義一覧」画面 - ルーティング情報の入力

4. 「登録」をクリックしてルーティング定義を登録します。

5. 「認可URI」の「認可設定」アイコンをクリックします。

   

   図：「認可URI」 - 「認可設定」アイコン

6. 「認可設定」画面で、作成したルーティングに対する認可設定を行います。

   本作成例では、対象者条件の「認証済みユーザ」に対して「認可」を設定します。
   

   図：「認可設定」画面 - 「認証済みユーザ」へ認可設定

4.19.5.3. 画面の作成¶

1. 「サイトマップ」→「BloomMaker」→「インポート」をクリックし、IM-BloomMakerのインポート機能を利用して完成サンプルをインポートします。

   コラム

   インポート手順については、「IM-BloomMaker ユーザ操作ガイド」の「定義ファイルをインポートする」を参照してください。
2. 完成サンプルに含まれる以下のルーティング定義に対して、「ルーティング定義の作成」の認可設定と同じく「認証済みユーザ」の「認可」を設定します。
   • ルーティングID : routing_issue_32032
   • ルーティング名 : ViewCreator SampleRouting(issue32032)

   コラム

   ルーティング定義の認可設定については、「IM-BloomMaker チュートリアルガイド」の「ルーティングの認可を設定する」を参照してください。

   注意

   ViewCreatorのルーティング定義とIM-BloomMakerのルーティング定義の認可対象を揃えてください。

   認可にずれがある場合、ユーザによっては画面の表示のみ可能（クエリの実行が不可能）な状態が発生する可能性があります。

3. 認証済みユーザで「http://localhost:8080/imart/viewcreator/sample/routes/view/list」にアクセスし、本作成例のアプリケーション画面が表示されることを確認します。

   コラム

   ベースURLである以下の部分は環境に合わせて適宜変更してください。

   http://localhost:8080/imart