スクリプトの実行要求の受信設定については、コントロールパネルの「ScriptRunner for Amazon SQS設定」を参照してください。
ScriptRunner for Amazon SQSで使用するキューについては、「スクリプト実行要求格納キュー・スクリプト実行結果格納キューについて」を参照してください。
ScriptRunner for Amazon SQSが必要とするIAM権限については、「ScriptRunner for Amazon SQSが必要とするIAM権限について」を参照してください。
|
|
変数の定義方法については、こちらを参照してください。
プロパティファイルについては、「プロパティファイルによる起動設定の記述」を参照してください。
| <?xml version="1.0" encoding="Shift_JIS"?> <scriptrunner> <connection> <credential> <accesskey>AKIAIDWXMMTS4L4IXXXXX</accesskey> <secretkey>eukotvrxG/7KTT79yAb+Ya0SBVnILxxxxxxxxxx</accesskey> </credential> <region>ap-northeast-1</region> <requestqueuename>runner_sqs_ixxxxx_req</requestqueuename> <receivequeuename>runner_sqs_ixxxxx_recv</receivequeuename> <description>ScriptRunner for Amazon SQSから実行します。</description> <user>root</user> <password>password</password> </connection> <params> <param project="root@project" script="script"> <input key="var">value</input> <option key="TYPE">production</option> <option key="ENABLE_TYPE_SWITCH">false</option> <option key="ENABLE_XML_LOG">true</option> <option key="LOG_LEVEL">FINFO</option> </param> </params> </scriptrunner> |
TYPEを指定する<option>要素は省略可能です。その場合は、「デフォルト」の種別として実行します。
| 要素 | 属性 | 必須/省略可 | 説明 | 備考 |
|---|---|---|---|---|
| scriptrunner | - | 必須 | ||
| connection | - | 必須 | 接続情報を記述します。scriptrunner要素に一つ記述します。 | |
| credential | - | 必須 | Amazon Web Servicesのクレデンシャル情報を記述します。scriptrunner要素に一つ記述します。 | |
| accesskey | - | 必須 | Amazon Web Servicesのアクセスキーを記述します。credential要素に一つ記述します。 | |
| secretkey | - | 必須 | Amazon Web Servicesのシークレットキーを記述します。credential要素に一つ記述します。 | |
| encrypt | 省略可 | secretkey要素の内容(シークレットキー)が暗号化されているかどうかを表します。
encrypt属性の内容が[true]以外、または省略した場合、[false]を設定します。encrypt設定に関わらずAmazon Web Servicesとの通信は復号後のシークレットキーを用いますが、Amazon Web Servicesとの通信全体がHTTPSによって暗号化されます。平文で指定されているシークレットキーを暗号化する方法については、「起動設定ファイルのシークレットキー、パスワード暗号化」を参照してください。
|
||
| requestqueuename | - | 必須 | スクリプト実行要求格納キューのキュー名を指定します。connection要素に一つ記述します。 | receivequeuename | - | 必須 | スクリプト実行結果格納キューのキュー名を指定します。connection要素に一つ記述します。 | region | - | 必須 | requestqueuename・receivequeuenameで指定したキューが所属するリージョンを記述します。connection要素に一つ記述します。
指定できるリージョンは以下の通りです。
|
| receivetimeout | - | 省略可 | スクリプトの実行結果の受信を待機する時間(秒)を指定します。省略した場合、3600(1時間)を設定します。 | |
| description | - | 省略可 | このScriptRunner for Amazon SQSで実行した際のセッションの情報を指定します。ここで指定した情報はコントロールパネルの「タスクマネージャ」の[セッション]タブの[説明]項目に表示される内容です。 | |
| user | - | 必須 | スクリプトを実行するユーザ | |
| password | - | 必須 | スクリプトを実行するユーザのパスワード | |
| encrypt | 省略可 | password要素の内容(パスワード)が暗号化されているかどうかを表します。
encrypt属性の内容が[true]以外、または省略した場合、[false]を設定します。encrypt設定に関わらずAmazon Web Servicesとの通信は復号後のパスワードを用いますが、Amazon Web Servicesとの通信全体がHTTPSによって暗号化されます。平文で指定されているパスワードを暗号化する方法については、「起動設定ファイルのシークレットキー、パスワード暗号化」を参照してください。
|
||
| params | - | 必須 | ||
| param | - | 必須 | 起動スクリプトの設定をします。param一つが一つのスクリプトの起動に対応します。 | |
| project | 必須 | サービス名を指定します。デフォルトのサービス名の形式は<作成者>@<プロジェクト名>となります。 | ||
| script | 必須 | スクリプト名を指定します。 | ||
| input | - | 省略可 | スクリプトに渡す引数を設定します。param要素に複数のinputを指定できます。 | |
| key | 必須 | スクリプトに渡す引数の名前です。スクリプトで設定した引数名と同一である必要があります。 | ||
| option | - | 省略可 | スクリプトに渡すオプションです。param要素に複数のoptionを指定できます。
オプションについては、「オプション」を参照してください。 |
|
| key | 必須 | オプションのキーです。 |
デザイナで設定したスクリプト変数の初期値を使用したい場合は、その変数をinput要素のkey属性に指定しないようにします。
| スクリプト変数の型 | デフォルト値 | 備考 |
|---|---|---|
| 文字列型 | 空文字 | |
| 整数型 | 0 |
|
| 10進数型 | 0 |
|
| 日付/時間型 | 1970-01-01T09:00:00.000+0900 | |
| 真偽値型 | false | |
| バイナリ型 | null | |
| XML型 | 空文字 |
| キー | 値 | 説明 | 備考 |
|---|---|---|---|
| TYPE | - | 実行時の種別を指定します。 | |
| default | 「デフォルト」種別で実行します。 TYPEが指定されなかった場合も「デフォルト」で実行します |
||
| test | 「テスト用」種別で実行します。 | ||
| production | 「本番用」種別で実行します。 | ||
| <ユーザ指定種別> | サービス登録時、グローバルリソース作成時にユーザが任意で指定した種別で実行します。 | ||
| ENABLE_TYPE_SWITCH | - | 指定した種別のグローバルリソースが存在しなかった場合、種別を切り替えて再検索するかどうかのON/OFFを設定します。 | |
| true | 指定した種別のグローバルリソースが存在しなかった場合、「デフォルト」の種別で再検索します。 | ||
| false | 指定した種別のグローバルリソースが存在しなかった場合、エラーとします。 ENABLE_TYPE_SWITCHが省略された場合は「false」として動作します。 |
||
| ENABLE_XML_LOG | - | XMLログのON/OFFを設定します。 | |
| true | XMLログを出力します | ||
| false | XMLログを出力しません(既定値) | ||
| LOG_LEVEL | - | ログレベルを設定します。 | |
| NOTICE | 重要なログのみを出力するログレベル(既定値) | ||
| INFO | 運用時推奨のログレベル | ||
| FINFO | 開発時推奨のログレベル | ||
| FINEST | より詳細にログを出力するログレベル | ||
| DEBUG | 非常に詳細なログを出力するログレベル |
| <?xml version="1.0" encoding="Shift_JIS"?> <scriptrunner> <connection> <credential> <accesskey>%{1}</accesskey> <secretkey>%{2}</accesskey> </credential> <region>ap-northeast-1</region> <requestqueuename>runner_sqs_ixxxxx_req</requestqueuename> <receivequeuename>runner_sqs_ixxxxx_recv</receivequeuename> <description>ScriptRunner for Amazon SQSから実行します。</description> <user>root</user> <password>password</password> </connection> <params> <param project="root@project" script="%{3}"> <input key="var">%{4}</input> <option key="TYPE">production</option> <option key="ENABLE_TYPE_SWITCH">false</option> <option key="ENABLE_XML_LOG">true</option> <option key="LOG_LEVEL">FINFO</option> </param> </params> </scriptrunner> |
コマンドライン引数が存在しない場合には空文字が設定されます。詳細については、「終了ステータス」を参照してください。
スクリプトが終了する時間よりも起動設定ファイルに指定した時間が短い場合、スクリプトが終了する前にタイムアウトします。このときにスクリプトが強制終了されることはありません。
| キー | 説明 | 備考 |
|---|---|---|
| AWS_ACCESS_KEY | Amazon Web Servicesのアクセスキーです。 |
|
| AWS_SECRET_KEY | Amazon Web Servicesのシークレットキーです。 |
|
| REQUEST_QUEUE_NAME | スクリプト実行要求格納キューのキュー名です。 |
|
| RECEIVE_QUEUE_NAME | スクリプト実行結果格納キューのキュー名を指定します。 |
|
| AWS_REGION | REQUEST_QUEUE_NAMEー・RECEIVE_QUEUE_NAMEで指定したキューが所属するリージョンです。 |
|
| RECEIVE_TIMEOUT | スクリプトの実行結果の受信を待機する時間(秒)です。 |
|
| ENCRYPTED | AWS_SECRET_KEYが暗号化されて保存されている場合に[true]が設定されます。 |
| AWS_ACCESS_KEY=AKIAIDWXMMTS4xxxxxxx AWS_SECRET_KEY=eukotvrxG/7KTT79yAb+Ya0SBVnILxxxxxxx AWS_REGION=ap-northeast-1 REQUEST_QUEUE_NAME=runner_on_demand_ixxxxx_req RECEIVE_QUEUE_NAME=runner_on_demand_ixxxxx_recv RECEIVE_TIMEOUT=3600 |
「起動設定ファイルのシークレットキー・パスワード暗号化」実行はDataSpiderServerの起動状態に依存しません。
「プロパティファイルのシークレットキー暗号化」実行はDataSpiderServerの起動状態に依存しません。-epオプションでは、引数による暗号化対象ファイル名や暗号化後のファイル名の指定はできません。
| > ScriptRunnerSQS.exe scriptrunnersqs.xml \" \" |