Web UI フレームワークのデフォルトのコード・テンプレート

Web UI フレームワークにはデフォルトとして付属しているコード・テンプレートがいくつか存在します。 それらのコード・テンプレートには、リソース、リソース許可、およびメニューが含まれます。

Web UI フレームワークには、実行時にさまざまな WUF 画面コンポーネントを更新するために使用できる、以下のテンプレートが含まれています。

  • マッシュアップ API
  • Struts アクション
  • JSB (JavaScript ビルダー)
  • リソース
  • リソース許可
  • リソースおよび許可 (リソースとリソース許可テンプレートの組み合わせ)
  • メニュー

WUF は、XML コード・テンプレートの (デフォルトでの) 作成に、テンプレート・メタデータを使用します。次いでこのテンプレートは、アプリケーションが使用する XML コードを生成するために使用されます。 ただし、定義できるのは XML テンプレートではないカスタム・テンプレートです。

テンプレートの更新は、以下の方法で行われます。

  • 現在のログイン・セッションにおいて (すべてのテンプレート)。 変更内容は、ログインしている間のみ持続します。 変更内容は、ログインしている間にテストできます。
  • データベースにおいて (マッシュアップと JSB を除く、すべてのテンプレート)。 変更内容は永続的であり、それらを削除するまで維持されます。 データベース内でのコンポーネントの更新は、Applications Manager でのそれら同じコンポーネントの更新の代替方法です。

続くいくつかのセクションでは、各テンプレートが機能する方法、および各種コンポーネントの XML エレメントについて説明しています。

マッシュアップ

これはセッション内のマッシュアップ・レジストリーのみを更新します (データベース内での永続的な更新ではありません)。

生成されたテンプレート・コードは、コピー・アンド・ペーストによって、mashup.xml ファイルの更新に使用できます。 集約機能マッシュアップを使用するか、またはさらに属性をマッシュアップ・コードに追加する場合は、独自のテンプレートを定義する必要があります。

以下の変数は、マッシュアップのデフォルトのコード・テンプレートで使用されます。

アイテム 説明 ソース
ID アプリケーション内のマッシュアップを一意的に識別します。 ユーザー入力。
説明 マッシュアップに関する情報。 ユーザー入力。
apiName マッシュアップで使用される API。 ユーザー入力。
入力 マッシュアップへの入力。 ユーザー入力。
outputTpl サーバーからの出力。 ユーザー入力。

struts

Struts は、以下の場合に、生成されたコードをアプリケーションの struts.xml ファイルに追加することによって更新できます。

  • struts.xml ファイルは、パッケージされていた jar ファイルから除去され、WEB-INF/classes ディレクトリーの下に置かれます。

    例えば stk の場合は、stk_struts.xml ファイルを platform_ui_demo_app.jar ファイルから除去し、それを WEB-INF/classes ディレクトリーの下に置きます。

    struts.xml ファイルに加えるすべての変更は、アプリケーションに反映されます。 2 つのアクションが同じ ID を持っている場合、アプリケーションでは、ファイル内で後のほうにあるアクションが選出されます。

  • Struts dev モードが有効になります (WAR ファイルが -Ddevmode=true を指定して作成されている場合は、自動的にオンになります)。
  • 以下のコマンドを使用すると、アプリケーションは展開された WAR ファイルとしてデプロイされます。
    buildwar.sh -Dwarfiles=<war file name> -Dappserver=<appserver> -Dnowebservice=true -Ddevmode=true

    WebLogic 12.1.2 を使用する場合は、次のコマンドを使用します。

    buildwar.sh -Dwarfiles=<war file name> -Dappserver=weblogic -Dnowebservice=true -Ddevmode=true Dwls-12=true

以下の変数は、Struts アクションのデフォルトのコード・テンプレートで使用されます。

アイテム 説明 ソース
actionName アプリケーション内のアクションを一意的に識別します。 ユーザー入力。
ID 使用される/呼び出されるマッシュアップの ID。 ユーザー入力。
input_ns 入力に使用される名前空間。 ユーザー入力。
output_ns 出力に使用される名前空間。 ユーザー入力。
success_jsp_path アクションが正常に完了した場合にロードする JSP。 ユーザー入力。

JSB (JavaScript ビルダー)

これはセッション内の JSB レジストリーのみを更新します (データベース内での永続的な更新ではありません)。

JSB (JavaScript ビルダー) のデフォルト・コード・テンプレートでは、以下の変数が使用されます。

アイテム 説明 ソース
proj_name プロジェクトの名前。 ユーザー入力。
target_name JavaScript ライブラリーを識別します。 アプリケーション内で固有である必要があります。 ユーザー入力。
target_file JavaScript ライブラリーのディレクトリー/ファイル・パス。 ユーザー入力。
loadAfter 後に現在の JSB ライブラリーがロードされる必要のあるライブラリーを指定します。 ユーザー入力。
config_js 画面の config.js ファイルのパス。 ユーザー入力。
js 画面用の JavaScript ファイルのパス。 ユーザー入力。
bundle_js 画面用のバンドル JavaScript ファイルのパス。 ユーザー入力。

リソース

これはリソースを、現行セッション内で、およびデータベース内で永続的に、更新または追加します。

以下の変数は、リソースのデフォルトのコード・テンプレートで使用されます。

アイテム 説明 ソース
app_code アプリケーション・コード。 ユーザー入力。
app_name アプリケーション名。 ユーザー入力。
parent_resource_id 親リソースのリソース ID。 ユーザー入力。
resource_create_type リソース作成タイプ (例えば、USER)。 ユーザー入力。
resource_desc リソースに関する情報。 ユーザー入力。
resource_key リソースの固有キー。 ユーザー入力。
URL Struts アクションのアクション URL。 ユーザー入力。

リソース許可

これはリソース許可を、現行セッション内で、およびデータベース内で永続的に、更新または追加します。

以下の変数は、リソース許可のデフォルトのコード・テンプレートで使用されます。

アイテム 説明 ソース
resource_perm_key リソース許可キー。 ユーザー入力。
user_group_id ユーザーが属するグループの ID。 ユーザー入力。
user_group_key ユーザーが属するグループのキー。 ユーザー入力。

リソースおよび許可

これはリソース・テンプレートとリソース許可テンプレートを組み合わせたものです。 これはリソースとリソース許可を、現行セッション内で、およびデータベース内で永続的に、更新または追加します。

以下の変数は、リソースと許可のデフォルトのコード・テンプレートで使用されます。

アイテム 説明 ソース
app_code アプリケーション・コード。 ユーザー入力。
app_name アプリケーション名。 ユーザー入力。
parent_resource_id 親リソースのリソース ID。 ユーザー入力。
resource_create_type リソース作成タイプ (例えば、USER)。 ユーザー入力。
resource_desc リソースに関する情報。 ユーザー入力。
resource_key リソースの固有キー。 ユーザー入力。
URL Struts アクションのアクション URL。 ユーザー入力。
resource_perm_key リソース許可キー。 ユーザー入力。
user_group_id ユーザーが属するグループの ID。 ユーザー入力。
user_group_key ユーザーが属するグループのキー。 ユーザー入力。

メニュー

これはメニューを、現行セッション内で、およびデータベース内で永続的に、更新または追加します。 これにより、Applications Manager によるメニュー作成方式の代替方法が提供されます。

以下の変数は、メニューのデフォルトのコード・テンプレートで使用されます。

アイテム 説明 ソース
menu_desc メニュー項目に関する情報。 ユーザー入力。
menu_key このメニューを一意的に識別するために使用されるキー/ID。 ユーザー入力。
menu_type メニュー・タイプ。 ユーザー入力。
parent_menu_key 親のメニュー・キー。 ユーザー入力。
resource_key ソースを識別するために使用されるキー。 ユーザー入力。