インフォテリア株式会社

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

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

起動方法

flow-ctrlの実行ファイルは[INSTALL_DIR]/flow/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:\Documents and Settings\ユーザー名
    (Vistaの場合はC:\Users\ユーザー名)

コマンドの使い方

凡例

コマンドとキーワード

概要説明

引数 引数の意味 または使用可能なワード
区分 必須またはプレフィクス
説明 説明

必須の引数は標準版で指定する必要があります。
オプションの引数は必須引数の後ろに順不同で指定することができます。
プレフィクスがある場合は「-username:guest」のように「プレフィクス:」に続けて指定します。

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

コマンド一覧

コマンド説明
connect ログイン
user ユーザー名
quit flow-ctrlの終了
regist project プロジェクトの登録
regist url URL実行設定
regist soap SOAP実行設定
regist schedule 一度だけ実行するスケジュールの登録
regist interval 指定間隔で実行するスケジュールの登録
regist daily 毎日実行するスケジュールの登録
regist weekly 毎週実行するスケジュールの登録
regist monthly 毎月実行するスケジュールの登録
unregist project プロジェクトの登録解除
unregist url URL実行設定解除
unregist soap SOAP実行設定解除
unregist schedule スケジュール実行設定解除
export 実行設定のエクスポート
import 実行設定のインポート
exec フローの実行
post フローのポスト
resume フローの再開
kill request フローの強制終了
set session セッションIDの設定
set request-id リクエストIDの設定
set stream フローの入力ストリームの設定
list session セッション一覧の表示
list project プロジェクト一覧の表示
list url URL実行設定一覧の表示
list schedule Schedule実行設定一覧の表示
list soap SOAP実行設定一覧の表示
list project-pool プロジェクトプール一覧の表示
list worker Worker一覧の表示
list request リクエスト一覧の表示
list mutex Mutex一覧の表示
list transaction トランザクション一覧の表示
show project プロジェクト詳細の表示
show session セッション詳細の表示
show user ユーザー詳細の表示
show worker Worker状態の表示
show request Request状態の表示
show transaction トランザクション状態の表示
clear aac AACキャッシュのクリア
clear connection-pool コネクションプールのクリア
clear project-pool プロジェクトプールのクリア
upload ファイルのアップロード
timing コマンド実行時間の計測
script コマンドスクリプトを実行
spool コンソールのファイル出力
alias ワードの別名登録
unlock mutex Mutexロックの解除
xa XAResourceに対するコマンドの発行
version バージョン情報
help ヘルプ

connect

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

引数 区分 説明
ユーザー名 必須
パスワード
// /FlowService/guestとして接続
connect /FlowService/guset password

▲ コマンド一覧へ

user

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

user

▲ コマンド一覧へ

quit

flow-ctrlを終了します。

quit

▲ コマンド一覧へ

regist project

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

引数 区分 説明
プロジェクトファイル名 必須 登録するプロジェクトのxfpファイル名。
-s
//サーバー上に既に存在するProject1.xfpを登録
regist project Project1.xfp -s
//ホームディレクトリのサブフォルダ「test」下に存在するProject2.xfpを登録
regist project test/Project2.xfp -s

▲ コマンド一覧へ

regist url

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

引数 区分 説明
プロジェクト名 必須 プロジェクト名
フロー名 必須 フロー名
URL 必須 実行設定するURL。
フロー実行URLのコンテキストパスに続く部分を指定する。
normal|debug|profile -mode
実行ユーザー名 -user
パスワード -password
//Flow1をデバッグモードで「/FLow1」と関連付ける
regist url Project1 Flow1 /Flow1 -mode:debug

▲ コマンド一覧へ

regist soap

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

引数 区分 説明
プロジェクト名 必須 プロジェクト名
フロー名 必須 フロー名
メソッド名 必須 実行設定するSOAPのメソッド名。
SOAPのTargetObjectURIは「urn:asteria-service-flowservice」になります。
normal|debug|profile -mode
実行ユーザー名 -user
パスワード -password
regist soap Project1 Flow2 Method1

▲ コマンド一覧へ

regist schedule

開始日のみのスケジュール実行設定を行います。

引数 区分 説明
プロジェクト名 必須 プロジェクト名
フロー名 必須 フロー名
DateTime 必須 スケジュールを実行する日時を指定します。
日時の書式はフローのDateTime型と同じです。
normal|debug|profile -mode
実行ユーザー名 -user
パスワード -password
休日設定名 -holiday
Skip|Plus|Minus -holidayaction
//Flow3を2003年5月5日正午にスケジュール
regist schedule Project1 Flow3 2003-05-05T12:00:00

▲ コマンド一覧へ

regist interval

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

引数 区分 説明
プロジェクト名 必須 プロジェクト名
フロー名 必須 フロー名
[[HH:]MM:]SS 必須 スケジュールの実行間隔を指定します。
例えば1時間10分5秒なら「1:10:5」のように「:」で区切って指定します。
「1000」のようにすべて秒で指定することも可能です。
normal|debug|profile -mode
実行ユーザー名 -user
パスワード -password
休日設定名 -holiday
Skip|Plus|Minus -holidayaction
DateTime -startdate
DateTime -enddate
//Flow4を2時間30分おきに実行
regist interval Project1 Flow4 2:30:00

▲ コマンド一覧へ

regist daily

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

引数 区分 説明
プロジェクト名 必須 プロジェクト名
フロー名 必須 フロー名
HH:MM:SS 必須 スケジュールを実行する時刻を指定します。
書式は時、分、秒を「:」で区切る形式となります。
normal|debug|profile -mode
実行ユーザー名 -user
パスワード -password
休日設定名 -holiday
Skip|Plus|Minus -holidayaction
DateTime -startdate
DateTime -enddate
//Flow5を2003年5月の間毎日正午に実行
regist daily Project1 Flow5 12:00:00 -startdate:2003-05-01T00:00:00 -enddate:2003-06-01T00:00:00

▲ コマンド一覧へ

regist weekly

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

引数 区分 説明
プロジェクト名 必須 プロジェクト名
フロー名 必須 フロー名
HH:MM:SS 必須 スケジュールを実行する時刻を指定します。
書式は時、分、秒を「:」で区切る形式となります。
SUN|MON|TUE|WED|THU|FRI|SAT -w
normal|debug|profile -mode
実行ユーザー名 -user
パスワード -password
休日設定名 -holiday
Skip|Plus|Minus -holidayaction
DateTime -startdate
DateTime -enddate
//Flow6を毎週月曜と火曜の正午に実行
regist weekly Project1 Flow6 12:00:00 -w:MON -w:TUE

▲ コマンド一覧へ

regist monthly

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

引数 区分 説明
プロジェクト名 必須 プロジェクト名
フロー名 必須 フロー名
HH:MM:SS 必須 スケジュールを実行する時刻を指定します。
書式は時、分、秒を「:」で区切る形式となります。
実行日 -d
normal|debug|profile -mode
実行ユーザー名 -user
パスワード -password
休日設定名 -holiday
Skip|Plus|Minus -holidayaction
DateTime -startdate
DateTime -enddate
//Flow7を毎月5日、15日、25日の正午に実行
regist monthly Project1 Flow7 12:00:00 -d:5 -d:15 -d:25

▲ コマンド一覧へ

unregist project

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

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

▲ コマンド一覧へ

unregist url

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

引数 区分 説明
プロジェクト名 必須 プロジェクト名
フロー名 必須 フロー名
URL 必須 実行設定を解除するURL。
//「/Test1」というURLに対する実行設定の解除
unregist url Project1 Flow1 /Test1

▲ コマンド一覧へ

unregist soap

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

引数 区分 説明
プロジェクト名 必須 プロジェクト名
フロー名 必須 フロー名
メソッド名 必須 実行設定を解除するSOAPのメソッド名。
//「Method1」というメソッドに対する実行設定の解除
unregist soap Project1 Flow1 Method1

▲ コマンド一覧へ

unregist schedule

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

引数 区分 説明
プロジェクト名 必須 プロジェクト名
フロー名 必須 フロー名
スケジュールID 必須 実行設定を解除するスケジュールのID。
//IDに対応するスケジュールの解除
unregist schedule Project1 Flow1 0eb3b70243c44dad9d3397806f44ad23.scx

▲ コマンド一覧へ

export

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

引数 区分 説明
エクスポートファイル名 必須 エクスポートファイル名
//実行設定のエクスポート
export project.xml

▲ コマンド一覧へ

import

実行設定ファイルからユーザーのプロジェクト情報と実行設定をインポートします。

引数 区分 説明
インポートファイル名 必須 インポートファイル名
//実行設定のインポート
import project.xml

▲ コマンド一覧へ

exec

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

引数 区分 説明
プロジェクト名 必須
フロー名 必須
normal|debug|profile -mode
ファイル名 -output
パラメータ名=値 -p
-set
//引数を指定してFlow1をプロファイルモードで実行
exec Project1 Flow1 -mode:profile -p:param1=v1 -p:param2=v2

▲ コマンド一覧へ

post

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

引数 区分 説明
プロジェクト名 必須
フロー名 必須
normal|debug|profile -mode
パラメータ名=値 -p
-suspend
//Flow1を実行して開始直後にサスペンド状態にする
post Project1 Flow1 -suspend

▲ コマンド一覧へ

resume

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

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

▲ コマンド一覧へ

kill request

実行中のフローを強制終了します。
フローの強制終了はコンポーネントから次のコンポーネントに制御が移るタイミングで実行されるので、 ひとつのコンポーネントの処理が長時間かかるような場合にはすぐには終了しないことがあります。
強制終了に成功した場合は最後に実行されたコンポーネント名が表示されます。

引数 区分 説明
リクエストID 必須 強制終了するリクエストのリクエストID
このコマンドではリクエストIDの省略はできません。
タイムアウト
//指定のリクエストを強制終了します。10秒待っても終了しない場合は制御が戻ります。
kill request 6e8e4181-700f-4cf0-9274-e83be63184ae 10

▲ コマンド一覧へ

set session

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

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

▲ コマンド一覧へ

set request-id

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

引数 区分 説明
リクエストID

▲ コマンド一覧へ

set stream

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

引数 区分 説明
BINARY|TEXT|HTML|ParameterList|Record|CSV|FixedLength|MIME|XML|NULL 必須 設定するストリームのフォーマットを指定します。
NULL以外を指定した場合はオプションとしてファイル名の指定が必要です。
NULLを指定した場合入力ストリームなしになります。
ファイル名
//次回のフローの実行の入力ストリームとしてxmldata.xmlを使用する
set stream XML xmldata.xml

▲ コマンド一覧へ

list session

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

リストされるアイテム

list session

▲ コマンド一覧へ

list project

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

リストされるアイテム

list project

▲ コマンド一覧へ

list url

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

リストされるアイテム

list url

▲ コマンド一覧へ

list schedule

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

リストされるアイテム

list schedule

▲ コマンド一覧へ

list soap

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

リストされるアイテム

list soap

▲ コマンド一覧へ

list project-pool

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

リストされるアイテム

list project-pool

▲ コマンド一覧へ

list worker

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

リストされるアイテム

list worker

▲ コマンド一覧へ

list request

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

リストされるアイテム

list request

▲ コマンド一覧へ

list mutex

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

リストされるアイテム

list mutex

▲ コマンド一覧へ

list transaction

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

リストされるアイテム

list transaction

▲ コマンド一覧へ

show project

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

引数 区分 説明
プロジェクト名 必須 プロジェクト名
show project Project1

▲ コマンド一覧へ

show session

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

引数 区分 説明
セッションID 必須 セッションID
show session ec1ec684-ce24-4d9f-bb5c-ad0efb76b5da

▲ コマンド一覧へ

show user

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

show user

▲ コマンド一覧へ

show worker

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

引数 区分 説明
No 必須 表示するWorkerのスレッド番号
-fv
-cp
-stream
//すべての情報をつけてWorker2の状態を表示します。
show worker 2 -fv -cp -stream

▲ コマンド一覧へ

show request

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

引数 区分 説明
リクエストID
-fv
-cp
-stream
//Set変数「request-id」に設定されているリクエストの状態をすべての情報をつけて表示します。
show request -fv -cp -stream

▲ コマンド一覧へ

show transaction

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

引数 区分 説明
トランザクションID 必須
show transaction 7c9edf5250fa439280d3d72d98feff53

▲ コマンド一覧へ

clear aac

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

clear aac

▲ コマンド一覧へ

clear connection-pool

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

clear connection-pool

▲ コマンド一覧へ

clear project-pool

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

clear project-pool

▲ コマンド一覧へ

upload

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

引数 区分 説明
ファイル名 必須 アップロードするファイルのパス。
サーバーファイル名
//abc.txtと言うファイルをdef.txtと言う名前でホームディレクトリにアップロードします。
upload abc.txt def.txt

▲ コマンド一覧へ

timing

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

引数 区分 説明
on|off 必須 onにするとコマンド実行後に処理時間が表示されます。
//コマンド処理時間を表示するモードに変更
timing on

▲ コマンド一覧へ

script

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

引数 区分 説明
ファイル名 必須 コマンドを記述したスクリプトファイル名
エンコーディング
//script.txtというスクリプトファイルを実行します
script script.txt

▲ コマンド一覧へ

spool

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

引数 区分 説明
on|off|ファイル名 必須 出力ファイル名を指定します。
ファイル名を指定した後はon, offで出力を停止再開できます。
//flow-ctrl.logというファイルに実行ログを出力します
spool flow-ctrl.log

▲ コマンド一覧へ

alias

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

引数 区分 説明
WORD1 必須 別名として登録するワード。
WORD2 必須 別名の対象とするワード。
//「XMLをテストするフロー」という単語の別名として「xmlTestFlow」を登録します
alias xmlTestFlow XMLをテストするフロー

▲ コマンド一覧へ

unlock mutex

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

引数 区分 説明
MutexID 必須 list mutexで表示されるID
unlock mutex /guest.Project1.Flow1

▲ コマンド一覧へ

xa

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

引数 区分 説明
メソッド 必須 実行するXAResourceのメソッド
以下のうちのいずれか
  • recover
  • end
  • prepare
  • forget
  • commit
  • rollback
それぞれのメソッドの詳細な意味についてはXAResourceのJavaDoc を参照してください。
コネクション 必須 メソッドを発行するXAResource(コネクション)の定義名
トランザクションID recover以外は必須 メソッドの引数となるXidのGlobalTransactionId
recoverメソッド以外では必須
コネクション種別 -con 第一引数に指定したコネクションのコネクション種別
省略時はRDBConnection
フォーマットID -fid メソッドの引数となるXidのFormatId
省略時はASTERIA WARPのデフォルト値
ブランチID -bid メソッドの引数となるXidのBranchQualifier
省略時は「0」
フラグ -flag recoverメソッドとendメソッドの引数となるフラグ
指定できる値はXAResourceで定義されているTMxxxx
(「|」で区切ることで複数のフラグを設定できます。)
省略時のデフォルトは以下
  • recover - TMSTARTRSCAN|TMENDRSCAN
  • end - TMSUCCESS
true|false -onePhase commitメソッドのonePhase指定
省略時はfalse
//フラグを指定してrecoverメソッドを発行
xa recover RDB1 -flag:TMNOFLAGS
//rollbackを発行
xa rollback RDB1 7c9edf5250fa439280d3d72d98feff53

▲ コマンド一覧へ

version

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

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

▲ コマンド一覧へ

help

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

引数 区分 説明
コマンド名
//execコマンドのヘルプを表示します。
help exec
 

▲ このページのトップへ