サポート > リポジトリ > スクリプト > 生成されるスクリプトファイルの詳細 スクリプト

Designerで入力したスクリプトはファイルとして生成されます。

開発者によって記述されたコードは、次に示すテンプレートコードの内部に埋め込まれます。process という名前の関数の中にコードが含まれます。

ExcelFunction, Jfcerror, Jfcwarn, Jfcinfo, JFCUtils, HolidayManager は後述する「利用できる変数」で説明します。
function process() {
var ExcelFunction = Java.type("jp.jasminesoft.util.ExcelFunction");
var Jfcerror = Java.type("jp.jasminesoft.jfc.error.Jfcerror");
var Jfcwarn = Java.type("jp.jasminesoft.jfc.error.Jfcwarn");
var Jfcinfo = Java.type("jp.jasminesoft.jfc.error.Jfcinfo");
var JFCUtils = Java.type("jp.jasminesoft.jfc.JFCUtils");
var HolidayManager = Java.type("jp.jasminesoft.util.HolidayManager");

...ここに開発者独自のコードが埋め込まれる...

}
Java.type は特別な表記です。Java.type(FQCN形式のクラス名) と記述することで、Javaのクラスを表す変数を用意することができます。この変数を使って、オブジェクトを new 演算子で生成することができるようになります。

生成されるファイル

Designerで入力したスクリプトは、wagbyapp フォルダに存在するスクリプトファイル wagbyapp/webapp/$(APPNAME)/WEB-INF/script/<モデルID>/スクリプトファイル.js に上書き保存されます。

そのため再ビルドなしで、動作しているアプリケーションの挙動を確認することができます。

本番機のファイルは変更されません。同じ開発機上の wagbyapp フォルダのみ、変更されます。本番機へ反映させる場合は上のファイルを手動でコピーするか、改めてビルドを行ってから wagbyapp フォルダ全体を差し替えてください。

基本テンプレートを使わない

基本テンプレートを使わないようにすることもできます。例えば、独自の関数を用意する場合などです。

この場合、開発するコードは必ず function process() から開始してください。コードの先頭がこの記述で始まる場合、基本テンプレートは使わないと判断します。

例えば、次のように記述します。

function process() {
var ExcelFunction = Java.type("jp.jasminesoft.util.ExcelFunction");
var Jfcerror = Java.type("jp.jasminesoft.jfc.error.Jfcerror");
var Jfcwarn = Java.type("jp.jasminesoft.jfc.error.Jfcwarn");
var Jfcinfo = Java.type("jp.jasminesoft.jfc.error.Jfcinfo");
var JFCUtils = Java.type("jp.jasminesoft.jfc.JFCUtils");
var HolidayManager = Java.type("jp.jasminesoft.util.HolidayManager");

...開発者独自のコードを記述する...

}

function foo() {...独自の関数を記述する...}
function bar() {...独自の関数を記述する...}

定義した関数を(別のファイルに保存されたスクリプトから)呼び出すことはできません。

スクリプトに関する詳細なルールは次のとおりです。

  • [基本テンプレート] 開発者が作成したスクリプトコードの先頭に "function process() {" が付与されます。また末尾に "}" が付与されます。Wagbyは、常にこの process 関数を呼び出します。
  • ただし開発者が直接、process 関数の宣言 "function process() {" を明示的に記述することもできます。この場合、いくつかの変数の宣言も省略されるため、開発者自身で再定義してください。
  • Designerでスクリプトを変更すると、同じ開発機上の wagbyapp フォルダに存在するスクリプトファイル wagbyapp/webapp/$(APPNAME)/WEB-INF/script/<モデルID>/スクリプトファイル.js が上書きされます。そのため、ビルドすることなく、動作しているアプリケーションの挙動を確認することができます。(注意:本番機のファイルは変更されません。同じ開発機上の wagbyapp フォルダのみ、変更されます。)

customizeフォルダとの関係

もし customize フォルダ (正確には customize/webapp/WEB-INF/script/<モデルID> フォルダ) にもスクリプトを保存していた場合は注意が必要です。Designerに用意された設定欄でスクリプトを編集したあとビルド処理を行うと、customize フォルダにあるスクリプトに上書きされます。すなわち、customizeフォルダにあるファイルが優先されます。

スクリプトエディタで、先頭にドキュメンテーションコメントを記述することができます。この内容がスクリプト一覧表で抽出されます。

書式は次の通りです。

/**
 * タイトル
 * (空行)
 * 本文
 * 複数行にまたがってよい。
 */

例を示します。

/**
 * 受注明細自動作成処理
 *
 * 受注登録時に、受注明細を自動作成する。
 */
  • このドキュメンテーションコメントが未指定の場合、設計書出力ツールで作成されるスクリプト一覧表のタイトルと本文は空白になります。
  • タイトルが存在しない場合は「(スクリプト設定ずみ)」というタイトルのみ記載されます。
  • タイトルの最大文字列は50文字です。
  • タイトルが指定の最大文字列を超えた場合、超えた分は本文に含まれるようになります。
  • 本文中の改行はそのまま維持されます。
  • ドキュメンテーションコメントの有無でスクリプトの動作は変わりません。(スクリプト自体に影響を与えるものではありません。)

スクリプト中に、Javaが提供する標準クラスを利用することができます。これらは Java.type で再宣言する必要はありません。パッケージ名も含めたクラス名を使ってください。

var list = new java.util.ArrayList();
list.add("Apple");
list.add("Orange");
list.add("Banana");
print(list);

スクリプト内で利用できる変数をまとめます。

名前スクリプト内での表現説明
ストアモデル モデル名 customer データベースに保存されるオブジェクト
プレゼンテーションモデル モデル名_p customer_p Webフォームから入力された値。
すべて文字列型。
コンディションモデル モデル名_c customer_c 検索条件が格納されたオブジェクト。
リストモデル モデル名_l customer_l 一覧表示される値が格納されたオブジェクト
エラーメッセージ errorManager errorManager (エラーメッセージで解説)
SCREENTYPE if (SCREENTYPE == "copy") {...} SCREENTYPE関数と同じ。[例..]
UPLOADFILENAME 8.1.0 UPLOADFILENAME UPLOADFILENAME アップロード更新の「ファイル名」が格納されている。アップロード更新のタイミングで動作するスクリプト内で利用できる。
UPLOADFILEPATH 8.3.1 UPLOADFILEPATH UPLOADFILEPATH アップロード更新の「実ファイルのパス名」が格納されている。アップロード更新のタイミングで動作するスクリプト内で利用できる。
UPLOADFILEENTRY 8.3.1 UPLOADFILEENTRY UPLOADFILEENTRY アップロード更新でzipファイルがアップロードされた時、UPLOADFILENAMEはzipファイルのファイル名となる。そこで展開後のzipファイルで、今、処理されている(zipファイル内の)ファイル名を保持するものとして UPLOADFILEENTRY を用意した。アップロード更新のタイミングで、zipファイルがアップロードしているときにスクリプト内で利用できる。
UserElement 8.1.0 $owner $owner.group().descendants().groupId(); 階層グループで解説。
ActionParameter p p p.appctxで(Springの)ApplicationContextを参照できるなどの使い方がある。
ExcelFunctionクラス (*1) var s = ExcelFunction.FIND(...); (Wagby関数の利用で解説)
Jfcerrorクラス (*1) var error = new Jfcerror; (エラーメッセージで解説)
Jfcwarnクラス (*1) var warn = new Jfcwarn; (エラーメッセージで解説)
Jfcinfoクラス (*1) var info = new Jfcinfo; (エラーメッセージで解説)
JFCUtilクラス (*1) var s = JFCUtils.Message(p, "M0001") (Wagby関数で解説)
HolidayManagerクラス (*1) var d = HolidayManager.getInstance().getEigyoDayAsSQLDate(model1.item1, 7) (Wagby関数で解説)
ジョブパラメータ 8.2.0 var dataMap = p.request.getAttribute("__jfcjob_dataMap"); (ジョブパラメータで解説)
1. ExcelFunction, Jfcerror, Jfcwarn, Jfcinfo, JFCUtils, HolidayManager は基本テンプレートで宣言したものです。
ストアモデル以外のオブジェクトは、存在しない場合もあります。例えば検索画面の操作でない場合、コンディションモデルは含まれません。
状況によってはストアモデルの取得もできない場合があります。例えば削除処理の場合、ストアモデルは消えています。
トランザクションスクリプトでは、トランザクションの範囲内として指定された複数のストアモデルを扱うことができます。
トランザクションスクリプトでは、トランザクションの対象となる繰り返しコンテナもオブジェクトとして扱うことができます。

"環境 > スクリプト" では「共通関数」を用意することができます。

図1 環境>スクリプトの定義

「共通関数」の実体は WEB-INF/script/myfunction.js ファイルです。このファイルが存在した時、その内容を各スクリプトに含めます。

正確には、スクリプトの後にmyfunction.jsのコードがコピーされます。

利用例

あるスクリプトで、次のように記載します。

print(foo(1,2));

開発者は共通関数の定義で、関数 foo を用意することができます。

function foo(a1,a2) { 
  return a1+a2; 
}

スクリプトを実行すると、コンソールに 3.0 と表示されます。

R8.3.0 以前のバージョンをご利用の場合

Designer で設定するのではなく、開発者が作成した myfunction.js を customize/webapp/WEB-INF/script フォルダに保存してください。(インストール直後の状態では、WEB-INF フォルダ内に script フォルダはありませんので、これも作成してください。)次回のビルドから反映されるようになります。

ワークフローのイベントスクリプト

R8.2より、共通関数の定義(myfunction.js) はワークフローのフローイベントスクリプトでも利用できるようになりました。

独自に用意したスクリプトファイルを読み込むために load 関数を使うことができます。

load("wagby:xxx.js");

次のコードはいずれも /WEB-INF/script/sample/test.js を読み込みます。

load("wagby:sample/test.js");
load("wagby:/sample/test.js");
load("wagby:\\sample\\test.js");
load("wagby:../../WEB-INF/script/sample/test.js");
セキュリティの理由から、/WEB-INF/script より上位のフォルダにあるファイルを読み込むことはできません。例えば次のコードは実行時に IllegalArgumentException が発生します。
load("wagby:../test.js");//IllegalArgumentException が発生。

ファイルの区切り文字

"/" の利用を推奨します。Windows/Linux いずれの環境でも動作します。"\\" は Windows では動作しますが、Linux では動作しません。

ワークフローのイベントスクリプト

R8.2より、load 関数はワークフローのフローイベントスクリプトでも利用できるようになりました。

R8.1.2 より前の Wagby で、ワークフローのフローイベントスクリプトで load 関数を利用する場合は、フルパスでファイルの位置を記述するか、wagbyapp/bin を起点とした相対パスで記述してください。

ヘルパの次のタイミングで、関数 preprocess を用意することができます。処理の前に呼び出されます。

実行タイミングファイル名
登録 モデルIDHelper_beforeInsert.js
登録(初期データ作成) モデルIDHelper_initialize.js
更新 モデルIDHelper_beforeUpdate.js
詳細画面表示 モデルIDHelper_beforeShow.js

開発者は WEB-INF/script/<モデルID> フォルダに作成された上記ファイルを直接、テキストエディタで修正し、関数 preprocess を用意してください。

function preprocess() {
var ExcelFunction = Java.type("jp.jasminesoft.util.ExcelFunction");
var Jfcerror = Java.type("jp.jasminesoft.jfc.error.Jfcerror");
var Jfcwarn = Java.type("jp.jasminesoft.jfc.error.Jfcwarn");
var Jfcinfo = Java.type("jp.jasminesoft.jfc.error.Jfcinfo");

...ここに開発者独自のコードを記述する...

}

function process() {
...
}
preprocess 関数を定義した場合は、修正したスクリプトファイルを customize フォルダ (正確には customize/webapp/WEB-INF/script/<モデルID> フォルダ) 以下に保存するとよいでしょう。関数 preprocess を作成したあと、WagbyDesigner で編集するとスクリプトファイルは上書きされ、preprocess 関数の定義が消去されてしまうためです。

スクリプトの内部で用意した変数は、このスクリプトの中だけで有効です。他のスクリプトから参照することはできません。

他のスクリプトにデータを渡す場合は、p.request オブジェクトを使います。p.request オブジェクトはユーザから要求のあった処理を行なっている間中、共通で利用できる「入れ物」です。

例 処理中の値によって画面遷移ルールを変更する

ヘルパのスクリプトで、p.request に何らかの制御フラグをセットします。

p.request.setAttribute("適当なキー名", 値);

コントローラのスクリプトでは、この値によって遷移先を変更することができます。

var flag = p.request.getAttribute("上のキー名");
if (flag === 求める値) {
  return 画面遷移先;
}
すでにあるキー名は使ってはいけません。値が上書きされてしまいます。開発者が独自のルールを決め、重複しないように配慮してください。例えばキー名の最初に "__プロジェクト名_" という接頭語を付与する、などは有効です。

ジョブパラメータをリクエストから取得することができます。

var dataMap = p.request.getAttribute("__jfcjob_dataMap");
if (dataMap != null) {
    print("value="+dataMap.get("key"));
} else {
    print("dataMap is null.")
}
  • ヘルパ > アップロード更新(開始時)のタイミングで上記のようなスクリプトを用いて、ジョブパラメータを取得するといった使い方ができます。
  • スクリプトで null チェックは必ず行うようにしてください。例えばジョブではなく画面操作でのアップロード更新では、上記スクリプトの dataMap 変数は null となっています。