flow-ctrl コマンドリファレンス

flow-ctrlとはコマンドラインからフローの実行設定、実行を行うためのツールです。
flow-ctrlの各コマンドをスクリプトファイルに記述することでバッチ的に処理を実行することもできます。

※flow-ctrlは、Standard/Enterpriseエディションでのみ使用することができます。

起動方法

flow-ctrlの実行ファイルは[INSTALL_DIR]/server/bin/flow-ctrl（.bat）にあります。起動時のオプションを指定しない場合は起動後にログインユーザー名とパスワードの入力をうながされるので、実行設定などを行うユーザー名とパスワードでログインしてください。

起動時のオプション

-host:ホスト名

接続するフローサービスのホスト名。省略時は localhost

-port:ポート番号

接続するフローサービスのポート番号。省略時は 21381

-user:ユーザー名

ログインユーザー名。
省略時は起動後にユーザー名の入力を求められます。

-password:パスワード

-userを指定した場合のパスワード。
パスワードが空文字の場合は不要です。

-script:ファイル名

起動後に実行するスクリプト。
-scriptが指定された場合、スクリプト実行後すぐに終了します。

-output:ファイル名

実行コンソールのログファイル名。
-outputが指定された場合、コンソールでの出力内容がすべて指定ファイルに記録されます。
絶対パスで指定します。

相対パスの指定

引数にファイル名を相対パスで指定したときの起点は、以下のようになります。

flow-ctrlコマンドをフローサービスと同一マシンで実行する場合

flow-ctrlコマンドでログインしたフローサービスユーザーアカウントのホームフォルダーになります。

flow-ctrlコマンドをフローサービスと別マシンで実行する場合

• UNIXの場合
  UNIXのログインユーザーのホームフォルダー
• Windowsの場合
  C:\Users\ユーザー名

コマンドの使い方

凡例

コマンドと引数

flow-ctrlを起動するとプロンプトが表示され、そこにコマンドを打ち込んでいくことで処理を行っていきます。
(DOSやUnixのシェルと同様の操作イメージです。）

コマンドは1〜2語の単語で構成され、コマンドのみまたはコマンドに引数が必要なものがあります。

引数には、必須引数とオプション引数があります。

必須引数は、コマンドの直後にコマンドごとに決められた順序で指定します。

オプション引数は、「-username」のように「-」で始まるキーワードで指定します。オプションに値を指定する場合は「-username:guest」のように「:」で区切って値を指定します。値に空白を含める場合は「"-description:空白 あり"」のように引数全体を「"」で囲みます。必須引数と異なり、オプション引数は順不同で指定することができます。

//コマンドサンプル
//「//」で始まる行はコメント

コマンド一覧

コマンド	説明
connect	ログイン
user	ユーザー名
version	バージョン情報
help	ヘルプ
quit	flow-ctrlの終了
regist project	プロジェクトの登録
regist url	URL実行設定
regist soap	SOAP実行設定
regist ftp	FTP実行設定
regist schedule	一度だけ実行するスケジュールの登録
regist interval	指定間隔で実行するスケジュールの登録
regist daily	毎日実行するスケジュールの登録
regist weekly	毎週実行するスケジュールの登録
regist monthly	毎月実行するスケジュールの登録
regist mail	メール監視実行設定
regist queue	キュー監視実行設定
unregist project	プロジェクトの登録解除
unregist url	URL実行設定解除
unregist soap	SOAP実行設定解除
unregist ftp	FTP実行設定解除
unregist schedule	スケジュール実行設定解除
unregist mail	メール監視実行設定解除
unregist queue	キュー監視実行設定解除
enable url	URL実行設定有効化
enable soap	SOAP実行設定有効化
enable ftp	FTP実行設定有効化
enable schedule	スケジュール実行設定有効化
enable mail	メール監視実行設定有効化
enable queue	キュー監視実行設定有効化
enable all	すべての実行設定を有効化
disable url	URL実行設定無効化
disable soap	SOAP実行設定無効化
disable ftp	FTP実行設定無効化
disable schedule	スケジュール実行設定無効化
disable mail	メール監視実行設定無効化
disable queue	キュー監視実行設定無効化
disable all	すべての実行設定を無効化
export	実行設定のエクスポート
import	実行設定のインポート
exec	フローの実行
post	フローのポスト
resume	フローの再開
kill request	フローの強制終了
rerun checkpoint	チェックポイントフローのリクエスト再実行
repair checkpoint	チェックポイントフローのステータスに「リトライ待ち」を設定
delete checkpoint	チェックポイントフローのリクエスト情報削除
set session	セッションIDの設定
set request-id	リクエストIDの設定
set stream	フローの入力ストリームの設定
list session	セッション一覧の表示
list project	プロジェクト一覧の表示
list url	URL実行設定一覧の表示
list soap	SOAP実行設定一覧の表示
list ftp	FTP実行設定一覧の表示
list schedule	Schedule実行設定一覧の表示
list mail	メール監視実行設定一覧の表示
list queue	キュー監視実行設定一覧の表示
list project-pool	プロジェクトプール一覧の表示
list function-pool	関数プール一覧の表示
list connection-pool	コネクションプール一覧の表示
list worker	Worker一覧の表示
list request	リクエスト一覧の表示
list mutex	Mutex一覧の表示
list transaction	トランザクション一覧の表示
list checkpoint	チェックポイントフローのリクエスト一覧の表示
list server	サーバー一覧の表示
show project	プロジェクト詳細の表示
show session	セッション詳細の表示
show user	ユーザー詳細の表示
show worker	Worker状態の表示
show request	Request状態の表示
show transaction	トランザクション状態の表示
show checkpoint	チェックポイントフローのリクエスト状態の表示
clear aac	AACキャッシュのクリア
clear connection-pool	コネクションプールのクリア
clear project-pool	プロジェクトプールのクリア
upload	ファイルのアップロード
timing	コマンド実行時間の計測
script	コマンドスクリプトを実行
spool	コンソールのファイル出力
alias	ワードの別名登録
unlock mutex	Mutexロックの解除
recover transaction	トランザクションの手動リカバリー
xa	XAResourceに対するコマンドの発行
svn	SVNのバージョン管理コマンドの発行
git	Gitのバージョン管理コマンドの発行
service status	フローサービスの状態表示

connect

指定のユーザーでサーバーに接続します。

必須引数	説明
第1引数	ユーザー名を指定します。
第2引数	パスワードを指定します。 パスワードなしの場合は指定しません。

// /FlowService/guestとして接続
connect /FlowService/guset password

▲ コマンド一覧へ

user

現在接続中のユーザー名を表示します。

user

▲ コマンド一覧へ

version

バージョン情報を表示します。

//バージョン情報を表示します。
version

▲ コマンド一覧へ

help

コマンドのヘルプを表示します。

必須引数	説明
第1引数	ヘルプを表示するコマンド名を指定します。 省略時はコマンド一覧が表示されます。

//execコマンドのヘルプを表示します。
help exec

▲ コマンド一覧へ

quit

flow-ctrlを終了します。

quit

▲ コマンド一覧へ

regist project

指定のxfpファイルをホームフォルダーにアップロードし、 プロジェクト登録を行います。ホームフォルダー直下のプロジェクトファイルのみ対象です。サブフォルダ下のプロジェクトファイルは、-sオプションを指定してアップロードしない場合のみ指定することができます。

必須引数	説明
第1引数	登録するプロジェクトのxfpファイル名を指定します。

オプション引数

キーワード	値	説明
-s	なし	サーバー上のホームフォルダー下に既にxfpファイルが置かれている場合に指定します。 このオプションを指定するとxfpファイルのアップロードは行われません。

//サーバー上に既に存在するProject1.xfpを登録
regist project Project1.xfp -s

//ホームフォルダーのサブフォルダ「test」下に存在するProject2.xfpを登録
regist project test/Project2.xfp -s

//クライアント（Windows）に存在するファイルC:￥Temp￥Project3.xfpをサーバーのホームフォルダーへアップロードして登録
regist project C:￥Temp￥Project3.xfp

▲ コマンド一覧へ

regist url

URLの実行設定を行います。

必須引数	説明
第1引数	実行設定を行うフローのプロジェクト名を指定します。
第2引数	実行設定を行うフローのフロー名を指定します。
第3引数	実行設定を行うURLを指定します。

オプション引数

キーワード	値	説明
-name	あり	トリガー名を指定します。 省略時はトリガー名なしになります。
-description	あり	説明を指定します。 省略時は説明なしです。
-mode	あり	実行モードを指定します。 省略時はnormalです。 normal - 通常モード debug - デバッグモード profile - プロファイルモード high - 優先実行モード
-sessionlifetime	あり	セッション有効時間を時刻フォーマット([[HH:]MM:]SS)で指定します。 例えば1時間10分5秒なら「1:10:5」のように「:」で区切って指定します。 「1800」のようにすべて秒で指定することも可能です。 省略時は1800です。
-user	あり	実行設定に実行ユーザーを設定する場合に指定します。 省略時には実行ユーザーなしになります。
-password	あり	実行ユーザーを指定した場合のパスワードを指定します。
-protocol	あり	URL実行設定を有効にするプロトコルを「http」または「https」で指定します。 省略時はhttp、https共に有効になります。

//Flow1をデバッグモードで「/FLow1」と関連付ける
regist url Project1 Flow1 /Flow1 -mode:debug

▲ コマンド一覧へ

regist soap

SOAPの実行設定を行います。

必須引数	説明
第1引数	実行設定を行うフローのプロジェクト名を指定します。
第2引数	実行設定を行うフローのフロー名を指定します。
第3引数	実行設定するSOAPのOperation名を指定します。

オプション引数

キーワード	値	説明
-name	あり	トリガー名を指定します。 省略時はトリガー名なしになります。
-description	あり	説明を指定します。 省略時は説明なしです。
-mode	あり	実行モードを指定します。 省略時はnormalです。 normal - 通常モード debug - デバッグモード profile - プロファイルモード high - 優先実行モード
-user	あり	実行設定に実行ユーザーを設定する場合に指定します。 省略時には実行ユーザーなしになります。
-password	あり	実行ユーザーを指定した場合のパスワードを指定します。
-tns	あり	SOAPのTargetNamespaceを指定します。 省略時は「urn:asteria-service-flowservice」です。
-style	あり	SOAPのstyleを「rpc」または「document」で指定します。 省略時はrpcです。
-use	あり	SOAPのstyleを「encoded」または「literal」で指定します。 省略時はencodedです。
-endpoint	あり	標準ではSOAPのendpointのURLは「http://<SERVER>:<PORT>/soap」です。 endpointを指定した場合は指定したパスが標準のendpointのURLの後に付加されます。

regist soap Project1 Flow2 Method1

▲ コマンド一覧へ

regist ftp

FTPの実行設定を行います。

必須引数	説明
第1引数	実行設定を行うフローのプロジェクト名を指定します。
第2引数	実行設定を行うフローのフロー名を指定します。
第3引数	監視の対象とするフォルダを指定します。

オプション引数

キーワード	値	説明
-name	あり	トリガー名を指定します。 省略時はトリガー名なしになります。
-description	あり	説明を指定します。 省略時は説明なしです。
-mode	あり	実行モードを指定します。 省略時はnormalです。 normal - 通常モード debug - デバッグモード profile - プロファイルモード high - 優先実行モード
-user	あり	実行設定に実行ユーザーを設定する場合に指定します。 省略時には実行ユーザーなしになります。
-password	あり	実行ユーザーを指定した場合のパスワードを指定します。
-includeSubdir	あり	サブフォルダを対象とするかどうかをtrue/falseで指定します。 省略時はfalseです。

regist ftp Project1 Flow2 dir1

▲ コマンド一覧へ

regist schedule

1度だけ実行するスケジュール実行設定を行います。

必須引数	説明
第1引数	実行設定を行うフローのプロジェクト名を指定します。
第2引数	実行設定を行うフローのフロー名を指定します。
第3引数	スケジュールを実行する日時を指定します。 日時の書式はフローのDateTime型と同じです。

オプション引数

キーワード	値	説明
-name	あり	トリガー名を指定します。 省略時はトリガー名なしになります。
-description	あり	説明を指定します。 省略時は説明なしです。
-mode	あり	実行モードを指定します。 省略時はnormalです。 normal - 通常モード debug - デバッグモード profile - プロファイルモード high - 優先実行モード
-user	あり	実行設定に実行ユーザーを設定する場合に指定します。 省略時には実行ユーザーなしになります。
-password	あり	実行ユーザーを指定した場合のパスワードを指定します。
-holiday	あり	フローサービス管理コンソールで設定した休日設定名を指定します。 指定されなかった場合は休日も実行されます。
-holidayaction	あり	スケジュール実行時刻が休日だった場合の処理を指定します。 -holidayが指定され、-holidayactionが指定されない場合は、Skipとなります。 Skip - 実行しない Plus - 翌日実行 Minus - 前日実行
-restart	あり	停止中に実行時刻が経過した場合の動作指定します。 省略時はOneです。 One - 実行する Skip - 実行しない
-p	あり	フローの引数を「パラメーター名=値」の形式で指定します。 -pを複数指定し、複数のパラメーターを引数として渡すことができます。

//Flow3を2003年5月5日正午にスケジュール
regist schedule Project1 Flow3 2003-05-05T12:00:00 -p:var1=aaa -p:var2=bbb

▲ コマンド一覧へ

regist interval

指定間隔でのスケジュール実行設定を行います。

必須引数	説明
第1引数	実行設定を行うフローのプロジェクト名を指定します。
第2引数	実行設定を行うフローのフロー名を指定します。
第3引数	スケジュールの実行間隔を時刻フォーマット([[HH:]MM:]SS)で指定します。 例えば1時間10分5秒なら「1:10:5」のように「:」で区切って指定します。 「1800」のようにすべて秒で指定することも可能です。

オプション引数

キーワード	値	説明
-name	あり	トリガー名を指定します。 省略時はトリガー名なしになります。
-description	あり	説明を指定します。 省略時は説明なしです。
-mode	あり	実行モードを指定します。 省略時はnormalです。 normal - 通常モード debug - デバッグモード profile - プロファイルモード high - 優先実行モード
-user	あり	実行設定に実行ユーザーを設定する場合に指定します。 省略時には実行ユーザーなしになります。
-password	あり	実行ユーザーを指定した場合のパスワードを指定します。
-startdate	あり	スケジュールの開始日時を日付時刻形式で指定します。 省略時には現在時刻が開始日時となります。
-enddate	あり	スケジュールの終了日時を日付時刻形式で指定します。 省略時には終了日なしになります。
-validtime	あり	有効時間の開始時刻と終了時刻を「-」で区切った時刻形式(HH:MM:SS-HH:MM:SS)で指定します。 開始時刻が終了時刻よりも遅い時間であっても構いません。 省略時は全時間帯有効になります。
-holiday	あり	フローサービス管理コンソールで設定した休日設定名を指定します。 指定されなかった場合は休日も実行されます。
-holidayaction	あり	スケジュール実行時刻が休日だった場合の処理を指定します。 -holidayが指定され、-holidayactionが指定されない場合は、Skipとなります。 Skip - 実行しない Plus - 翌日実行 Minus - 前日実行
-restart	あり	停止中に実行時刻が経過した場合の動作指定します。 省略時はOneです。 One - 実行する Skip - 実行しない
-p	あり	フローの引数を「パラメーター名=値」の形式で指定します。 -pを複数指定し、複数のパラメーターを引数として渡すことができます。

//Flow4を2時間30分おきに実行
regist interval Project1 Flow4 2:30:00

▲ コマンド一覧へ

regist daily

毎日指定時間に実行するスケジュール実行設定を行います。

必須引数	説明
第1引数	実行設定を行うフローのプロジェクト名を指定します。
第2引数	実行設定を行うフローのフロー名を指定します。
第3引数	スケジュールを実行する時刻を時刻フォーマットで指定します。 書式は時、分、秒を「:」で区切る形式となります。

オプション引数

キーワード	値	説明
-name	あり	トリガー名を指定します。 省略時はトリガー名なしになります。
-description	あり	説明を指定します。 省略時は説明なしです。
-mode	あり	実行モードを指定します。 省略時はnormalです。 normal - 通常モード debug - デバッグモード profile - プロファイルモード high - 優先実行モード
-user	あり	実行設定に実行ユーザーを設定する場合に指定します。 省略時には実行ユーザーなしになります。
-password	あり	実行ユーザーを指定した場合のパスワードを指定します。
-startdate	あり	スケジュールの開始日時を日付時刻形式で指定します。 省略時には現在時刻が開始日時となります。
-enddate	あり	スケジュールの終了日時を日付時刻形式で指定します。 省略時には終了日なしになります。
-holiday	あり	フローサービス管理コンソールで設定した休日設定名を指定します。 指定されなかった場合は休日も実行されます。
-holidayaction	あり	スケジュール実行時刻が休日だった場合の処理を指定します。 -holidayが指定され、-holidayactionが指定されない場合は、Skipとなります。 Skip - 実行しない Plus - 翌日実行 Minus - 前日実行
-restart	あり	停止中に実行時刻が経過した場合の動作指定します。 省略時はOneです。 One - 実行する Skip - 実行しない
-p	あり	フローの引数を「パラメーター名=値」の形式で指定します。 -pを複数指定し、複数のパラメーターを引数として渡すことができます。

//Flow5を2003年5月の間毎日正午に実行
regist daily Project1 Flow5 12:00:00 -startdate:2003-05-01T00:00:00 -enddate:2003-06-01T00:00:00

▲ コマンド一覧へ

regist weekly

毎週指定曜日の指定時間に実行するスケジュール実行設定を行います。

必須引数	説明
第1引数	実行設定を行うフローのプロジェクト名を指定します。
第2引数	実行設定を行うフローのフロー名を指定します。
第3引数	スケジュールを実行する時刻を時刻フォーマットで指定します。 書式は時、分、秒を「:」で区切る形式となります。

オプション引数

キーワード	値	説明
-w	あり	曜日を指定します。 一つ以上複数指定できます SUN - 日曜日 MON - 月曜日 TUE - 火曜日 WED - 水曜日 THU - 木曜日 FRI - 金曜日 SAT - 土曜日
-name	あり	トリガー名を指定します。 省略時はトリガー名なしになります。
-description	あり	説明を指定します。 省略時は説明なしです。
-mode	あり	実行モードを指定します。 省略時はnormalです。 normal - 通常モード debug - デバッグモード profile - プロファイルモード high - 優先実行モード
-user	あり	実行設定に実行ユーザーを設定する場合に指定します。 省略時には実行ユーザーなしになります。
-password	あり	実行ユーザーを指定した場合のパスワードを指定します。
-startdate	あり	スケジュールの開始日時を日付時刻形式で指定します。 省略時には現在時刻が開始日時となります。
-enddate	あり	スケジュールの終了日時を日付時刻形式で指定します。 省略時には終了日なしになります。
-holiday	あり	フローサービス管理コンソールで設定した休日設定名を指定します。 指定されなかった場合は休日も実行されます。
-holidayaction	あり	スケジュール実行時刻が休日だった場合の処理を指定します。 -holidayが指定され、-holidayactionが指定されない場合は、Skipとなります。 Skip - 実行しない Plus - 翌日実行 Minus - 前日実行
-restart	あり	停止中に実行時刻が経過した場合の動作指定します。 省略時はOneです。 One - 実行する Skip - 実行しない
-p	あり	フローの引数を「パラメーター名=値」の形式で指定します。 -pを複数指定し、複数のパラメーターを引数として渡すことができます。

//Flow6を毎週月曜と火曜の正午に実行
regist weekly Project1 Flow6 12:00:00 -w:MON -w:TUE

▲ コマンド一覧へ

regist monthly

毎月指定日の指定時間に実行するスケジュール実行設定を行います。

必須引数	説明
第1引数	実行設定を行うフローのプロジェクト名を指定します。
第2引数	実行設定を行うフローのフロー名を指定します。
第3引数	スケジュールを実行する時刻を時刻フォーマットで指定します。 書式は時、分、秒を「:」で区切る形式となります。

オプション引数

キーワード	値	説明
-d	あり	月の中での実行日を指定します。 一つ以上複数指定できます
-name	あり	トリガー名を指定します。 省略時はトリガー名なしになります。
-description	あり	説明を指定します。 省略時は説明なしです。
-mode	あり	実行モードを指定します。 省略時はnormalです。 normal - 通常モード debug - デバッグモード profile - プロファイルモード high - 優先実行モード
-user	あり	実行設定に実行ユーザーを設定する場合に指定します。 省略時には実行ユーザーなしになります。
-password	あり	実行ユーザーを指定した場合のパスワードを指定します。
-startdate	あり	スケジュールの開始日時を日付時刻形式で指定します。 省略時には現在時刻が開始日時となります。
-enddate	あり	スケジュールの終了日時を日付時刻形式で指定します。 省略時には終了日なしになります。
-holiday	あり	フローサービス管理コンソールで設定した休日設定名を指定します。 指定されなかった場合は休日も実行されます。
-holidayaction	あり	スケジュール実行時刻が休日だった場合の処理を指定します。 -holidayが指定され、-holidayactionが指定されない場合は、Skipとなります。 Skip - 実行しない Plus - 翌日実行 Minus - 前日実行
-restart	あり	停止中に実行時刻が経過した場合の動作指定します。 省略時はOneです。 One - 実行する Skip - 実行しない
-p	あり	フローの引数を「パラメーター名=値」の形式で指定します。 -pを複数指定し、複数のパラメーターを引数として渡すことができます。

//Flow7を毎月5日、15日、25日の正午に実行
regist monthly Project1 Flow7 12:00:00 -d:5 -d:15 -d:25

▲ コマンド一覧へ

regist mail

メール監視実行設定を行います。

必須引数	説明
第1引数	実行設定を行うフローのプロジェクト名を指定します。
第2引数	実行設定を行うフローのフロー名を指定します。
第3引数	メール監視の実行間隔を時刻フォーマットで指定します。 例えば1時間10分5秒なら「1:10:5」のように「:」で区切って指定します。 「1800」のようにすべて秒で指定することも可能です。
第4引数	メール監視を行うPOPのコネクション名を指定します。

オプション引数

キーワード	値	説明
-name	あり	トリガー名を指定します。 省略時はトリガー名なしになります。
-description	あり	説明を指定します。 省略時は説明なしです。
-mode	あり	実行モードを指定します。 省略時はnormalです。 normal - 通常モード debug - デバッグモード profile - プロファイルモード high - 優先実行モード
-user	あり	実行設定に実行ユーザーを設定する場合に指定します。 省略時には実行ユーザーなしになります。
-password	あり	実行ユーザーを指定した場合のパスワードを指定します。
-holiday	あり	フローサービス管理コンソールで設定した休日設定名を指定します。 指定されなかった場合は休日も実行されます。
-holidayaction	あり	スケジュール実行時刻が休日だった場合の処理を指定します。 -holidayが指定され、-holidayactionが指定されない場合は、Skipとなります。 Skip - 実行しない Plus - 翌日実行 Minus - 前日実行
-attachment	あり	添付ファイル処理を行うのフローを指定します。 フロー名は「Project1.Flow1」のようにプロジェクト名とフロー名を「.」で区切った形式で指定します。
-error	あり	エラー処理を行うのフローを指定します。 フロー名は「Project1.Flow1」のようにプロジェクト名とフロー名を「.」で区切った形式で指定します。
-transaction	あり	本文処理と添付ファイル処理をトランザクション化するかどうかをtrue/falseで指定します。 省略時はfalseです。
-html	あり	メールがHTMLメールだった場合の扱いを指定します。 省略時はTextです。 Text - テキストを本文とする HTML - HTMLを本文とする Attachment - テキストを本文としHTMLは添付ファイルとする
-overlap	あり	起動時に前回の処理が終了していなかった場合の処理方法を指定します。 省略時はSkipです。 Skip - 処理をスキップします。 Wait - 前回の処理の終了を待って起動します。
-deleteAction	あり	メールを削除する条件を指定します。 省略時はNormalEndです。 NormalEnd - 正常終了時に削除します。 ReturnValue - フローの返り値が「-deleteValue」で指定した値だった場合に削除します。 None - メールを削除しません。
-deleteValue	あり	「-deleteAction」がReturnValueだった場合のメールを削除するフローの戻り値を指定します。 「-deleteAction」がReturnValue以外の場合は無視されます。

//添付ファイル処理フローを指定してpop1というメールボックスを10分おきに監視
regist mail Project1 Flow4 10:00 pop1 -attachment:Project1.Flow5 -transaction:true

▲ コマンド一覧へ

regist queue

キュー監視実行設定を行います。

必須引数	説明
第1引数	実行設定を行うフローのプロジェクト名を指定します。
第2引数	実行設定を行うフローのフロー名を指定します。
第3引数	キュー監視の実行間隔を時刻フォーマットで指定します。 例えば1時間10分5秒なら「1:10:5」のように「:」で区切って指定します。 「1800」のようにすべて秒で指定することも可能です。
第4引数	監視を行うキューコネクション名を指定します。
第5引数	監視を行うキュー名を指定します。

オプション引数

キーワード	値	説明
-name	あり	トリガー名を指定します。 省略時はトリガー名なしになります。
-description	あり	説明を指定します。 省略時は説明なしです。
-mode	あり	実行モードを指定します。 省略時はnormalです。 normal - 通常モード debug - デバッグモード profile - プロファイルモード high - 優先実行モード
-user	あり	実行設定に実行ユーザーを設定する場合に指定します。 省略時には実行ユーザーなしになります。
-password	あり	実行ユーザーを指定した場合のパスワードを指定します。
-holiday	あり	フローサービス管理コンソールで設定した休日設定名を指定します。 指定されなかった場合は休日も実行されます。
-holidayaction	あり	スケジュール実行時刻が休日だった場合の処理を指定します。 -holidayが指定され、-holidayactionが指定されない場合は、Skipとなります。 Skip - 実行しない Plus - 翌日実行 Minus - 前日実行
-selection	あり	キューに対する選択式を指定します。
-overlap	あり	起動時に前回の処理が終了していなかった場合の処理方法を指定します。 省略時はSkipです。 Skip - 処理をスキップします。 Wait - 前回の処理の終了を待って起動します。
-deleteAction	あり	キューからデータを削除する条件を指定します。 省略時はNormalEndです。 NormalEnd - フローが正常終了した場合にのみデータを削除します。 Before - フロー実行前にデータを削除してからフローを実行します。 After - フロー終了後に実行結果に関わらずデータを削除します。

//「queue1」というコネクションのキュー「q1」を監視
regist queue Project1 Flow4 10:00 queue1 q1

▲ コマンド一覧へ

unregist project

指定のプロジェクトを登録解除します。
そのプロジェクトの実行設定もすべて解除されます。
登録解除を行ってもxfpファイルは削除されません。

必須引数	説明
第1引数	登録解除するプロジェクトのプロジェクト名を指定します。。 regist時にはファイル名を指定しますが、解除時にはプロジェクト名の指定になります。

//Project1を登録解除
unregist project Project1

▲ コマンド一覧へ

unregist url

URL実行設定を解除します。

必須引数	説明
第1引数	URLまたはトリガー名を指定します。

※過去との互換性のため、引数として「プロジェクト名」「フロー名」「URL」の3つをとる形式も有効です。

//「/Test1」というURLに対する実行設定の解除
unregist url /Test1

▲ コマンド一覧へ

unregist soap

SOAP実行設定を解除します。

必須引数	説明
第1引数	TargetNamespaceまたはトリガー名を指定します。
第2引数	第1引数がTargetNamespaceの場合にOperation名を指定します。 第2引数が指定されなかった場合は第1引数はトリガー名として扱われます。

※過去との互換性のため、引数として「プロジェクト名」「フロー名」「Operation名」の3つをとる形式も有効です。

//「{urn:asteria-service-flowservice}Method1」というメソッドに対する実行設定の解除
unregist soap urn:asteria-service-flowservice Method1

▲ コマンド一覧へ

unregist ftp

FTP実行設定を解除します。

必須引数	説明
第1引数	フォルダまたはトリガー名を指定します。

//dir1に対する実行設定の解除
unregist ftp dir1

▲ コマンド一覧へ

unregist schedule

スケジュール実行設定を解除します。
regist時にはスケジュールのタイプごとにキーワードが異なりますが、解除の場合は すべてscheduleというキーワードになります。

必須引数	説明
第1引数	スケジュールIDまたはトリガー名を指定します。

※過去との互換性のため、引数として「プロジェクト名」「フロー名」「スケジュールID」の3つをとる形式も有効です。

//IDに対応するスケジュールの解除
unregist schedule 0eb3b70243c44dad9d3397806f44ad23

▲ コマンド一覧へ

unregist mail

メール監視実行設定を解除します。

必須引数	説明
第1引数	コネクション名またはトリガー名を指定します。

//コネクション「pop1」に対する実行設定の解除
unregist mail pop1

▲ コマンド一覧へ

unregist queue

キュー監視実行設定を解除します。

必須引数	説明
第1引数	コネクション名またはトリガー名を指定します。
第2引数	第1引数がコネクション名の場合にキュー名を指定します。 第2引数が指定されなかった場合は第1引数はトリガー名として扱われます。

//コネクション「jms1」、キュー「queue1」に対する実行設定の解除
unregist queue jms1 queue1

▲ コマンド一覧へ

enable url

URL実行設定を有効化します。

必須引数	説明
第1引数	URLまたはトリガー名を指定します。

//「/Test1」というURLに対する実行設定の有効化
enable url /Test1

▲ コマンド一覧へ

enable soap

SOAP実行設定を有効化します。

必須引数	説明
第1引数	TargetNamespaceまたはトリガー名を指定します。
第2引数	第1引数がTargetNamespaceの場合にOperation名を指定します。 第2引数が指定されなかった場合は第1引数はトリガー名として扱われます。

//「{urn:asteria-service-flowservice}Method1」というメソッドに対する実行設定の有効化
enable soap urn:asteria-service-flowservice Method1

▲ コマンド一覧へ

enable ftp

FTP実行設定を有効化します。

必須引数	説明
第1引数	フォルダまたはトリガー名を指定します。

//dir1に対する実行設定の有効化
enable ftp dir1

▲ コマンド一覧へ

enable schedule

スケジュール実行設定を有効化します。
regist時にはスケジュールのタイプごとにキーワードが異なりますが、有効化の場合は すべてscheduleというキーワードになります。

必須引数	説明
第1引数	スケジュールIDまたはトリガー名を指定します。

//IDに対応するスケジュールの有効化
enable schedule 0eb3b70243c44dad9d3397806f44ad23

▲ コマンド一覧へ

enable mail

メール監視実行設定を有効化します。

必須引数	説明
第1引数	コネクションまたはトリガー名を指定します。

//コネクション「pop1」に対する実行設定の有効化
enable mail pop1

▲ コマンド一覧へ

enable queue

キュー監視実行設定を有効化します。

必須引数	説明
第1引数	コネクション名またはトリガー名を指定します。
第2引数	第1引数がコネクション名の場合にキュー名を指定します。 第2引数が指定されなかった場合は第1引数はトリガー名として扱われます。

//コネクション「jms1」、キュー「queue1」に対する実行設定の有効化
enable queue jms1 queue1

▲ コマンド一覧へ

enable all

すべての実行設定を有効化します。

enable all

▲ コマンド一覧へ

disable url

URL実行設定を無効化します。

必須引数	説明
第1引数	URLまたはトリガー名を指定します。

//「/Test1」というURLに対する実行設定の無効化
disable url /Test1

▲ コマンド一覧へ

disable soap

SOAP実行設定を無効化します。

必須引数	説明
第1引数	TargetNamespaceまたはトリガー名を指定します。
第2引数	第1引数がTargetNamespaceの場合にOperation名を指定します。 第2引数が指定されなかった場合は第1引数はトリガー名として扱われます。

//「{urn:asteria-service-flowservice}Method1」というメソッドに対する実行設定の無効化
disable soap urn:asteria-service-flowservice Method1

▲ コマンド一覧へ

disable ftp

FTP実行設定を無効化します。

必須引数	説明
第1引数	フォルダまたはトリガー名を指定します。

//dir1に対する実行設定の無効化
disable ftp dir1

▲ コマンド一覧へ

disable schedule

スケジュール実行設定を無効化します。
regist時にはスケジュールのタイプごとにキーワードが異なりますが、無効化の場合は すべてscheduleというキーワードになります。

必須引数	説明
第1引数	スケジュールIDまたはトリガー名を指定します。

//IDに対応するスケジュールの無効化
disable schedule 0eb3b70243c44dad9d3397806f44ad23

▲ コマンド一覧へ

disable mail

メール監視実行設定を無効化します。

必須引数	説明
第1引数	コネクションまたはトリガー名を指定します。

//コネクション「pop1」に対する実行設定の無効化
disable mail pop1

▲ コマンド一覧へ

disable queue

キュー監視実行設定を無効化します。

必須引数	説明
第1引数	コネクション名またはトリガー名を指定します。
第2引数	第1引数がコネクション名の場合にキュー名を指定します。 第2引数が指定されなかった場合は第1引数はトリガー名として扱われます。

//コネクション「jms1」、キュー「queue1」に対する実行設定の無効化
disable queue jms1 queue1

▲ コマンド一覧へ

disable all

すべての実行設定を無効化します。

disable all

▲ コマンド一覧へ

export

ユーザーのプロジェクト情報と実行設定を実行設定ファイルとしてエクスポートします。
通常、実行設定ファイルの拡張子は「.xml」です。引数を指定する時に拡張子がない場合、自動的に「.xml」拡張子が補完されます。

必須引数	説明
第1引数	エクスポートファイル名を指定します。

//実行設定のエクスポート
export project.xml

▲ コマンド一覧へ

import

実行設定ファイルからユーザーのプロジェクト情報と実行設定をインポートします。
IDが重複する場合の処理や実行を有効にするか無効にするかのオプションを指定することができます。
更新オプション（-rまたは-o）を指定しない場合、IDが重複する実行設定は取り込まれません。
実行可能オプション（-eaまたは-da）を指定しない場合、実行を有効にするか無効にするかの設定はインポートするファイルの設定に従います。

必須引数	説明
第1引数	インポートするファイル名を指定します。

オプション引数

キーワード	値	説明
-r	なし	インポートの前にすでに設定してあるすべてのプロジェクトの登録情報と実行設定を削除します。 「-o」と同時には指定できません。
-o	なし	IDの同じ実行設定がある場合は上書きします。 「-r」と同時には指定できません。
-ea	なし	インポートする実行設定をすべて有効にします。 「-da」と同時には指定できません。
-da	なし	インポートする実行設定をすべて無効にします。 「-ea」と同時には指定できません。

//実行設定のインポート
import project.xml

▲ コマンド一覧へ

exec

指定のフローを実行します。
実行後は戻り値と結果ストリームの文字列値が表示されます。

必須引数	説明
第1引数	実行するフローのプロジェクト名を指定します。
第2引数	実行するフローのフロー名を指定します。

オプション引数

キーワード	値	説明
-mode	あり	実行モードを指定します。 省略時はnormalです。 normal - 通常モード debug - デバッグモード profile - プロファイルモード high - 優先実行モード
-output	あり	指定した場合、実行結果のストリームが値に指定したファイルに保存されます。
-p	あり	フローの引数を「パラメーター名=値」の形式で指定します。 -pを複数指定し、複数のパラメーターを引数として渡すことができます。
-set	なし	フローの結果ストリームをコンソールの変数「stream」にセットします。

//引数を指定してFlow1をプロファイルモードで実行
exec Project1 Flow1 -mode:profile -p:param1=v1 -p:param2=v2

▲ コマンド一覧へ

post

指定のフローを実行します。
execコマンドと異なり、フローの実行を開始するとその終了を待たずに直ちに制御が戻ります。
実行後はフロー実行のリクエストIDが表示されます。
また、そのリクエストIDはコンソールの変数「request-id」に設定されます。

必須引数	説明
第1引数	実行するフローのプロジェクト名を指定します。
第2引数	実行するフローのフロー名を指定します。

オプション引数

キーワード	値	説明
-mode	あり	実行モードを指定します。 省略時はnormalです。 normal - 通常モード debug - デバッグモード profile - プロファイルモード high - 優先実行モード
-p	あり	フローの引数を「パラメーター名=値」の形式で指定します。 -pを複数指定し、複数のパラメーターを引数として渡すことができます。
-set	なし	フローの結果ストリームをコンソールの変数「stream」にセットします。
-suspend	なし	フローの実行開始直後に直ちにサスペンド状態とします。

//Flow1を実行して開始直後にサスペンド状態にする
post Project1 Flow1 -suspend

▲ コマンド一覧へ

resume

サスペンド中のフローを再開します。
コマンド実行後はフローの終了を待ってその結果ストリームを表示します。
リクエストが実行を完了している場合は何もしません。

必須引数	説明
第1引数	再開するリクエストのリクエストIDを指定します。 省略時はSet変数「request-id」に設定されるリクエストIDが使用されます。

オプション引数

キーワード	値	説明
-timeout	あり	フローの実行完了を待つタイムアウト値を秒単位で指定します。 省略時はフローのタイムアウトプロパティの値が使用されます。

//Set変数「request-id」に設定されているリクエストを再開します。10秒待ってもフローの実行が終了しない場合は制御が戻ります。
resume -timeout:10

▲ コマンド一覧へ

kill request

実行中のフローを強制終了します。
強制終了に成功した場合は最後に実行されたコンポーネント名が表示されます。

必須引数	説明
第1引数	強制終了するリクエストのリクエストIDを指定します。
第2引数	強制終了を待つタイムアウト値を秒単位で指定します。 省略時は5秒です。

//指定のリクエストを強制終了します。10秒待っても終了しない場合は制御が戻ります。
kill request 6e8e4181-700f-4cf0-9274-e83be63184ae 10

▲ コマンド一覧へ

rerun checkpoint

異常終了しているチェックポイントフローのリクエストを、異常終了する直前のチェックポイントから再実行します。
フローの実行を開始するとその終了を待たずに直ちに制御が戻ります。
実行後はフロー実行のリクエストIDが表示されます。
また、そのリクエストIDはコンソールの変数「request-id」に設定されます。

必須引数	説明
第1引数	再実行するリクエストの開始日付をYYYYMMDDの形式で指定します。
第2引数	再実行するリクエストのリクエストIDを指定します。

//開始日付が2012年10月5日の指定のリクエストを再実行します。
rerun checkpoint 20121005 eedd0d83-ac7a-482d-ae95-aa16c1d87d432

▲ コマンド一覧へ

repair checkpoint

チェックポイントフローのステータスに「waiting（リトライ待ち）」を設定します。
ステータスを設定できるリクエストはリクエストステータスが「preparing（実行準備中）」「running（実行中）」のいずれかのものだけです。
※チェックポイントフロー実行時に処理が止まってしまった場合、処理を復旧するときにのみ使用します。

必須引数	説明
第1引数	ステータスを修正するリクエストの開始日付をYYYYMMDDの形式で指定します。
第2引数	ステータスを修正するリクエストのリクエストIDを指定します。

//開始日付が2014年03月05日の指定のリクエストのステータスに「リトライ待ち」を設定します。
repair checkpoint 20140305 eedd0d83-ac7a-482d-ae95-aa16c1d87d432

▲ コマンド一覧へ

delete checkpoint

チェックポイントフローのリクエスト情報を削除します。
削除できるリクエストはリクエストステータスが「waiting（リトライ待ち）」「success（正常終了）」「error（異常終了）」のいずれかのものだけです。
実行後は削除したリクエストのリクエストIDが表示されます。

必須引数	説明
第1引数	削除するリクエストの開始日付をYYYYMMDDの形式で指定します。
第2引数	削除するリクエストのリクエストIDを指定します。

//開始日付が2014年03月05日の指定のリクエストの情報を削除します。
delete checkpoint 20140305 eedd0d83-ac7a-482d-ae95-aa16c1d87d432

▲ コマンド一覧へ

set session

フローの実行時に使用するセッションIDを指定します。
指定がない場合は実行毎に毎回セッションIDが生成されます。
※複数のクライアントから同一のセッションIDを指定して実行してもエラーとはなりませんが、 混乱の原因となるので可能な限りユニークな文字列を指定してください。

必須引数	説明
第1引数	任意の文字列をセッションIDとして指定します。

//これ以降のフローの実行のセッションIDを「SESSION-ID1」とする
set session SESSION-ID1

▲ コマンド一覧へ

set request-id

show requestコマンドとresumeコマンドでリクエストIDが省略された場合に使用されるリクエストIDを指定します。
ここでIDを設定してもその値がexecやpostで使用されるわけではないのでこの変数に値を明示的に設定する必要はありません。
postコマンド実行時にはそのリクエストIDが自動的にこの変数に設定されます。

必須引数	説明
第1引数	任意の文字列をリクエストIDとして指定します。

▲ コマンド一覧へ

set stream

フローの実行時の入力ストリームをファイルから読み込んで設定します。

必須引数	説明
第1引数	設定するストリームのフォーマットを指定します。 NULL以外を指定した場合は第2引数としてファイル名の指定が必要です。 NULLを指定した場合入力ストリームなしです。 BINARY TEXT HTML ParameterList Record CSV FixedLength MIME XML JSON NULL
第2引数	入力ストリームとして設定する外部ファイル名を指定します。 ファイルの内容が指定のストリーム型として正しくない場合はエラーになります。 第1引数が「NULL」の場合は不要です。

//次回のフローの実行の入力ストリームとしてxmldata.xmlを使用する
set stream XML xmldata.xml

▲ コマンド一覧へ

list session

セッションの一覧を表示します。

リストされるアイテム

• セッションID
• 実行ユーザー名
• タイムアウトまでの時間
• Running
  セッションが実行中の場合、Runningと表示されます。

list session

▲ コマンド一覧へ

list project

ログインユーザーのプロジェクト一覧を表示します。
フロー名は表示されません。

リストされるアイテム

• プロジェクトオーナー
• プロジェクト名

list project

▲ コマンド一覧へ

list url

ログインユーザーのプロジェクトでURL実行設定されているフローの一覧を表示します。

リストされるアイテム

• 名前
• URL
• プロジェクト名
• フロー名
• 実行モード
• 実行ユーザー
• 有効／無効

list url

▲ コマンド一覧へ

list soap

ログインユーザーのプロジェクトでSOAP実行設定されているフローの一覧を表示します。

リストされるアイテム

• 名前
• {TargetObjectURI}メソッド名
• プロジェクト名
• フロー名
• 実行モード
• 実行ユーザー
• 有効／無効

list soap

▲ コマンド一覧へ

list ftp

ログインユーザーのプロジェクトでFTP実行設定されているフローの一覧を表示します。

リストされるアイテム

• 名前
• フォルダ(サブフォルダも対象となっている場合は「(*)」が末尾に付加されます)
• プロジェクト名
• フロー名
• 実行モード
• 実行ユーザー
• 有効／無効

list ftp

▲ コマンド一覧へ

list schedule

ログインユーザーのプロジェクトでスケジュール実行設定されているフローの一覧を表示します。
表示されるのはスケジュールのIDのみで詳細は表示されません。

リストされるアイテム

• 名前
• スケジュールID
• プロジェクト名
• フロー名
• 実行モード
• 実行ユーザー
• 有効／無効

list schedule

▲ コマンド一覧へ

list mail

ログインユーザーのプロジェクトでメール監視実行設定されているフローの一覧を表示します。

リストされるアイテム

• 名前
• コネクション名
• プロジェクト名
• フロー名
• 実行モード
• 実行ユーザー
• 有効／無効

list mail

▲ コマンド一覧へ

list queue

ログインユーザーのプロジェクトでキュー監視実行設定されているフローの一覧を表示します。

リストされるアイテム

• 名前
• コネクション名とキュー名
• プロジェクト名
• フロー名
• 実行モード
• 実行ユーザー
• 有効／無効

list queue

▲ コマンド一覧へ

list project-pool

プロジェクトプールにキャッシュされているプロジェクトの一覧を表示します。

リストされるアイテム

• プロジェクトオーナー名
• プロジェクト名

list project-pool

▲ コマンド一覧へ

list function-pool

関数プールにキャッシュされている関数の一覧を表示します。
このメソッドが実行されるとサーバー側で無効な関数のキャッシュはクリアされます。

リストされるアイテム

• 関数オーナー名
• 関数コレクションファイル名
• 関数名

list function-pool

▲ コマンド一覧へ

list connection-pool

コネクションプールにキャッシュされているコネクションの一覧を表示します。
ユーザーコネクションでリストされるのはログインユーザーがオーナーのコネクションだけです。

リストされるアイテム

• オーナー種別(system or user)
• コネクション種別
• コネクション名
• 使用回数
• 最終使用日時

list connection-pool

▲ コマンド一覧へ

list worker

フローの実行スレッドの一覧を表示します。

リストされるアイテム

• スレッド番号
• リクエストID
  フローが実行中でない場合は「wait」と表示されます。
• フロー名
  リクエストされたフロー名
• セッションID
• リクエスト時刻

list worker

▲ コマンド一覧へ

list request

現在実行中およびキューで待機中のリクエストの一覧を表示します。

リストされるアイテム

• リクエストID
• フロー名
  リクエストされたフロー名
• セッションID
• リクエスト時刻
• 状態
  「in queue」「running」「suspend」「end」のいずれか

list request

▲ コマンド一覧へ

list mutex

現在ロック中のMutex一覧を表示します。

リストされるアイテム

• MutexID
• ロック状態
  タイミングによってはfalseと表示されることがありますが基本的にはtrueです

list mutex

▲ コマンド一覧へ

list transaction

トランザクションの一覧を表示します。

リストされるアイテム

• トランザクションID
• 状態
  「Running（実行中）」「RetryWaiting（リトライ待ち）」「Error（エラー）」のいずれか
• トランザクションの最終更新時間

list transaction

▲ コマンド一覧へ

list checkpoint

チェックポイントフローのリクエストの一覧を表示します。
オプション引数を指定することで一覧を絞り込むことができます。

リストされるアイテム

• プロジェクトオーナー名
• プロジェクト名
• フロー名
• 開始日時
• リクエストステータス
  「preparing（実行準備中）」「running（実行中）」「waiting（リトライ待ち）」「success（正常終了）」「error（異常終了）」のいずれか
• チェックポイントステータス
• リクエストID

オプション引数

キーワード	値	説明
-o	あり	リクエストの担当サーバーIDを指定します。
-d	あり	リクエストの開始日付をYYYYMMDDの形式で指定します。 省略時はコマンド実行時の日付になります。
-p	あり	プロジェクト名を指定します。
-f	あり	フロー名を指定します。
-s	あり	リクエストのステータスを指定します。 preparing - 実行準備中 running - 実行中 waiting - リトライ待ち success - 正常終了 error - 異常終了
-pn	あり	一覧のページ番号を指定します。 他の引数を変えずに、ページ番号を変更することで一覧を表示する範囲を変更できます。 省略時は1になります。
-ps	あり	一覧の行数を指定します。 省略時は50になります。

//開始日付が2012年10月5日でリクエストステータスが「error（異常終了）」のリクエストの一覧を表示
list checkpoint -d:20121005 -s:error

▲ コマンド一覧へ

list server

サーバー一覧を表示します。

リストされるアイテム

• サーバーID
• サーバー名

list server

▲ コマンド一覧へ

show project

指定のプロジェクトについて、コンパイルが実行され、フローの一覧とコンパイル結果（OK/NG）が表示されます。

必須引数	説明
第1引数	表示するプロジェクトのプロジェクト名を指定します。

show project Project1

▲ コマンド一覧へ

show session

指定のIDのセッションについて以下の情報が表示されます。

• 規定のタイムアウトまでの時間
• 作成日時
• 実行ユーザー
• タイムアウトまでの時間
• セッション変数(外部変数セット)
• StreamPutコンポーネントでセッションに保存されたストリームの内容

必須引数	説明
第1引数	表示するセッションのセッションIDを指定します。

show session ec1ec684-ce24-4d9f-bb5c-ad0efb76b5da

▲ コマンド一覧へ

show user

指定のユーザーについて、権限、属性情報が表示されます。

必須引数	説明
第1引数	表示するユーザーのユーザー名を指定します。 省略時はログインユーザーの情報が表示されます。

show user

▲ コマンド一覧へ

show worker

指定のWorkerについての情報を表示します。
Workerがフローを実行中でない場合は何も表示されません。
表示する情報はオプションによって変更できます。

必須引数	説明
第1引数	表示するWorkerのスレッド番号を指定します。

オプション引数

キーワード	値	説明
-fv	なし	表示情報に現在実行中のフローのフロー変数を含めます。
-cp	なし	表示情報に現在実行中のコンポーネントのプロパティを含めます。
-stream	なし	表示情報に現在実行中のフローのストリームを含めます。

//すべての情報をつけてWorker2の状態を表示します。
show worker 2 -fv -cp -stream

▲ コマンド一覧へ

show request

指定のRequestについての情報を表示します。
リクエストが実行を完了している場合は何も表示されません。
表示する情報はオプションによって変更できます。

必須引数	説明
第1引数	表示するリクエストのリクエストIDを指定します。 省略時はコンソールの変数「request-id」に設定されるリクエストIDが使用されます。
第2引数	Request情報を取得するためのタイムアウト値を秒単位で指定します。 省略時は5秒が指定されます。

オプション引数

キーワード	値	説明
-fv	なし	表示情報に現在実行中のフローのフロー変数を含めます。
-cp	なし	表示情報に現在実行中のコンポーネントのプロパティを含めます。
-stream	なし	表示情報に現在実行中のフローのストリームを含めます。

//コンソールの変数「request-id」に設定されているリクエストの状態をすべての情報をつけて表示します。
show request -fv -cp -stream

▲ コマンド一覧へ

show transaction

指定のトランザクションについて以下の情報を表示します。
トランザクションがエラーなく完了している場合は何も表示されません。

• ユーザー
• 実行中のフロー
• Xid
• リカバリーファイル名
• ステータスの最終更新時間
• トランザクションアイテムの一覧
• ステータス

必須引数	説明
第1引数	表示するトランザクションのトランザクションIDを指定します。

show transaction 7c9edf5250fa439280d3d72d98feff53

▲ コマンド一覧へ

show checkpoint

チェックポイントフローの指定のリクエストについて以下の情報を表示します。

• リクエストステータス
  「preparing（実行準備中）」「running（実行中）」「waiting（自動リトライ待ち）」「success（正常終了）」「error（異常終了）」のいずれか
• プロジェクト名
• フロー名
• プロジェクトオーナー名
• 開始日時
• チェックポイントステータス
• 終了日時
• 再実行日時
• 再実行時のチェックポイントステータス
• 担当サーバーID
• キュータイプ名
• リトライ数
• 最大リトライ数
• リトライ間隔
• 次回リトライ時刻
• スタートサーバーID
• 他サーバーリトライ

必須引数	説明
第1引数	表示するリクエストのリクエストIDを指定します。

オプション引数

キーワード	値	説明
-d	あり	表示するリクエストの開始日付をYYYYMMDDの形式で指定します。 この引数を指定すると、省略した時よりコマンドの実行が早く完了します。

show checkpoint eedd0d83-ac7a-482d-ae95-aa16c1d87d43 -d:20121005

▲ コマンド一覧へ

clear aac

AACのユーザーキャッシュをクリアします。

clear aac

▲ コマンド一覧へ

clear connection-pool

コネクションプールをクリアします。

clear connection-pool

▲ コマンド一覧へ

clear project-pool

プロジェクトプールをクリアします。

clear project-pool

▲ コマンド一覧へ

upload

指定のファイルをホームフォルダーにアップロードします。
ホームフォルダー下のサブフォルダにファイルをアップロードする場合、事前にサブフォルダを作成しておく必要があります。

必須引数	説明
第1引数	アップロードするファイルのパスを指定します。
第2引数	サーバー側で保存する際に使用するファイル名を指定します。 省略時第1引数で指定したファイル名でホームフォルダー直下に保存されます。 フォルダーを含めて指定することでサブフォルダに保存することもできます。

//abc.txtと言うファイルをdef.txtと言う名前でホームフォルダーにアップロードします。
upload c:\abc.txt def.txt

▲ コマンド一覧へ

timing

コマンドの実行開始から終了までにかかった時間をミリ秒単位で表示します。

必須引数	説明
第1引数	処理時間の計測を有効にするかどうかをon/offで指定します。

//コマンド処理時間を表示するモードに変更
timing on

▲ コマンド一覧へ

script

コマンドを記述した外部ファイルを読み込んで実行します。

必須引数	説明
第1引数	コマンドを記述したスクリプトファイルのパスを指定します。
第2引数	スクリプトファイルのエンコーディングを指定します。 省略時はプラットフォームのエンコーディングです。

//script.txtというスクリプトファイルを実行します
script script.txt

▲ コマンド一覧へ

spool

コンソールの出力結果をファイルに記録します。
ファイルへの書き込みはすべて追加書き込みです。

必須引数	説明
第1引数	出力を行うファイル名またはon/offを指定します。 初回の実行では必ず出力ファイル名を指定しなければなりませんが、 一度出力ファイルが設定された後はoff/onで出力を停止／再開できます。

//flow-ctrl.logというファイルに実行ログを出力します
spool flow-ctrl.log

▲ コマンド一覧へ

alias

ワードの別名を登録します。
コマンドが入力された場合、最初に各単語のエイリアスを変換し、その後プロセッサーに渡されます。
初期状態で「quit」の別名として「exit」が登録されています。

必須引数	説明
第1引数	別名として登録するワードを指定します。
第2引数	別名の対象とするワードを指定します。

//「XMLをテストするフロー」という単語の別名として「xmlTestFlow」を登録します
alias xmlTestFlow XMLをテストするフロー
//alias登録後は「xmlTestFlow」という単語は「XMLをテストするフロー」として扱われます。
exec Project1 xmlTestFlow
//上記execコマンドで実行されるフローは「Project1.XMLをテストするフロー」です。

▲ コマンド一覧へ

unlock mutex

Mutexロックを強制的に解除します

必須引数	説明
第1引数	ロックを解除するMutexのIDを指定します。

unlock mutex /guest.Project1.Flow1

▲ コマンド一覧へ

recover transaction

トランザクションを手動でリカバリーします。

必須引数	説明
第1引数	リカバリーするトランザクションのIDを指定します。

recover transaction 06f6bf2259ff4de5821598bf43e935d4

▲ コマンド一覧へ

xa

XAResourceに対してメソッドを発行します。

必須引数	説明
第1引数	実行するXAResourceのメソッドを指定します。 メソッドは以下のうちのいずれかです。 それぞれのメソッドの詳細な意味についてはXAResourceのJavaDoc を参照してください。 recover end prepare forget commit rollback
第2引数	メソッドを発行するXAResourceのコネクション名(RDBコネクション名)を指定します。
第3引数	メソッドの引数となるXidのGlobalTransactionIdを指定します。 第1引数で指定したメソッドが「recover」の場合は不要です。

オプション引数

キーワード	値	説明
-con	あり	第2引数に指定したコネクションのコネクション種別を指定します。 省略時は「RDBConnection」です。 現在はRDBConnection以外にXAResourceとなるものがないので指定する必要はありません。
-fid	あり	メソッドの引数となるXidのFormatIdを指定します。 省略時はASTERIA Warpのデフォルト値となります。
-bid	あり	メソッドの引数となるXidのBranchQualifierを指定します。 省略時は「0」です。
-flag	あり	第1引数で指定したメソッドが「recover」または「end」の場合にその引数となるフラグを指定します。 指定できる値はXAResourceで定義されている定数「TMxxxx」です。 （「|」で区切ることで複数のフラグを設定できます。） それぞれのメソッドでの省略時のデフォルト値は以下になります。 recover - TMSTARTRSCAN|TMENDRSCAN end - TMSUCCESS
-onePhase	あり	第1引数で指定したメソッドが「commit」場合にそのOnePhase指定をtrue/falseで指定します。 省略時はfalseです。

//フラグを指定してrecoverメソッドを発行
xa recover RDB1 -flag:TMNOFLAGS
//rollbackを発行
xa rollback RDB1 7c9edf5250fa439280d3d72d98feff53

▲ コマンド一覧へ

svn

SVNのバージョン管理のコマンドを発行します。
FSMCのユーザーのバージョン管理設定で、リポジトリのタイプがSVNである場合に使用できます。リポジトリのタイプがGITの場合はgitコマンドを使用してください。
現在サポートされているコマンドは「log」「status」「update」の3つです。

パラメーターやレスポンスの形式はsvnコマンドラインクライアントと同様です。
flow-ctrlのオプションパラメーターは通常「-param:value」のようにパラメーターと値を「:」で区切っていますが、 svnコマンドではsvnコマンドラインクライアントに合わせるため「-param value」のようにスペースで区切る形式もサポートしています。

svn log

履歴を表示します。

必須引数	説明
第1引数	履歴を表示するファイルを指定します。 省略時はホームフォルダーが対象になります。

オプション引数

キーワード	値	説明
-r または --revision	あり	履歴の表示を開始するリビジョンを指定します。 リビジョン番号または日付（yyyy-MM-dd形式）を指定します。 省略時は最新リビジョンからの履歴です。 「-c」とは同時に指定できません。
-q または --quiet	なし	表示が要約のみになります。 指定された場合、コメントを表示しません。
-v または --verbose	なし	表示が詳細表示になります。 指定された場合、変更のあったパスを表示します。
-c または --change	あり	履歴を表示するリビジョンを指定します。 指定された場合はそのリビジョンのみの情報が表示されます。 リビジョン番号または日付（yyyy-MM-dd形式）を指定します。 「-r」とは同時に指定できません。
--stop-on-copy	なし	指定された場合コピー以前の履歴は表示しません。
-l または --limit	あり	表示する履歴の数の最大値を指定します。 省略時は100です。

//dir1の履歴を200件まで変更されたパスを含めて表示
svn log dir1 -l 200 -v

svn status

ファイルの状態を表示します。

必須引数	説明
第1引数	状態を表示するファイルを指定します。 省略時はホームフォルダーが対象になります。

オプション引数

キーワード	値	説明
-u または --show-updates	なし	リポジトリ側の更新情報を表示します。
-q または --quiet	なし	表示が要約のみになります。 指定された場合、管理外のファイルを表示しません。
-v または --verbose	なし	表示が詳細表示になります。 指定された場合、変更のないファイルも表示します。
-N または --non-recursive	なし	指定された場合、子フォルダを対象としません。
--depth	あり	操作の対象の深さを以下のいずれかに限定します。 empty フォルダー自体。その子ファイルは含まない。 files フォルダーとその直接の子ファイル。ただし、直接の子であってもフォルダーは含まない。 immediates フォルダーとその直接の子ファイル。ただし、直接の子であるフォルダーは含むが、その中のファイルは含まない。 infinity フォルダーとそのすべての子ファイル。子フォルダーがある場合はそのすべての子を含む。
--no-ignore	なし	指定された場合無視ファイルも表示されます。

//リポジトリの更新情報も含めて状態を表示
svn status -u

svn statusの出力は以下のフォーマットになります。

出力の最初の 6 列はそれぞれ 1 文字の幅をもっています:
　　 1 列目: 項目が追加や変更あるいはその他の変更を受けたかを示します
　　　　 ' ' 修正はありません
　　　　 'A' 追加されました
　　　　 'C' 競合しています
　　　　 'D' 削除されました
　　　　 'I' 無視されています
　　　　 'M' 修正されました
　　　　 'R' 置換されました
　　　　 'X' 項目はバージョン管理下におかれていませんが外部定義で使われています
　　　　 '?' 項目はバージョン管理下におかれていません
　　　　 '!' 項目は行方不明 （svn 以外のコマンドによって削除された） または不完全です
　　　　 '~' 項目はバージョン管理されていますが、種類の異なる何らかの項目によって妨害されています
　　 2 列目: ファイルまたはフォルダーの属性の修正を示します
　　　　 ' ' 修正はありません
　　　　 'C' 競合しています
　　　　 'M' 修正されました
　　 3 列目: 作業コピーのフォルダーがロックされているかいないかを示します
　　　　 ' ' ロックされていません
　　　　 'L' ロックされています
　　 4 列目: 項目が、過去の履歴と共に追加されるよう準備されているかそうでないかを示します
　　　　 ' ' 項目は、過去の履歴と共に追加されるよう準備されていません
　　　　 '+' 項目は、過去の履歴と共に追加されるよう準備されています
　　 5 列目: svn switch によって、参照する URL を項目の親に対して相対的に切り替えられているかいないかを示します
　　　　 ' ' 通常です
　　　　 'S' 切り替えられています
　　 6 列目: リポジトリロックトークンを示します
　　　 （-u が指定されている場合）
　　　　 ' ' 通常です
　　　　 'K' ロックトークンをもっています
　　　 （-u が指定されていない場合）
　　　　 ' ' リポジトリではロックされておらず、ロックトークンももっていません
　　　　 'K' リポジトリではロックされており、ロックトークンをもっています
　　　　 'O' リポジトリではロックされています。ロックトークンは他の作業コピーがもっています
　　　　 'T' リポジトリではロックされています。ロックトークンはもっていますが、奪われました
　　　　 'B' リポジトリではロックされていません。ロックトークンはもっていますが、破壊されました

　　 作業コピー内の項目がサーバーのリポジトリ側と比べて古くなっていないかに関する情報が 8 列目に表示されます （-u が指定されている場合）:
　　　　 '*' 新しいリビジョンがサーバーに存在します
　　　　 ' ' 作業コピーは最新です

　　 残りのフィールドは可変長で、空白で区切られています:
　　　　 作業中のリビジョン （-u か -v が指定されている場合）
　　　　 最後のコミットのリビジョンおよび変更者 （-v が指定されている場合）
　　　　 作業コピーのパスは常に最後のフィールドとなるので、空白を含められます。

svn update

リポジトリから指定のリビジョンを取得します。

必須引数	説明
第1引数	更新を行うファイルを指定します。 省略時はホームフォルダーが対象になります。

オプション引数

キーワード	値	説明
-r または --revision	あり	取得するリビジョンを指定します。 リビジョン番号または日付（yyyy-MM-dd形式）を指定します。 省略時は最新リビジョンを取得します。
-q または --quiet	なし	表示が要約のみになります。 指定された場合、更新情報を表示しません。
-N または --non-recursive	なし	指定された場合、子フォルダを対象としません。
--depth	あり	操作の対象の深さを以下のいずれかに限定します。 empty フォルダー自体。その子ファイルは含まない。 files フォルダーとその直接の子ファイル。ただし、直接の子であってもフォルダーは含まない。 immediates フォルダーとその直接の子ファイル。ただし、直接の子であるフォルダーは含むが、その中のファイルは含まない。 infinity フォルダーとそのすべての子ファイル。子フォルダーがある場合はそのすべての子を含む。
--force	なし	指定された場合、ローカルで変更のあるファイルも強制的に更新します。

//Project1.xfpをリビジョン100に更新します。
svn update Project1.xfp -r 100

▲ コマンド一覧へ

git

GITのバージョン管理のコマンドを発行します。
FSMCのユーザーのバージョン管理設定で、リポジトリのタイプがGITである場合に使用できます。リポジトリのタイプがSVNの場合はsvnコマンドを使用してください。
現在サポートされているコマンドは「log」「status」「update」「stash list」「stash delete」の5つです。

git log

履歴を表示します。

必須引数	説明
第1引数	履歴を表示するファイルを指定します。 省略時はホームフォルダーが対象になります。

オプション引数

キーワード	値	説明
-r または --revision	あり	履歴の表示を開始するリビジョンを指定します。 リビジョンのコミットのハッシュ文字列または日付（yyyy-MM-dd形式）を指定します。 省略時は最新リビジョンからの履歴です。 「-c」とは同時に指定できません。
-q または --quiet	なし	表示が要約のみになります。 指定された場合、コメントを表示しません。
-v または --verbose	なし	表示が詳細表示になります。 指定された場合、変更のあったパスを表示します。
-c または --change	あり	履歴を表示するリビジョンを指定します。 指定された場合はそのリビジョンのみの情報が表示されます。 リビジョンのコミットのハッシュ文字列または日付（yyyy-MM-dd形式）を指定します。 「-r」とは同時に指定できません。
--stop-on-copy	なし	指定された場合コピー以前の履歴は表示しません。
-l または --limit	あり	表示する履歴の数の最大値を指定します。 省略時は100です。

//dir1の履歴を200件まで変更されたパスを含めて表示
git log dir1 -l 200 -v

git status

ファイルの状態を表示します。

必須引数	説明
第1引数	状態を表示するファイルを指定します。 省略時はホームフォルダーが対象になります。

オプション引数

キーワード	値	説明
-u または --show-updates	なし	リポジトリ側の更新情報を表示します。
-q または --quiet	なし	表示が要約のみになります。 指定された場合、管理外のファイルを表示しません。
-v または --verbose	なし	表示が詳細表示になります。 指定された場合、変更のないファイルも表示します。
-N または --non-recursive	なし	指定された場合、子フォルダを対象としません。
--depth	あり	操作の対象の深さを以下のいずれかに限定します。 empty フォルダー自体。その子ファイルは含まない。 files フォルダーとその直接の子ファイル。ただし、直接の子であってもフォルダーは含まない。 immediates フォルダーとその直接の子ファイル。ただし、直接の子であるフォルダーは含むが、その中のファイルは含まない。 infinity フォルダーとそのすべての子ファイル。子フォルダーがある場合はそのすべての子を含む。
--no-ignore	なし	指定された場合無視ファイルも表示されます。

//リポジトリの更新情報も含めて状態を表示
git status -u

git statusの出力は以下のフォーマットになります。

出力の最初の 6 列はそれぞれ 1 文字の幅をもっています:
　　 1 列目: 項目が追加や変更あるいはその他の変更を受けたかを示します
　　　　 ' ' 修正はありません
　　　　 'A' 追加されました
　　　　 'C' 競合しています
　　　　 'D' 削除されました
　　　　 'I' 無視されています
　　　　 'M' 修正されました
　　　　 '?' 項目はバージョン管理下におかれていません
　　　　 '!' 項目は行方不明（ユーザーのホームフォルダーからは削除されていますがGITサーバー上では削除されていません）
　　 2 列目: ファイルまたはフォルダーの属性の修正を示します
　　　　 ' ' 修正はありません
　　　　 'C' 競合しています
　　　　 'M' 修正されました
　　 3 列目: 作業コピーのフォルダーがロックされているかいないかを示します
　　　　 ' ' ロックされていません
　　　　 'L' ロックされています
　　 4 列目: 空欄
　　 5 列目: 空欄
　　 6 列目: リポジトリロックトークンを示します
　　　 （-u が指定されている場合）
　　　　 ' ' 通常です
　　　　 'K' ロックトークンをもっています
　　　 （-u が指定されていない場合）
　　　　 ' ' リポジトリではロックされておらず、ロックトークンももっていません
　　　　 'K' リポジトリではロックされており、ロックトークンをもっています
　　　　 'O' リポジトリではロックされています。ロックトークンは他の作業コピーがもっています
　　　　 'T' リポジトリではロックされています。ロックトークンはもっていますが、奪われました
　　　　 'B' リポジトリではロックされていません。ロックトークンはもっていますが、破壊されました

　　 作業コピー内の項目がサーバーのリポジトリ側と比べて古くなっていないかに関する情報が 8 列目に表示されます （-u が指定されている場合）:
　　　　 '*' 新しいリビジョンがサーバーに存在します
　　　　 ' ' 作業コピーは最新です

　　 残りのフィールドは可変長で、空白で区切られています:
　　　　 作業中のリビジョン （-u か -v が指定されている場合）
　　　　 最後のコミットのリビジョンおよび変更者 （-v が指定されている場合）
　　　　 作業コピーのパスは常に最後のフィールドとなるので、空白を含められます。

git update

リポジトリから指定のリビジョンを取得します。

オプション引数

キーワード	値	説明
-r または --revision	あり	取得するリビジョンを指定します。 リビジョンのコミットのハッシュ文字列または日付（yyyy-MM-dd形式）を指定します。 省略時は最新リビジョンを取得します。
-q または --quiet	なし	表示が要約のみになります。 指定された場合、更新情報を表示しません。

// ホームフォルダーをリビジョン 6e38f2d4 に更新
git update -r 6e38f2d4

git stash list

すべてのGitスタッシュの一覧を表示します。
フローデザイナー以外の外部のツールで作成されたGitスタッシュも表示されます。
フローデザイナーによって作成されたGitスタッシュの説明は「aswarp_stash」となっています。

// すべてのGitスタッシュを表示
git stash list

結果は次のような形式で出力されます。

sta:<ハッシュ値> <説明> <日付>

例）

sta:38a4fe5a aswarp_stash 20220118
sta:7ec428b2 WIP on master: 3a3e2f6 feature commit 20211210

git stash delete

指定されたGitスタッシュを削除します。

必須引数	説明
第1引数	削除するGitスタッシュのハッシュ値

// ハッシュ値 38a4fe5a のGitスタッシュを削除
git stash delete 38a4fe5a

指定されたハッシュ値のスタッシュが存在して削除された場合は、結果が出力されます。
指定されたハッシュ値のスタッシュが存在しなかった場合は、結果は出力されません。

▲ コマンド一覧へ

service status

フローサービスの状態（Enabled：有効 / Disabled：無効）を表示します。

>service status
Enabled