次の例では、「プロセス マニュアル」レポートにより「ユナイテッド・モーター・グループ」デモ データベースのプロセス モデルに対してスクリプトが実行されます。
これを実行するために、ARIS クライアント インストール ディレクトリ/tools/scriptrunner/ の「scriptrunner.cfg.template」のエントリが変更され、クライアント インストール ディレクトリに scriptrunner.cfg として保存されています。
リンクをクリックすると、パラメータ エントリに関する情報が表示されます。
サンプル ファイルの scriptrunner.cfg を変更し、scriptrunner.bat と scriptrunner.sh と同じディレクトリに保存したら、オペレーティング システムに応じた方法で scriptrunner を起動します。ARIS クライアント インストール ディレクトリ/tools/scriptrunner でコマンド プロンプトを開きます。Microsoft® Windows® オペレーティング システムの場合、次のように入力します。
scriptrunner.bat scriptrunner.cfg
Linux オペレーティング システムの場合は、次のように入力します。
scriptrunner.sh scriptrunner.cfg
このアクションが完了すると、D:/Evaluations/Reports/example.pdf ディレクトリで出力ファイルが利用できます。
サンプル ファイル「scriptrunner.cfg」
# client home directory (to be changed if required)
クライアント インストール ディレクトリ。
デフォルト設定 (.) は、scriptrunner.bat ファイルを ARIS クライアント インストール ディレクトリ/tools/scriptrunner から実行する場合のみ保持できます。
# server to connect to
スクリプトを実行して、評価したモデル データを保存する ARIS サーバーの名前。
完全修飾名または IP アドレスを入力します。
# port the server is listening
ARIS サーバーへの接続のポート番号です。
デフォルト ポートは 80 です。システム管理者が別のポート番号を割り当てている場合は、その番号をここに入力する必要があります。
# to use ssl set to true
ARIS Server Administrator と ARIS クライアント 間の転送のために暗号化されるデータの SSL (Secure Socket Layer) 暗号化を有効にします。
デフォルトでは、このオプションは無効化されています。 SSL を使用するには、値 true を入力します。
# tenant to use
ライセンス キーに応じて、特定の機能と特定のデータをユーザーに提供する有効なテナントです。
この例では、テナント名は default です。
# User name for login.Use the login of the user who runs the report.
ログオンに使用するユーザーのユーザー名とパスワードです。
この例では、システム ユーザー system でログオンを実行します。
ユーザー名を入力します。 このユーザーには十分なライセンス、利用権限、アクセス権が必要です。
# Password for login.Use the password of the user who runs the report.Can/Should be encrypted.
ログオンに使用するユーザーのパスワードです。
この例では、ログオンはシステム ユーザー「system」およびパスワード「manager」 ({crypted}d12173f23e5f6e5d3cf163169b1068a4) で実行されます。
レポートを実行するユーザーのパスワードを入力してください。セキュリティ上の理由のため、ARIS Server Administratorコマンド「encrypt」を使用してパスワードを暗号化することを推奨します。
# Name of the database to which to log in.
レポートを実行するデータベースの名前、またはレポートを実行する要素を含むデータベースの名前。
この場合、データベース名は「United Motor Group」です。このデータベースにアクセスできない場合は、システム管理者に連絡してください。デモ データベースは、ARIS インストール パッケージにあります。
# GUID of the method filter for login.No entry (default) is "entire method".
メソッド フィルターの GUID。この例では、GUID は dd838074-ac29-11d4-85b8-00005a4053ff です。ここで GUID を指定しないと、自動的に「全メソッド」フィルターが適用されます。
フィルターの GUID は、[管理] タブで目的のフィルターを右クリックして、[編集] をクリックすると表示されます。
# Locale for database login.ISO 639 code for language.
レポートに使用するデータベース言語の ISO 639-1 コード。
この例では、ドイツ語を表す「de」が選択されています。
「scriptrunner.dblocale.country=」を入力して、言語が話されている国を指定することもできます。
# Locale for database login.ISO 3166 code for country (optional).
#
言語が話されている国の ISO-3166 コードです (オプション)。
この例では、米国を表す「EN」が選択されています。
# oem identifier (do not change)
#
内部名。
エラーが発生することを回避するために、このエントリは変更しないようにしてください。
# Locale for script string table and error messages.ISO 639 code for language.
エラー メッセージとレポート テキストを表示するインターフェイス言語の ISO 639-1 コード。 これは、スクリプト エディターの文字列テーブルの [言語] タブを決定します。
この例では、ドイツ語を表す「de」が選択されています。
# Locale for script string table and error messages.ISO -3166 code for language.(optional)
言語が話されている国の ISO-3166 コードです (オプション)。
この例では、米国を表す「EN」が選択されています。
# Script component - id. Default is 'Report' (value = 1).Optional 'static publisher' (value = 10).
# scriptrunner.component=1
# GUID of script to run.
実行するレポート スクリプトの GUID。
この例ではサンプル スクリプト「プロセス マニュアル」(f1253ea0-1c0f-11dd-3a64-0015582c76ab) です。
スクリプトの GUID は、[管理] タブで目的のスクリプトを右クリックして、[プロパティ] をクリックすると表示されます。
[全般] プロパティ ページで [ダイアログを開く] チェック ボックスがオフになっているレポートのみを使用してください。
# Output format ID, defaults to -1 (no output)
# 0 = RTF
# 2 = Text
# 3 = HTML
# 4 = MS Word
# 5 = MS Excel
# 7 = other
# 8 = XML
# 9 = PDF
# -1 = No output
出力ファイルのフォーマットを定義します。
この例では、出力形式 PDF (9) が使用されます。
# Path and name for output file.Only relevant if output format != -1
出力ファイルのパスと名前。
この例では、エントリ「D:/Evaluations/Reports/example.pdf」が使用されます。パスが存在しない場合は、自動的に作成されます。ターゲット パスにアクセス権があることを確認してください。
# GUID of evaluation filter (optional)
評価からアイテムを除外するために使用する評価フィルターの GUID。 この例では、評価フィルターは定義されていません。
フィルターの GUID は、[管理] タブで目的のフィルターを右クリックして、[編集] をクリックすると表示されます。
# IDs of objects from which to start the script.Separated by ';'
# DB : the script is to be run from a database context (database is specified by srciptrunner.dbname property)
# F:[GUID]: for scripts running from "configuration filter" context a configuration filter is specified by "F:" directly followed by the filter GUID
# G:[OID]: for scripts running from group objects: their OIDs, each preceded by "G:"
# M:[GUID]or[OID]: for scripts running from models: their OID or their GUID, each preceded by "M:"
# O:[GUID]or[OID]: for scripts running from object definitions: their OID or their GUID, each preceded by "O:"
# examples:
# scriptrunner.scriptinput=DB
# scriptrunner.scriptinput=F:f98555a9-6158-11d4-8582-00005a4053ff
# scriptrunner.scriptinput=G:
# scriptrunner.scriptinput=M:abababab-cdcd-efef-a1a2-b1b33fce23e5;M:ef2579bd-cdcd-efef-a1a2-b1b33fce23e5
# scriptrunner.scriptinput=O:abababab-cdcd-efef-a1a2-b1b33fce23e5;O:ef2579bd-cdcd-efef-a1a2-b1b33fce23e5
レポートを実行するデータベース アイテムを定義します。
構文: <要素タイプ>:<GUID>
複数の同一データベース アイテムを評価する場合は、エントリをセミコロン (;) で分割します。例はファイルでコメントとして提供されています。
この例では、データベースのプロセス モデルが評価されます (M:c45e1bd1-eff6-11e0-1cef-0025b3bf9d9d)。「M:」はモデルを意味し、その後にはモデルの GUID が続きます。
GUID は、モデルのプロパティ ページの [情報] で確認できます。
# User-defined properties.Can be accessed in script using Context.getProperty("propertyname")
「criptrunner.userproperty<番号>.key=」および「scriptrunner.userproperty<番号>.value=」行で定義できるテキストを呼び出す設定。
エントリ「0」は、独自のレポート スクリプトで「Context.getProperty("<キーの値>")」コールを使用する場合のみ変更するようにしてください。
たとえば、次のテキストとキーを設定した場合:
scriptrunner.userproperty.count=2
scriptrunner.userproperty1.key=send_mail
scriptrunner.userproperty1.value=true
scriptrunner.userproperty2.key=追加テキスト
scriptrunner.userproperty2.value=Started with scriptrunner.bat
これらのテキストをスクリプトで次のようにして呼び出すことができます。
var text = Context.getProperty("追加テキスト") //returns "Started with scriptrunner.bat"
if(“true”==Context.getProperty("send_mail")
sendMail();
# as many user-defined properties as specified in scriptrunner.userproperty.count.
# syntax:
#scriptrunner.userproperty1.key=
#scriptrunner.userproperty1.value=
#scriptrunner.userproperty2.key=
#scriptrunner.userproperty2.value=
#...