RoboServer の開始
RoboServer はいくつかの異なる方法で開始できます:
-
コマンド ラインから呼び出す。
-
サービスとして実行する。サーバーを自動的に起動を参照してください。
-
Docker コンテナを実行する。詳細については、『Kofax RPA 管理者ガイド』を参照してください。
-
RoboServer プログラム アイコン (または、Management Console および RoboServer の両方を開始する Management Console プログラムの開始アイコン) をクリックする。デモおよびテストのみを目的としています。
コマンド ラインから RoboServer を呼び出すには、コマンド プロンプト ウィンドウを開き、以下の Kofax RPA インストール フォルダにある bin フォルダに移動し、次のコマンドを実行します:
RoboServer
必要なパラメータがすべて C:Users\[ユーザー]\AppData\Local\[バージョン]\Kofax RPA\Configuration\roboserver.settings 設定ファイルで指定されている場合、RoboServer が開始されます。
必要なパラメータのいずれかが欠落している場合、RoboServer はエラーを指定し、使用法のヘルプと使用可能なパラメータを表示します。
RoboServer パラメータ
RoboServer を開始するためのコマンド ラインは、次のパラメータを含めることができます。
RoboServer [-client] [-MC] [-mcUrl <arg>] [-cl <arg>] [-cpuThreads <arg>] [-h] [-maxConcurrentRobots <arg>] [-maxQueuedRobots <arg>] [-ss <MC Shared Secret>] [-p <arg>] [-pauseAfterStartupError] [-s <arg>] [-sslPort <arg>] [-v] [-V]
RoboServer は、次の表のパラメータを受け入れます。RoboServer 設定アプリケーションですべてのパラメータを編集できることに注意してください。詳細については、RoboServer の設定 を参照してください。
|
パラメータ |
説明 |
|---|---|
|
-mcUrl <arg> |
この必須パラメータでは、次の形式で登録する Management Console を指定します。 http[s]://[ホスト名]:[ポート番号] 例:-mcUrl http://myserver:8080/ManagementConsole ロボットでコールバック オプションとともに Document Transformation ステップを使用する場合は、-mcUrl パラメータで RoboServer ホスト名または IP アドレスを使用します。Document Transformation サービスが Management Console にアクセスできなくなり、コールバック ロボットがキューに格納されなくなるため、「localhost」は使用しないでください。 |
|
-ss --mcSharedSecret [MC 共有シークレット] |
この必須パラメータにより、RoboServer を Management Console で認証するために使用される共有シークレットを指定します。共有シークレットは、Management Console の [サービス認証] セクションからコピーする必要があります。詳細については サービス認証 を参照してください。 |
|
-cl --cluster <arg> |
この必須パラメータは Management Console で指定されたクラスタに RoboServer を自動的に登録します。以下の例では、RoboServer が Production クラスタにそれ自体を登録します。 例:-cl Production 例:-mcUrl http://myserver:8080/ManagementConsole -ss [MC 共有シークレット] -cl Production |
|
-eh --externalHost <ポート番号> |
RoboServer ホストの名前または IP アドレスを明示的に指定します。 このパラメータは、クラウド内で NAT を使用して実行しているとき、または Docker コンテナ内で RoboServer を実行しているときのように、RoboServer がローカルマシンで見つけたものとホスト アドレスが異なる場合に指定する必要があります。 例:-eh 10.10.0.123 |
|
-ep --externalPort <ポート番号> |
RoboServer ホストのポート番号を明示的に指定します。 クラウド内で NAT を使用して実行しているとき、または Docker コンテナ内で RoboServer を実行しているときのように、RoboServer がローカル マシンで見つけたものとホスト ポートが異なる場合、このパラメータを指定する必要があります。 |
|
-jmxPass |
JMX アプリケーションを使用して RoboServer を監視し、パスワードが必要な場合、JMX パスワードを設定します。 |
|
-v --verbose |
このオプション パラメータにより、RoboServer がステータスおよびランタイム イベントを出力します。 |
|
-V --version |
このオプションのパラメータによって、RoboServer でバージョン番号が出力され、終了します。 |
|
-h --help |
ヘルプを表示します。 |
|
-pauseAfterStartupError |
起動時にエラーが発生した場合に一時停止します。 |
|
-s --service <service-name:service-parameter> |
このパラメータは、RoboServer が開始する必要のある RQL または JMX サービスを指定します。このパラメータは少なくとも一度指定する必要があり、同じ RoboServer で複数のサービスを開始するには複数回指定する場合があります。利用可能なサービスは、インストールによって異なります。 例:--service socket:50000 例:--service jmx:50100 詳細については、下の表で「利用可能なサービス」を確認してください。 |
|
-p --port <ポート番号> |
これは、-s socket:<port-number> を呼び出すための省略形です。 例:--port 50000 |
|
-sslPort <arg> |
これは、-s ssl:<port number> を書き込むための省略形です。 |
|
-nd --NoDoc |
このオプション パラメータにより、この RoboServer に対する ロボットのドキュメント リクエストを禁止します。 |
|
-sn --serverName |
これは、後で Kofax Analytics for RPA に表示される、RoboServer 統計を記録するためのサーバー名を設定するオプション パラメータです。サーバー名を指定しない場合、統計はサーバーの IP アドレスに基づいて収集されます。 |
|
-ll --licenseLimit <arg> |
このパラメータは、RoboServer が受け取ることができるライセンス ユニットの最大数を定義します。 |
|
-client |
RoboServer が Management Console クラスタ向けのクライアントとして実行されるように指定します。高可用性モードではサポートされません。 |
|
利用可能なサービス |
|
|
--service socket:<portNumber> |
RoboServer が Management Console クラスタ向けのサービスとして実行されるように指定します。 <portNumber>: 監視対象のソケット サービスのポート番号。 |
|
--service ssl:<portNumber> |
RoboServer を Management Console クラスタ向けのサービスとして実行し、セキュアな接続を作成することを指定します。 <portNumber>: 監視対象のソケット サービスのポート番号。 |
|
--service jmx:<jmx_port_Number>,<jmx_rmi_url> |
<jmx_port_Number>: 監視対象の JMX サービスのポート番号。 <jmx_rmi_url>: JMX サービス向けのオプションの RMI ホストとポート。ファイアウォールを接続する必要がある場合に使用します。 例:example.com:51001 |
RoboServer と Management Console の間の接続タイプを設定するには、次のパラメータのいずれかを選択します。
-
-client
-
--service socket:<portNumber>
-
--service ssl:<portNumber>
RoboServer に接続するコマンド ラインの例:
-
Management Console クラスタ向けのクライアントとして:
ここで、clientCluster は、Management Console で作成されたクライアント接続タイプのクラスタの名前です。-client -mcUrl http://localhost:8080/ManagementConsole -cluster <clientCluster> -ss <MC Shared Secret> -
Management Console クラスタ向けのサービスとして:
ここで、<serviceCluster> は、Management Console で作成されたサービス接続タイプのクラスタの名前です。-service socket:50000 -mcUrl http://localhost:8080/ManagementConsole -cluster <serviceCluster> -ss <MC Shared Secret>
Kofax RPA バージョン 10 以降、すべての RoboServer は Management Console に自動登録する必要があります。したがって、Management Console を起動するときに、Management Console の URL と共有シークレット、およびクラスタ名を指定する必要があります (次の例のようにコマンド ラインで指定するか、[Management Console に登録] オプションで RoboServer 設定アプリケーションを使用します)。
RoboServer.exe -mcUrl http://myserver:8080/ManagementConsole -ss [MC 共有シークレット] -cluster Production -service socket:50000
サーバーを自動的に起動
インストールにサーバー機能が含まれている場合、サーバーが自動的に開始するように設定できます。
「サーバー機能」とは、RoboServer および Management Console (ライセンス サーバー) を意味します。実際には、この 2 つの機能は、このプログラムの起動時に指定した引数に基づいて、同じサーバー プログラム RoboServer から提供されます。
「RoboServer パラメータ」セクションには、RoboServer プログラム用のコマンドライン引数の詳細な説明が含まれています。RoboServer プログラムを有効にするにはロボットを実行し、 -service 引数を指定します。同様に、-MC 引数により Management Console 機能が有効になります (『インストール ガイド』の「Management Console」(ライセンス サーバー) を参照)。
RoboServer およびその他の RPA コンポーネントをサービスとして起動することについては、『Kofax RPA 管理者ガイド』の「RPA コンポーネントをサービスとして実行」を参照してください。
RoboServer のシャットダウン
RoboServer は、次のコマンド ライン ツールを使用してシャットダウンできます。引数なしで ShutDownRoboServer を実行して、サーバーをシャットダウンする方法、特に現在サーバーで実行中のロボットを処理する方法のさまざまなオプションを確認します。