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

17. フロー設計書出力

フロー設計書出力の仕様を説明します。

17.1. フロー設計書出力の基本仕様

  1. フロー設計書出力の単位

    • フロー設計書はフローのバージョン単位で出力することができます。
  2. フロー設計書出力の対象

    • フロー設計書出力は、「フロー設計書出力」画面で「出力」アイコンをクリックしたフローの情報を出力します。

    • 出力基準日として任意の年月日を指定する必要があります。
      出力基準日によってフロー・ルート・コンテンツの各バージョンが自動的に特定されます。
    • 「フロー設計書出力」画面には IM-BIS と IM-Workflow の 2 種類あります。
      後者には IM-BIS で作成したフローも表示されますが、出力される設計書には IM-BIS の情報は含まれません。
    • フロー・ルート・コンテンツに含まれる国際化情報は、出力操作を行ったユーザのアカウントコンテキストのロケールの情報のみ出力します。

17.2. フロー設計書の出力ファイルに関する仕様

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

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

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

    • IM-BIS フロー設計書の場合

      bis-flow-%BIS ID%-%出力基準日%.xlsx
      
    • IM-Workflow フロー設計書の場合

      imw-flow-%フローID%-%出力基準日%.xlsx
      
    “bis-flow” および “imw-flow” は、固定値です。
    %出力基準日% は yyyyMMdd 形式です。

17.2.2. フロー設計書のテンプレートファイル

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

    %PUBLIC_STORAGE_PATH% / im_bis / document_template / flow /
    
    • テンプレートファイルは、ロケール単位で以下の4種類を提供しています。
      • デフォルト(BIS_Workflow.xlsx)
      • 日本語(BIS_Workflow_ja.xlsx)
      • 英語(BIS_Workflow_en.xlsx)
      • 中国語(中華人民共和国)(BIS_Workflow_zh_CN.xlsx)
    • テンプレートファイルのロケールは、出力操作を行ったユーザのアカウントコンテキストのロケールに基づいて決定されます。
  • テンプレートファイルを変更した場合、変更後に出力したすべてのフロー設計書には変更内容が反映されます。

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

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

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

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

17.2.3. フロー設計書の出力ファイルの構成

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

    シート名
    出力有無
    ( IM-BIS )
    出力有無
    ( IM-Workflow )
    補足
    表紙  
    BIS概要 ×  
    フロー概要  
    コンテンツ概要 フローのバージョンの属性が「システム無効」の場合は出力されません。
    ルート概要 フローのバージョンの属性が「システム無効」の場合は出力されません。
    コンテンツ詳細
    以下のいずれかの場合は出力されません。
    • フローのバージョンの属性が「システム無効」
    • コンテンツのバージョンの属性が「システム無効」
    ルート詳細 (1)
    以下のいずれかの場合は出力されません。
    • フローのバージョンの属性が「システム無効」
    • ルートのバージョンの属性が「システム無効」
    ルート詳細 (2)
    以下のいずれかの場合は出力されません。
    • フローのバージョンの属性が「システム無効」
    • ルートのバージョンの属性が「システム無効」
    • コンテンツのバージョンの属性が「システム無効」
    ルート詳細 (3)
    以下のいずれかの場合は出力されません。
    • フローのバージョンの属性が「システム無効」
    • ルートのバージョンの属性が「システム無効」
    出力有無    ○ : 必ず出力されます    △ : 出力されない場合があります  × : 出力されません

コラム

バージョンの属性については、「 IM-Workflow 仕様書 」-「 バージョン 」を参照してください。

17.2.4. シート全般の出力仕様

  • 設定不可能な項目は「-」を出力します。
  • 未設定の項目は「(なし)」を出力します。
  • 概要の備考欄など文字列を入力する項目については、未入力の場合は空欄のまま出力します。
  • メール名やルール名などの名称が取得できない場合、当該IDを出力します。

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

IM-BIS フロー設計書の場合、以下の内容が出力されます。

  • 設計書出力基準日
  • BIS名

IM-Workflow フロー設計書の場合、以下の内容が出力されます。

  • 設計書出力基準日
  • フロー名

17.2.6. 「BIS概要」シートに出力される内容

以下の内容が出力されます。

  • 以下の基本情報
    • BIS ID
    • BIS名
    • BIS作成種類
    • 説明
  • 以下のバージョン情報
    • 有効期間
    • ステータス(バージョン有効/無効)
    • 説明

17.2.7. 「フロー概要」シートに出力される内容

以下の内容が出力されます。

  • フロー定義 - 基本情報
  • フロー定義 - バージョン - 基本情報

17.2.8. 「コンテンツ概要」シートに出力される内容

以下の内容が出力されます。

  • コンテンツ定義 - 基本情報
  • コンテンツ定義 - バージョン - 基本情報

17.2.9. 「ルート概要」シートに出力される内容

以下の内容が出力されます。

  • ルート定義 - 基本情報
  • ルート定義 - バージョン - 基本情報

17.2.10. 「コンテンツ詳細」シートに出力される内容

以下の内容が出力されます。
フロー定義にて「標準から変更しない」を選択している項目は、コンテンツ定義の「初期使用」に設定されている内容が出力されます。
  • フロー定義 - バージョン - コンテンツ詳細

17.2.11. 「ルート詳細 (1)」シートに出力される内容

ルートの各ノードに対する以下の設定内容が出力されます。
ノードの識別番号として「No.」を連番で設定しているため、「ルート詳細」各シートの情報とNo.で紐づけることができます。
テンプレート内のノードは対象のフロー定義に座標情報を保持していないため、位置(X、Y)は出力されません。
  • ルート定義 - バージョン - ルート詳細
    • ノードID
    • ノード名
    • ノード種別
    • 位置(X、Y)
以下のノードはフロー定義で設定した内容が併せて出力されます。
ノード種別により、出力される内容が異なります。
  • フロー定義 - バージョン - ルート詳細 - ノード設定
    ノード種別 出力内容
    申請 標準設定 - 機能設定
    承認 標準設定 - 機能設定
    動的処理
    • 基本設定 - 動的承認ノードの削除
    • 基本設定 - 処理対象者設定可能ノード
    • 標準設定 - 機能設定
    • プラグイン設定
    確認
    • 標準設定 - 確認対象者設定可能ノード
    • プラグイン設定
    分岐開始
    • 分岐開始方法
    • 分岐先設定可能ノード(申請/処理時に分岐先を選択する)
    • 分岐先ノード名、分岐ルール名(ルール定義で分岐開始する)
    • 分岐先ノード名、分岐ルール名(ユーザプログラムで分岐開始する)
    分岐終了
    • 分岐終了方法
    • ルール名(ルール定義で分岐終了する)
    • 分岐プログラム(ユーザプログラムで分岐終了する)
    横配置・縦配置
    • 基本設定 - 割当可能ノード数
    • 基本設定 - 処理対象者設定可能ノード
    • 標準設定 - 機能設定
    • プラグイン設定
    テンプレート置換
    • テンプレートID
    • テンプレート名

コラム

コメント、スイムレーンの設定内容は出力されません。

17.2.12. 「ルート詳細 (2)」シートに出力される内容

ルートの各ノードに対する以下の設定内容が出力されます。
ノードの識別番号として「No.」を連番で設定しているため、「ルート詳細」各シートの情報とNo.で紐づけることができます。
フロー定義にて「標準から変更しない」を選択している項目は、コンテンツ定義の「初期使用」に設定されている内容が出力されます。
フロー定義にて「標準から変更する」を選択している項目は、太字で表示されます。
  • フロー定義 - バージョン - ルート詳細 - ノード設定 - 標準設定(コンテンツ定義に関連する設定)

17.2.13. 「ルート詳細 (3)」シートに出力される内容

ルートの各ノードに対する以下の設定内容が出力されます。
ノードの識別番号として「No.」を連番で設定しているため、「ルート詳細」各シートの情報とNo.で紐づけることができます。
  • フロー定義 - バージョン - ルート詳細 - ノード設定 - 処理設定

コラム

「処理許可」にチェックがついている処理種別は「有効」、「処理許可」にチェックがついていない処理種別は「無効」として出力されます。