シナリオ実行コマンドでは、コマンドプロンプトからの一括実行によるシナリオの呼び出しが可能です。
シナリオ実行コマンドは「WSMGR for Web V9.1」以降および「WSMGR for Web APIサポート V9.1」以降がサポートする環境で動作します。
■実行方法
サーバ環境では、シナリオ実行コマンドに必要なモジュールは以下のフォルダに配置されています。
<インストールフォルダ>\wwwroot\bin
上記のフォルダのscenario.exeを起動することにより、シナリオ実行コマンドを実行することが可能です。
クライアント環境ではWSMGR for Webのサーバからシナリオ実行コマンドパッケージをダウンロードして使用します。パッケージはzip形式のファイルで配布されます。
圧縮パッケージ名および配布URLを以下に記載します。
圧縮パッケージ名 | 配布URL |
scenario.zip | http:// <WebサーバのURL> /wsmgrweb/scenario.zip |
圧縮パッケージには以下のモジュールが含まれます。
モジュール名 | 説明 |
scenario.exe | シナリオ実行コマンド |
ExcelLib.dll | Excel出力ライブラリ |
DocumentFormat.OpenXml.dll | Open XMLライブラリ |
圧縮パッケージを展開後、Windowsのログオンユーザが、コマンド実行権限を持つフォルダにモジュールをコピーして使用します。
■コマンドプロンプト指定方法
scenario /url:サーバURL /key:APIキー /project:プロジェクト名
/scenario:シナリオ名
[/in:入力変数の値] [/in:csv:入力変数ファイル名]
[/time:タイムアウト時間(秒)] [/out:出力形式[:出力フォルダ名]]
[/log]
※[]は省略可能なオプションであることを表す
オプション | 省略可能 | 説明 |
/url:サーバURL | シナリオを実行するサーバのWSMGR for WebのURLを指定します。 | |
/key:APIキー | シナリオを実行するためのAPIキー文字列を指定します。 | |
/project:プロジェクト名 | 実行するシナリオが含まれたプロジェクト名を指定します。 大文字・小文字は区別されます。 | |
/scenario:シナリオ名 | 実行するシナリオ名を指定します。 大文字、小文字は区別されません。 シナリオ名に「#」「'」を含むシナリオは指定できません。 | |
/in:入力変数の値 | ○ | 入力変数に設定する値を指定します。 /in:csvオプションと同時に指定することはできません。 |
/in:csv:入力変数ファイル名 | ○ | csvファイルから入力変数への設定値を読み込みます。 ファイル名には、相対パス、絶対パスの指定も可能です。 /inオプションと同時に指定することはできません。 |
/time:タイムアウト時間 | ○ | 一括実行要求のタイムアウト時間を秒単位で指定します。 指定可能な値は1～65535までの値となります。 省略時は90秒となります。 |
/out:出力形式[:出力フォルダ名] | ○ | 出力フォーマットを指定します。 以下の値が指定可能です。 excel csv 省略時はコマンドプロンプトのみに結果を出力します。 出力フォルダ名を指定した場合、指定のフォルダにファイルが出力されます。 出力フォルダ名は相対パス、または絶対パスによる指定が可能です。 |
/log | ○ | 実行結果ログを記録するログファイル出力を指定します。 ログファイルはシステムの一時ファイル保存フォルダ(環境変数のTEMPで指定されているフォルダ)に出力されます。 |
■入力情報
/in:オプションの指定により、シナリオの入力変数への入力値を入力情報として設定できます。
/in:オプションに続けて、以下のようにカンマ区切りのリスト形式で指定します。
変数名=値,変数名=値
○値にカンマを含める場合
値にカンマを含める場合、区切り文字のカンマと区別するために、以下のように
ダブルクォーテーションで値を囲みます。
例：「値,」という値の場合
変数名="値,"
○値にダブルクォーテーションを含める場合
値にダブルクォーテーションを含める場合、以下のようにダブルクォーテーションで値を囲み、
文字として含むダブルクォーテーションを2重に指定します。
例：「値"」という値の場合
変数名="値"""
例：「"値"」という値の場合
変数名="""値"""
注意
コマンドプロンプトからダブルクォーテーションを入力する場合、'\'でエスケープ入力を行う必要があります。
上記で示したダブルクォーテーションを指定する例では、実際には以下のように入力を行います。
○値にカンマを含める場合
変数名=\"値,\"
○値にダブルクォーテーションを含める場合
変数名=\"値\"\"\"
変数名=\"\"\"値\"\"\"
/in:csv:オプションに続けて、CSV形式の入力ファイル名を指定します。
CSVファイルは以下の形式で記述します。
列名 | 記述内容 |
変数名 | 出力変数名を記述します。 |
型 | 変数の型名を記述します。 string型のみ指定可能です。 |
値 | 入力値を記述します。 |
CSVファイルの記述例
変数名,型,値
変数1,string,data1
変数2,string,data2
■出力情報
/out:オプションの指定により、シナリオの出力変数の値をファイルに出力します。
/out:excelオプションを指定すると、以下の規則でExcelファイルを作成します。
<プロジェクト名>-<シナリオ名>-out.xlsx
出力フォルダ名未指定時は、コマンド実行時のカレントフォルダに出力されます。
Excelファイルには、以下の内容が出力されます。
列名 | 出力内容 |
変数名 | 出力変数名を出力します。 |
型 | 変数の型名を出力します。 |
値 | 変数の値を出力します。 |
Excelファイルの出力例
変数名 | 型 | 値 | |||
変数1 | string | data1 | |||
変数2 | list | data1 | data2 | data3 | data4 |
変数3 | table | data1 | data2 | data3 | |
data4 | data5 | data6 | |||
data7 | data8 | data9 |
/out:csvオプションを指定すると、以下の規則でCSVファイルを作成します。
string, list型の変数
<プロジェクト名>-<シナリオ名>-out.csv
CSVファイルには、以下の内容が出力されます。
列名 | 出力内容 |
変数名 | 出力変数名を出力します。 |
型 | 変数の型名を出力します。 |
値 | 変数の値を出力します。 |
CSVファイルの出力例
変数名,型,値
変数1,string,data1
変数2,list,data1,data2,data3,data4
table型の変数
<プロジェクト名>-<シナリオ名>-<変数名>-table.csv
CSVファイルには、以下のように、テーブル型の設定値が出力されます。
CSVファイルの出力例
data1,data2,data3
data4,data5,data6
data7,data8,data9
■復帰値
コマンドプロンプトからのシナリオの呼び出しが完了すると、処理結果により復帰値を返します。
成功した場合は0を返します。
WSMGR for WebのWeb APIが0以外のエラーを返した場合は、Web APIのエラーコードをそのまま返します。
復帰値 | 処理結果 | メッセージ |
|---|---|---|
0 | 正常終了 | コマンドの実行が完了しました。 |
1 | パラメータエラー | パラメータの指定が不正です。 |
97 | ファイル出力エラー | ファイルの出力でエラーが発生しました。 |
98 | HTTP通信エラー | HTTP通信でエラーが発生しました。 |
99 | 内部エラー | 内部で不正な処理が発生しました。 |
上記以外 | Web APIのエラー | 「34.2.6 エラーコード一覧」を参照。 |
参考
シナリオ実行コマンドは「WSMGR for Web V9.1」以降および「WSMGR for Web APIサポート V9.1」以降がサポートする環境で動作します。
V9.1以降のAPIサポートがインストールされていないサーバにシナリオ実行を要求した場合
シナリオ実行コマンドは、以下の復帰値を返します。
・APIサポートがインストールされていない場合
復帰値:98
エラーメッセージ:HTTP通信でエラーが発生しました。
・APIサポートのバージョンが古い(V9.0以前)場合
復帰値:1102
エラーメッセージ:APIキーが無効です。
