自動化 - インストール ガイド

role: SCHEDULER、Automate Scheduler コンポーネントが実行されることを示します。

apiSecret: Automate コンポーネント間の認証に使用されるキー。すべての Automate Scheduler、Proxy、Server インスタンスに同じランダム値を設定します。

internalCredentials：構成ファイルで定義された資格情報が認証に使用されることを示します。構成は、次のサブキーで提供されます。

username

email

salt、base64 でエンコードされた文字列

iterations、ハッシュの反復回数

hash、キーの長さが 512 ビットの PBKDF2WithHmacSHA512 アルゴリズムを使用して計算されます。

username

email

password

userSessionTimeout：ユーザーセッションが期限切れになるまでの非アクティブ期間（秒単位）。

nuixEnginePath：Nuixエンジンデプロイメントの場所。このフォルダーには、bin、lib、および`user-data`サブフォルダーが直接含まれている必要があります。

log4jConfigurationFile：log4j構成ファイル。

enableCentralizedLogging：true`またはfalse`は、集中ログ機能が有効になっているかどうかを示します。

centralizedLoggingRetention：ログが保持される日数。

centralizedLoggingMaxSize：ロールオーバー前の最大データベースサイズ（バイト単位）。

centralizedLoggingSizeCheckInterval: データベースがサイズ チェックを実行するまでの秒数。

enableRollingLoggingDatabases: ログ データベースが SQLite 用に構成されている場合、たとえば、ログ データベースが centralizedLoggingMaxSize で定義された最大サイズを maxRollingLoggingDatabases 設定で定義されたローリング データベースの数で割った値に達すると、データベースはローリングされます。データベースの名前が変更され、新しいデータベースが作成されます。デフォルトでは、この機能は無効になっています。たとえば、ユーザーの最大サイズが 1 GB で、ローリング データベースが 5 つある場合、すべてのローリング データベースの最大サイズは 200 MB になります。

maxRollingLoggingDatabases: ローリング データベースの最大数。データベースの最大数に達すると、最も古いログを持つデータベースが削除されます。

enableCentralizedLoggingDownloadTimeout: 集中ログのダウンロード タイムアウト機能が有効になっているかどうかを示す true または false。

centralizedLoggingDownloadTimeout: 終了する前にログをダウンロードする時間（ミリ秒単位）。デフォルトではこの値は 180000 (3 分) に設定されています。

engineInitLogFolder：ジョブを実行する前に、エンジンの初期化中に使用するログフォルダー。

archiveJobsPastDuration：終了したジョブが自動的にアーカイブされるまでの秒数。

archiveJobsPastCount：最も古いジョブが自動的にアーカイブされるまでの終了したジョブの最大数。

server：リッスンするIP /ポートとHTTPS接続のTLS証明書を示します。

webConfiguration: HSTS、XSS 保護、CORS、CSP など、REST API に使用される Web サーバーに適用する Web 設定を示します。

cors: CORS 構成。

logging：サービスが実行するロギングのパラメーターを示します。これらのログには、通常Nuix Workstationによってログに記録される情報も含まれます。ワーカーログの場所は`nuixFlags`パラメーターで指定されます。

applicationStore：監査情報の保存にカスタムデータベースが使用されることを示します。

utilizationStore：稼働率データの保存にカスタムデータベースが使用されることを示します。

loggingStore：カスタムデータベースがログの保存に使用されていることを示します。

defaultUserSettings：ユーザープロファイルに特定の構成が設定されていない場合に適用されるユーザー設定を上書きします。

sortAllowedParametersValues：true`またはfalse`は、ユーザーインターフェイスで定義された、またはスクリプトによって返される許可されたパラメーター値を並べ替える必要があるかどうか、または元の順序を維持する必要があるかどうかを示します。

jobMaximumExecutionParametersLength: 値がトリミングされる前に実行パラメータに含めることができる文字数。これは、スケジューラのフロントエンドのパフォーマンスにのみ影響します。デフォルトでは`200`文字に設定されています。

archivedJobCleanupEnabled: true または false は、アーカイブジョブクリーナーを実行するかどうかを示します。アーカイブジョブクリーナーは、アーカイブされたジョブが一定日数経過した後に、ジョブ、ジョブ実行ログ、およびジョブ操作のMIMEタイプ統計を削除します。デフォルトの値は false です。

archivedJobCleanupInterval: ジョブクリーンアップタスクの実行間隔（時間単位）。デフォルトでは`24`時間に設定されています。

archivedJobRetentionDays: ジョブが削除対象となるまでにアーカイブされる必要がある日数。デフォルトでは`584`日（1年半）に設定されています。

synchronizeJobsOnAllMatters：true`またはfalse`は、マターで一度に1つのジョブのみを実行できるかどうかを示します。

authTokenTtl：ユーザー認証トークンの有効期限が切れるまでの秒数。ブラウザは、トークンの寿命の半分で認証トークンを更新するように要求します。デフォルトでは`600`秒に設定されています。

disableAuthTokenExpiration：true`またはfalseは、ユーザー認証トークンの有効期限が切れていないことを示します。デフォルトでは、これはfalse`に設定されています。

expiredAuthTokenTombstone：期限切れの認証トークンを追跡するための秒単位の期間。有効期限が切れた認証トークンを使用して*自動化*にアクセスしようとすると、わかりやすいエラーメッセージが返され、現在のライブユーザーセッションが無効になります。デフォルトでは`900`に設定されています。

downgradeWebWorkerToken：true`またはfalseは、ブラウザがWeb Workerトークンをダウングレードして、ブラウザのスクリプトからアクセスできるようにする必要があることを示します。デフォルトでは、これはfalse`に設定されています。

enforceSingleUserSession: true または false は、ユーザーが一度に複数のセッションを持つことができるかどうかを示します。このオプションが true に設定されている場合、1 つのセッションのみが許可されます。

libraryFileMaxSize：デフォルトでファイルライブラリにアップロードできるファイルの最大サイズ（バイト単位）10000000。

expireIdleUploadAfter：データリポジトリへのアイドルアップロードが期限切れになるまでのミリ秒単位の期間。デフォルトでは`3600000`1時間に相当します。

uploadBufferMaxSize：データリポジトリへのアップロード中に割り当てるKiBの最大バッファサイズ。デフォルトでは`8192`。バッファサイズは、ファイルのアップロードごとに最大3回割り当てることができ、ファイルのアップロード中にのみ使用されます。

uploadHashAlgorithms：デフォルトでデータリポジトリにファイルをアップロードするときにサーバー側でハッシュに使用するアルゴリズム`MD5。アップロード中にハッシュを無効にするには、値None`を使用します。

enableUtilizationEndpoint: デフォルトで、スケジューラーの OData サービスを有効にします true。無効にするには、値 false を使用します。

utilizationErrorsSoftFail: デフォルトでは、使用率データ データベースのアプリケーションへの書き込みエラーをマスクします false。

azureLocations: (オプション) VM を実行する場所のリスト。azureLocations 設定の例:

azureVmSizes: (オプション) VM サイズのリスト。 「azureVmSizes」設定のサンプル:

データベースのリダイレクト。次の設定を使用して、アプリケーションを SQL データベースにリダイレクトします。

認証。次の設定を使用して、初期構成のためにアプリケーションにログインするためのアクセス資格情報を構成します。

マルチサーバー API シークレット。次の設定を使用して、さまざまなエンジン サーバーの管理に使用される API シークレットを構成します。

セキュリティポリシー。セキュリティ ポリシーを構成するには、次の設定を使用します。

セキュリティ ポリシー。次の設定を使用して、Automate ライセンスを構成します。

Nuix CLSライセンス。 Nuix CLS ライセンスを構成するには、次の設定を使用します。

リソースプール。リソース プールを構成するには、次の設定を使用します。

実行プロファイル。実行プロファイルを構成するには、次の設定を使用します。

ユーザー データ ディレクトリ。次の設定を使用して、ユーザー データ ディレクトリの動作を構成します。

任意の設定を上書きするには、設定名を大文字のスネークケースに変換し、先頭に「Automate」を付けます。たとえば、downgradeWebWorkerToken 設定を構成するには、AUTOMATE_DOWNGRADE_WEB_WORKER_TOKEN 環境変数を使用します。

role: PROXY、Automate Scheduler Proxy コンポーネントが実行されることを示します。

apiSecret: Automate コンポーネント間の認証に使用されるキー。すべての Automate Scheduler、Proxy、Server インスタンスに同じランダム値を設定します。

proxy：プロキシが使用するメインスケジューラインスタンスの詳細。構成は、次のサブキーで提供されます。

allowedAuthenticationServices: この Proxy 経由で使用できる認証サービス名のリスト。この設定が定義されていない場合、すべての認証サービスがプロキシ経由で許可されます。

log4jConfigurationFile：log4j構成ファイル。

server: Web アクセス ログ設定、リッスンする HTTP プロトコル、および HTTPS 接続の対応する IP、ポート、TLS 証明書を示します。

webConfiguration：RESTAPIに使用されるWebサーバーに適用するWeb設定を示します。

role: ENGINE_SERVER、Automate Engine Server コンポーネントが実行されることを示します。

apiSecret: Automate コンポーネント間の認証に使用されるキー。すべての Automate Scheduler、Proxy、Server インスタンスに同じランダム値を設定します。

nuixEnginePath：Nuixエンジンデプロイメントの場所。このフォルダーには、bin、lib、および`user-data`サブフォルダーが直接含まれている必要があります。

log4jConfigurationFile：log4j構成ファイル。

engineInitLogFolder：初期化フェーズ中に構成ファイルとログを保存するためにエンジンが使用する一時的な場所。ジョブを実行すると、エンジンはログと構成ファイルを実行プロファイルで指定された場所に保存します。

engineInitTimeout：エンジンが初期化できる秒単位のタイムアウト。デフォルトでは`120`。

engineAbortTimeout: エンジンがジョブを中止するまで待機するタイムアウト (ミリ秒単位)。デフォルトは 5000 (5 秒)

server: Web アクセス ログ設定、リッスンする HTTP プロトコル、および HTTPS 接続の対応する IP、ポート、TLS 証明書を示します。

webConfiguration：RESTAPIに使用されるWebサーバーに適用するWeb設定を示します。

jobRunningLogMaxSize：ログを実行しているジョブがデフォルトで保存するログの最大数を示します`20`。

logging：サービスが実行するロギングのパラメーターを示します。これらのログには、通常Nuix Workstationによってログに記録される情報も含まれます。ワーカーログの場所は`nuixFlags`パラメーターで指定されます。

メモ：リモートワーカーを実行するときにワーカーブローカーをホストするために使用するIPアドレス。

workerBrokerStartPort：ワーカーブローカーのポート範囲の開始。

workerBrokerEndPort：Worker Brokersのポート範囲の終わり。

データベースのリダイレクト。次の設定を使用して、アプリケーションを SQL データベースにリダイレクトします。

自動登録。エンジン サーバーをスケジューラ リソース プールに自動的に登録するには、次の設定を使用します。リソース プールは、自動登録機能を有効にして構成する必要があります。

マルチサーバー展開。マルチサーバー展開シナリオでは、次の設定を使用します。

エンジンログレイアウト

role: ODATA_SERVER、Automate OData Server コンポーネントが実行されることを示します。

internalCredentials：構成ファイルで定義された資格情報が認証に使用されることを示します。構成は、次のサブキーで提供されます。

username

email

salt、base64 でエンコードされた文字列

iterations、ハッシュの反復回数

hash、キーの長さが 512 ビットの PBKDF2WithHmacSHA512 アルゴリズムを使用して計算されます。

username

email

password

server: Web アクセス ログ設定、リッスンする HTTP プロトコル、および HTTPS 接続の対応する IP、ポート、TLS 証明書を示します。

webConfiguration：RESTAPIに使用されるWebサーバーに適用するWeb設定を示します。

utilizationStore：監査情報の保存にカスタムデータベースが使用されることを示します。

C:\Program Files\Nuix\Automate：インストールフォルダー

%programdata%\Nuix\Automate\Scheduler\config：構成フォルダー

%programdata%\Nuix\Automate\Scheduler\stores：ジョブの詳細、使用率、監査、レポート、使用率の永続化とアーカイブ

C:\Temp\logs\automate-scheduler.log: アプリケーションログ

C:\Temp\logs\automate-scheduler.%d.log.zip: 以前のアプリケーションログファイル

C:\Temp\logs\automate-scheduler-access.log：Webアクセスログ

C:\Temp\logs\automate-scheduler-access.%d.log.zip：以前のメインログファイル

C:\Temp\logs\Automate Scheduler.wrapper.log：サービスラッパーログ

C:\Temp\logs\Automate Scheduler.err.log：サービス標準エラーログ

C:\Temp\logs\Automate Scheduler.out.log：サービス標準出力ログ

C:\Program Files\Nuix\Automate：インストールフォルダー

%programdata%\Nuix\Automate\EngineServer\config：構成フォルダー

C:\Temp\logs\automate-engine-server.log: アプリケーションログ

C:\Temp\logs\automate-engine-server.%d.log.zip: 以前のアプリケーションログファイル

C:\Temp\logs\automate-engine-server-access.log：Webアクセスログ

C:\Temp\logs\automate-engine-server-access.%d.log.zip：以前のメインログファイル

C:\Temp\logs\Automate Engine Server.wrapper.log：サービスラッパーログ

C:\Temp\logs\Automate Engine Server.err.log：サービス標準エラーログ

C:\Temp\logs\Automate Engine Server.out.log：サービス標準出力ログ

C:\Temp\logs\automate-engine.aaaaaaaa-init.log：初期ログ

C:\Temp\logs\automate-engine.aaaaaaaa-init.yml：初期構成

C:\Temp\logs\automate-engine.aaaaaaaa-service.exe：サービスラッパー

C:\Temp\logs\automate-engine.aaaaaaaa-service.xml：サービス構成

C:\Temp\logs\automate-engine.aaaaaaaa-job.bbbbbbbb.log：ジョブログ

C:\Temp\logs\automate-engine.aaaaaaaa-job.bbbbbbbb.yml：ジョブ構成