コマンドラインオプション
Blue Prismには、コマンドラインスイッチを受け入れる2つのユーティリティがあります。
- Automate.exe
グラフィカルなBlue Prismアプリケーション。このアプリケーションからのメッセージやフィードバックはすべて視覚的に行われます。リターンコード0は成功を示します。0以外のリターンコードはエラーを示します。
- AutomateC.exe
メッセージとフィードバックを(標準出力経由で)コマンドラインに返すコマンドラインユーティリティ。リターンコード0は成功を示します。0以外のリターンコードはエラーを示します。
ヒント:
- 「/help」スイッチを使用すると、AutomateCの動的ヘルプを利用できます。Automate.exeで「help」スイッチを指定すると、このドキュメントがグラフィカルウィンドウで表示されます。
- 一部のスイッチでは、追加のパラメーターが必要です(以下では<parameter>として示します)。これらのパラメーターはスイッチの後に入力する必要があります。
- スイッチとパラメーターはスペースで区切ります。パラメーターの値にスペースやその他の特殊文字が含まれている場合は、値を「引用符」で囲む必要があります。このため、実際の値に引用符を含めることはできません。引用符を含めないように注意してください。
- XMLを渡す場合は、xml文字列を引用符で囲む必要があります。引用符は標準入力でパラメーターのXML文字列の開始/終了を区切るために使用されるため、xml属性は単一引用符で区切ることをお勧めします。また、パラメーターxml内の引用符ごとに2つの引用符を入力することで、存在する引用符をエスケープすることもできます。
使用例
Blue Prismを「admin」ユーザー専用のリソースPCとして実行します。
automate /resourcepc /user admin mypwd
または、シングルサインオンユーザー用として実行します。
automate /resourcepc /sso
Blue PrismをパブリックリソースPCとして実行します。
automate /resourcepc /public
ローカルPCでプロセスを実行します。
AutomateC /run "My Scheduled Process" /user admin mypwd
または、シングルサインオンユーザー用として実行します。
AutomateC /run "My Scheduled Process" /sso
開始パラメーターを指定してリモートPCでプロセスを実行します。
AutomateC /run "Excel Test" /resource YourPCHostName /user admin mypwd /startp "<inputs> <input name='Comment' type='text' value='Hello World' /></inputs>"
メインのBlue Prismアプリケーションを起動せずに、バックグラウンドのプロセスアラートモニタリングを開始します。
automate /alerts /user admin mypwd
または、シングルサインオンユーザー用として実行します。
automate /alerts /sso
使用可能なスイッチ
/help
Blue Prism htmlヘルプブラウザーでこのドキュメントを開きます。
/resourcepc
Blue PrismをリソースPCモードで起動します。 /publicスイッチを追加すると、すべてのBlue PrismユーザーがリソースPCを利用できるようになります。追加しない場合は、/userオプションまたは/ssoオプションで指定されたユーザーのみが利用できます。
このオプションを/resourceスイッチと混同しないでください。
/public
/resourcepcスイッチとの組み合わせでのみ使用されます。実行モードのヘルプで説明されているように、リソースPCを公開します。
/sslcert
/resourcepcスイッチとの組み合わせでのみ使用され、所定の捺印が押された証明書を使用してリソースPCへの接続でトランスポートセキュリティ(SSL/TLS)を有効にします。この証明書は、ユーザーまたはマシンの証明書ストアにインストールされている必要があります。
トランスポートセキュリティを有効にすると、コントロールルームおよびスケジューラーからの接続とリソースにルーティングされる公開Webサービスの両方に影響します。証明書のCNは、リソースへの接続に使用されるアドレスと一致する必要があります。また、接続するクライアントは、証明書の発行元のCAを信頼する必要があります。
/wslocationprefix
(詳細設定)/resourcepcスイッチとの組み合わせでのみ使用され、このデバイスでホストされるパブリッシュされたWebサービスと関連リソース(WSDLなど)の表示されるアドレス指定可能な場所をオーバーライドします。指定した値には、フルパスアドレス(例:「https://blueprismws.myorg.com:8181」)が含まれている必要があります。Blue Prismは、/ws/と関連するパスをローカルで利用可能なリソースに自動的に追加します。
指定したプレフィックスがこのデバイスにルーティングする有効なアドレスになるように、適切なネットワークルーティングを手動で適用することが重要です。
/nohttp
(詳細設定)/resourcepcスイッチとの組み合わせでのみ使用され、リスニングポートで受信したHTTP通信を無視するようランタイムリソースに指示します。 このオプションは、Webサービスを公開するためのリソースが不要で、HTTPインターフェイスでリソースをコントロールする必要がない場合にのみ使用してください。
/dbwait
起動時に、指定された秒数の間、データベースが使用可能になるのを待機し、指定された秒数が経過すると接続を断念します。この間、接続は周期的に再試行されます。 これは、小規模なインストールで起動時にリソースPCを同じマシン上のデータベース「サーバー」と一緒に実行している場合に役立つことがあります。このような場合、リソースPCの起動時にデータベースがすぐに接続を受け入れる準備ができないことがあります。たとえば、/dbwait 120を使用すると、2分間再試行してから接続を断念します。
/invisible
/resourcepcスイッチとの組み合わせでのみ使用されます。リソースPC情報フォームはデフォルトで非表示になります。通知領域のコンテキストメニューを使用して再度表示できます(アイコンをご覧ください)。
/local
/resourcepcスイッチとの組み合わせでのみ使用されます。リソースPCは、ローカルマシンからのみコントロールできます。リモートリソースは、リソースPCの存在を認識しません。
/port
/resourcepcスイッチとの組み合わせでのみ使用されます。Blue Prismがそれ自体をリソースPCとして使用できるようにするポートを指定します。この方法で、同じマシンから複数のリソースPCを実行できます。
このオプションは、特定のまれな状況で役立つ場合があります。以下は、その例です。
- デフォルトポートをオーバーライドする
デフォルトポートの8181がすでにネットワーク上の別のサービスに使用されている場合は、別のポートを使用できます。特別な理由がない限り、必ずネットワーク上のすべてのリソースPCに同じポートを使用します。
- ターミナルサービスを使用する
ターミナルサービスホストを操作するとき、Blue Prismは各リソースPC上で一度に1つのセッションしか実行できません。これは、Microsoftターミナルサービスの実装の技術的な制限によるものです。複数のリソースPCをそれぞれ異なるポートで実行することで、通常どおり1台のマシンで複数のセッションを実行できます。
/resource <name>
プロセスアラートの対象となるリソースPCを決定します。指定されていない場合は、ローカルPCが使用されます。
このオプションを/resourcepcスイッチと混同しないでください。
/user <name> <pwd>
必要に応じてBlue Prismのログイン認証情報を提供するために使用されます。データベースがシングルサインオン用に構成されている場合は、代わりに/ssoスイッチを使用してください。
/sso
シングルサインオン(SSO)構成で現在のユーザーの認証情報に基づいてコマンドを認証するようBlue Prismに指示します。 データベースがシングルサインオン用に構成されていない場合は、代わりに/userスイッチを使用してください。
たとえば、/runスイッチを使用する場合は、次のように指定する代わりに、
Automate.exe /run Process1 /user admin pwd
次のように指定します。
Automate.exe /run Process1 /sso
/useropts
現在ログインしているオペレーティングシステムユーザーに、すべてのBlue Prism構成オプションを適用できるようにします。デフォルトでは、構成はすべてのユーザーに適用されます。
/setdbserver <databaseservername> /setdbname <databasename> /setdbusername <username> /setdbpassword <password>
これらのパラメーターを組み合わせて使用すると、指定されたデータベース名と同じ名前の新しいデータベース接続を作成したり(/dbconnameも参照してください)、その接続を更新したりできます(存在する場合)。推奨されるSQL Server認証では、4つのパラメーターすべてを指定する必要があります。Windows認証の場合は、ユーザー名とパスワードを省略する必要があります。接続も現在の接続に設定されます。この後、Blue Prismは終了します。
/ag <host> <port>
/setdbserverと組み合わせて使用すると、直接データベース接続ではなく、可用性グループ接続を指定できます。この場合、「databaseservername」は可用性グループリスナーの名前になります。
/agport <host> <port>
/agと組み合わせて使用すると、可用性グループリスナーのポートを指定できます。指定しない場合は、デフォルトの1433が使用されます。
/multisubnetfailover <host> <port>
/agと組み合わせて使用すると、マルチサブネットフェイルオーバーを有効にするように指定できます。
/setbpserver <host> <port>
指定されたホストと同じ名前の新しいBlue Prismサーバー接続を作成します (/dbconname、/connectionmode、/bpserversecureも参照してください)。接続も現在の接続に設定されます。 この後、Blue Prismは終了します。
/dbconname <name>
/setdbserverまたは/setbpserverオプションと組み合わせて使用すると、デフォルトの接続名を使用する代わりに特定の接続名を指定できます。 これらのパラメーターのいずれも指定せずに使用された場合は、このセッションについてのみ、現在のデータベース接続ではなく、実際に使用するデータベース接続の名前を指定します (つまり、現在の接続は変更されません)。
/connectionmode <connectionmode>
/setbpserverオプションと組み合わせて使用すると、クライアントとBlue Prismサーバーの間の接続に使用される接続モードを選択できます。このオプションは、Blue Prismサーバー構成で構成した対応する値と一致する必要があります。
デフォルト値は0です。利用可能な接続モードは以下のとおりです。
- 0 - WCF:メッセージの暗号化付きSOAP&Windows認証
- 1 - WCF:転送の暗号化付きSOAP&Windows認証
- 2 - WCF:転送の暗号化付きSOAP
- 3 - .NET Remoting:セキュア
- 4 - .NET Remoting:非セキュア
- 5 - WCF:セキュアでない
/bpserversecure False
/setbpserverオプションと組み合わせて使用すると、Blue Prismサーバー接続のセキュリティを無効できます。接続を保護するための代替手段を用意していない限り、これは決して使用しないでください。注:/bpserversecureオプションは推奨されていないため、代わりに/connectionmodeオプションを使用してください。
/alerts
バックグラウンドのプロセスアラートモニタリングを開始します。適切なユーザーのプロセスアラート構成が使用されるように、/Userまたは/ssoのいずれかのスイッチと組み合わせて使用する必要があります。
/p:<mode>
Blue Prismアプリケーションの優先度を指定されたモードに設定します。通常は、Blue PrismがリソースPCとして機能している場合に、Blue Prism Windowsプロセスの優先度をコントロールするために使用されます。これは、Blue PrismにPC上の他のプロセスよりも高い優先度を割り当てる必要がある(そうしないとそれらのプロセスによってCPUが占有され、Blue Prismが効率的に動作できなくなるおそれがある)場合に役立ちます。有効なモードは以下のとおりです。
- below - 通常の優先度より下
- above - 通常の優先度より上
- high - 高い優先度
- realtime - 可能な最も高い優先度
/run <processname>
コマンドラインからプロセスを実行するために使用されます。processnameパラメーターにスペースが含まれる場合は、引用符で囲む必要があります。指定したプロセスが実行されるようにするには、そのプロセスをパブリッシュする必要があります(/publishを参照)。入力パラメーターは、/startpパラメーターを使用して指定できます。
プロセスを実行するにはユーザー認証情報が必要です。/userおよび/ssoを参照してください。
/startp <paramsxml>
セッションに開始パラメーターを指定するため、/runパラメーターと組み合わせて使用されます。
paramsxmlパラメーターには、有効なBlue Prismパラメーターxmlを引用符("")で囲んで含める必要があります。 引用符は標準入力でパラメーターのXML文字列の開始/終了を区切るために使用されるため、xml属性は単一引用符('')で区切ることをお勧めします。次に例を示します。
AutomateC /run "Excel Test" /resource YourPCHostName /user admin mypwd /startp "<inputs> <input name='Comment' type='text' value='Hello World' /></inputs>"
また、パラメーターxml内の引用符ごとに2つの引用符を入力することで、存在する引用符をエスケープすることもできます。次に例を示します。
AutomateC /run "Excel Test" /resource YourPCHostName /user admin mypwd /startp "<inputs> <input name=""Comment"" type=""text"" value=""Hello World"" /></inputs>"
シングルサインオンユーザーは、上の例の/userスイッチの代わりに/ssoスイッチを使用する必要があります。次に例を示します。
AutomateC /run "Excel Test" /resource YourPCHostName /sso /startp "<inputs> <input name=""Comment"" type=""text"" value=""Hello World"" /></inputs>"
/showdbconfig
データベース構成フォームを表示します。ユーザーがこのフォームを終了([OK]または[キャンセル]ボタンを使用)すると、アプリケーションは終了します。
/help
クイックヘルプのヒントをコマンドラインの標準出力に出力します。
/createdb <dbpassword>
構成済みのデータベース接続を使用してデータベースを作成します(Automate.exeの/setdbserverを参照)。必要なパスワードは、構成済みデータベース接続の一部として提供されているものです。
これは、/replacedbスイッチとは異なり、同じ名前の既存のデータベースをすべてドロップします。一方、/replacementbスイッチは、データベース自体をドロップせずに、データベース内の既存のテーブルをドロップします。
/replacedb <dbpassword>
構成済みのデータベース接続を使用してデータベースを作成します(Automate.exeの/setdbserverを参照)。必要なパスワードは、構成済みデータベース接続の一部として提供されているものです。
これは、/createdbスイッチとは異なり、同じ名前のデータベースがすでに存在する場合は、そのデータベース内の既存のテーブルのみをドロップします。一方、/createdbコマンドは、データベース全体をドロップして再作成します。
/setadadmingroup <groupname>
データベース作成時のBlue Prism管理者のActive Directoryグループを決定します。シングルサインオンを使用する場合にのみ関連します。/setaddomainおよび/createdbまたは/replacementbのいずれかと組み合わせて使用する必要があります。
/setaddomain <name>
データベース作成時のBlue Prism管理者のドメイン名を決定します。シングルサインオンを使用する場合にのみ関連します。/setadadmingroupおよび/createdbまたは/replacementbのいずれかと組み合わせて使用する必要があります。
/upgradedb <dbpassword>
必要に応じて既存のデータベースをアップグレードします。必要なパスワードは、構成済みデータベース接続の一部として提供されているものです。
/getdbscript > [filename].sql
新しいデータベースを作成するためにDBAに渡すことができるSQLスクリプトを作成します。例:
AutomateC.exe /getdbscript > createdb.sql
これはcreatedb.sqlスクリプトを出力します。
/serverconfig <name> <connection> <port>
指定された名前で識別されるBPサーバー構成を作成または更新し、データベース接続名とリスニングポートを指定された値に構成します。
オプションの/connectionmodeスイッチを使用して接続モードを設定できます。
BPサーバー構成に暗号化方式が構成されていない場合は、新しい暗号化方式レコードが作成されます。デフォルトでは、この方式は「デフォルトの暗号化方式
」という名前になり、AES 256(AESCryptoService)とランダムに生成されたキーを使用するように構成されます。または、/encryptionschemeスイッチを使用して、使用する設定を定義します。
/encryptionscheme <name> <encryptionmethod>
/serverconfigスイッチと組み合わせて使用され、暗号化スキームの作成時に使用される構成を定義するために使用できるオプションのスイッチです。
<name>には、暗号化方式の名前を指定します。
<encryptionmethod>(オプション)には、使用する暗号化アルゴリズムを指定します。
- 1 = Triple DE(192ビット)
- 2 = AES-256 RijndaelManaged(256ビット)
- 3 = AES-256 AesCryptoService(256ビット) - デフォルト
トリプルDES(192ビット)は後方互換性を確保するために用意されています。新しい暗号化方式は、この方法を使用しないように構成することを強くお勧めします。
/refreshdependencies {force}
オブジェクト/プロセス依存関係リポジトリがBlue Prismのアップグレードによって期限切れとマークされた場合に、そのオブジェクト/プロセス依存関係リポジトリを更新するよう要求します。「force」キーワードが指定されている場合、リポジトリはその現在の状態に関係なく更新されます。
/license <licensefile>
指定されたファイルのライセンスキーをBlue Prismデータベースに追加します。/userまたは/ssoスイッチのいずれかを使用してユーザー認証情報を提供する必要があります。
ライセンスは、クライアントアプリケーションのシステムマネージャーを使用して管理することもできます。
/removelicense <licensefile>
指定されたファイルのライセンスキーをBlue Prismデータベースから削除します。/userまたは/ssoスイッチのいずれかを使用してユーザー認証情報を提供する必要があります。
ライセンスは、クライアントアプリケーションのシステムマネージャーを使用して管理することもできます。
/regobject <clsid>
COMビジネスオブジェクトをローカルマシンで使用できるように登録します。これは、System Managerの「外部ビジネスオブジェクト」領域にアクセスするのと同じです。
clsidパラメーターはCOMクラスIDを参照します。
/regwebservice <servicename> <WSDLURL>
WebサービスをBlue Prismプロセスで使用できるように登録します。これは、システムマネージャーの「Webサービス領域」にあるウィザードを使用してWebサービスを登録するのと同じです。
- /userまたは/ssoスイッチのいずれかを使用してユーザー認証情報を提供する必要があります。
- オプションで/objectnameスイッチと組み合わせて使用することもできます。
- オプションで/timeoutスイッチを指定できます。
- WSDLドキュメントを取得するために認証情報が必要な場合は、/wsauthスイッチを使用できます。
<servicename>識別子は、WebサービスのWSDLドキュメントに表示されるサービスの名前と一致する必要があります(WSDLドキュメントの詳細については、Webサービス用語集を参照してください)。1つのWSDLドキュメントで複数の異なるWebサービスを記述できるため、これは必須です。指定する名前は、/objectnameスイッチで指定する名前とは異なります。このスイッチでは、WebサービスがBlue Prismプロセス内で内部的に認識される名前を指定します。
<WSDLURL>パラメーターには、対象となるWebサービスのWSDLドキュメントの場所(URL)を指定する必要があります。これはhttpまたはhttpsのいずれか適切なほうを使用して取得されます。
/unregwebservice <servicename>
Webサービスを登録解除します。これは、システムマネージャーの「Webサービス」領域にあるウィザードを使用してWebサービスを削除するのと同じです。
<servicename>識別子は、WebサービスがBlue Prismプロセス内で内部的に認識されている名前と一致する必要があります。
/objectname <objectname>
/regwebserviceスイッチと組み合わせて使用され、登録後にWebサービスに付与されるビジネスオブジェクト名を指定します。
/wsauth <username> <password>
/regwebserviceスイッチと組み合わせて使用され、WSDLドキュメントをダウンロードするときにhttpリクエストで使用されるユーザー認証情報を指定します。このスイッチは、WSDLがホスティングサーバーによってパスワードで保護されている場合にのみ使用する必要があります。
/timeout <milliseconds>
/regwebserviceスイッチと組み合わせて使用され、Webサービスに関連付けられるタイムアウト値をミリ秒単位で指定します。 これは、Webサービスからのレスポンスを待っているときに実行時に適用されるタイムアウトになります。この値は、後でシステムマネージャーにアクセスしてWebサービスを編集することで変更できます。
このスイッチは、オプションで/regwebserviceコマンドと組み合わせて使用できます。使用しない場合は、デフォルト値の10,000ミリ秒が適用されます。
/report <filespec>
指定されたファイルにシステムレポートを書き出します。 システムレポートは、システムの現在の状態(セッションとログエントリの数、キューアイテムの数、プロセスの検証状態など)に関する広範な概要です。
/elementusage <filespec>
指定されたファイルに要素の使用状況レポートをCSV形式で書き出します。レポートするビジネスオブジェクトを指定するには、/processオプションを使用します。レポートには、アプリケーションモデルの各要素が使用されているページとステージの詳細が含まれます。
/import <filespec>
デフォルトでファイル内のID(IDが存在する場合。存在しない場合は、新しいIDが生成されます)を使用してBlue Prismプロセス(またはビジュアルビジネスオブジェクト)をデータベースにインポートします。この動作をオーバーライドするには、/forceidを参照してください。
filespecパラメーターは、インポートされるxmlファイルの場所を参照します。
デフォルトでは、インポートされるプロセス/オブジェクトが選択した環境にすでに存在する場合、この操作は失敗します。これを回避するには、/overwriteを参照してください。
/forceid {new|<guid>}
インポート対象のファイルで定義されているIDを使用する代わりに、指定したIDをプロセスに使用するように強制するには、/importと組み合わせて使用します。
「new」キーワードを使用すると、インポートされるオブジェクト用の新しいIDが生成されます、このキーワードを使用しない場合は、有効なGUIDを指定する必要があります。
/overwrite
デフォルトでは、インポートされるプロセス/オブジェクトがすでにデータベースに存在する場合、/importは失敗します。
/overwriteオプションを使用すると、新しいバージョンのプロセス/オブジェクトがインポートされ、既存のプロセス/オブジェクトがオーバーライドされます。
注意:インポートされるプロセス/オブジェクトと名前が同じで、IDが異なる別のプロセス/オブジェクトが存在する場合、インポート操作は失敗します。/overwriteは、同じIDを持つプロセス/オブジェクトが見つかった場合にのみ機能します。
このケースに対処するには、製品に含まれているインポートウィザードを使用できます。
/importrelease <filespec>
Blue Prismリリースファイル(.bprelease)またはBlue Prism Skillファイル(.bpskill)をデータベースにインポートします。このアクションは、非対話的で、可能な場合には競合が自動的に処理されることを除き、Blue Prismクライアント([リリース]タブを参照)を使用して対話的にインポートを実行するのと機能的に同じです。通常、デフォルトでは、インポートされるアイテムがすでに存在するデータベース内の場所が上書きされます。ただし、競合が発生すると、リリースの非対話的インポートが妨げられます。次の表は、競合の処理をまとめたものです。
競合 | 結果 |
---|---|
データベースに同じID/名前とタイプのアイテムがすでに存在する | アイテムが上書きされる |
インポート後にプロセスをパブリッシュまたは廃止する必要がある | プロセスがパブリッシュ/廃止される |
次に、インポートの失敗につながる競合の例を示します。
|
リリースはインポートされない |
注意:新しい認証情報を対話的にインポートする場合、ユーザーはユーザー名とパスワードの入力を求められます(この情報はエクスポートファイルに書き込まれないため)。非対話的にインポートする場合、認証情報は空白のユーザー名/パスワードでインポートされるため、Blue Prismクライアントを使用し手動で更新する必要があります。
filespecパラメーターは、インポートされる.bprelease
ファイルの場所を参照します。
/export <processname>
Blue Prismプロセス(またはビジュアルビジネスオブジェクト)をデータベースからローカルファイルシステムにエクスポートします。
/archive
セッションログをファイルにアーカイブします。詳細については、「アーカイブ」を参照してください。オプションを指定しない場合、すべてのセッションログがアーカイブされます。アーカイブされるログの範囲を制限するには、/ageオプションか、/fromオプションと/toオプションの組み合わせを使用します。/processを使用して、アーカイブを特定のプロセスのログに制限することもできます。
セッションログをエクスポートせずに削除するには、/deleteオプションを追加します。
/restorearchive
セッションログをファイルからデータベースに復元します。詳細については、「アーカイブ」を参照してください。オプションを指定しない場合、すべてのセッションログが復元されます。アーカイブされるログの範囲を制限するには、/ageオプションか、/fromオプションと/toオプションの組み合わせを使用します。
/setarchivepath <path>
アーカイブパスを設定します。これは、/archiveおよび/restorearchiveコマンドとシステムマネージャーインターフェイスで使用されるパスです。
/from <yyyyMMdd>
/archiveおよび/restorearchiveと組み合わせて使用され、日付範囲の開始日(基準となる日付を含む)を設定します。
/to <yyyyMMdd>
/archiveおよび/restorearchiveと組み合わせて使用され、日付範囲の終了日(基準となる日付を含まない)を設定します。
/age <value>
/queueclearworkedと組み合わせて使用され、指定された期間より古い作業済みアイテムをすべて削除します(これには、これ以前に例外としてマークされたアイテムを含みます)。
/archiveおよび/restorearchiveと組み合わせて使用され、日付範囲に基づく選択を省略し、特定の期間よりも古いセッションを選択します。値は、数値の後に「y」(年)、「m」(月)、「w」(週)、または「d」(日)のいずれかを指定したものです。たとえば、「6m」は、6か月より古いログをアーカイブするように指定します。
/process <name>
/archiveと組み合わせて使用され、アーカイブの対象を、指定されたプロセスを実行したセッションに制限します。/elementusageと組み合わせて使用され、レポートを生成するプロセスを選択します。
/delete
/archiveと組み合わせて使用され、最初にログをエクスポートせずにログを削除します。
/publish <processname>
指定されたBlue Prismプロセスをパブリッシュします。プロセスの名前にスペースが含まれる場合は、名前を引用符で囲む必要があります。
/unpublish <processname>
指定されたBlue Prismプロセスのパブリッシュを解除します。プロセスの名前にスペースが含まれる場合は、名前を引用符で囲む必要があります。
/publishws <name> [/forcedoclitencoding] [/useGlobalNamespace]
指定されたBlue PrismオブジェクトまたはプロセスをWebサービスとして公開し、外部アプリケーションで使用できるようにします。オブジェクト名またはプロセス名にスペースが含まれる場合は、名前を引用符で囲む必要があります。
オプションの/forcedoclitencoding
が存在する場合、WebサービスはWS-Iに準拠するため、常にDocument/Literal形式のSOAPメッセージを返します。
/forcedoclitencoding
パラメーターが存在しない場合は、グローバル名前空間を使用するよう強制できます。
/unpublishws <name>
以前にWebサービスとして公開されていたBlue Prismオブジェクトまたはプロセスを隠します。 オブジェクト名またはプロセス名にスペースが含まれる場合は、名前を引用符で囲む必要があります。
/status <sessionid>
実行中のセッションのステータスを取得します。SessionIDは、xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxの形式の固有IDです。/userまたは/ssoスイッチのいずれかを使用してユーザー認証情報を提供する必要があります。
/getlog <sessionid>
指定されたセッションのログを取得します。SessionIDは、xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxの形式の固有IDです。/userまたは/ssoスイッチのいずれかを使用してユーザー認証情報を提供する必要があります。
ログは1行ずつ標準出力に書き込まれます。232 -1行のデータ制限がありますが、これは数百ギガバイトのデータに相当するため、実用上は影響ありません。
/dbconname、/user、/sso、/resource、/port、/startp
AutomateC.exeでのこれらのコマンドの使用法は、Automate.exeでの使用法に正確に対応しています。それぞれ(/dbconname、/user、/sso、/resource、/port、/startp)の詳細については、上を参照してください。
/リソースステータス <リソース名> <制限数> <制限タイプ>
与えられたリソース名のセッションを報告してください。結果は指定期間に制限することができます。
全リソースを一覧表示するにはリソース名に[全て]
を指定してください。
また、制限数やタイプ(m=分、h=時間、d=日、mm=月)を記載して返却結果を制限することもできます。たとえば/resourcestatus ABC:8181 1 d
と記載すると、前日以降の指定した名称のリソースの全セッションが返却されます。
/userスイッチで取得したユーザー資格情報が必要です。
/requeststop <sessionid|sessionnumber>
指定されたセッションに「停止リクエスト」を送信し、実行中のプロセスが決定ステージでIsStopRequested()
関数を使用して確認できるフラグを設定します。
セッションID(GUID)またはセッション番号(番号)のいずれかを入力して、停止リクエストのフラグを付けるセッションを指定する必要があります。
これは、セッション管理へのフルアクセス許可を持つ認証済みユーザー(/userまたは/sso
スイッチで指定されたユーザー)のみが実行できます。
/createqueue <keyfield> >running< <maxattempts>
システムマネージャーで手動によりキューを作成するときに必要になるワークキューを、keyfield、running、maxattemptsの各値を使用して作成します。
/queuenameと組み合わせて使用する必要があります。/userまたは/ssoスイッチのいずれかを使用してユーザー認証情報を提供する必要があります。
/setencrypt <encryption-scheme-name>
指定されたキューで使用される暗号化方式を設定します。暗号化を正しく機能させるには、指定された方式をこの環境内に構成する必要があります。Blue Prismサーバーの構成で設定されるデフォルトの方式名は、デフォルトの暗号化方式
と呼ばれます。
キューの暗号化キーを無効にするには、//resetencryptスイッチを参照してください。
/queuenameと組み合わせて使用する必要があります。/userまたは/ssoスイッチのいずれかを使用してユーザー認証情報を提供する必要があります。
/resetencrypt
指定されたキューの暗号化方式をリセットして、そのキューが暗号化されないようにします。
/queuenameと組み合わせて使用する必要があります。/userまたは/ssoスイッチのいずれかを使用してユーザー認証情報を提供する必要があります。
/reencryptdata [/batchsize <size>] [/maxbatches <max>]
このオプションは、現在選択されている方式に従って暗号化されていない認証情報、リソース画面キャプチャ、またはキュー項目データを再暗号化します。暗号化方式を削除する前に古いキーを無効にする場合などに使用できます。パラメーター/batchsizeは更新されたレコードをデータベースにコミットする頻度(デフォルトは1000)をコントロールし、/maxbatchesは処理するバッチの数(デフォルトは1)をコントロールします。
/userまたは/ssoスイッチのいずれかを使用してユーザー認証情報を提供する必要があります。また、「セキュリティ - 暗号化方式を管理
」許可へのアクセスが必要です。
/exportqueue <filespec>
ワークキューからデータをエクスポートし、そのデータを<filespec>で指定された場所に保存します。
/userまたは/ssoスイッチのいずれかを使用してユーザー認証情報を提供する必要があります。
/queuenameと組み合わせて使用する必要があります。/queuefilterと/clearexportedの一方または両方を組み合わせて使用できます。
/exportqueueでは、/userまたは/ssoスイッチのいずれかを使用してユーザーの認証情報を提供する必要があります。また、次のいずれかの許可へのアクセスが必要です。キュー管理へのフルアクセス
、キュー管理への読み取り専用アクセス
/queueclearworked /queuename <name> [/age <age>]
ワークキューから作業済みケース(完了済みまたは例外としてマークされたケース)をクリアします。
/userまたは/ssoスイッチのいずれかを使用してユーザー認証情報を提供する必要があります。
/queuenameと組み合わせて使用する必要があります。
/ageスイッチを使用すると、指定された期間よりも古い作業済みアイテムのみがキューから削除されます。このスイッチを使用しない場合は、すべての作業済みアイテムが指定されたキューから削除されます。
代わりに、/exportqueueコマンドと/clearexportedを組み合わせて使用することもできます。この組み合わせを使用すると、プロセスで削除されたアイテムのレコードを生成できます(このコマンドでは、このようなレコードは作成されません)。
/queuename <queuename>
/exportqueueや/createqueueなどのキュー関連のコマンドと組み合わせて使用する場合にキューの名前を指定します。
/queuefilter
/exportqueueを使用してキューをエクスポートするときに使用するフィルターの名前を指定します。これは、コントロールルームの「キュー管理」領域で作成されたフィルターの名前です。
/clearexported
/exportqueueと組み合わせて使用した場合、エクスポートされた作業済みアイテムおよび参照済みアイテムをキューから削除します。
/userまたは/ssoスイッチのいずれかを使用してユーザー認証情報を提供する必要があります。また、「キュー管理へのフルアクセス
」許可へのアクセスが必要です。
/createcredential <name> <username> <password> [/description <string>] [/expirydate <date>] [/invalid <flag>] [/credentialtype <string>]
指定された名前、パスワード、ユーザー名を使用して新しい認証情報を作成します。
ユーザー名とパスワードが不要な場合は、どちらも""で表すことができます。
何も指定されていない場合、一般的な認証情報タイプが作成されます。
/userまたは/ssoスイッチのいずれかを使用してユーザー認証情報を提供する必要があります。また、「セキュリティ - 認証情報を管理」許可へのアクセスが必要です。
作成された認証情報は、デフォルトですべてのユーザーの役割、リソース、プロセスに広範に使用できます。
/updatecredential <name> [/username <username>] [/password <password>] [/description <string>] [/expirydate <date>] [/invalid <flag>][/credentialtype <string>]
指定された名前を使用して見つかった既存の認証情報を更新します。
/userまたは/ssoスイッチのいずれかを使用してユーザー認証情報を提供する必要があります。また、「セキュリティ - 認証情報を管理」許可へのアクセスが必要です。
/password <password>
/updatecredentialと一緒に使用して、認証情報のパスワードを更新します。
/username <username>
/updatecredentialと一緒に使用して、認証情報に保持されているユーザー名を更新します。
/description <text>
/updatecredentialまたは/createcredentialと一緒に使用して、認証情報に説明として保持されるテキストを設定します。
/expirydate <date>
/updatecredentialまたは/createcredentialと一緒に使用して、認証情報の有効期限が切れる日付を設定します。
日付はyyyyMMddの形式である必要があります。
/invalid <flag>
/updatecredentialまたは/createcredentialと一緒に使用して、認証情報を無効とマークするかどうかを指定します。
/credentialtype <string>
/updatecredentialまたは/createcredentialと一緒に使用して、認証情報のタイプを指定します。サポートされている値である必要があります。
/setcredentialproperty <credname> <propertyname> <propertyvalue>
新しい認証情報プロパティを作成するか、すでに存在する場合は更新します。
/userまたは/ssoスイッチのいずれかを使用してユーザー認証情報を提供する必要があります。また、「セキュリティ - 認証情報を管理」許可へのアクセスが必要です。
automatecコマンドラインプログラムを使用すると、スケジュールを開始および削除したり、レポートやタイムテーブルを表示したりできます。
スケジュールアクションを実行するには、有効なログイン詳細を入力する必要があります。
/schedule <name|...>
/startschedule、/deleteschedule、/viewschedtimetable、/viewschedreportの各アクションと組み合わせて使用するスケジュールの名前を指定します。
/scheduleスイッチの後続のパラメーターは、別のスイッチ(「/」文字で始まるパラメーター)またはコマンドの最後に到達するまで、スケジュール名として扱われます。
スケジュールが指定されていない場合、このコマンドは、通常はすべてのスケジュールに対して実行されているものとして扱われます。
/startschedule [/schedule <name|...>]
指定されたスケジュールを現在の時間に開始します。 スケジューラーが実行されている場合は、30秒以内にスケジュールを実行する必要があります。
/deleteschedule [/schedule <name|...>]
指定されたスケジュールとそれに関連するスケジュールログを削除します。
/format {txt|csv}
スケジュールレポートまたはタイムテーブルの出力形式を、「txt」(判読可能)または「csv」(コンマ区切り変数)のいずれかで指定します。形式が明示的に指定されていない場合、デフォルトは「txt」です。
/viewschedtimetable {<name> | <no-of-days> <date>} [/schedule <name>|...] [/format {txt|csv}]
指定されたタイムテーブルを出力します。
Blue Prismクライアントで作成および構成された名前付きのタイムテーブルを指定できます。
または、タイムテーブルの実行を開始する日付、表示する日数、含めるスケジュールを指定して、アドホックタイムテーブルを指定することもできます。
/viewschedreport {<name> | <no-of-days> <date>} [/schedule <name>|...] [/format {txt|csv}]
指定されたレポートを出力します。
Blue Prismクライアントで作成および構成された名前付きレポートを指定できます。
または、レポートに含める最新の日付、表示する過去の日数、含めるスケジュールを指定して、アドホックレポートを指定することもできます。
automateCコマンドラインプログラムを使用すると、リソースプールを作成および削除したり、既存のプールにリソースを追加および削除したりできます。
リソースプールアクションを実行するには、有効なログイン詳細を入力する必要があります。
/poolcreate /pool <name>
指定された名前でリソースプールを作成します。
/pooldelete /pool <name>
指定されたリソースプールを削除します。
/pooladd /pool <name> [/resource <name>]
指定されたプールにリソースを追加します。
リソース名が指定されていない場合は、ローカルリソースがプールに追加されます。
/poolremove [/resource <name>]
リソースが存在するプールからそのリソースを削除します。
リソース名が指定されていない場合は、ローカルリソースがそのプールから削除されます。