Haftungsausschluss Haftungsausschluss

Das Material in diesem Dokument dient nur zu Informationszwecken. Die darin beschriebenen Produkte können aufgrund des kontinuierlichen Entwicklungsprogramms des Herstellers ohne vorherige Ankündigung geändert werden. Nuix übernimmt keine Zusicherungen oder Gewährleistungen in Bezug auf dieses Dokument oder in Bezug auf die darin beschriebenen Produkte. Nuix haftet nicht für direkte, indirekte oder zufällige Schäden, Verluste, Kosten oder Ausgaben, Folgeschäden oder besondere Schäden, die aus der Verwendung dieses Materials oder der darin beschriebenen Produkte entstehen oder damit in Zusammenhang stehen.

© Nuix Canada Inc. 2024 Alle Rechte vorbehalten

Einführung

Diese Anleitung beschreibt die Installation von Automatisieren. Dieses Dokument funktioniert wie eine Referenz. Verwenden Sie das Inhaltsverzeichnis, um nach dem Thema zu suchen, über das Sie sich informieren.

Die Automate-Software und diese Dokumentation können Bugs, Fehler oder andere Einschränkungen enthalten. Wenn Sie Probleme mit der Automate-Software oder dieser Dokumentation haben, wenden Sie sich bitte an den nuix-Support.

Obwohl wir Feedback zu allen Produktversionen akzeptieren, ist der Support auf die neueste Haupt- und Nebenversion aus den vierteljährlichen und jährlichen Release-Kanälen beschränkt. Automate empfiehlt, Benachrichtigungen zu Produktaktualisierungen zu abonnieren und die Aktualisierungen innerhalb kurzer Zeit nach ihrer Verfügbarkeit zu prüfen und anzuwenden.

Für die Software ist eine gültige Automate-Lizenz erforderlich. Die Lizenz ist in der Regel zeitlich begrenzt und bestimmte Funktionen der Software erfordern eine bestimmte Lizenzversion. Wenn Sie Probleme mit der Automate-Lizenz haben oder spezielle Fragen zu einer Produktfunktion haben, wenden Sie sich bitte an den nuix-Support.

In diesem Handbuch verwendete Stile

Hinweis: Dieses Symbol zeigt an, dass zusätzliche Erläuterungen bereitgestellt werden, z. B. die gültigen Optionen.
Trinkgeld: Dieses Symbol weist Sie darauf hin, dass ein besonders nützlicher Leckerbissen bereitgestellt wird, möglicherweise eine Möglichkeit, die Anwendung zu verwenden, um ein bestimmtes Verhalten zu erzielen.
Warnung: Dieses Symbol hebt Informationen hervor, die Ihnen helfen können, ein unerwünschtes Verhalten zu vermeiden.

  • Hervorgehoben: Dieser Stil gibt den Namen eines Menüs, einer Option oder eines Links an.

  • code: Dieser Stil gibt Code an, der wörtlich verwendet werden soll, und kann auf Dateipfade, Parameternamen oder Nuix-Suchabfragen verweisen.

1. Die Architektur

1.1. Komponenten

Zu einer Automate-Bereitstellung gehören mehrere Komponenten:

  • Automatisieren Sie den Scheduler: Empfängt Anfragen von Analysten oder Unternehmensdiensten zum Einreihen von Jobs und leitet die Jobs an die Automate Engine-Server weiter.

  • Automate Engine Server: Empfängt Jobs vom Automate Scheduler, startet Engines und führt Jobs aus.

  • Nuix Engine: Die Nuix Engine erstellt / öffnet Nuix-Fälle und führt die erforderlichen Arbeiten in den Fällen aus.

  • Nuix-Lizenzquelle: Es können eine oder mehrere Nuix-Lizenzquellen der folgenden Typen verwendet werden:

    • Nuix NMS

    • Nuix License Dongle

    • Nuix Cloud-Lizenz

  • Authentifizierungsquelle: Der Dienst, mit dem Benutzer authentifiziert und die Gruppenmitgliedschaft ermittelt werden. Dies kann eine Kombination der folgenden sein:

    • Nuix UMS: Der Nuix User Management Server

    • LDAP: On-Premise-Active Directory

    • Azure AD: Microsoft Azure Active Directory

    • OIDC: Ein mit Open ID Connect kompatibler Authentifizierungsdienst

    • Intern: Intern definierte Benutzernamen und Passwörter für die Erstkonfiguration.

Darüber hinaus sind die folgenden Komponenten optional:

  • OData-Server automatisieren: Gibt Nutzungsdaten mithilfe des OData-Protokolls zurück.

  • Proxy automatisieren: Entlastet den Haupt-Automate-Scheduler vom Hochladen und Hashen der Daten.

  • Business Intelligence-Software: Ein Softwaretool, das die Automate-Umgebung nach Metriken abfragt, die Daten analysiert und interaktive Dashboards bereitstellt, beispielsweise Microsoft Power BI oder Tableau.

  • Microsoft SQL: Kann verwendet werden, um die integrierte Scheduler-Datenbank zum Speichern von Auftragsinformationen, Konfigurations- und Überwachungsprotokollen zu ersetzen.

1.2. Einsatz

Mit Ausnahme des Automate Engine Servers, der auf jedem Nuix-Server installiert werden muss, der Teil der Automate-Bereitstellung ist, können alle verbleibenden Komponenten entweder auf demselben Server oder auf dedizierten Servern bereitgestellt werden.

Wenn Sie den optionalen Automate OData Server auf einem anderen Server als dem bereitstellen, auf dem Automate Scheduler gehostet wird, müssen die Nutzungsdaten von der eingebetteten Datenbank in eine Microsoft SQL-Datenbank umgeleitet werden.

1.2.1. Beispiel für eine verteilte Architektur

Diese Beispielarchitektur besteht aus einem dedizierten Server, der den Automate Scheduler hostet, mehreren Servern, die Automate Engine Server und Nuix Engines hosten, dedizierten Servern für Nuix NMS und Nuix UMS sowie Konnektivität mit Azure AD.

Beispiel für eine verteilte Architektur

1.2.2. Beispiel für eine eigenständige Architektur

Diese Beispielarchitektur besteht aus einem einzelnen Server, der den Automate Scheduler und den Automate Engine Server, mehrere Nuix Engines sowie das Nuix NMS und Nuix UMS hostet.

Beispiel für eine eigenständige Architektur

1.3. Netzwerkverkehrsfluss

Komponenten in einer automatisierten Bereitstellung kommunizieren über HTTP. Informationen zum Konfigurieren der TCP-Ports und TLS-Zertifikate finden Sie in Abschnitt Configuration.

Verkehrsfluss
Quelle Ziel Protokoll (Port)

Analyst-Webbrowser

Automatisierter Planer

HTTPS (TCP/443)

Analyst-Webbrowser

Azure AD

HTTPS (TCP/443)

Automatisierter Planer

Automatisierter Engine-Server

HTTPS (TCP/443)

Automatisierter Engine

Automatisierter Planer

HTTPS (TCP/443)

Automatisierter Planer

Nuix UMS

HTTPS (TCP/443)

Automatisierter Planer

Azure AD

HTTPS (TCP/443)

Nuix Engine

Nuix NMS

HTTPS (TCP/27443)

2. Voraussetzungen

Siehe https://nuix.service-now.com/support?id=kb_Artikel_view&sys_kb_id=7ef9b32b47cc96102d9c89cbd36d4368[https://nuix.service-now.com/support?id=kb_Artikel_view&sys_kb_id=7ef9b32b47cc96102d9c89cbd36d4368]

3. Konfiguration

3.1. Serviceeinstellungen

Die Konfigurationsdateien befinden sich an folgenden Speicherorten:

  • Planer automatisieren C:\ProgramData\Nuix\Automate\Scheduler\config\config.yml

  • Automate Engine Server C:\ProgramData\Nuix\Automate\EngineServer\config\config.yml

  • OData-Server automatisieren C:\ProgramData\Nuix\Automate\ODataServer\config\config.yml

Darüber hinaus können bestimmte Konfigurationsoptionen des Scheduler-Dienstes mithilfe von Umgebungsvariablen festgelegt werden (weitere Einzelheiten finden Sie in Abschnitt Scheduler Service Environmental Variables).

3.1.1. Scheduler-Serviceeinstellungen

Diese Dateien folgen der YAML-Syntax und enthalten die folgenden Parameter:

  • role: SCHEDULER zeigt an, dass die Komponente „Automate Scheduler“ ausgeführt wird;

  • apiSecret: Schlüssel, der für die Authentifizierung zwischen Automate-Komponenten verwendet wird. Legen Sie für alle Automate Scheduler-, Proxy- und Serverinstanzen denselben Zufallswert fest.

  • internalCredentials: Gibt an, dass die in der Konfigurationsdatei definierten Anmeldeinformationen zur Authentifizierung verwendet werden. Die Konfiguration wird in den folgenden Unterschlüsseln bereitgestellt:

    • displayName: (Optional) Der Name, der auf der Anmeldeseite für diese Authentifizierungsmethode angezeigt werden soll.

    • restrictToLocalhost: (Optional) Beschränken Sie die Verfügbarkeit der internen Authentifizierung auf Browser von localhost. Wenn diese Eigenschaft nicht angegeben ist, ist sie standardmäßig false.

    • usersEligibleLegalHoldAdministrator: (Optional) Berechtigen Sie interne Benutzer für Legal Hold-Verwaltungen. Wenn diese Eigenschaft nicht angegeben ist, ist sie standardmäßig false.

    • usersEligibleLegalHoldCustodian: (Optional) Berechtigen Sie interne Benutzer für Legal Hold Custodians. Wenn diese Eigenschaft nicht angegeben ist, ist sie standardmäßig false.

    • credentials: Die Liste der Anmeldeinformationen.

Die Anmeldeinformationen können in beiden PBKDF2-Formaten bereitgestellt werden, indem Sie Folgendes verwenden:

  • username

  • email

  • salt, eine base64-codierte Zeichenfolge

  • iterations, die Anzahl der Hash-Iterationen

  • hash, berechnet mit dem PBKDF2WithHmacSHA512-Algorithmus mit einer Schlüssellänge von 512 Bits.

oder im Klartext mit:

  • username

  • email

  • password

Beispiel für eine interne Authentifizierungskonfiguration mit 2 Benutzern:

internalCredentials:
  displayName: UsernamePassword
  restrictToLocalhost: true
  credentials:
    - username: user1
      email: user1@example.com
      salt: NlbCqq8kL6sqdZQrjMmgSw==
      iterations: 1000000
      hash: ca4xiopDRshgyKvArOfKqBoDeVfbsOpayzVrh8n1WAWOhqvunITolqBBTiSAn1VxTBUz+15IfX4qxiTuHrthuA==

    - username: user2
      email: user2@example.com
      password: Password2@
Die interne Authentifizierungsmethode erfordert das Speichern der Benutzernamen und Passwörter oder Hashes in der Konfigurationsdatei. Es wird empfohlen, diese Methode auf localhost zu beschränken.
Legen Sie die Eigenschaft restrictToLocalhost auf true fest, um die Anmeldung nur mit internen Anmeldeinformationen zuzulassen, wenn Sie als lokaler Host auf Automate zugreifen.

  • userSessionTimeout: Die Dauer der Inaktivität in Sekunden, nach der eine Benutzersitzung abläuft.

  • nuixEnginePath: Der Speicherort der Nuix Engine-Bereitstellung. Dieser Ordner sollte die Unterordner bin, lib und user-data direkt enthalten.

  • log4jConfigurationFile: Die log4j-Konfigurationsdatei.

  • enableCentralizedLogging: true oder false geben an, ob die zentrale Protokollierungsfunktion aktiviert ist.

Standardmäßig ist diese Funktion aktiviert. Um diese Funktion zu deaktivieren, setzen Sie den Wert auf false

  • centralizedLoggingRetention: Die Dauer in Tagen, für die die Protokolle aufbewahrt werden.

  • centralizedLoggingMaxSize: Die maximale Datenbankgröße in Byte vor einem Rollover.

  • centralizedLoggingSizeCheckInterval: Die Dauer in Sekunden, nach der die Datenbank eine Größenprüfung durchführt.

  • enableRollingLoggingDatabases: Wenn die Protokollierungsdatenbank für SQLite konfiguriert ist, werden Datenbanken gerollt, z. B. wenn die Protokollierungsdatenbank die in centralizedLoggingMaxSize definierte maximale Größe erreicht, geteilt durch die Anzahl der in der Einstellung maxRollingLoggingDatabases definierten rollierenden Datenbanken. Die Datenbank wird umbenannt und eine neue Datenbank wird erstellt. Standardmäßig ist diese Funktion deaktiviert. Wenn der Benutzer beispielsweise eine maximale Größe von 1 GB und 5 rollierende Datenbanken hat, beträgt die maximale Größe für alle rollierenden Datenbanken 200 MB.

Wenn die Datenbank Protokolle rollt, werden die heruntergeladenen Protokolle eine abgespeckte Version sein, die alles außer den eigentlichen Protokollen aus der Datenbank enthält, und die zentrale Protokollierung wird vorübergehend deaktiviert. Wenn die Datenbankrotation stattfindet, während der Benutzer Protokolle herunterlädt, wird der Download-Thread beendet und gibt dem Benutzer die Protokolle, die er sammeln konnte, und protokolliert eine Warnung, um den Benutzer darüber zu informieren, dass der Download aufgrund der Rotation beendet wurde.

  • maxRollingLoggingDatabases: Die maximale Anzahl rollierender Datenbanken. Wenn die maximale Anzahl an Datenbanken erreicht ist, wird die Datenbank mit den ältesten Protokollen gelöscht.

  • enableCentralizedLoggingDownloadTimeout: true oder false zeigt an, ob die Funktion für das Download-Timeout für die zentrale Protokollierung aktiviert ist.

Diese Funktion schließt den Stream zum Herunterladen von Protokollen nach einem in der Einstellung zentralisiertLoggingDownloadTimeout` festgelegten Intervall. Diese Funktion wird nur für die Fehlerbehebung empfohlen und ist standardmäßig deaktiviert.

  • centralizedLoggingDownloadTimeout: Die Zeit in Millisekunden zum Herunterladen der Protokolle vor dem Beenden. Standardmäßig ist dieser Wert auf 180000 (3 Minuten) eingestellt.

  • engineInitLogFolder: Der Protokollordner, der während der Engine-Initialisierung verwendet werden soll, bevor der Job ausgeführt wird.

  • archiveJobsPastDuration: Die Dauer in Sekunden, nach der abgeschlossene Jobs automatisch archiviert werden.

  • archiveJobsPastCount: Die maximale Anzahl abgeschlossener Jobs, nach denen der älteste Job automatisch archiviert wird.

  • server: Zeigt die IP / Ports an, die abgehört werden sollen, und das TLS-Zertifikat für HTTPS-Verbindungen.

Standardmäßig lauscht der Dienst auf HTTP auf Port 80 auf localhost und auf HTTPS auf Port 443 auf alle IP-Adressen. Um den Server auf das Abhören einer bestimmten IP-Adresse zu beschränken, ändern Sie 0.0.0.0 in die erforderliche IP-Adresse in der config.yml-Datei.
Wenn Sie Scheduler von einer Version vor 6.0 aktualisieren, akzeptiert der Server standardmäßig nur HTTP/1.1-Verbindungen. Um HTTP/2-Verbindungen zu aktivieren, ändern Sie type: https in type: h2 in der config.yml-Datei.

  • webConfiguration: Gibt an, welche Webeinstellungen auf den Webserver angewendet werden sollen, der für die REST-API verwendet wird, einschließlich HSTS, XSS-Schutz, CORS und CSP.

  • cors: Die CORS-Konfiguration.

Die Automate REST API ist so konzipiert, dass sie sowohl von der auf dem Scheduler-Server gehosteten Webseite als auch von Diensten und Webseiten von Drittanbietern aufgerufen werden kann. Aus diesem Grund lässt die standardmäßige CORS-Konfiguration alle Ursprünge zu. Diese Konfiguration ist sicher, da jede Anforderung an die REST API mit einem Bearer-Token authentifiziert werden muss. Wenn die zulässigen CORS-Ursprünge weiter eingeschränkt werden müssen, kann eine strengere Richtlinie eingeführt werden, indem die standardmäßigen CORS-Einstellungen in der Datei config.yml bearbeitet werden.

Beispiel für eine CORS-Richtlinie, die die zulässigen Ursprünge einschränkt:

  cors:
    allowedOrigins: ["https://scheduler.example.com"]

  • logging: Zeigt die Parameter der vom Dienst durchgeführten Protokollierung an. Diese Protokolle enthalten auch die Informationen, die normalerweise von Nuix Workstation protokolliert werden. Der Speicherort der Arbeitsprotokolle wird im Parameter nuixFlags angegeben.

  • applicationStore: Gibt an, dass eine benutzerdefinierte Datenbank zum Speichern der Überwachungsinformationen verwendet wird.

    • driverClass: net.sourceforge.jtds.jdbc.Driver

    • user: Der Datenbank-Benutzername

    • password: Das Datenbankkennwort

    • url: Die JDBC-Verbindungszeichenfolge, zum Beispiel jdbc:jtds:sqlserver://HOST:1433/DATABASE

    • properties: Die Verbindungseigenschaften.

Beispiel für eine Microsoft SQL-Konfiguration:

applicationStore:
  driverClass: net.sourceforge.jtds.jdbc.Driver
  user: automate-service
  password: SecretGoesHere
  url: jdbc:jtds:sqlserver://localhost:1433/automate
  properties:
    charSet: UTF-8
Wenn in der Microsoft SQL-Speicherkonfiguration kein Benutzername und kein Kennwort angegeben sind, wird die Verbindung mithilfe der integrierten Windows-Authentifizierung hergestellt. Wenn Sie auf diese Weise eine Verbindung zu Microsoft SQL herstellen, sollte der Automate Scheduler-Dienst so konfiguriert werden, dass er unter einem Konto ausgeführt wird, das Zugriff auf die Microsoft SQL-Datenbank hat.

  • utilizationStore: Gibt an, dass eine benutzerdefinierte Datenbank zum Speichern der Betriebsauslastungsdaten verwendet wird.

  • loggingStore: Gibt an, dass eine benutzerdefinierte Datenbank zum Speichern von Protokollen verwendet wird.

Das loggingStore ist ein Ringpuffer aller Plattformprotokolle und soll einen Schreibdurchsatz generieren. Es wird nicht empfohlen, diesen Protokollspeicher an eine SQL-Datenbank umzuleiten.

Beispielkonfiguration, bei der das loggingStore nach D:\Logs\Automate verschoben wird:

loggingStore:
  driverClass: org.sqlite.JDBC
  url: jdbc:sqlite:D:/Logs/Automate/logging.db
  properties:
    charSet: UTF-8
Die verschiedenen oben aufgeführten Speicher können alle in eine einzelne Microsoft SQL-Datenbank oder nach Bedarf in separate Datenbanken umgeleitet werden.

  • defaultUserSettings: Überschreiben Sie die Benutzereinstellungen, die gelten, wenn für ein Benutzerprofil keine bestimmte Konfiguration festgelegt wurde.

Beispieleinstellungen zum Definieren der zulässigen Parameterwerte, die beim Erstellen eines neuen Clients oder einer neuen Angelegenheit standardmäßig ausgefüllt werden:

defaultUserSettings:
  newMatter:
    allowedParameterValues:
      - "{custodian}": ["John Smith","Annie Rosella"]
      - "{sample_parameter_1}": []
    synchronizeJobs: true
  newClient:
    allowedParameterValues:
      - "{doc_id_prefix}": ["DOC","DOC-","DOCID"]
      - "{sample_parameter_2}": []

  • sortAllowedParametersValues: true oder false geben an, ob die in der Benutzeroberfläche definierten oder von Skripten zurückgegebenen Werte für zulässige Parameter sortiert werden sollen und ob sie die ursprüngliche Reihenfolge beibehalten sollen.

  • jobMaximumExecutionParametersLength: Die Anzahl der Zeichen, die Ausführungsparameter haben können, bevor der Wert gekürzt wird. Dies wirkt sich nur auf die Leistung des Front-Ends des Schedulers aus. Standardmäßig ist dies auf 200-Zeichen eingestellt.

  • archivedJobCleanupEnabled: true oder false gibt an, ob der Archivierungsjob-Cleaner ausgeführt werden soll oder nicht. Dieser löscht Jobs, Jobausführungsprotokolle und MIME-Typ-Statistiken zu Jobvorgängen, wenn ein archivierter Job älter als eine festgelegte Anzahl von Tagen ist. St`falseardmäßig ist der Wert `false.

  • archivedJobCleanupInterval: Das Intervall in Stunden, wie oft die Jobbereinigungsaufgabe ausgeführt werden soll. Standardmäßig ist dies auf 24 Stunden eingestellt.

  • archivedJobRetentionDays: Anzahl der Tage, die ein Job archiviert werden muss, bevor er gelöscht werden kann. Standardmäßig ist dies auf 584 Tage (eineinhalb Jahre) eingestellt.

  • synchronizeJobsOnAllMatters: true oder false geben an, ob zu einem bestimmten Zeitpunkt nur ein Job auf einer Materie ausgeführt werden darf.

  • authTokenTtl: Die Dauer in Sekunden, nach der das Benutzerauthentifizierungstoken abläuft. Der Browser stellt eine Anforderung zum Aktualisieren des Authentifizierungstokens bei der Hälfte der Lebensdauer des Tokens. Standardmäßig ist dies auf 600 Sekunden eingestellt.

  • disableAuthTokenExpiration: true oder false geben an, dass das Benutzerauthentifizierungstoken nicht abläuft. St`falseardmäßig ist dies auf `false eingestellt.

  • expiredAuthTokenTombstone: Die Dauer in Sekunden, für die abgelaufene Authentifizierungstoken nachverfolgt werden. Beim Versuch, mit einem abgelaufenen Authentifizierungstoken auf Automatisieren zuzugreifen, wird eine freundliche Fehlermeldung zurückgegeben, und die aktuelle Live-Benutzersitzung wird ungültig. Standardmäßig ist dies auf 900 eingestellt.

  • downgradeWebWorkerToken: true oder false geben an, dass der Browser das Web Worker-Token herunterstufen sollte, um es für Skripte im Browser zugänglich zu machen. St`falseardmäßig ist dies auf `false eingestellt.

Mit der Standardeinstellung downgradeWebWorkerToken: false wird der Benutzer beim Aktualisieren des Browserfensters abgemeldet. Wenn Sie diese Option auf true setzen, wird die Benutzersitzung beibehalten, wenn das Browserfenster aktualisiert wird, aber das Authentifizierungstoken wird für Skripte im Browser zugänglich, was weniger sicher ist.

  • enforceSingleUserSession: true oder false gibt an, ob ein Benutzer mehr als eine Sitzung gleichzeitig haben kann. Wenn diese Option auf „true“ gesetzt ist, ist nur eine Sitzung zulässig.

Wenn ein Benutzer bereits angemeldet ist und eine weitere Sitzung für denselben Benutzer gestartet wird, wird die ältere Sitzung abgemeldet.

  • libraryFileMaxSize: Die maximale Größe in Bytes von Dateien, die in die Dateibibliothek hochgeladen werden können, standardmäßig 10000000.

Die Dateibibliothek dient zum Speichern von Konfigurationsdateien und Profilen. Diese Beschränkung gilt nicht für Dateien, die in Data Repositories hochgeladen werden.

  • expireIdleUploadAfter: Die Dauer in Millisekunden, nach der untätige Uploads in Daten-Repositories ablaufen, standardmäßig 3600000 entspricht 1 Stunde.

  • uploadBufferMaxSize: Die maximale Puffergröße in KiB, die standardmäßig während des Hochladens in Daten-Repositorys zugewiesen wird 8192. Die Puffergröße kann für jeden Datei-Upload bis zu 3-mal zugewiesen werden und wird nur für die Dauer des Datei-Uploads verwendet.

Beim Schreiben von Daten auf eine Dateifreigabe, die über ein Netzwerk mit hoher Latenz verbunden ist, kann die Erhöhung der Größe des uploadBufferMaxSize die Gesamtübertragungsleistung auf Kosten einer erhöhten Speichernutzung erhöhen.

  • uploadHashAlgorithms: Der Algorithmus, der standardmäßig für das Hashing auf der Serverseite verwendet wird, wenn Dateien in Daten-Repositorys hochgeladen werden MD5. Um das Hashing während des Hochladens zu deaktivieren, verwenden Sie den Wert None.

Das Hashen von Dateien während des Hochladens erfordert erhebliche CPU-Ressourcen auf dem Scheduler-Server. Um diese Berechnung auf einen anderen Server auszulagern, verwenden Sie die Rolle Scheduler-Proxy.

  • enableUtilizationEndpoint: Aktivieren Sie standardmäßig den OData-Dienst im Scheduler true. Zum Deaktivieren verwenden Sie den Wert false.

  • utilizationErrorsSoftFail: Schreibfehler der Nutzungsdatendatenbank in die Anwendung maskieren, standardmäßig false.

  • azureLocations: (Optional) Die Liste der Standorte, an denen VMs ausgeführt werden sollen. Beispieleinstellungen für „azureLocations“:

azureLocations: westus,eastus

  • azureVmSizes: (Optional) Die Liste der VM-Größen. Beispieleinstellungen für „azureVmSizes“:

azureVmSizes: Standard_M8ms,Standard_M16ms,Standard_M32ts

3.1.2. Umgebungsvariablen des Scheduler-Dienstes

Die folgenden Umgebungsvariablen können konfiguriert werden, um die in der Konfigurationsdatei des Scheduler-Dienstes konfigurierten Einstellungen festzulegen oder zu überschreiben:

  • Datenbankumleitung. Verwenden Sie die folgenden Einstellungen, um die Anwendung auf eine SQL-Datenbank umzuleiten:

    • AUTOMATE_STORE_APPLICATION_ENABLED: Zum Aktivieren auf true setzen

    • AUTOMATE_STORE_APPLICATION_DRIVER_CLASS: Die Fahrerklasse, zum Beispiel org.postgresql.Driver

    • AUTOMATE_STORE_APPLICATION_URL: Die JDBC-Verbindungszeichenfolge, zum Beispiel jdbc:postgresql://postgres.example.internal:5432/automateScheduler

    • AUTOMATE_STORE_APPLICATION_USERNAME: Der Datenbank-Benutzername

    • AUTOMATE_STORE_APPLICATION_PASSWORD: Das Datenbankkennwort

    • AUTOMATE_STORE_APPLICATION_CHARSET: Der Datenbank-Zeichensatz, zum Beispiel UTF-8

    • AUTOMATE_STORE_LOGGING_REDIRECT_TO_APPLICATION: Legen Sie true fest, um die zentralisierte Protokollierung an denselben Speicherort wie den Anwendungsspeicher umzuleiten

    • AUTOMATE_CENTRALIZED_LOGGING_ENABLED: Auf false setzen, um die zentralisierte Protokollierung zu deaktivieren

    • AUTOMATE_STORE_UTILIZATION_REDIRECT_TO_APPLICATION: Auf true einstellen, um die Nutzungsdaten an denselben Speicherort wie den Anwendungsspeicher umzuleiten

    • AUTOMATE_STORE_APPLICATION_SCHEDULER_MIN_CONNECTIONS: Die minimale Anzahl offen zu haltender Verbindungen

    • AUTOMATE_STORE_APPLICATION_SCHEDULER_MAX_CONNECTIONS: Die maximale Anzahl offen zu haltender Verbindungen

  • Authentifizierung. Verwenden Sie die folgenden Einstellungen, um die Zugangsdaten für die Anmeldung bei der Anwendung für die Erstkonfiguration zu konfigurieren:

    • Interne Benutzername/Passwort-Authentifizierung:

      • AUTOMATE_AUTH_INTERNAL_ENABLED: Zum Aktivieren auf true setzen

      • AUTOMATE_AUTH_INTERNAL_USERNAME: Der Benutzername zum Anmelden

      • AUTOMATE_AUTH_INTERNAL_EMAIL: Die E-Mail-Adresse des Benutzers

      • AUTOMATE_AUTH_INTERNAL_PASSWORD: Das Passwort zum Anmelden.

    • Interne PBKDF2-Authentifizierung:

      • AUTOMATE_AUTH_INTERNAL_ENABLED: Zum Aktivieren auf true setzen

      • AUTOMATE_AUTH_INTERNAL_USERNAME: Der Benutzername zum Anmelden

      • AUTOMATE_AUTH_INTERNAL_EMAIL: Die E-Mail-Adresse des Benutzers

      • AUTOMATE_AUTH_INTERNAL_SALT: Eine Base64-codierte Zeichenfolge

      • AUTOMATE_AUTH_INTERNAL_ITERATIONS: Die Anzahl der Hash-Iterationen

      • AUTOMATE_AUTH_INTERNAL_HASH: Der mit dem PBKDF2WithHmacSHA512-Algorithmus berechnete Passwort-Hash mit einer Schlüssellänge von 512 Bits.

    • OIDC-Authentifizierung:

      • AUTOMATE_AUTH_OIDC_ENABLED: Zum Aktivieren auf true setzen

      • AUTOMATE_AUTH_OIDC_NAME: Der Name des Authentifizierungsmechanismus

      • AUTOMATE_AUTH_OIDC_DESCRIPTION: Die Beschreibung des Authentifizierungsmechanismus

      • AUTOMATE_AUTH_OIDC_WELL_KNOWN_CONFIG_URI: Der bekannte Konfigurations-URI, zum Beispiel http://keycloak:8080/realms/default/.well-known/openid-configuration

      • AUTOMATE_AUTH_OIDC_SCOPE: Der Umfang, zum Beispiel openid email profile

      • AUTOMATE_AUTH_OIDC_USERNAME_CLAIM: Der Anspruch auf den Benutzernamen, zum Beispiel email

      • AUTOMATE_AUTH_OIDC_CLIENT_ID: Die Client-ID

      • AUTOMATE_AUTH_OIDC_CLIENT_SECRET: Das Kundengeheimnis

    • Derby Control-Dienst:

      • AUTOMATE_DERBY_CONTROL_SERVICE_ENABLED: Zum Aktivieren auf true setzen

      • AUTOMATE_DERBY_CONTROL_SERVICE_NAME: Der Name des Derby Control-Dienstes

      • AUTOMATE_DERBY_CONTROL_SERVICE_DESCRIPTION: Die Beschreibung des Derby Control-Dienstes

      • AUTOMATE_DERBY_CONTROL_SERVICE_URL: Die Basis-URL von Derby Control, zum Beispiel http://127.0.0.1:8999/DERBY-CONTROL

  • API-Geheimnis für mehrere Server. Verwenden Sie die folgenden Einstellungen, um das API-Secret zu konfigurieren, das zum Verwalten verschiedener Engine-Server verwendet wird:

    • AUTOMATE_API_SECRET: Schlüssel, der für die Authentifizierung zwischen Automate-Komponenten verwendet wird. Legen Sie für alle Automate Scheduler-, Proxy- und Serverinstanzen denselben Zufallswert fest.

  • Sicherheitsrichtlinie. Verwenden Sie die folgenden Einstellungen, um eine Sicherheitsrichtlinie zu konfigurieren:

    • AUTOMATE_SECURITY_POLICY_ENABLED: Zum Aktivieren auf true setzen

    • AUTOMATE_SECURITY_POLICY_NAME: Der Richtlinienname

    • AUTOMATE_SECURITY_POLICY_DESCRIPTION: Die Richtlinienbeschreibung

    • AUTOMATE_SECURITY_POLICY_PRINCIPALS: Die Liste der Auftraggeber, für die die Richtlinie gilt. Die folgende Einstellung gilt für jeden authentifizierten Benutzer: [{"identifierType":"BUILTIN","identifierName":"AUTHENTICATED_USER"}]

    • AUTOMATE_SECURITY_POLICY_PERMISSIONS: Die Richtlinienberechtigungen, zum Beispiel ["VIEW","VIEW_SENSITIVE","MODIFY","CREATE","SUBMIT_JOB","DOWNLOAD_LOGS"]

    • AUTOMATE_SECURITY_POLICY_SCOPE_BUILTIN: Die in die Richtlinie integrierten Bereiche, zum Beispiel ["ALL_CLIENT_POOLS","ALL_CLIENTS","ALL_LIBRARIES","API_KEYS","COLLECTIONS","LEGAL_HOLDS","SCRIPTS","SCHEDULES","SECURITY","RESOURCES"]

    • AUTOMATE_SECURITY_POLICY_SCOPE: Definieren Sie optional die vollständigen Richtlinienbereiche, zum Beispiel [{"identifierType":"BUILTIN","identifierName":"RESOURCES"}]

  • Sicherheitsrichtlinie. Verwenden Sie die folgenden Einstellungen, um eine Automate-Lizenz zu konfigurieren:

    • AUTOMATE_LICENSE_ENABLED: Zum Aktivieren auf true setzen

    • AUTOMATE_LICENSE_ID: Die Lizenz-ID

    • AUTOMATE_LICENSE_KEY: Der Lizenzschlüssel

    • AUTOMATE_LICENSE_DIAGNOSTIC_LEVEL: Die Diagnoseebene, zum Beispiel ENHANCED

  • Nuix CLS-Lizenz. Verwenden Sie die folgenden Einstellungen, um eine Nuix CLS-Lizenz zu konfigurieren:

    • AUTOMATE_NUIX_CLS_LICENSE_ENABLED: Zum Aktivieren auf true setzen

    • AUTOMATE_NUIX_CLS_LICENSE_NAME: Der Lizenzname

    • AUTOMATE_NUIX_CLS_LICENSE_DESCRIPTION: Die Lizenzbeschreibung

    • AUTOMATE_NUIX_CLS_LICENSE_FILTER: Der Lizenzarbeiterfilter, zum Beispiel workstation

    • AUTOMATE_NUIX_CLS_LICENSE_DESCRIPTION: Die Lizenzbeschreibung

    • AUTOMATE_NUIX_CLS_LICENSE_USERNAME: Der CLS-Benutzername

    • AUTOMATE_NUIX_CLS_LICENSE_PASSWORD: Das CLS-Passwort

  • Ressourcenpool. Verwenden Sie die folgenden Einstellungen, um einen Ressourcenpool zu konfigurieren:

    • AUTOMATE_RESOURCE_POOL_ENABLED: Zum Aktivieren auf true setzen

    • AUTOMATE_RESOURCE_POOL_NAME: Der Name des Ressourcenpools

    • AUTOMATE_RESOURCE_POOL_DESCRIPTION: Die Beschreibung des Ressourcenpools

    • AUTOMATE_RESOURCE_POOL_AUTO_REGISTRATION_ENABLED: Auf true setzen, um die automatische Registrierung zu aktivieren.

    • AUTOMATE_RESOURCE_POOL_AUTO_REGISTRATION_ACCESS_KEY: Der Zugriffsschlüssel für die automatische Registrierung. Die Engine-Server müssen denselben Schlüssel verwenden.

    • AUTOMATE_RESOURCE_POOL_AUTO_REGISTRATION_STRICT_IP: Optional, auf true setzen, um die Registrierung standardmäßig über dieselbe IP-Adresse wie der Zielserver zu erzwingen false.

    • AUTOMATE_RESOURCE_POOL_AUTO_REGISTRATION_MIN_WORKERS: Optional, die automatische Registrierung von Mindestarbeitern, standardmäßig 1.

    • AUTOMATE_RESOURCE_POOL_AUTO_REGISTRATION_TARGET_WORKERS: Optional, standardmäßig die automatischen Registrierungszielarbeiter 2.

    • AUTOMATE_RESOURCE_POOL_AUTO_REGISTRATION_EXECUTION_MODE: Optional, der automatische Registrierungsausführungsmodus, standardmäßig AUTOMATE_NUIX.

  • Ausführungsprofil. Verwenden Sie die folgenden Einstellungen, um ein Ausführungsprofil zu konfigurieren:

    • AUTOMATE_EXECUTION_PROFILE_ENABLED: Zum Aktivieren auf true setzen

    • AUTOMATE_EXECUTION_PROFILE_NAME: Der Name des Ausführungsprofils

    • AUTOMATE_EXECUTION_PROFILE_DESCRIPTION: Die Beschreibung des Ausführungsprofils

    • AUTOMATE_EXECUTION_PROFILE_ENGINE_COMMAND_LINE_PARAMS: Optional, die Engine-Befehlszeilenparameter, standardmäßig -Xmx16g -Dnuix.logdir=/var/log/nuix/automate -Duser.language=en -Duser.country=US.

    • AUTOMATE_EXECUTION_PROFILE_NUIX_ENGINE_FOLDER: Optional, standardmäßig der Binärordner der Nuix-Engine /opt/nuix/engine.

    • AUTOMATE_EXECUTION_PROFILE_ENGINE_LOG_FOLDER: Optional, standardmäßig der Engine-Protokollordner /var/log/nuix/automate.

    • AUTOMATE_EXECUTION_PROFILE_JAVA_FOLDER: Optional, der Java-Binärordner, standardmäßig leer.

    • AUTOMATE_EXECUTION_PROFILE_PARAMETERS: Optional, eine JSON-serialisierte Map<String,String> von Parametern und Werten, standardmäßig leer.

    • AUTOMATE_EXECUTION_JOB_PROGRESS_MIN_PERCENTAGE: Optional, der Mindestauftragsfortschritt vor dem Abbruch des Auftrags, standardmäßig 1.0.

    • AUTOMATE_EXECUTION_JOB_PROGRESS_TIMEOUT_HOURS: Optional, das Zeitlimit, nach dem der Job abgebrochen werden soll, wenn der Jobfortschritt nicht erreicht wurde, standardmäßig 48.0.

    • AUTOMATE_EXECUTION_OPERATION_PROGRESS_MIN_PERCENTAGE: Optional, der minimale Vorgangsfortschritt vor dem Abbruch des Jobs, standardmäßig 1.0.

    • AUTOMATE_EXECUTION_OPERATION_PROGRESS_TIMEOUT_HOURS: Optional, das Zeitlimit, nach dem der Job abgebrochen werden soll, wenn der Vorgangsfortschritt nicht erreicht wurde, standardmäßig 24.0.

    • AUTOMATE_EXECUTION_SKIP_OPERATION_PROGRESS_MIN_PERCENTAGE: Optional, der Mindestvorgangsfortschritt, bevor versucht wird, den Vorgang zu überspringen, standardmäßig 1.0.

    • AUTOMATE_EXECUTION_SKIP_OPERATION_PROGRESS_TIMEOUT_HOURS: Optional, das Zeitlimit, nach dem versucht wird, den Vorgang zu überspringen, wurde standardmäßig nicht erreicht 12.0.

  • Benutzerdatenverzeichnis. Verwenden Sie die folgenden Einstellungen, um das Verhalten des Benutzerdatenverzeichnisses zu konfigurieren:

    • AUTOMATE_USER_DATA_DIR_SCAN_INTERVAL: Legen Sie die Intervalldauer in Sekunden fest, in der das Benutzerdatenverzeichnis gescannt wird, auch wenn das Betriebssystem keine Änderung erkennt.

  • Um eine beliebige Einstellung zu überschreiben, konvertieren Sie den Einstellungsnamen in Großbuchstaben und stellen Sie „Automate“ voran. Verwenden Sie beispielsweise zum Konfigurieren der Einstellung downgradeWebWorkerToken die Umgebungsvariable AUTOMATE_DOWNGRADE_WEB_WORKER_TOKEN.

3.1.3. Scheduler Proxy Service-Einstellungen

Diese Datei folgt der YAML-Syntax und enthält die folgenden Parameter:

  • role: PROXY zeigt an, dass die Automate Scheduler Proxy-Komponente ausgeführt wird;

  • apiSecret: Schlüssel, der für die Authentifizierung zwischen Automate-Komponenten verwendet wird. Legen Sie für alle Automate Scheduler-, Proxy- und Serverinstanzen denselben Zufallswert fest.

  • proxy: Die Details der Haupt-Scheduler-Instanz, die der Proxy verwendet. Die Konfiguration wird in den folgenden Unterschlüsseln bereitgestellt:

    • baseUrl: Die URL der Scheduler-Instanz.

    • whitelistedCertFingerprints: Fingerabdrücke des Scheduler-Zertifikats, die zur Überprüfung beim Öffnen einer sicheren Verbindung verwendet werden.

  • allowedAuthenticationServices: Die Liste der Authentifizierungsdienstnamen, die über diesen Proxy verwendet werden können. Wenn diese Einstellung nicht definiert ist, werden alle Authentifizierungsdienste über den Proxy zugelassen.

Beispiel für eine Proxy-Konfiguration:

proxy:
  baseUrl: https://scheduler.automate.local
  whitelistedCertFingerprints:
    - e62dd01ca608c10402d07714cfd626bfc6b1001e5a16ca039d1050a71f73ee24

allowedAuthenticationServices:
  - Internal
  - Lab Azure AD

  • log4jConfigurationFile: Die log4j-Konfigurationsdatei.

  • server: Zeigt die Webzugriffsprotokolleinstellungen, die zu überwachenden HTTP-Protokolle und die entsprechende IP, den Port und das TLS-Zertifikat für HTTPS-Verbindungen an.

  • webConfiguration: Gibt an, welche Webeinstellungen auf den für die REST-API verwendeten Webserver angewendet werden sollen.

3.1.4. Diensteinstellungen des Engine-Servers

Diese Datei folgt der YAML-Syntax und enthält die folgenden Parameter:

  • role: ENGINE_SERVER zeigt an, dass die Automate Engine Server-Komponente ausgeführt wird;

  • apiSecret: Schlüssel, der für die Authentifizierung zwischen Automate-Komponenten verwendet wird. Legen Sie für alle Automate Scheduler-, Proxy- und Serverinstanzen denselben Zufallswert fest.

  • nuixEnginePath: Der Speicherort der Nuix Engine-Bereitstellung. Dieser Ordner sollte die Unterordner bin, lib und user-data direkt enthalten.

  • log4jConfigurationFile: Die log4j-Konfigurationsdatei.

  • engineInitLogFolder: Der temporäre Speicherort, der von Engines zum Speichern von Konfigurationsdateien und Protokollen während der Initialisierungsphase verwendet wird. Beim Ausführen von Jobs speichert die Engine die Protokolle und Konfigurationsdateien an dem im Ausführungsprofil angegebenen Speicherort.

  • engineInitTimeout: Der Timeout in Sekunden, den die Engine standardmäßig initialisieren darf 120.

  • engineAbortTimeout: Die Zeitüberschreitung in Millisekunden, die die Engine wartet, um einen Job abzubrechen. Der Standardwert ist 5000 (5 Sekunden).

  • server: Zeigt die Webzugriffsprotokolleinstellungen, die zu überwachenden HTTP-Protokolle und die entsprechende IP, den Port und das TLS-Zertifikat für HTTPS-Verbindungen an.

  • webConfiguration: Gibt an, welche Webeinstellungen auf den für die REST-API verwendeten Webserver angewendet werden sollen.

  • jobRunningLogMaxSize: Gibt die maximale Anzahl von Protokollen an, die das Jobausführungsprotokoll speichert, standardmäßig 20.

  • logging: Zeigt die Parameter der vom Dienst durchgeführten Protokollierung an. Diese Protokolle enthalten auch die Informationen, die normalerweise von Nuix Workstation protokolliert werden. Der Speicherort der Arbeitsprotokolle wird im Parameter nuixFlags angegeben.

  • workerBrokerIP: Die IP-Adresse, die zum Hosten von Worker Brokers beim Ausführen von Remote Workers verwendet werden soll.

  • workerBrokerStartPort: Der Portbereich beginnt für Worker Brokers.

  • workerBrokerEndPort: Das Ende des Portbereichs für Worker Brokers.

Beispieleinstellungen für die Konfiguration eines Worker Broker auf IP 10.0.0.1:

workerBrokerIP: 10.0.0.1
workerBrokerStartPort: 50000
workerBrokerEndPort: 50100
Wenn die Einstellung workerBrokerIP nicht angegeben ist, startet der Server einen Broker auf einem St`workerBrokerIPardnetzwerkadapter. Konfigurieren Sie in einer Umgebung, in der Server über mehrere Netzwerkadapter verfügen, das `workerBrokerIP auf jedem Server mit der IP-Adresse, die von `workerBrokerIP`eren Servern verwendet werden soll, die Remote-Jobs verbinden, um diesen Server zu kontaktieren.

3.1.5. Umgebungsvariablen des Engine-Server-Dienstes

Die folgenden Umgebungsvariablen können konfiguriert werden, um die in der Konfigurationsdatei des Engine-Server-Dienstes konfigurierten Einstellungen festzulegen oder zu überschreiben:

  • Datenbankumleitung. Verwenden Sie die folgenden Einstellungen, um die Anwendung auf eine SQL-Datenbank umzuleiten:

    • AUTOMATE_STORE_APPLICATION_ENABLED: Zum Aktivieren auf true setzen

    • AUTOMATE_STORE_APPLICATION_DRIVER_CLASS: Die Fahrerklasse, zum Beispiel org.postgresql.Driver

    • AUTOMATE_STORE_APPLICATION_URL: Die JDBC-Verbindungszeichenfolge, zum Beispiel jdbc:postgresql://postgres.example.internal:5432/automateEngineServer

    • AUTOMATE_STORE_APPLICATION_USERNAME: Der Datenbank-Benutzername

    • AUTOMATE_STORE_APPLICATION_PASSWORD: Das Datenbankkennwort

    • AUTOMATE_STORE_APPLICATION_CHARSET: Der Datenbank-Zeichensatz, zum Beispiel UTF-8

    • AUTOMATE_STORE_APPLICATION_SCHEDULER_MIN_CONNECTIONS: Die minimale Anzahl offen zu haltender Verbindungen

    • AUTOMATE_STORE_APPLICATION_SCHEDULER_MAX_CONNECTIONS: Die maximale Anzahl offen zu haltender Verbindungen

  • Automatische Registrierung. Verwenden Sie die folgenden Einstellungen, um den Engine-Server automatisch bei einem Scheduler-Ressourcenpool zu registrieren. Der Ressourcenpool muss mit aktivierter automatischer Registrierungsfunktion konfiguriert werden:

    • AUTOMATE_REGISTRATION_ENABLED: Zum Aktivieren auf true setzen

    • AUTOMATE_REGISTRATION_SERVER_NAME: Der Name des Engine-Servers, zum Beispiel Server1

    • AUTOMATE_REGISTRATION_SERVER_URL: Die URL, unter der der Scheduler auf den Engine-Server zugreifen kann, zum Beispiel http://Server1.internal.local

    • AUTOMATE_REGISTRATION_SCHEDULER_URL: Die Scheduler-URL, zum Beispiel http://Scheduler.internal.local

    • AUTOMATE_REGISTRATION_RESOURCE_POOL_ID: Optional, die Ressourcenpool-ID für die Registrierung. Standardmäßig die ID des im Scheduler mit ENV-Variablen konfigurierten Ressourcenpools. Diese Einstellung muss nur bereitgestellt werden, um sich bei einem anderen Ressourcenpool zu registrieren.

    • AUTOMATE_REGISTRATION_ROLE_MAIN: Optional, auf true gesetzt, damit die Engine als Haupt-Engine im Ressourcenpool fungieren kann.

    • AUTOMATE_REGISTRATION_ROLE_REMOTE: Optional, auf true gesetzt, damit die Engine als Remote-Engine im Ressourcenpool fungieren kann.

    • AUTOMATE_REGISTRATION_RESOURCE_POOL_ACCESS_KEY: Der Zugriffsschlüssel für den Ressourcenpool. Wählen Sie denselben Wert aus, der für den Ressourcenpool mit der ENV-Variablen konfiguriert wurde.

  • Multi-Server-Bereitstellung. Verwenden Sie die folgenden Einstellungen für Bereitstellungsszenarien mit mehreren Servern:

    • AUTOMATISIEREN_API_SECRET: Schlüssel, der für die Authentifizierung zwischen Automate-Komponenten verwendet wird. Legen Sie für alle Automate Scheduler-, Proxy- und Serverinstanzen denselben Zufallswert fest.

    • AUTOMATISIEREN_SERVER_ID: Legen Sie eine eindeutige Zufalls-ID für jeden Engine-Server fest.

  • Layout der Motorprotokollierung

    • AUTOMATE_ENGINE_LOG_LAYOUT_JSON: Set to true, um die Engine-Protokolle im JSON-Format zu konfigurieren. Beachten Sie, dass dies nicht für die Protokollformate Scheduler oder Engine Server gilt, die direkt in ihren jeweiligen config.yml konfiguriert werden.

3.1.6. OData Server-Diensteinstellungen

Diese Datei folgt der YAML-Syntax und enthält die folgenden Parameter:

  • role: ODATA_SERVER zeigt an, dass die Automate OData Server-Komponente ausgeführt wird;

  • internalCredentials: Gibt an, dass die in der Konfigurationsdatei definierten Anmeldeinformationen zur Authentifizierung verwendet werden. Die Konfiguration wird in den folgenden Unterschlüsseln bereitgestellt:

    • displayName: (Optional) Der Name, der auf der Anmeldeseite für diese Authentifizierungsmethode angezeigt werden soll.

    • restrictToLocalhost: (Optional) Beschränken Sie die Verfügbarkeit der internen Authentifizierung auf Browser von localhost. Wenn diese Eigenschaft nicht angegeben ist, ist sie standardmäßig false.

    • credentials: Die Liste der Anmeldeinformationen.

Die Anmeldeinformationen können in beiden PBKDF2-Formaten bereitgestellt werden, indem Sie Folgendes verwenden:

  • username

  • email

  • salt, eine base64-codierte Zeichenfolge

  • iterations, die Anzahl der Hash-Iterationen

  • hash, berechnet mit dem PBKDF2WithHmacSHA512-Algorithmus mit einer Schlüssellänge von 512 Bits.

oder im Klartext mit:

  • username

  • email

  • password

Beispiel für eine interne Authentifizierungskonfiguration mit 2 Benutzern:

internalCredentials:
  displayName: UsernamePassword
  restrictToLocalhost: true
  credentials:
    - username: user1
      email: user1@example.com
      salt: NlbCqq8kL6sqdZQrjMmgSw==
      iterations: 1000000
      hash: ca4xiopDRshgyKvArOfKqBoDeVfbsOpayzVrh8n1WAWOhqvunITolqBBTiSAn1VxTBUz+15IfX4qxiTuHrthuA==

    - username: user2
      email: user2@example.com
      password: Password2@
Die interne Authentifizierungsmethode erfordert das Speichern der Benutzernamen und Passwörter oder Hashes in der Konfigurationsdatei. Es wird empfohlen, diese Methode auf localhost zu beschränken.
Legen Sie die Eigenschaft restrictToLocalhost auf true fest, um die Anmeldung nur mit internen Anmeldeinformationen zuzulassen, wenn Sie als lokaler Host auf Automate zugreifen.

  • server: Zeigt die Webzugriffsprotokolleinstellungen, die zu überwachenden HTTP-Protokolle und die entsprechende IP, den Port und das TLS-Zertifikat für HTTPS-Verbindungen an.

Standardmäßig lauscht der Dienst bei HTTP auf Port 8081 auf localhost und bei HTTPS auf Port 8443 auf alle IP-Adressen. Um den Server auf das Abhören einer bestimmten IP-Adresse zu beschränken, ändern Sie 0.0.0.0 in die erforderliche IP-Adresse in der config.yml-Datei.

  • webConfiguration: Gibt an, welche Webeinstellungen auf den für die REST-API verwendeten Webserver angewendet werden sollen.

  • utilizationStore: Gibt an, dass eine benutzerdefinierte Datenbank zum Speichern der Überwachungsinformationen verwendet wird.

    • driverClass: net.sourceforge.jtds.jdbc.Driver

    • user: Der Datenbank-Benutzername

    • password: Das Datenbankkennwort

    • url: Die JDBC-Verbindungszeichenfolge, zum Beispiel jdbc:jtds:sqlserver://HOST:1433/DATABASE

    • properties: Die Verbindungseigenschaften.

Beispiel für eine Microsoft SQL-Konfiguration:

utilizationStore:
  driverClass: net.sourceforge.jtds.jdbc.Driver
  user: automate-service
  password: SecretGoesHere
  url: jdbc:jtds:sqlserver://localhost:1433/automate
  properties:
    charSet: UTF-8
Wenn in der Microsoft SQL-Speicherkonfiguration kein Benutzername und kein Kennwort angegeben sind, wird die Verbindung mithilfe der integrierten Windows-Authentifizierung hergestellt. Wenn Sie auf diese Weise eine Verbindung zu Microsoft SQL herstellen, sollte der Automate Scheduler-Dienst so konfiguriert werden, dass er unter einem Konto ausgeführt wird, das Zugriff auf die Microsoft SQL-Datenbank hat.

3.2. Authentifizierung

3.2.1. Nuix UMS

Wenn Sie die Nuix UMS-Authentifizierungsmethode verwenden, konfigurieren Sie den UMS-Authentifizierungsdienst auf der Automate-Webseite auf der Registerkarte Einstellungen unter Authentifizierungsdienste. Alle Benutzer, die in Nuix UMS definiert sind, können sich bei Automate anmelden. Die Zugriffsebene jedes Benutzers wird durch die Sicherheitsrichtlinien bestimmt, die auf der Automaten-Webseite auf der Registerkarte Einstellungen definiert sind.

3.2.2. LDAP

Wenn Sie die LDAP-Authentifizierungsmethode verwenden, konfigurieren Sie den LDAP-Authentifizierungsdienst auf der Webseite Automatisieren auf der Registerkarte Einstellungen unter Authentifizierungsdienste. Alle Benutzer, die im bereitgestellten LDAP domainDN definiert sind, können sich bei Automate anmelden. Die Zugriffsebene jedes Benutzers wird durch die Sicherheitsrichtlinien bestimmt, die auf der Automaten-Webseite auf der Registerkarte Einstellungen definiert sind.

3.2.3. Intern

Wenn Sie die interne Authentifizierungsmethode verwenden, legen Sie die internalCredentials-Konfiguration in der YAML-Datei wie in Service Settings angegeben fest.

3.3. Zugriff auf Sicherheitsrichtlinien

Der Zugriff auf Ressourcen automatisieren wird auf der Seite Einstellungen auf der Registerkarte Sicherheitsrichtlinien definiert. Die Standardrichtlinie ermöglicht es jedem authentifizierten Benutzer, alle Ressourcen anzuzeigen und zu ändern sowie Aufträge mit beliebigen Einstellungen zu senden.

3.4. Erinnerung

3.4.1. Nuix Arbeiter

Der Speicher von Nuix Workers kann entweder in der Workflow-Operation oder explizit als Befehlszeilenparameter in den Ausführungsprofilen angegeben werden, zum Beispiel:

-Dnuix.worker.jvm.arguments="-Xmx8g"

3.4.2. Nuix Engine

Der Speicher der Nuix Engine, der dem Speicher der Nuix Workstation als Befehlszeilenparameter in den Ausführungsprofilen entspricht, zum Beispiel:

-Xmx2g
Jede Nuix Engine wird unter einer separaten JVM ausgeführt und teilt keinen Speicher mit den anderen Nuix Engines oder den Automate-Diensten.

3.5. Freigegebene Datenquellen

Automate-Workflows werden auf den Servern ausgeführt, auf denen die Automate Engine Server-Komponente ausgeführt wird. Um sicherzustellen, dass Workflows auf Fälle und Quelldaten von einem freigegebenen Speicherort aus zugreifen können, geben Sie einen UNC-Pfad oder einen zugeordneten Laufwerksbuchstabenpfad an, auf den von allen Servern aus zugegriffen werden kann, auf denen die Automate Engine Server-Komponente ausgeführt wird.

Standardmäßig wird der Automate Engine Server-Dienst unter dem lokalen Systemkonto ausgeführt und startet Engines unter demselben Benutzerkonto.

Bei Bedarf kann in Ausführungsprofilen ein anderes Benutzerkonto angegeben werden.

4. Fehlerbehebung

4.1. Zum Automate Scheduler navigieren

Standardmäßig lauscht Automate Scheduler auf 127.0.0.1 auf Port 80 und auf allen IP-Adressen auf Port 443. Um auf die Standardinstallation zuzugreifen, navigieren Sie zu der Adresse: http://localhost

4.2. Der Automate-Dienst startet nicht

Automate Scheduler und Engine Server werden als Windows-Dienste ausgeführt. Wenn die Dienste gestartet sind, überprüfen Sie die Protokolldateien unter C:\Temp\Log\automate-scheduler.log und C:\Temp\Log\automate-engine-server.log.

4.3. Login Fehler

Wenn beim Anmeldeversuch der Fehler Fehler bei der Kommunikation mit dem Authentifizierungsserver angezeigt wird, überprüfen Sie die Protokolle, um das von Automate bei der Kommunikation mit dem Authentifizierungsserver aufgetretene Problem zu ermitteln.

4.4. Beim Hinzufügen des Automate Engine-Servers wird der Fehler javax.net.ssl.SSLHandshakeException ausgelöst.

Stellen Sie sicher, dass die Java Runtime Environment der neuesten Version von Nuix Workstation, die auf jedem Automate Scheduler-Server bereitgestellt wird, dem TLS-Zertifikat des Automate Engine-Servers vertraut. Weitere Einzelheiten finden Sie in Abschnitt Managing Certificates.

5. Zertifikate verwalten

Siehe https://nuix.service-now.com/support?id=kb_Artikel_view&sys_kb_id=fcd9bfe747cc96102d9c89cbd36d438f.

6. Nutzung und Berichterstattung

Die Nutzungs- und Berichtsdaten werden als OData V4-Feed bereitgestellt, wenn diese Funktion in der Automate-Lizenz aktiviert ist.

Der OData-Feed unterstützt nur das Abfragen der Metadaten und das Abrufen aller Daten aus den Ansichten. OData-Filter werden nicht unterstützt.

Auf den OData-Feed kann unter folgendem Endpunkt mithilfe der Basic- oder Microsoft OAuth-Authentifizierung zugegriffen werden:

  • /api/v2/reporting/odata

7. REST-API-Dokumentation

Auf Automate Scheduler kann entweder direkt über einen Browser oder über die REST-API zugegriffen werden. Die Dokumentation der API finden Sie im OpenAPI v3-Format unter /openapi.

Um beispielsweise auf die API-Dokumentation in einer Standardinstallation von Automate Scheduler zuzugreifen, navigieren Sie zu http://localhost/openapi

8. Zentralisierte Protokollierung

Durch die zentralisierte Protokollierung werden alle Protokolle aus Scheduler-, Engine Server-, Engine- und Worker-Protokollen in der von Scheduler verwalteten Protokollierungsdatenbank konsolidiert.

Die zentralisierte Protokollierung ist st`YAMLardmäßig aktiviert. Dies bedeutet, dass sowohl die Protokolldatei als auch das Datenbankprotokoll vorhYAMLen sind. Um die zentralisierte Protokollierung zu deaktivieren, setzen Sie die Taste `enableCentralizedLogging in der Konfigurationsdatei auf false, wie in der Datei Service Settings angegeben.

Wenn die zentralisierte Protokollierung deaktiviert ist, werden die Funktionen zum Herunterladen von Auftragsprotokollen und zum Herunterladen von Systemprotokollen deaktiviert.

Durch die zentralisierte Protokollierung werden automatisch Protokolle gelöscht, die älter als der Aufbewahrungszeitraum sind. Die Standardaufbewahrungsfrist beträgt 30 Tage. Um die Aufbewahrungsfrist zu ändern, bearbeiten Sie den Schlüssel centralizedLoggingRetention in der Datei YAML.

Wenn die Größe der Datenbankprotokolle die maximale Datenbankgröße überschreitet, werden ältere Protokolle gelöscht. Standardmäßig beträgt die maximale Datenbankgröße 1000000000 Bytes (1 GB). Um die maximale Standarddatenbankgröße zu ändern, bearbeiten Sie die Taste centralizedLoggingMaxSize in der Datei YAML.

Die tatsächliche Größe der zentralisierten Protokollierungsdatenbank kann aufgrund des Datenbankaufwands und der Verzögerungen beim Löschen alter Protokollzeilen die angegebene maximale Größe überschreiten.

9. Dateipfad-Inventar

9.1. Standarddateipfade

9.1.1. Planer

  • C:\Program Files\Nuix\Automate: Installationsordner

  • %programdata%\Nuix\Automate\Scheduler\config: Konfigurationsordner

  • %programdata%\Nuix\Automate\Scheduler\stores: Persistenz und Archivierung von Jobdetails, Nutzung, Prüfung, Berichterstattung und Nutzung

  • C:\Temp\logs\automate-scheduler.log: Anwendungsprotokoll

  • C:\Temp\logs\automate-scheduler.%d.log.zip: Vorherige Anwendungsprotokolldateien

  • C:\Temp\logs\automate-scheduler-access.log: Webzugriffsprotokoll

  • C:\Temp\logs\automate-scheduler-access.%d.log.zip: Vorherige Hauptprotokolldateien

  • C:\Temp\logs\Automate Scheduler.wrapper.log: Service Wrapper-Protokolle

  • C:\Temp\logs\Automate Scheduler.err.log: Service Standard Fehlerprotokoll

  • C:\Temp\logs\Automate Scheduler.out.log: Servicestandard-Ausgabeprotokoll

9.1.2. Engine Server

  • C:\Program Files\Nuix\Automate: Installationsordner

  • %programdata%\Nuix\Automate\EngineServer\config: Konfigurationsordner

  • C:\Temp\logs\automate-engine-server.log: Anwendungsprotokoll

  • C:\Temp\logs\automate-engine-server.%d.log.zip: Vorherige Anwendungsprotokolldateien

  • C:\Temp\logs\automate-engine-server-access.log: Webzugriffsprotokoll

  • C:\Temp\logs\automate-engine-server-access.%d.log.zip: Vorherige Hauptprotokolldateien

  • C:\Temp\logs\Automate Engine Server.wrapper.log: Service Wrapper-Protokolle

  • C:\Temp\logs\Automate Engine Server.err.log: Service Standard Fehlerprotokoll

  • C:\Temp\logs\Automate Engine Server.out.log: Servicestandard-Ausgabeprotokoll

9.1.3. Motor

  • C:\Temp\logs\automate-engine.aaaaaaaa-init.log: Init Log

  • C:\Temp\logs\automate-engine.aaaaaaaa-init.yml: Erstkonfiguration

  • C:\Temp\logs\automate-engine.aaaaaaaa-service.exe: Service Wrapper

  • C:\Temp\logs\automate-engine.aaaaaaaa-service.xml: Dienstkonfiguration

  • C:\Temp\logs\automate-engine.aaaaaaaa-job.bbbbbbbb.log: Auftragsprotokoll

  • C:\Temp\logs\automate-engine.aaaaaaaa-job.bbbbbbbb.yml: Jobkonfiguration

9.2. Ändern der Protokollpositionen

Die Standarddateipfade können an folgenden Speicherorten geändert werden:

  • Scheduler-Hauptprotokoll: Aktualisieren Sie den Abschnitt logging von C:\ProgramData\Nuix\Automate\Scheduler\config\config.yml

  • Scheduler-Service-bezogene Protokolle: Aktualisieren Sie die Tags <workingdirectory> und <logpath> von C:\Program Files\Nuix\Automate\Scheduler\Automate Scheduler.xml

  • Engine Server-Hauptprotokoll: Aktualisieren Sie den Abschnitt logging von C:\ProgramData\Nuix\Automate\EngineServer\config\config.yml

  • Service-bezogene Engine Server-Protokolle: Aktualisieren Sie die Tags <workingdirectory> und <logpath> von C:\Program Files\Nuix\Automate\EngineServer\Automate Engine Server.xml

  • Engine-Init-Protokoll, Konfigurations- und Service-bezogene Protokolle: Aktualisieren Sie den Abschnitt engineInitLogFolder von C:\ProgramData\Nuix\Automate\EngineServer\config\config.yml

  • Auftragsprotokoll und Konfiguration: Aktualisieren Sie das Feld Log Folder und legen Sie den Befehlszeilenparameter -Dnuix.logdir=c:\Temp\Logs im Ausführungsprofil fest