リソースPCコマンド
本書には、Blue PrismリソースPCリスナーと通信するときに使用するコマンドのリストを収録しています。Blue Prismはネットワーク通信にこれらのコマンドを使用します。また、HTTPインターフェイスを介してサードパーティのクライアントに使われます。
推奨する使用方法
これらのコマンドを習得するときは、この文書を読みながら試してみることをお勧めします。次の方法で行います。
- 下のコマンドを使用してBlue PrismリソースPCリスナーを起動する。
automate.exe /public /resourcepc
telnet localhost 8181
コマンド
認可:認証済み
トークン認証を使用して、指定されたプロセスIDで保留中のセッションを作成します:「createas <token> <procid>」。指定されたプロセスIDで指定されたキューに保留中のセッションを作成します:「createas <token> <procid> <queueident>」。プロセス名を使用して保留中のセッションを作成します:「createas name <token> <name>」。応答は「SESSION CREATED : <sessionid>」またはエラーコードです。
認可:認証済み
トークン認証を使用して保留中のセッションを削除します:「deleteas <token> <sessionid>」。応答は「SESSION DELETED」またはエラーコードです。
認可:認証済み
トークン認証を使用して、セッションの実行を開始します:「startas <token> <sessionid>」。またはこの接続で作成された最後のセッションを開始します:「startas last <token>」。応答は「STARTED」またはエラーコードです。
認可:任意
指定された認証情報を使用して承認トークンを取得します。ネイティブ/SSO認証の資格情報を提供するには、「getauthtoken <processid> <userid> <password>」、Active Directory認証の資格情報を提供するには「getauthtoken upn <userprincipalname> <password> <processid>」を使用します。この方法は、セキュアなネットワーク用に設計されたカスタムソリューションに使用できます。通常の運用ではBlue Prismで使用されません。
認可:認証済み
指定されたセッションでアクションを実行する場合は「action <sessionid> <actionname>」、この接続で作成された最後のセッションでアクションを実行する場合は「action last <actionname>」。応答は「STARTED」またはエラーコードです。
認可:AuthedOrLocal
さらにプロセスを実行するため、このリソースPCの現在の利用状況を報告します。応答は「AVAILABLITY:level」です。「level」には次の4つの値のいずれかが入ります。
- None - 排他的プロセスがすでに実行中(または保留中)のため、現在プロセスを実行できないことを示します。
- Background - フォアグラウンドプロセスがすでに実行中(または保留中)のため、バックグラウンドプロセスのみ実行可能なことを示します。
- Foreground - 実行中(または保留中)のフォアグラウンドプロセスまたは排他的プロセスがないため、バックグラウンドプロセスまたはフォアグラウンドプロセスのいずれでも実行可能なことを示します。
- Exclusive - 実行中(または保留中)のプロセスがないため、どの種類のプロセス(排他的プロセスを含む)でも実行可能なことを示します。
認可:AuthedOrLocal
保留中または実行中のセッションの有無を確認します。応答は、はい、または、いいえです。
認可:認証済み
リソース機能を取得
capsコマンド(Blue Prismインタラクティブクライアントがランタイムリソースに接続されるたびに使用されます)は、パフォーマンスを向上させるためにデフォルトでは無効になっています。capsコマンドは当初、バージョン3でバイナリビジネスオブジェクトとの連携をサポートするために導入されました。現在バイナリビジネスオブジェクトを使用している場合、機能(caps)コマンドを再度有効にする方法についてはBlue Prismサポートにお問い合わせください。
認可:AuthedOrLocal
このリストは、INBOUNDとOUTBOUNDとラベルされた2つのセクションに分かれています。受信リストには、このリソースへの接続(リモートアドレスと認証されたユーザー名として)が表示され、送信リストには、このリソースが他のリソースに対して開いている接続(これはリソースがプールコントローラーでない限りありません)が表示されます。
認可:認証済み
これがプールのコントローラーからの接続であることを示します。このコマンドは、リソースPC間でのみ内部的に使用されます。
認可:認証済み
指定されたプロセスIDで保留中のセッションを作成するには「create <procid>」、指定されたプロセスIDで指定されたキューに保留中のセッションを作成するには「create <procid> <queueident>」、プロセス名を使用して保留中のセッションを作成するには「create name <name>」。応答は「SESSION CREATED : <session id>」またはエラーコードです。セッション管理がユーザー設定の制御の許可を有効にする場合は、代わりにcreateasを使用してください。
認可:認証済み
「delete <sessionid>」コマンドは、[セッション管理でユーザーを制御する許可を実行]オプションが無効になっている場合にのみ使用できます。デフォルトでは「deleteas」コマンドが有効になっているため、「delete <sessionid>」の代わりに使用してください。
認可:認証済み
「getparams <sessionid>」を使用して、プロセスを開始するのに使用する開始パラメーターを取得します。プロセスがすでに開始されている必要がありますが、リクエストが行われたリソース上にある必要はありません。応答は「PARAMS:」で、その後にXML形式のパラメーターが続きます。パラメーターがなかった場合は「NONE」、その他の場合はエラーの記述です。
認可:任意
「internalauth <token>」を使用してトークンベースの認証を実行します。これは、生成されてデータベースに登録された使い捨てトークンを使用して、接続しているユーザーのIDの確認、盗聴とリプレイ攻撃の抑制、AD環境における直接接続の許可を行います。Blue Prismソフトウェアはこのメソッドのみを使用しています。Blue Prism以外のソフトウェアはAutomateCを使用してトークンを生成できます。
認可:AuthedOrLocal
このリソースPCがコントローラーであるプールのメンバーを一覧で表示します。応答例:
MEMBERS – 2
9efb8f78-0777-4d28-aaa3-6fbd5da70f36 PC1
21e960d0-140a-488c-b09d-d3d7257bae54 PC2
報告される値は、リソースのIDと名前です。
認可:認証済み
「outputs <sessionid>」(または「outputs last」)を使用して正常に完了したプロセスまたはアクションから出力パラメーターを取得、または失敗したプロセスから失敗した理由を取得します。ビジネスオブジェクトアクションの実行時にオブジェクトをアイドル状態に戻すこともします。別のアクションが開始する前に使用する必要があります。応答は「OUTPUTS:」で、その後に完了したセッションの出力パラメーターがXML形式で記述されます。
認可:任意
「user」コマンドの後に「password <pwd>」を使用して認証を完了します。詳細については、「user」の説明を参照してください。
認可:AuthedOrLocal
メッセージ「pong」を返します。診断に使用されます。
認可:認証済み
このリソースがどのプールのメンバー/コントローラーになっているかを判断します。応答は「Not in a pool」、「Controller of <pool name>」、「Member of <pool name>」のいずれかです。
認可:認証済み
実行可能なプロセスのリストを提供します。出力は、次に示すように1行につき1プロセスの形式です。
xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx – プロセス1 xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx – プロセス2
最初のフィールドの値は、プロセスの一意の識別子です。この値を「create」コマンドとともに使用してプロセスの保留セッションを作成します。
認可:認証済み
プールメンバーがセッションを実行する際に使用するユーザーIDを設定します
認可:任意
このセッションを中止します。クライアントは切断されます。サーバーは稼働を続けます。
認可:認証済み
setvar <sessionid> [<varname>] type "<value>" "<description>"
セッション内のセッション変数の値を設定します。処理が正常に行われた場合の応答は「SET」です。その他の場合はエラーコードが返されます。
認可:AuthedOrLocal
リソースPCをシャットダウンします。オプションのパラメーター「waitforsessions」を使用すると、現在実行中のセッションが完了するまで待機してからシャットダウンします。「loginagent」パラメーターを使用すると、リソースPCがLogin Agentによって使用されていない場合にシャットダウンリクエストを無視します。
認可:認証済み
実行中のセッションを開始するには「start <sessionid>」、この接続で作成された最後のセッションを開始するには「start last」。応答は「STARTED」またはエラーコードです。セッション管理がユーザー設定の制御の許可を有効にする場合は、代わりにstartasを使用してください。
認可:認証済み
この接続で作成された次のセッションに使用される開始パラメーターを設定します。パラメーターはXML形式で指定します。応答は「PARAMETERS SET」です。
認可:AuthedOrLocal
リソースPC上で保留中、実行中、完了済みのセッションのリストを取得します。出力は、次に示すように1行につき1セッションの形式です。
RESOURCE UNIT – PENDING 9efb8f78-0777-4d28-aaa3-6fbd5da70f36 – PENDING 21e960d0-140a-488c-b09d-d3d7257bae54 Total running: 2
最後のフィールドの値は、セッションの一意の識別子です。
合計実行数は、リソース PC上で保留中、実行中、完了したセッションの合計数を表します。
認可:認証済み
プロセスの実行を停止するには「stop <sessionid>」を使用します。セッションに対してこの情報を記録する場合は、オプションの追加パラメーター「<userid> <resourceid>」をペアで指定します。リソースIDを「name <resource name>」に置き換えることもできます。応答は「STOPPING」またはエラーコードです。
認可:任意
ユーザー名/パスワードベースの認証を開始します。ユーザーIDを設定するには「user <userid>」、ユーザー名を使用するユーザーを設定するには「user name <name>」を使用します。認証シーケンスを完了するには、この後に「password」コマンドを続ける必要があります。この認証方法は、セキュアなネットワーク用に設計された診断およびカスタムソリューションに使用できます。通常の運用ではBlue Prismで使用されません。
認可:認証済み
すべてのユーザーを一覧で表示します。次に示すように1行に1ユーザーの形式で表示されます。
xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx – ユーザー1 xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx – ユーザー2
最初のフィールドの値は、ユーザーに一意の識別子です。
認可:認証済み
指定したセッションIDの現在のセッション変数とその値をすべて取得します。応答例:VARIABLES:2
[CasesWorked] number 212 [Exceptions] number 4
認可:認証済み
セッション変数の更新を有効または無効にします。「on」または「off」を指定します。応答は「SET」またはエラーコードです。
認可:任意
バージョン情報を取得します – 応答は内部プロトコルのバージョン番号。