intra-mart Accel Platform Accel Studio テンプレートカタログ 第7版 2024-04-01

5.3.3. CSVエクスポート

このページでは「CSVエクスポート」テンプレートの概要、アプリケーションへの追加方法について解説します。

5.3.3.1. 「CSVエクスポート」テンプレートとは

../../../_images/csv_export.png
このテンプレートは、CSV形式のファイルでエクスポートする処理を提供します。
このテンプレートでは、IM-BloomMakerの資材は作成されません。
このテンプレートから作成された処理をIM-BloomMaker等の画面資材と組み合わせて、活用していただくことができます。

コラム

「CSVエクスポート」テンプレートは2022 Winter(Freesia)から利用可能です。

コラム

「CSVエクスポート」テンプレートから作成された処理は、単一のテーブルにのみ対応しています。

「CSVエクスポート」機能を追加した際のイメージは、以下の通りです。
../../../_images/csv_export_option_02.png

追加手順の詳細については、「チュートリアル」で紹介します。

5.3.3.2. チュートリアル

ここでは「マスタメンテナンス」テンプレートから作成されたアプリケーションへ「CSVエクスポート」機能を追加する手順について紹介します。

コラム

紹介した手順通りではなくても、「CSVエクスポート」機能を追加することは可能です。

5.3.3.2.1. 「CSVエクスポート」機能の追加手順

  1. 「既存アプリケーションの更新」画面への遷移
    「アプリケーション管理」画面の「テンプレートからリソースを追加する」をクリックします。
    ../../../_images/csv_export_option_03.png

    「業務テンプレート一覧」が表示されるので、「CSVエクスポート」テンプレートを選択します。
    ../../../_images/csv_export_option_04.png

  2. IDの決定に利用する文字列の設定
    「既存アプリケーションの更新」画面が表示されたら、「IDの決定に利用する文字列」を設定します。
    「IDの決定に利用する文字列」は、各処理やIDなどに利用されます。
    ../../../_images/csv_export_option_05.png

    コラム

    「既存アプリケーションの更新」画面では、既存アプリケーションの基本情報が自動入力されます。
    なお、アプリケーションIDとアプリケーション名は変更できません。

  3. 利用するデータベース種別とテーブルの名称の設定
    次に、利用するデータベース種別とテーブルの名称を設定します。
    なお、「CSVエクスポート」テンプレートでは、既存のテーブルを利用します。
    ../../../_images/csv_export_option_06.png

  4. 既存アプリケーションの更新
    アプリケーションの基本情報とテーブル情報を設定した後、「既存アプリケーションの更新」ボタンをクリックしてください。
    入力項目に不備が無ければ、自動で既存アプリケーションの更新が行われます。
    ../../../_images/csv_export_option_07.png

  5. 既存アプリケーションの更新結果
    アプリケーションの更新が完了すると、ステータスが「COMPLETE」と表示されます。
    ../../../_images/csv_export_option_08.png

5.3.3.2.2. IM-BloomMaker資材の編集

「CSVエクスポート」機能を追加するために、IM-BloomMaker資材の編集を行います。
「アプリケーション管理」画面の「【チュートリアル】 CSVエクスポート 一覧画面」を選択してください。
../../../_images/csv_export_option_09.png

注意

画像のアプリケーションは、「マスタメンテナンス」テンプレートのアプリケーション名に「【チュートリアル】 CSVエクスポート」と入力して作成されたアプリケーションの例です。

「デザイン編集」画面が表示されたら、以下の手順でコンテンツを編集します。

コラム

コンテンツの編集作業中は、編集した内容を保存するために、こまめに「デザイン編集」画面左上の「上書き保存」をクリックすることを推奨します。
  1. 新規アクションの追加
    1. Export CSV アクション
      アクション名には「Export CSV」と入力してください。
      「IM-LogicDesigner」から「IM-LogicDesigner フロールーティング○にリクエストを送信する」アクションアイテムを配置して、以下のように設定してください。
      項目 指定する値 備考
      ルーティング accel-studio-app/{IDの決定に利用する文字列}/export-csv 「CSVエクスポート処理」で検索してください。
      セキュアトークンを送信する チェックを入れない  
      ../../../_images/csv_export_option_11.png
      アクションアイテムの設定後、「決定」をクリックしてアクションを保存してください。

  2. コンテナページの追加
    新規にコンテナページを追加し、「フレックスコンテナ」のエレメント固有の「name」には「Button Area」と入力してください。
    ../../../_images/csv_export_option_12.png

  3. 既存エレメントのコピー
    コンテナ「Table Operation」の「フレックスコンテナ」を選択した状態で、「コピー」をクリックしてください。
    ../../../_images/csv_export_option_13.png

    その後、先ほど作成したコンテナ「Button Area」に、コピーしたエレメントを貼り付けてください。
    ../../../_images/csv_export_option_14.png

  4. コピーしたエレメントの編集
    右の「フレックスアイテム」内の「ボタン要素」のエレメント固有には以下を設定してください。
    プロパティ 指定する値 備考
    textContent CSV Export  
    leftIconClass 空欄 元々設定されていた「fas fa-plus」を削除してください。
    ../../../_images/csv_export_option_15.png

    「ボタン要素」のイベントの「クリック時」には先ほど作成した「Export CSV」を設定してください。
    ../../../_images/csv_export_option_16.png

    「ボタン」のイベントの「クリック時」に設定されている「Transition to Register Screen」アクションを「なし」に変更してください。
    ../../../_images/csv_export_option_17.png

  5. 追加したコンテナページの配置
    「パーツ」から「コンテナページ埋め込み」エレメントをコンテナ「Overall」に配置してください。
    「コンテナ埋め込みページ」のエレメント固有の「page」には、作成した「Button Area」を指定してください。
    ../../../_images/csv_export_option_18.png

  6. 編集内容の保存
    最後に編集内容の保存を行います。画面左上の「上書き保存」をクリックしてください。
    ../../../_images/csv_export_option_19.png

5.3.3.2.3. 「CSVエクスポート」機能の使用例

チュートリアルで追加した「CSVエクスポート」機能の使用例をご紹介します。

コラム

アプリケーションの認可設定については、「 Accel Studioのテンプレート 」を参照してください。

5.3.3.2.3.1. 一覧画面

「一覧画面」では、CSVファイルをエクスポートできます。
「CSV Export」ボタンをクリックすると、CSVファイルがダウンロードされます。
../../../_images/csv_export_option_20.png

5.3.3.3. 「CSVエクスポート」テンプレートから作成される資材

「CSVエクスポート」テンプレートは、 アプリケーション作成時に指定したテーブルのデータをCSVファイルとしてエクスポートする処理が作成されます。
処理はIM-LogicDesignerで作成されます。

5.3.3.3.1. CSVエクスポート処理

5.3.3.3.1.1. ルーティングURL

accel-studio-app/{IDの決定に利用する文字列}/export-csv

コラム

REST APIとして利用するためのURLについては、「 IM-LogicDesigner仕様書 」 - 「 ルート・HTTPメソッドに一致するフロールーティング情報の取得 」を参照してください。

5.3.3.3.1.2. メソッド

GET

5.3.3.3.1.3. 入力値

無し

5.3.3.3.1.4. 出力値

{
  "body": ""
}
変数名 説明
body binary エクスポートされるCSVファイルのデータです。

コラム

CSVエクスポート処理のレスポンス種別は「ファイルダウンロード」です。
レスポンス種別「ファイルダウンロード」の詳細は「 IM-LogicDesigner仕様書 」 - 「 ロジックフローの出力データの返却 ファイルダウンロード 」を参照してください。