はじめに
ServiceNowで個別機能開発などのカスタマイズを行う際にライブラリ的な使い方ができる機能としてScript Includeがあり、公開情報(Docs)に以下が記載されている通り独自のクラスや関数を定義して再利用を可能にします。
Script Includeは、サーバー上で実行されるJavaScriptを保存するために使用されます。サーバースクリプトで使用するJavaScript関数とクラスを保存するためのScript Includeを作成します。各Script Includeは、オブジェクトクラスまたは関数のいずれかを定義します。
具体的な使用方法はDocsの同ページに記載があり、Script Includeを新規作成する際に、名前を指定するとスクリプトフィールド上にテンプレートが自動入力されるのでプロトタイプに関数などの処理を記述しますが、それ以外にどの様な記述であれば動作するのかが気になり調べてみました。
※ServiceNowでコードを書くことはありますがJavaScript自体は素人ですのでツッコミどころは多数あるかと思いますがご容赦ください。
ベーシックな記述方法
まず一番ベーシックな記述方法です。
既にまえがきで記載したとおりですが、名前を指定するとテンプレートが自動入力されるのであとはスクリプトフィールドで処理を追記していくだけです。
特徴としてはScript Includeのレコードにつけた名前と同じ変数名で宣言する関数オブジェクトが1つだけ存在しているという点です。
テンプレートで行われていること
余談ですがテンプレート 1行目の「Class.create()」が、どの様な処理を行っているのか確認したところScript IncludeのPrototypeServerを呼び出しおり、以下に置き換えることもできます。
var BasicSI = function() {
if (this.initialize)
this.initialize.apply(this, arguments);
};
プロトタイプを使用しない場合
プロトタイプを使用しない場合ですが、ベーシックな記述方法と同様にレコードの名前とスクリプトの変数名が一致するようにします。
また、以下の例ではテンプレートからの変更箇所を減らすためにClass.create()を使用していますが、通常のオブジェクトとして宣言しても問題ありません。
通常のクラスを使用する場合
JavaScriptの通常のクラスとして宣言した場合や無名クラスとして変数に代入した場合ですが結論から言うと動作しません。というより構文エラーとなり保存することができません。
定数として使用する場合
定数(的)として使用する場合ですが、これまでと同様にレコードの名前とスクリプトの変数名が一致するようにします。
しかし、実際に使用するケースでは関連する複数の定数を宣言できなければ不便だと思います。オブジェクトのプロパティとして記述することでも対応できますが、その場合は定数として呼び出す際に「オブジェクト名.プロパティ名」となり、毎回オブジェクト名を記述するのが手間になってきます。これを回避するために変数名で2つ以上を記述をしてみますが、その場合は以下の通り名前と異なる変数を呼び出すことはできません。
通常Script Includeは名前を記述すればそのまま呼び出すことが可能ですが、この様な場合は呼び出す側でgs.include(”Script Include名”)を使用することで対処します。
関数を宣言する場合
関数を宣言する場合は定数として使用する場合と同様です。
関数1つだけであれば名前と関数名が一致するようにします。2つ以上、かつ名前と関数名が異なる場合は呼び出す側でgs.includeを使用します。
関数が1つのみ
関数が2つ以上、かつ名前と関数名が異なる
まとめ
色々なパターンを試しましたが、名前を一致させるか呼び出す側でgs.includeを使用すればServiceNow上で実行できるコードはScript Includeでもだいたい動かせる(テンプレートから外れた記述ができる)という結果になりました。