処理サーバーコマンドの説明
処理サーバーの管理に、コマンドラインインターフェースが使用することができます。コマンドラインインターフェースは、処理サーバーでの下記の動作の実行に使用できます：
- サーバーの初期化と停止
- ステーションの追加、セットアップ、および削除
- データセットの更新
- ホットフォルダの管理
- 診断モードの管理
処理サーバーコマンドは、次のようにして入力しなければなりません：「FlexiBrSvc Please [command]」毎回「FlexiBrSvc Please 」のフレーズを入力しなくても良いようにするには、FlexiBrSvc Please obeyを使用してコマンドモードを有効化することができます。コマンドモードを無効にするには、FlexiBrSvc Please quitを使用します。
上記コマンドのひとつまたは複数に関するヘルプは、help [command]で表示されます。
処理サーバーで使用する権限が与えられた全コマンドの説明を下記に示します。
認証資格の指定
- set basicauthstring=<username>:<password> –処理サーバーと処理ステーションの基本認証資格を設定します。このコマンドで資格が指定されるユーザーは、処理サーバーの役割を持っている必要があります。現在使用されている認証資格を削除するには、空の文字列を使用します：「set basicauthstring=」。 現在使用されている資格を表示するには、「view」を使用します（資格が指定されていない場合は、空白の文字列が返されます）。
注：基本的な認証資格は、処理サーバーおよび処理ステーションが実行中でない場合にのみ指定できます。無効な資格が指定された場合、処理サーバーと処理ステーションは起動しません。
サーバー管理
- set <param>=<value> – <value> 値を<param>パラメータに割り当てます。「view」コマンドを使用して、使用可能なパラメータの一覧を表示させます。「set <param>=?」コマンドを使用して、あるパラメータに使用できる値すべての一覧を表示させます。
- start server – 処理サーバーを初期化します。
- stop server [timeout] – 処理サーバーを停止します。
[timeout] パラメータを使用して、サーバーが初期化済みタスクを完了しなければならない時間長を設定します。このパラメータがセットされていない場合、サーバーは直ちに停止します。
ステーションの管理
- add station <location> – 新規のステーションを<location>に追加します。
- list stations – 既存のステーションについての情報を表示します。
- remove station <station>|* – <station>を削除します。全ステーションを削除するには「*」を使用してください。
注：このコマンドの実行には、ステーション名に加えてその場所またはUUIDを指定することが必要です。
- set station <station> <param>=<value> – <value>値を<param>ステーションパラメータに割り当てます。「view」コマンドを使用して、使用可能な全パラメータの一覧を表示させます。「set station <station> <param>=?」コマンドを使用して、使用可能なパラメータ値の一覧を表示させます。指定のパラメータ値を全ステーションに割り当てる場合は、ステーション名の代わりに「*」を使用してください。
- start station <<station>|*> [/Async] – <station>ステーションを初期化します。全ステーションを初期化するには、「*」を使用します。
注：このコマンドの実行には、ステーション名に加えてその場所またはUUIDを指定することが必要です。
<station>ステーションが初期化されていない場合、他のコマンドがブロックされないよう[/Async] パラメータを使用します。
- stop station <<station>|*> [timeout] – <station>ステーションを停止します。全ステーションを停止するには「*」を使用してください。
注：このコマンドの実行には、ステーション名に加えてその場所またはUUIDを指定することが必要です。
[timeout] パラメータを使用して、サーバーが初期化済みタスクを完了しなければならない時間長を設定します。
- view <station>|* – ステーション<station>についての詳細情報を表示します。全ステーションについての情報を表示するには、「*」を使用してください。ステーションが指定されていない場合、このコマンドによりサーバーの情報が表示されます。
ステーショングループを管理する
- set station <<station> StationGroup=<group name> – ステーションをグループに追加します。
- set station <<station> StationGroup= – グループからステーションを削除します。
注：ステーションがどのグループに属しているかを調べるには、 view <station>|*コマンドを使用します。
管理プロジェクト
- update dataset <project> [document definition] [data set] – データセットを更新します。プロジェクトへのフルパスを指定するには、<project>を使用します。例：https://app-server/f24d.../Banking_eng。文書定義名かデータセット名が指定されていない場合、すべての文書定義とデータセットが更新されます。
ホットフォルダの管理
- list hotfolders <project> – 使用可能な全ホットフォルダの詳細情報が表示されます。
- set hotfolder <project> Enabled/Disabled – プロジェクト<project>用のホットフォルダ処理を有効化または無効化します。「view」コマンドを使用して、使用可能なプロジェクトの一覧を表示させます。
処理の診断
プロファイルシステムは、サーバーおよび処理ステーションの状態の低レベルのモニタリング用に設計されています。プロファイリングが有効な場合、処理サーバーは、自身とステーションの内部処理についての統計値の収集を始めます。デフォルトでは、この機能は無効になっています。
処理サーバーは、ファイルシステム内の下記のフォルダに収集済みデータを保存します：%ProgramData%\ABBYY\FlexiCapture\12.0\FlexiBr[Svc]\Profiling。収集済みデータのディスクへの保存頻度は、下記のレジストリキーで設定されます。ProfilingManagerSaveWindowProfilingReportPeriod in HKEY_LOCAL_MACHINE\SOFTWARE\[Wow6432Node\]ABBYY\FlexiCapture\12.0\FlexiBr（単位：ミリ秒、デフォルト値は3600000）。
- reset total profiling report – プロファイリングレポート全体をリセットします。このコマンドを使用してプロファイリングレポートをリセットした後、レポートはコマンドが呼び出された後の期間のみをカバーします。
- save total profiling report <path> – 指定のフォルダーにプロファイリングレポート全体を保存します。
- save window profiling report <path> – 指定期間のプロファイリングレポート全体を指定フォルダに保存します。
- set profiling disabled – プロファイリングを無効にします。
- set profiling enabled – プロファイリングを有効にします。
12.04.2024 18:16:06