OutSystemsのアプリケーションテンプレートとは？ 作成方法やおすすめ機能を解説（Vol.34）

  • 公開日：

OutSystemsでアプリケーションを開発する際、ゼロから開発する方法とは別に、あらかじめいくつかの機能が実装されたアプリケーションテンプレートを利用して開発する方法があります。
アプリケーションテンプレートを適切に利用することで、開発の高速化や品質の安定化を図ることができます。
アプリケーションテンプレートには、OutSystemsが提供しているものやForgeで配布されているものがあり、開発者が独自に作成し利用することも可能です。
本ブログでは、アプリケーションテンプレートの機能、独自に作成する方法、あらかじめ設定しておくと便利な機能やメリットについて解説します。

OutSystems アプリケーションテンプレートを用いた開発の流れ

OutSystemsでは、アプリケーション開発を開始する際に、あらかじめ作成したテンプレートを利用できます。
利用したいテンプレートを選択し、アプリケーション名などを入力して開発を開始します。

テンプレートを選択して新しいアプリケーションを開発すると、テンプレート内の実装内容が新しく作成したアプリケーション内にコピーされた状態で開始することができます。
テンプレートに作成してある画面やロジックをはじめ、他アプリケーション／ライブラリへの参照情報など、新しいアプリケーションを開発するうえで必要な機能を最初から持った状態で開発をすることができます。
アプリケーションに必ず組み込みたい要素をあらかじめテンプレートに実装しておくことで、開発者の負担軽減はもちろん、複数のアプリケーションを実装した時の品質を一定に保つことができます。

 OutSystems アプリケーションテンプレートの作成方法

本章ではアプリケーションテンプレートの作成方法について解説します。
アプリケーションテンプレートも通常のアプリケーションと同様のプロセスで作成することができます。
＊OutSystemsを用いたアプリ開発については、「OutSystemsでモバイルアプリを開発するには？（vol.11）」にて解説しておりますので、ぜひご覧ください。

＜作成方法＞

  1. アプリケーションを新規作成する
  2.  通常のアプリケーション開発と同様に開発を行う
    （Studioで開発、Publishし、ブラウザ上で確認しながら開発します）
  3.  組み込みたい実装を施したら、アプリケーション名を「Template_<テンプレート名>」にし、アプリケーションのDescriptionを記載する
    （テンプレート化に必須ではありあませんが、アプリケーションのアイコンもテンプレートとわかるようなアイコンにすることをお勧めします）

上記の手順を終えると、アプリケーションテンプレートとして認識され、新規作成時にそのテンプレートをもとにアプリケーションの開発を開始できます。

アプリケーションテンプレートにすると、テンプレートそのものの動作をブラウザ上で確認できなくなるため、すべての実装が完了してから名前を変更すると良いでしょう。

OutSystems アプリケーションテンプレートのおすすめ機能4選

本章ではアプリケーションテンプレートとしてあらかじめ設定しておくと便利な4つの機能をご紹介します。

  1. バリデーションメッセージの日本語化の実装
  2. 共通アプリケーション・共通ライブラリの参照
  3. 外部のIdPを用いたログイン画面の実装
  4. Global Exception Handler（OnException）の編集

1. 　バリデーションメッセージの日本語化の実装

OutSystemsの標準言語は英語であるため、アプリケーションを新規作成すると、バリデーションメッセージは英語で設定されます。

バリデーションメッセージを日本語に変更する作業は、多くのアプリケーションで必要になります。しかし、それぞれのアプリケーションで日本語訳の作業をすると、開発者の翻訳方法によって文言にばらつきが生じ、アプリケーション全体の統一性を損なう要因となります。
アプリケーションテンプレートで日本語化の設定をしておくことで、そのような問題を解消できます。

2.　共通アプリケーション・共通ライブラリの参照

複数のアプリケーションを開発する際に、アプリケーションの基本テーマ（色やレイアウト）や通知機能、社員情報の取得機能のようなロジックを共通化することがあります。
そのようなアプリケーション・ライブラリの参照を追加しておき、必要な実装を組み込むことで、開発者の負担軽減が望めます。


3.　外部のIdPを用いたログイン画面の実装

OutSystemsではMicrosoft Entra IDなどの外部IdPを利用した認証を行うことができます。デフォルトで作成されるログイン画面は内部のDBに登録したユーザーに対して、メールアドレス、パスワードを用いた標準認証にのみ対応しているため、外部IdPでの認証を加えた際には、ログイン画面とログインのロジックを追加・編集する必要があります。
詳しいロジックの実装方法は以下のブログで解説しています。
（参考：OutSytems Developer Cloud（ODC）のIdP認証機能とは？～特長と設定方法を実際の画面で解説～（vol.24））

4.　Global Exception Handler（OnException）の編集

OutSytemsではアプリケーションで発生したあらゆるException（OutSystemsで開発するアプリケーション内で制御できる例外）をキャッチする、Global Exception Handlerを設定する必要があります。
アプリケーション作成時にもデフォルトで「OnException」が作成され、次のExceptionについてのハンドラーが作成されています。

  • Security Exception：認証・認可に関するException
  • Database Exception：テーブルの新規作成・更新時のデータ不整合時に発生するException
  • Communication Exception：リクエストのタイムアウト時に発生するException

その他のエラーはAll Exceptionsでまとめてハンドリングされます。


こちらもメッセージの日本語化をしておくと、ユーザーエクスペリエンスが向上します。

また、運用・保守を意識した実装をOnExceptionに組み込むことで、テンプレートを利用するすべてのアプリケーションで統一されたエラーハンドリングを実現できます。

まとめ

ここまでOutSystemsのアプリケーションテンプレートの特徴・作成方法・実装例を解説しました。アプリケーションテンプレートを適切に作成・利用することで、開発者の負担軽減や複数のアプリケーションの品質向上を図ることができます。

アプリケーションテンプレートはその導入が早ければ早いほど、後の品質向上にかかる負担を減らし、開発効率のさらなる向上に貢献します。
しかし、アプリケーションテンプレートの開発には高度な知識が必要なため、利用を始めたばかりの内製開発者にとっては難易度が高いのが実情です。

電通総研では、これまでの実績をもとに、お客様に適したアプリケーションテンプレートをご提供することができます。弊社のCoE支援サービスはアプリケーションテンプレート以外にも、OutSystemsの利活用を推進するための様々なサービスメニューをご提供しております。
「統一された品質で効率よく開発を進めたい」や「現在の環境を整理したい」といった課題をお持ちの方は、ぜひ一度ご相談ください。
https://itsol.dentsusoken.com/outsystems/inquiry/

＜筆者＞
氏名：野田頭凌冬（のだがしら　りょうと）
経歴：2023年、株式会社電通総研入社
　　　2023年よりOutSystems開発者として複数の案件に参画し、
　　　OutSystemsを用いたアプリケーション開発や内製開発者の育成を支援

保持資格：
– Professional Web Developer（OutSystems 11）