Accel Studio アプリケーション管理機能 仕様書 第6版 2024-04-01

4.11. 業務テンプレート

業務テンプレートとはAccel Studioで提供するアプリケーションの雛型となる情報を内包する定義情報です。 業務テンプレートを利用してアプリケーションを構成するロジックや画面などを自動で生成できます。

4.11.1. 業務テンプレートの種類

  • Accel Studio標準のテンプレート
    • 製品標準、サービスまたは追加モジュールで提供するテンプレートです。
    • Accel Studio標準のテンプレートに関する詳しい情報は 「Accel Studio テンプレートカタログ」 を参照してください。
  • ユーザが作成したテンプレート
    • ユーザがAccel Studioアプリケーションを元に作成したテンプレートです。
    • この章では、ユーザが作成したテンプレートに関する内容について説明します。

4.11.2. ユーザが作成したテンプレートが扱う情報

ユーザが作成したテンプレートが扱う情報は以下の通りです。

  • テンプレートID

    • テンプレートを一意に識別するためのIDです。
  • テンプレート名

    • テンプレートの名前です。
  • テンプレートデータ

    • アプリケーションを構成するロジックや画面などの雛型となる情報です。
      この情報を修正、削除することはできません。
  • 説明

    • テンプレートの内容に関する説明です。
  • ソート番号

    • テンプレートを表示する際のソート番号です。テンプレート一覧画面でソート番号が昇順となるように表示されます。

4.11.3. ユーザが作成したテンプレートの操作

  • 作成
    • テンプレート作成機能を利用して作成可能です。
    • アプリケーションを元に業務テンプレートを作成できます。
  • 更新
    • 業務テンプレート一覧画面からテンプレートを更新できます。
    • テンプレート名、説明、ソート番号の更新が可能です。
  • 削除
    • 業務テンプレート一覧画面からテンプレートを削除できます。
    • テンプレートを削除しても、削除するテンプレートから作成したアプリケーションは削除されません。
    • テンプレートを削除しても、元となるアプリケーションは削除されません。

コラム

アプリケーションに紐づいているリソースのバージョン情報は全てテンプレート化されます。
不要なバージョン情報はテンプレート作成前に削除してください。

注意

Accel Studio標準のテンプレートを修正、削除することはできません。

4.11.4. テンプレート化対象定義一覧

テンプレートを作成する際、アプリケーション内の定義情報はテンプレートデータとして登録されます。
アプリケーション作成時に、IDと各定義の参照情報は新しいIDに置換され、新しい定義として作成されます。
モジュール名 定義 対象 紐付いている定義 対象
IM-BloomMaker コンテンツ定義 ID    
画面 IM-LogicDesigner フロー定義 フロールーティング〇にリクエストを送信する
ViewCreator ルーティング定義 ルーティング〇にリクエストを送信する
IM-Repository エンティティ エンティティから作成した変数定義、入出力定義
IM-Repository 辞書項目 辞書項目から作成した変数定義、入出力定義
ルーティング定義 ID    
URL    
コンテンツ IM-BloomMaker コンテンツ定義  
IM-LogicDesigner フロー定義 ID    
フロー IM-LogicDesigner フロー定義 フロー呼び出し
IM-LogicDesigner フロー定義 ユーザ定義タスク
IM-Repository エンティティ エンティティから作成した変数定義、入出力定義
辞書項目から作成した変数定義、入出力定義
ユーティリティ 採番定義 採番取得、採番リセット
ルーティング定義 ID    
ルーティング(URL)    
認可URI    
対象フロー IM-LogicDesigner フロー定義  
トリガ定義 ID    
対象フロー IM-LogicDesigner フロー定義  
ユーザ定義タスク ID    
ViewCreator データ参照 データ参照コード    
対象クエリ ViewCreator クエリ  
クエリ クエリコード    
ルーティング定義 ルーティングID    
ルーティングURI    
対象クエリ ViewCreator クエリ  
認可URI    
IM-Workflow ワークフロー定義 ID    
コンテンツID    
ルートID    
フローID    
フロー設定・画面 IM-BloomMaker ルーティング定義 画面コンテンツ/URLを利用
フロー設定・処理 IM-LogicDesigner フロー定義 ロジックフローを利用
フロー設定・画面 IM-BloomMaker ルーティング定義 画面コンテンツ/URLを利用
ノード情報・処理 IM-LogicDesigner フロー定義 アクション処理
IM-Workflow ルート定義 テンプレート置換ノード
IM-Workflow ルール定義 条件分岐
案件プロパティ定義 キー    
ルール定義 ID    
条件値 IM-Workflow 案件プロパティ定義  
メッセージ定義 ID    
フロー定義 IM-LogicDesigner フロー定義 配信メディア: LogicDesigner
IM-Repository エンティティ ID    
エンティティ項目 IM-Repository 辞書項目  
エンティティ関連 IM-Repository エンティティ  
テーブル名    
参照項目設定 IM-Repository 辞書項目 他のエンティティを参照先とする場合
IM-Repository エンティティ 他のエンティティを参照先とする場合
検索条件 IM-Repository エンティティ  
辞書項目 ID    
エイリアス IM-Repository 辞書項目  
列挙型 IM-Repository 辞書項目  
列挙型 ID    
ユーティリティ 採番定義 ID    
共通定数定義 ID    
多言語メッセージ ID    

4.11.5. テンプレートに含まれる定義情報

テンプレート作成時に、元となるアプリケーション内の定義情報は、以下のどちらかを選択してテンプレートに取り込まれます。
※ ここで記述している「定義情報」とは、アプリケーションに紐づくリソース(例: IM-LogicDesigner フロー定義)と、リソースに内包される定義情報(例: IM-LogicDesigner ユーザ定義)を指します。
詳しい内容は、「リソース情報詳細」を参照してください。
  • アプリケーション作成時に定義情報を複製する

    • 定義情報が、アプリケーション作成の度に複製されるようにしてテンプレートに含めます。
      テンプレート作成画面において、「複製」を選択したままにしてください。
  • アプリケーション作成時に定義情報を複製せず、「共通定義」とする

    • 元となるアプリケーションの定義情報をそのままテンプレートに取り込みます。
      アプリケーション作成時にIDの置換などは行われません。
      複数のアプリケーションを跨って定義情報が利用されることを想定しています。
      テンプレート作成画面において、「複製」を選択しないでください。

注意

ユーティリティの定数定義と多言語メッセージはテンプレートでは複製は行えません。

以下はテンプレート作成からアプリケーション作成までの「定義情報」の一例です。

  1. 元となるアプリケーションは以下の通りです。
    • アプリケーションA

      • IM-LogicDesigner フロー定義A
      • IM-LogicDesigner フロー定義B
  2. アプリケーションA をテンプレート化します。ここで、フロー定義B は「共通定義」とします。
  3. 作成したテンプレートから アプリケーションB を作成します。作成したアプリケーションに含まれる定義は以下の通りです。
    • アプリケーションB

      • IM-LogicDesigner フロー定義A コピー
      • IM-LogicDesigner フロー定義B
フロー定義A は アプリケーションB が作成される時点で複製され、アプリケーションB には別の定義として登録されます。
一方、「共通定義」とした フロー定義B は アプリケーションA、アプリケーションB の両方に含まれます。

コラム

定義情報をテンプレートに含めたくない場合は、テンプレート作成前にアプリケーションから紐付けを解除してください。

注意

定義情報を「共通定義」とした場合の動作について
アプリケーション作成時に、共通定義が環境に存在しない場合は新規作成されます。
アプリケーション作成時に、テンプレート作成時点の定義情報で上書きインポートされるため、注意してください。

4.11.6. インポート・エクスポート

ユーザが作成したテンプレートはインポート・エクスポートができます。

注意

Accel Studio標準のテンプレートはインポート・エクスポートできません。

4.11.6.1. インポート・エクスポートで扱う情報

ユーザが作成したテンプレートのインポート・エクスポートでは以下の情報を扱います。

  • テンプレート情報
    • テンプレートID、テンプレート名(国際化情報)、説明(国際化情報)、ソート番号を含みます。
    • テンプレートデータを含みます。詳しい内容は「テンプレート化対象定義一覧」を参照してください。

4.11.6.2. インポート・エクスポート時の動作仕様

ユーザが作成したテンプレート のインポート・エクスポート機能の動作仕様は、以下の通りです。
  • エクスポート

    エクスポート機能は、「インポート・エクスポートで扱う情報」に記載した内容をZIPファイルとして出力します。

  • インポート

    インポート機能は、エクスポート機能により出力されたZIPファイルをもとに、 ZIPファイルに含まれるテンプレートデータを取り込みます。

注意

インポート先の環境に同一IDのテンプレートが存在する場合、上書きされます。
同一IDのテンプレートが存在しているかどうかを確認するには、インポートでファイルをアップロードした後、内容確認のステータスにて確認可能です。

注意

定義情報を「共通定義」とした場合の動作について
既に同一IDの定義情報がある場合、テンプレート作成時の「テンプレートに含まれる定義情報」の項目にて「複製」を選択していない定義情報は、インポート時には上書きされませんが、インポートしたテンプレートを使用してのアプリケーションの作成時にて上書きされます。
詳しい内容は「テンプレートに含まれる定義情報」を参照してください。