> ## Documentation Index
> Fetch the complete documentation index at: https://docs.abbyy.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Processing Server コマンドの説明

> ABBYY FlexiCapture Processing Server のコマンドライン リファレンス。ステーション、プロジェクト、hot folder、プロファイリングを管理するための FlexiBrSvc コマンドについて説明します。

コマンドライン インターフェイスを使用して、Processing Server に対して次の操作を実行できます。

* サーバーの初期化と停止
* ステーションの追加、設定、削除
* データセットの更新
* hot folder の管理
* 診断の管理

Processing Server コマンドは、次の形式で入力します: '**FlexiBrSvc Please \[command]**'。各コマンドで毎回 '**FlexiBrSvc Please** ' と入力する代わりに、**FlexiBrSvc Please obey** を使用してコマンドモードを有効にできます。コマンドモードを無効にするには、**FlexiBrSvc Please quit** を使用します。

上記のコマンドのヘルプを表示するには、**help \[command]** を使用します。

Processing Server で使用できるコマンドについて、以下で説明します。

<div id="specifying-authentication-credentials">
  ## 認証資格情報の指定
</div>

* **set basicauthstring=\<username>:\<password>** – Processing Server および Processing Stations の Basic 認証の資格情報を設定します。このコマンドで指定する資格情報に対応するユーザーには、[Processing Server role](/ja/flexi-capture/admin-guide/roles-setup)が付与されている必要があります。現在使用中の認証資格情報を削除するには、空の文字列 '**set basicauthstring=**' を使用します。現在使用中の資格情報を表示するには、**'view'** を使用します (資格情報が指定されていない場合は、空の文字列が返されます)。

<Note>
  Basic 認証の資格情報を指定できるのは、Processing Server と Processing Stations が実行されていない場合のみです。無効な資格情報を指定すると、Processing Server と Processing Stations は起動しません。
</Note>

<div id="managing-the-server">
  ## サーバーの管理
</div>

* **set \<param>=\<value>** – パラメーターに値を設定します。使用可能なすべてのパラメーターを表示するには、**'view'** を使用します。パラメーターに設定可能なすべての値を表示するには、**'set** **\<param>=?'** を使用します。

* **start server** – Processing Server を初期化します。

* **stop server \[timeout]** – Processing Server を停止します。

サーバーが開始済みのタスクを完了するまでの時間を設定するには、**\[timeout]** パラメーターを使用します。このパラメーターが設定されていない場合、サーバーは即座に停止します。

<div id="managing-stations">
  ## ステーションの管理
</div>

* **add station \<location>** – \<location> に新しいステーションを追加します。

* **list stations** – 既存のステーションの情報を表示します。

* **remove station \<station>|**\* – ステーションを削除します。すべてのステーションを削除するには、**'\*'** を使用します。

<Note>
  このコマンドでは、ステーション名と場所、または UUID を指定する必要があります。
</Note>

* **set station \<station> \<param>=\<value>** – パラメーターに値を設定します。使用可能なすべてのパラメーターを表示するには、**'view'** を使用します。設定可能なすべての値を表示するには、**'set station \<station> \<param>=?'** を使用します。

すべてのステーションに値を設定するには、ステーション名の代わりに **'\*'** を使用します。

* **start station \<\<station>|\*> \[/Async]** – ステーションの初期化を試行します。すべてのステーションの初期化を試行するには、'\*' を使用します。

<Note>
  このコマンドでは、ステーション名と場所、または UUID を指定する必要があります。
</Note>

指定したステーションが初期化されていない場合に他のコマンドがブロックされるのを防ぐには、**\[/Async]** パラメーターを使用します。

* **stop station \<\<station>|\*> \[timeout]** – ステーションを停止します。すべてのステーションを停止するには、'\*' を使用します。

<Note>
  このコマンドでは、ステーション名と場所、または UUID を指定する必要があります。サーバーが初期化済みのタスクを完了するまでの時間を設定するには、**\[timeout]** パラメーターを使用します。
</Note>

* **view \<station>|**\* – ステーションの詳細情報を表示します。すべてのステーションの情報を表示するには、'\*' を使用します。ステーションが指定されていない場合、このコマンドはサーバーの情報を表示します。

<div id="managing-station-groups">
  ## ステーショングループの管理
</div>

* **set station \<\<station> StationGroup=\<group name>** – ステーションをグループに追加します。
* **set station \<\<station> StationGroup=** – ステーションをグループから削除します。

<Note>
  ステーションがどのグループに属しているかを確認するには、**view \<station>|**\* コマンドを使用してください。
</Note>

<div id="managing-projects">
  ## Projectの管理
</div>

* **update dataset \<project> \[document definition] \[data set]** – データセットを更新します。Projectの完全パスを指定するには、**\<project>** を使用します (例: [https://app-server/f24d.../Banking\&#95;eng](https://app-server/f24d.../Banking\&#95;eng)) 。Document Definition またはデータセット名を指定しない場合は、すべての Document Definitions とデータセットが更新されます。

<div id="managing-hot-folders">
  ## Hot Folder の管理
</div>

* **list hotfolders \<project>** – 有効な Hot Folder すべての詳細情報を表示します。

* **set hotfolder \<project> Enabled/Disabled** – Project の Hot Folder 処理を有効または無効にします。使用可能な Project をすべて表示するには、**'view'** を使用します。

<div id="process-diagnostics">
  ## プロセス診断
</div>

プロファイリング システムは、Processing Server および Processing Station の内部プロセスを低レベルで監視するために設計されています。プロファイリングを有効にすると、Processing Server は自身と Processing Stations の内部プロセスに関する統計情報の収集を開始します。この機能はデフォルトで無効です。

Processing Server は、収集したデータをファイル システム内の次のフォルダーに保存します: **%ProgramData%\ABBYY\FlexiCapture\12.0\FlexiBr\[Svc]\Profiling**。収集したデータをディスクに保存する頻度は、HKEY\_LOCAL\_MACHINE\SOFTWARE\[Wow6432Node]ABBYY\FlexiCapture\12.0\FlexiBr​ にある次のレジストリ キー ProfilingManagerSaveWindowProfilingReportPeriod で設定します (単位はミリ秒。デフォルト値は 3600000)。

* **reset total profiling report** – プロファイリング レポート全体をリセットします。このコマンドでプロファイリング レポートをクリアすると、以後のレポートには、このコマンドの実行後の期間だけが含まれます。

* **save total profiling report \<path>** – プロファイリング レポート全体を指定したフォルダーに保存します。

* **save window profiling report \<path>** – 指定した期間のプロファイリング レポートを指定したフォルダーに保存します。

* **set profiling disabled** – プロファイリングを無効にします。

* **set profiling enabled** – プロファイリングを有効にします。