1.4.1 swrba_admin(管理コマンド)

機能説明

本コマンドを使用することで、Webコンソールを使用せずに以下の操作を行うことができます。

自動運用プロセスグループの登録と更新
プロセス定義の登録と更新
プロセス定義の検索と表示
プロセス定義の公開
プロセスの起動
プロセスインスタンスの検索
プロセスインスタンスの詳細情報取得
プロセスインスタンスの削除

記述形式

自動運用プロセスグループを登録する場合

swrba_admin app-add -user ユーザーID -file Barファイル

自動運用プロセスグループを更新する場合

swrba_admin app-update -user ユーザーID -file Barファイル

プロセス定義を登録する場合

swrba_admin pd-add -user ユーザーID -file プロセス定義ファイル -appid 自動運用プロセスグループID

プロセス定義を更新する場合

swrba_admin pd-update -user ユーザーID -file プロセス定義ファイル -appid 自動運用プロセスグループID

プロセス定義を公開する場合

swrba_admin pd-publish -user ユーザーID -appid 自動運用プロセスグループID -pdname プロセス定義名 [-version プロセス定義のバージョン]

プロセス定義を検索する場合

swrba_admin pd-list -user ユーザーID [-state {draft|published|obsolete}] [-appid 自動運用プロセスグループID] [-pdname プロセス定義名,... [-namematch {forward|backward}]]

プロセス定義を起動する場合

swrba_admin pi-start -user ユーザーID -appid 自動運用プロセスグループID -pdname プロセス定義名 [-version プロセス定義のバージョン] [-paramfile パラメーターファイル]

プロセスインスタンスを検索する場合

swrba_admin pi-list -user ユーザーID [-startedafter yyyy-mm-dd] [-startedbefore yyyy-mm-dd] [-state {running|closed|suspended|aborted|created|error}] [-piid プロセスインスタンスID] [-pdname プロセス定義名,... [-namematch {forward|backward}]] [-initiator プロセス起動ユーザーID] [-appid 自動運用プロセスグループID]

プロセスインスタンスの詳細情報を取得する場合

swrba_admin pi-get -user ユーザーID -d 出力ディレクトリ [-startedafter yyyy-mm-dd] [-startedbefore yyyy-mm-dd] [-state {running|closed|suspended|aborted|created|error}] [-piid プロセスインスタンスID] [-pdname プロセス定義名,... [-namematch {forward|backward}]] [-initiator プロセス起動ユーザーID] [-appid 自動運用プロセスグループID]

プロセスインスタンスを削除する場合

swrba_admin pi-delete -user ユーザーID {[-startedafter yyyy-mm-dd] [-startedbefore yyyy-mm-dd] [-state {running|closed|suspended|aborted|created|error}] [-piid プロセスインスタンスID] [-pdname プロセス定義名,... [-namematch {forward|backward}]] [-initiator プロセス起動ユーザーID] [-appid 自動運用プロセスグループID]}

-userを省略することでユーザーIDをパラメーターから省略することも可能です。パラメーターにユーザーIDが設定されていない場合は、コマンド実行後にユーザーIDの入力が求められます。

-passwordを指定することでパスワードをパラメーターとして設定することも可能です。パラメーターにパスワードが設定されていない場合は、コマンド実行後にパスワード入力が求められます。

オプション

以下の各オプションは、それぞれ同時に指定することはできません。

app-add

自動運用プロセスグループの登録を行います。

-file Barファイル: 登録するBarファイルのパスを指定します。すでに同一名の自動運用プロセスグループが登録されている場合はエラーとなります。正常に登録が完了すると自動運用プロセスグループは自動的にオンラインになります。

app-update

自動運用プロセスグループの更新を行います。

-file Barファイル

更新するBarファイルのパスを指定します。指定した自動運用プロセスグループが存在しない場合はエラーとします。

なお、自動運用プロセスグループ更新中は自動運用プロセスグループの状態がオフラインとなります。オフラインの間は自動運用プロセスグループ所有者以外にはプロセス定義が参照できなくなります。また、プロセスの起動もできません。自動運用プロセスグループの状態は、更新終了後に自動的にオンラインになります。

pd-add

プロセス定義の登録を行います。

-file プロセス定義ファイル: プロセス定義の登録を行います。同じ名前のプロセス定義が指定した自動運用プロセスグループ内に存在する場合や、指定した自動運用プロセスグループが存在しない場合はエラーとなります。プロセス定義は登録完了後にドラフト状態となります。また、自動運用プロセスグループIDを指定しない場合は、エラーとなります。

-appid 自動運用プロセスグループID: プロセス定義を格納するための自動運用プロセスグループIDを指定します。指定したIDの自動運用プロセスグループが存在しない場合はエラーとなります。

pd-update

プロセス定義の更新を行います。

-file プロセス定義ファイル

プロセス定義の更新を行います。指定したプロセス定義が存在しない場合はエラーとなります。プロセス定義はドラフト状態として登録されます。

また、プロセス定義の更新が完了しても、すでに起動しているプロセスインスタンスには反映されません。更新したプロセス定義が公開されたあとに起動されたプロセスより、更新内容が有効になります。

- appid 自動運用プロセスグループID: プロセス定義を格納するための自動運用プロセスグループIDを指定します。指定したIDの自動運用プロセスグループが存在しない場合はエラーとなります。

pd-publish

プロセス定義の公開を行います。

- appid 自動運用プロセスグループID: 自動運用プロセスグループIDを指定します。指定した自動運用プロセスグループが存在しない場合はエラーとなります。

-pdname プロセス定義名: プロセス定義名を指定します。指定したプロセス定義が存在しない場合はエラーとなります。

-version プロセス定義のバージョン

プロセス定義のバージョンを指定します。指定したバージョンが存在しない場合はエラーとなります。

本オプションが指定されていない場合は最新バージョンを公開します。また、すでに公開済みのバージョンが指定された場合はエラーとなります。

pd-list

プロセス定義を検索し、リスト形式で表示します。どのパラメーターも設定しない場合は全プロセス定義を対象に検索します。以下に指定できるパラメーターを示します。

-state プロセス定義の状態

プロセス定義の状態を指定します。本オプションを指定しない場合はすべての状態が検索対象となります。状態には以下を指定してください。

draft : ドラフト状態のプロセス定義を検索します。
published : 公開状態のプロセス定義を検索します。
obsolete : 廃止されたプロセス定義を検索します。

複数指定する場合は、カンマ（,）区切りで指定してください。

- appid 自動運用プロセスグループID: 自動運用プロセスグループIDを指定します。

-pdname プロセス定義名: プロセス定義名を指定します。

-namematch forward|backward: プロセス定義名の検索パターンを指定します。前方一致、後方一致いずれかを選択してください。何も指定しない場合は、完全一致となります。

pi-start

プロセスを起動します。

- appid 自動運用プロセスグループID: 自動運用プロセスグループIDを指定します。指定した自動運用プロセスグループが存在しない場合はエラーとなります。

-pdname プロセス定義名: プロセス定義名を指定します。指定したプロセス定義が存在しない場合はエラーとなります。

-version プロセス定義のバージョン

プロセス定義のバージョンを指定します。指定したバージョンが存在しない場合はエラーとなります。

本オプションが指定されていない場合は最新バージョンを起動します。

-paramfile パラメーターファイル名

起動するプロセスに必要なパラメーターを記述したファイル名を指定します。ファイルには、以下の内容を記述します。

UDA名=値
…

ファイルの記述形式は、一般的なJavaのプロパティの形式です。

指定されたUDAに、値を設定しプロセスを起動します。指定されたUDAが存在しない場合はエラーとなります。また、使用できる値の形式はSTRING型のみとなります。指定されたファイルの文字コードがUTF-8ではない場合、エラーとなります。

公開したプロセス定義と本コマンドの実行者に属するプロセス定義を起動できます。

pi-list

プロセスインスタンスを検索し、リスト形式で表示します。どのパラメーターも設定しない場合は全件検索となります。以下に指定できるパラメーターを示します。

-startedafter 開始日

プロセスが起動された期間の開始日を指定します。以下の形式で指定してください。

yyyy-mm-dd

-startedbefore 終了日

プロセスが起動された期間の終了日を指定します。以下の形式で指定してください。

yyyy-mm-dd

-startedafterのみを指定した場合は、指定された日付から現在までの期間で検索します。-startedbeforeのみを指定した場合は、指定された日付までの期間で検索します。上記以外の形式で指定された場合や開始日と終了日の関係が不正な場合はエラーとなります。

-piid プロセスインスタンスID: プロセスインスタンスIDを指定します。

-state プロセス定義の状態

プロセス定義の状態を指定します。本オプションを指定しない場合はすべての状態が検索対象となります。状態には以下を指定してください。

running
closed
suspended
aborted
created
error

複数指定する場合は、カンマ（,）区切りで指定してください。

- pdname プロセス定義名

プロセス定義名を指定します。複数指定する場合は、カンマ（,）区切りで指定してください。

また、本オプションには以下のパラメーターを使用し詳細な条件を設定することが可能です。

-namematch forward|backward: プロセス定義名の検索パターンを指定します。前方一致、後方一致いずれかを選択してください。何も指定しない場合は、完全一致となります。

- appid 自動運用プロセスグループID: 検索対象となる自動運用プロセスグループIDを指定します。本オプションが指定されない場合は全自動運用プロセスグループを対象として検索します。

-initiator プロセス起動ユーザーID: プロセスを起動したユーザーIDを指定します。複数指定する場合はカンマ区切り（,）で指定してください。

pi-get

プロセスインスタンスを検索し、詳細情報を取得します。どのパラメーターも設定しない場合は全件検索となります。以下に指定できるパラメーターを示します。

-d 出力ディレクトリ

出力ディレクトリを指定します。出力内容と構成は以下のとおりです。

- 自動運用プロセスグループID
    - プロセスインスタンスID
        - プロセスインスタンスID.xml   : プロセスインスタンス詳細情報ファイルです。
        - attachmentsfilesディレクトリ : プロセスインスタンスに添付された文書が格納されます。

プロセスインスタンス詳細情報ファイルの詳細は、“2.4 プロセスインスタンス詳細情報ファイル”を参照してください。

-startedafter 開始日

プロセスが起動された期間の開始日を指定します。以下の形式で指定してください。

yyyy-mm-dd

-startedbefore 終了日

プロセスが起動された期間の終了日を指定します。以下の形式で指定してください。

yyyy-mm-dd

-piid プロセスインスタンスID: プロセスインスタンスIDを指定します。

-state プロセス定義の状態

プロセス定義の状態を指定します。本オプションを指定しない場合はすべての状態が検索対象となります。状態には以下を指定してください。

running
closed
suspended
aborted
created
error

複数指定する場合は、カンマ（,）区切りで指定してください。

- pdname プロセス定義名

プロセス定義名を指定します。複数指定する場合は、カンマ（,）区切りで指定してください。また、本オプションには以下のパラメーターを使用し詳細な条件を設定することが可能です。

-namematch forward|backward: プロセス定義名の検索パターンを指定します。前方一致、後方一致いずれかを選択してください。何も指定しない場合は、完全一致となります。

- appid 自動運用プロセスグループID: 検索対象となる自動運用プロセスグループIDを指定します。本オプションが指定されない場合は全自動運用プロセスグループを対象として検索します。

-initiator プロセス起動ユーザーID: プロセスを起動したユーザーIDを指定します。複数指定する場合はカンマ区切り（,）で指定してください。

pi-delete

プロセスインスタンスを削除します。

-startedafter 開始日

プロセスが起動された期間の開始日を指定します。以下の形式で指定してください。

yyyy-mm-dd

-startedbefore 終了日

プロセスが起動された期間の終了日を指定します。以下の形式で指定してください。

yyyy-mm-dd

-state プロセス定義の状態

プロセス定義の状態を指定します。本オプションを指定しない場合はすべての状態が検索対象となります。状態には以下を指定してください。

running
closed
suspended
aborted
created
error

複数指定する場合は、カンマ（,）区切りで指定してください。

-piid プロセスインスタンスID: プロセスインスタンスIDを指定します。

- pdname プロセス定義名

-namematch forward|backward: プロセス定義名の検索パターンを指定します。前方一致、後方一致いずれかを選択してください。何も指定しない場合は、完全一致となります。

- appid 自動運用プロセスグループID: 検索対象となる自動運用プロセスグループIDを指定します。本オプションが指定されない場合は全自動運用プロセスグループを対象として検索します。

-initiator プロセス起動ユーザーID: プロセスを起動したユーザーIDを指定します。複数指定する場合はカンマ区切り（,）で指定してください。

復帰値

復帰値	意味
0	正常終了
1	パラメーターエラー
2	認証エラー
3	管理サーバでのエラー
4	内部エラー
5	権限エラー
6	ファイル入出力エラー
不定	強制終了

コマンド格納場所

【Windows】

[Systemwalker Runbook Automation管理サーバのインストールディレクトリ]\bin
※デフォルトの場合はC:\Fujitsu\Systemwalker\SWRBAM

【Linux】

/opt/FJSVswrbam/bin

実行に必要な権限/実行環境

【Windows】

Administrator権限が必要です。Windows Server 2008の場合、管理者として実行してください。
管理サーバで実行可能です。
Webコンソールにログインできる利用者のみが実行できます。
以下の操作を行う場合はWebコンソールにログインできる利用者でかつ管理者権限が必要です。
- 自動運用プロセスグループを登録・更新する場合
- プロセスインスタンスを削除する場合
- プロセス定義を公開する場合
また、上記のユーザーの場合、すべてのプロセス定義およびプロセスインスタンスが検索できます。

【Linux】

システム管理者(スーパーユーザー)のみが実行できます。
管理サーバで実行可能です。
Webコンソールにログインできる利用者のみが実行できます。
以下の操作を行う場合はWebコンソールにログインできる利用者でかつ管理者権限が必要です。
- 自動運用プロセスグループを登録・更新する場合
- プロセスインスタンスを削除する場合
- プロセス定義を公開する場合
また、上記のユーザーの場合、すべてのプロセス定義およびプロセスインスタンスが検索できます。

注意事項

Barファイルについて
Barファイルは、Systemwalker Runbook Automation StudioかWebコンソールからエクスポートした、拡張子が.bar形式のファイルである必要があります。それ以外のファイルを指定した場合はエラーとなります。
プロセス定義ファイルについて
プロセス定義ファイルは、Systemwalker Runbook Automation StudioかWebコンソールからエクスポートした、拡張子が.xpdl形式のファイルである必要があります。Webコンソールから、エクスポートしたプロセス定義ファイルを使用する場合はXPDL2.0の形式で出力したファイルを使用してください。XPDL1.0またはBPEL形式には対応していません。
プロセス定義名について
プロセス定義名には、空白が使用できます。空白を含むプロセス定義名を指定する場合はダブルクォーテーション（"）で囲んでください。

実行結果/出力形式

プロセス定義を新規登録する場合

FSP_SW/RB-A_BASE: INFO: 02001: pd-addが正常終了しました。 Option：pd-add -file sample0001.xpdl -appid app001 Code：0

プロセス定義を検索する場合

FSP_SW/RB-A_BASE: INFO: 02000: pd-listを開始します。Option：pd-list

ApplicationID ProcessID ProcessDifinitionName VersionStatusOwner
sample001 0001 sample process0011.0published rba_user1
sample002 0002 sample process0021.0published rba_user1
sample002 0001 sample process0031.0published rba_user1

FSP_SW/RB-A_BASE: INFO: 02001: pd-listが正常終了しました。 Option：pd-list Code：0

プロセスインスタンスを検索する場合

FSP_SW/RB-A_BASE: INFO: 02000: pi-listを開始します。Option：pi-list

ProcessInstanceID ProcessInstanceNameStatusInitiator
2889PROCESS_cl_1closedibpm_server1
2890PROCESS_cl_1runningibpm_server1
2891PROCESS_cl_1erroribpm_server1

FSP_SW/RB-A_BASE: INFO: 02001: pi-listが正常終了しました。 Option：pi-list Code：0