IM-BIS for Accel Platform IM-BIS 仕様書 第12版 2019-08-01

16. 画面設計書出力

画面設計書出力の仕様を説明します。

16.1. 画面設計書出力の基本仕様

  1. 画面設計書出力の単位

    • 画面設計書は、フォーム単位に出力できます。

    • 1つのアプリケーション、またはフローに複数のフォーム(画面)がある場合、それぞれのフォーム(画面)単位に出力します。
      タブ切替や画面遷移を利用している場合、タブや画面単位に出力する必要があります。
  2. 画面設計書出力の対象

    • 画面設計書出力は、フォーム・デザイナで表示しているフォームのみを出力します。
      他のフォームを出力する場合、それぞれのフォームをフォーム・デザイナで表示後に画面設計書出力を実行する必要があります。
    • 画面設計書出力では、ストレージに保存されているフォーム情報に基づいて出力します。
      フォーム(画面)の編集中に出力した場合、最後に「更新」をクリックして保存した時点までの内容で画面設計書を出力します。
    • 出力対象のフォームに複数のロケール情報が設定されている場合、出力時にフォーム・デザイナのツールバーで選択中のロケールでの設定情報を画面設計書に出力します。
      ../../_images/bis_design_document_1.png

16.2. 画面設計書の出力ファイルに関する仕様

16.2.1. 出力されるファイルの形式・名称

  • 画面設計書出力で出力されるファイルの形式は XLSX 形式です。

  • 画面設計書出力で出力されるファイル名は、以下の内容で設定されます。

    bis_forma-form-%アプリケーションID%-%アプリケーション履歴番号%-%フォームID%.xlsx
    
    “bis_forma-form”は、固定値です。

16.2.2. 画面設計書のテンプレートファイル

  • 画面設計書のテンプレートファイルは、以下の場所に格納しています。

    %PUBLIC_STORAGE_PATH% / im_bis / document_template / form /
    
    • テンプレートファイルは、ロケール単位で以下の4種類を提供しています。
      • デフォルト(BIS_FormaDesigner.xlsx)
      • 日本語(BIS_FormaDesigner_ja.xlsx)
      • 英語(BIS_FormaDesigner_en.xlsx)
      • 中国語(中華人民共和国)(BIS_FormaDesigner_zh_CN.xlsx)
    • テンプレートファイルのロケールは、出力を行ったユーザのアカウントコンテキストのロケールに基づいて決定されます。
  • 画面設計書の出力内容は、テンプレートファイルに基づいて出力されます。

  • テンプレートファイルを変更した場合、変更後に出力したすべての画面設計書には変更内容が反映されます。

  • テンプレートファイルのヘッダやフッタ、表紙への画像追加等の変更は可能ですが、以下の注意事項があります。

    • シート名に「一覧」を含むすべてのシートに対して、列の追加・削除、位置変更(列の入替、ヘッダ列を下方にずらす)を行ってはいけません。
    • すべてのシートについて、設定値が挿入されるセルは固定となっているため、セル位置をずらすことはできません。
  • テンプレートファイルのプロパティ(作成者等の属性情報)、ヘッダ・フッタ・印刷レイアウトの設定は自由に行うことができます。

  • 製品標準提供のテンプレートは、以下の場所に保持していますので、製品標準に戻したい場合には、以下のファイルをテンプレートファイルに置換してください。

    %CONTEXT_PATH%/WEB-INF/storage/public/im_bis/document_template/form
    

16.2.3. 画面設計書の出力ファイルの構成

  • 画面設計書は、設定内容に基づいて以下のシートが出力されます。

    シート名 出力有無 補足
    表紙  
    フォーム概要  
    アイテム一覧  
    フィールド一覧  
    入力チェック一覧  
    ラベル一覧  
    詳細
    以下のいずれかのアイテムが配置されていない場合は出力されません。
    • 一覧選択(互換用含む)
    • チェックボックス(互換用含む)
    • ラジオボタン(互換用含む)
    • セレクトボックス(互換用含む)
    • リストボックス(互換用含む)
    • インラインフレーム
    詳細(明細テーブル) 明細テーブル(互換用含む)が配置されていない場合は出力されません。
    詳細(グリッドテーブル) グリッドテーブルが配置されていない場合は出力されません。
    詳細(カスタム)
    以下のいずれかのアイテムが配置されていない場合は出力されません。
    • ボタン(イベント)
    • スクリプト
    • ラベル
    • グリッドテーブル(列タイプ:カスタム)
    スマートフォン設定  
    アクション設定  
    アクション設定
    (カスタムスクリプト)
    アクション設定のアクション「カスタムスクリプト」の内容を出力します。
    出力有無    ○ : 必ず出力されます    △ : 出力されない場合があります

コラム

画面設計書出力における独自に開発した画面アイテムの扱い

独自に開発した画面アイテムについては、「 IM-FormaDesigner 画面アイテム作成ガイド 」-「 画面アイテムプロパティ共通タグライブラリ 」で用意しているプロパティ項目を出力することができます。
画面アイテムに設定した独自のプロパティ項目は出力対象外です。

16.2.4. 「表紙」シートに出力される内容

シート「表紙」には以下のプロパティの設定内容が出力されます。
  • アプリケーション名
  • アプリケーション履歴番号
  • フォーム名

16.2.5. 「フォーム概要」シートに出力される内容

シート「フォーム概要」には以下のプロパティの設定内容が出力されます。
  • アプリケーション概要
  • アプリケーション履歴情報
  • フォーム情報
  • ヘッダー・フッター

16.2.6. 「アイテム一覧」シートに出力される内容

シート「アイテム一覧」には、出力対象のフォームのアイテムがすべて出力されます。
アイテムの識別番号として「No.」を連番で設定しているため、他のシートの情報とはNo.で紐づけることができます。
以下のプロパティの設定内容が出力されます。
  • 画面アイテムタイプ
  • 表示タイプ
  • アイテムサイズ・配置

16.2.7. 「フィールド一覧」シートに出力される内容

シート「フィールド一覧」では、入力フィールドを持つアイテム、ボタンアイテムが出力されます。
出力対象のフォーム上のタブインデックスが出力されるため、フォーム・デザイナの「フィールド一覧」と同様にタブインデックスを一覧で確認できます。
以下のプロパティの設定内容が出力されます。
  • 基本設定
  • 詳細設定
  • タブインデックス
  • フィールドスタイル

16.2.8. 「入力チェック一覧」シートに出力される内容

シート「入力チェック一覧」は、入力フィールドを持つアイテムが出力されます。
以下のプロパティの設定内容が出力されます。
  • 入力チェック

16.2.9. 「ラベル一覧」シートに出力される内容

シート「ラベル一覧」は、プロパティに「ラベル」のあるアイテムが出力されます。
以下のプロパティの設定内容が出力されます。
  • ラベル一覧
  • ラベルスタイル

16.2.10. 「詳細」シートに出力される内容

シート「詳細」に出力される画面アイテムのプロパティには以下があります。
画面アイテムの種類により、出力される内容が異なります。
画面アイテム名 画面アイテムタイプ 出力内容
一覧選択
product_72_itemSelect
  • データソース
一覧選択
product_80_itemSelect
  • 外部連携
チェックボックス
ラジオボタン
セレクトボックス
リストボックス
product_72_checkbox
product_72_radio
product_72_selectbox
product_72_listbox
  • データソース
チェックボックス
ラジオボタン
セレクトボックス
リストボックス
product_80_checkbox
product_80_radio
product_80_selectbox
product_80_listbox
  • データの定義
インラインフレーム
product_80_iframe
  • 基本設定
  • パラメータ設定
  • 詳細設定
  • フレームスタイル
  • アイテム「一覧選択(product_80_itemSelect)」の「取得値設定」は出力対象外です。

  • 以下のアイテムに関して、アクション設定の「初期表示イベント」や「入力イベント」等の「外部連携」によるマッピング情報は出力対象外です。
    該当の設定はマッピングしているデータソース定義名のみ「アクション設定」シートに出力します。
    • 一覧選択(product_80_itemSelect)
    • チェックボックス(product_80_checkbox)
    • ラジオボタン(product_80_radio)
    • セレクトボックス(product_80_selectbox)
    • リストボックス(product_80_listbox)

16.2.11. 「詳細(明細テーブル)」シートに出力される内容

シート「詳細(明細テーブル)」に出力される画面アイテムのプロパティには以下があります。
  • 明細テーブルの場合

    画面アイテム名 画面アイテムタイプ 出力内容
    明細テーブル
    product_80_table
    • 基本設定
    • 詳細設定
    明細テーブルの列タイプに応じて、以下の情報を出力します。
    列タイプ 出力内容
    一覧選択
    ラジオボタン
    セレクトボックス
    • 列プロパティ
  • 明細テーブル(互換用)の場合

    画面アイテム名 画面アイテムタイプ 出力内容
    明細テーブル
    product_72_table
    • 基本設定
    • 詳細設定
    明細テーブルの列タイプに応じて、以下の情報を出力します。
    列タイプ 出力内容
    一覧選択
    ラジオボタン
    セレクトボックス
    • 列プロパティ

16.2.12. 「詳細(グリッドテーブル)」シートに出力される内容

  • シート「詳細(グリッドテーブル)」に出力される画面アイテムのプロパティには以下があります。

    画面アイテム名 画面アイテムタイプ 出力内容
    明細テーブル
    product_80_gridtable
    • 基本設定
    • 詳細設定
    • 表示スタイル
    グリッドテーブルの列タイプに応じて、以下の情報を出力します。
    列タイプ 出力内容
    一覧選択
    セレクトボックス
    イメージ
    • 列プロパティ
    列タイプ「カスタム」の設定内容は、シート「詳細(カスタム)」に出力されます。

16.2.13. 「詳細(カスタム)」シートに出力される内容

  • シート「詳細(カスタム)」に出力される画面アイテムのプロパティには以下があります。

    画面アイテム名 画面アイテムタイプ 出力内容
    スクリプト
    product_72_script
    • スクリプト
    ボタン(イベント)
    product_80_eventButton
    • スクリプト
    グリッドテーブル
    (列タイプ:カスタム)
    product_80_gridtable
    • コード

16.2.14. 「スマートフォン設定」シートに出力される内容

  • シート「スマートフォン設定」に出力される設定内容には以下があります。

    • スマートフォン設定

16.2.15. 「アクション設定」シートに出力される内容

  • シート「アクション設定」に出力される設定内容には以下があります。

    • 初期表示イベント
    • アイテムイベント(通常イベント・特殊イベント)
    • テーブルイベント

16.2.16. 「アクション設定(カスタムスクリプト)」シートに出力される内容

  • シート「アクション設定(カスタムスクリプト)」に出力される設定内容には以下があります。

    • アクション「カスタムスクリプト」
    カスタムスクリプトのアクションの条件は「アクション設定」シートに出力されます。