ontkenning

Het materiaal in dit document is alleen bedoeld ter informatie. De producten die het beschrijft, kunnen zonder voorafgaande kennisgeving worden gewijzigd vanwege het continue ontwikkelingsprogramma van de fabrikant. Nuix geeft geen verklaringen of garanties met betrekking tot dit document of met betrekking tot de hierin beschreven producten. Nuix is ​​niet aansprakelijk voor schade, verliezen, kosten of uitgaven, direct, indirect of incidenteel, gevolgschade of speciaal, die voortvloeien uit of verband houden met het gebruik van dit materiaal of de hierin beschreven producten.

© Nuix Canada Inc. 2024 Alle rechten voorbehouden

Invoering

Deze gids beschrijft de installatie van Automatiseren. Dit document werkt als een referentie - gebruik de inhoudsopgave om te zoeken naar het onderwerp waarover u meer te weten komt.

De Automate-software en deze documentatie kunnen bugs, fouten of andere beperkingen bevatten. Als u problemen ondervindt met de Automate-software of met deze documentatie, neem dan contact op met de ondersteuning van nuix.

Hoewel we feedback accepteren op alle versies van het product, is de ondersteuning beperkt tot de nieuwste grote en de nieuwste kleine versie van de kwartaal- en jaarlijkse releasekanalen. Automate raadt aan om u te abonneren op productupdatemeldingen en de updates te bekijken en toe te passen binnen een korte tijd nadat ze beschikbaar zijn.

De software vereist een geldige Automate-licentie. De licentie is doorgaans tijdsgebonden en bepaalde functies van de software vereisen een specifieke licentie-editie. Als u problemen ondervindt met de Automate-licentie of specifieke vragen hebt over een productfunctie, neem dan contact op met de ondersteuning van Nuix.

Stijlen die in deze handleiding worden gebruikt

Notitie: Dit pictogram geeft aan dat er aanvullende verduidelijkingen worden gegeven, bijvoorbeeld wat de geldige opties zijn.
Tip: Dit pictogram laat je weten dat er een bijzonder nuttige versnapering is, misschien een manier om de applicatie te gebruiken om een bepaald gedrag te bereiken.
Waarschuwing: Dit pictogram markeert informatie die u kan helpen ongewenst gedrag te voorkomen.
  • Benadrukte: Deze stijl geeft de naam van een menu, optie of link aan

  • code: Deze stijl geeft code aan die letterlijk moet worden gebruikt en kan verwijzen naar bestandspaden, parameternamen of Nuix-zoekopdrachten.

1. Architectuur

1.1. Componenten

Een Automate-implementatie bestaat uit verschillende componenten:

  • Automatische planner: Ontvangt verzoeken van analisten of van bedrijfsservices voor het in de wachtrij plaatsen van taken en verzendt de taken naar de Automate Engine-servers.

  • Automatiseer Engine Server: Ontvangt taken van Automate Scheduler, start engines en voert taken uit.

  • Nuix Engine: De Nuix Engine maakt / opent Nuix-cases en voert het vereiste werk uit in de cases.

  • Nuix-licentiebron: Er kunnen een of meer Nuix-licentiebronnen worden gebruikt, van de volgende typen:

    • Nuix NMS

    • Nuix-licentiedongle

    • Nuix Cloud-licentie

  • Verificatiebron: De service die wordt gebruikt om gebruikers te verifiëren en het lidmaatschap van een groep te bepalen. Dit kan een combinatie zijn van:

    • Nuix UMS: de Nuix-server voor gebruikersbeheer

    • LDAP: Active Directory op locatie

    • Azure AD: Microsoft Azure Active Directory

    • OIDC: een Open ID Connect-compatibele authenticatieservice

    • Intern: intern gedefinieerde gebruikersnamen en wachtwoorden, voor initiële configuratie.

Bovendien zijn de volgende componenten optioneel:

  • Automatiseer OData-server: Retourneert gebruiksgegevens met behulp van het OData-protocol.

  • Automatiseer proxy: Haalt het uploaden en hashen van gegevens uit de hoofd-Automate Scheduler.

  • Business Intelligence-software: Een softwaretool die de Automate-omgeving raadpleegt voor statistieken, de gegevens analyseert en interactieve dashboards biedt, zoals Microsoft Power BI of Tableau.

  • Microsoft SQL: Kan worden gebruikt om de ingebouwde Scheduler-database te vervangen voor het opslaan van taakinformatie, configuratie en auditlogboeken.

1.2. Implementatie

Met uitzondering van Automate Engine Server, dat op elke Nuix-server moet worden geïnstalleerd die deel uitmaakt van de Automate-implementatie, kunnen alle overige componenten op dezelfde server of op speciale servers worden geïmplementeerd.

Wanneer u de optionele Automate OData Server implementeert op een andere server dan de server waarop Automate Scheduler wordt gehost, moeten de gebruiksgegevens worden omgeleid van de ingesloten database naar een Microsoft SQL-database.

1.2.1. Voorbeeld van gedistribueerde architectuur

Deze voorbeeldarchitectuur bestaat uit een speciale server die Automate Scheduler host, meerdere servers die Automate Engine Servers en Nuix Engines hosten, speciale servers voor Nuix NMS en Nuix UMS en connectiviteit met Azure AD.

Voorbeeld van gedistribueerde architectuur

1.2.2. Voorbeeld van zelfstandige architectuur

Deze voorbeeldarchitectuur bestaat uit één server waarop de Automate Scheduler en de Automate Engine Server, verschillende Nuix Engines en de Nuix NMS en Nuix UMS worden gehost.

Voorbeeld van zelfstandige architectuur

1.3. Netwerkverkeersstroom

Componenten in een Automate-implementatie communiceren via HTTP. Zie sectie Configuration om de TCP-poorten en TLS-certificaten te configureren.

Verkeersstroom
Bron Bestemming Protocol (poort)

Analyst-webbrowser

Automatiseer scheduler

HTTPS (TCP/443)

Analyst-webbrowser

Azure AD

HTTPS (TCP/443)

Automatiseer scheduler

Automatiseer Engine-server

HTTPS (TCP/443)

Automatiseer Engine

Automatiseer scheduler

HTTPS (TCP/443)

Automatiseer scheduler

Nuix UMS

HTTPS (TCP/443)

Automatiseer scheduler

Azure AD

HTTPS (TCP/443)

Nuix Engine

Nuix NMS

HTTPS (TCP/27443)

2. Vereisten

Zie 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. Configuratie

3.1. Service-instellingen

De configuratiebestanden bevinden zich op de volgende locaties:

  • Automatische planner C:\ProgramData\Nuix\Automate\Scheduler\config\config.yml

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

  • Automatiseer OData-server C:\ProgramData\Nuix\Automate\ODataServer\config\config.yml

Daarnaast kunnen bepaalde Scheduler Service-configuratieopties worden ingesteld met behulp van omgevingsvariabelen (zie paragraaf Scheduler Service Environmental Variables voor meer details.)

3.1.1. Scheduler Service-instellingen

Deze bestanden volgen de YAML-syntaxis en bevatten de volgende parameters:

  • role: SCHEDULER, geeft aan dat het onderdeel Automatische planner wordt uitgevoerd;

  • apiSecret: Sleutel gebruikt voor de authenticatie tussen Automate-componenten. Stel dezelfde willekeurige waarde in op alle Automate Scheduler-, Proxy- en Server-instanties.

  • internalCredentials: geeft aan dat inloggegevens die in het configuratiebestand zijn gedefinieerd, worden gebruikt voor verificatie. De configuratie is beschikbaar in de volgende subsleutels:

    • displayName: (Optioneel) De naam die wordt weergegeven op de aanmeldingspagina voor deze verificatiemethode.

    • Opmerking: (Optioneel) Beperk de beschikbaarheid van de interne authenticatie tot browsers van localhost. Als deze eigenschap niet is opgegeven, wordt deze st`restrictToLocalhostaard ingesteld op `false.

    • usersEligibleLegalHoldAdministrator: (Optioneel) Stel interne gebruikers in aanmerking voor wettelijke bewaarplichtadministraties. Als deze eigenschap niet is opgegeven, wordt deze standaard ingesteld op false.

    • usersEligibleLegalHoldCustodian: (Optioneel) Interne gebruikers in aanmerking laten komen voor Bewaarders. Als deze eigenschap niet is opgegeven, wordt deze standaard ingesteld op false.

    • credentials: De lijst met inloggegevens.

De inloggegevens kunnen in beide PBKDF2-indelingen worden verstrekt, met behulp van:

  • username

  • email

  • , een base64-gecodeerde string

  • iterations, het aantal hash-iteraties

  • hash, berekend met behulp van het PBKDF2WithHmacSHA512-algoritme met een sleutellengte van 512 bits.

of in leesbare tekst, met behulp van:

  • username

  • email

  • password

Voorbeeld van interne authenticatieconfiguratie met 2 gebruikers:

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@
De interne authenticatiemethode vereist het opslaan van de gebruikersnamen en wachtwoorden of hashes in het configuratiebestand. Het wordt aanbevolen om deze methode te beperken tot localhost.
Stel de eigenschap restrictToLocalhost in op true om alleen inloggen met interne inloggegevens toe te staan bij het openen van Automate als localhost.
  • userSessionTimeout: De duur in seconden van inactiviteit waarna een gebruikerssessie verloopt.

  • nuixEnginePath: de locatie van de implementatie van Nuix Engine. Deze map moet rechtstreeks de submappen bin, lib en user-data bevatten.

  • log4jConfigurationFile: het log4j-configuratiebestand.

  • enableCentralizedLogging: true of false die aangeven of de gecentraliseerde logboekfunctie is ingeschakeld.

Deze functie is standaard ingeschakeld. Om deze functie uit te schakelen, stelt u de waarde in op false
  • centralizedLoggingRetention: de duur in dagen dat de logboeken worden bewaard.

  • centralizedLoggingMaxSize: De maximale databasegrootte in bytes vóór een rollover.

  • centralizedLoggingSizeCheckInterval: De duur in seconden waarna de database een groottecontrole uitvoert.

  • enableRollingLoggingDatabases: Wanneer de logging database is geconfigureerd voor SQLite databases worden gerolled, bijvoorbeeld wanneer de logging databases de maximum grootte bereiken die is gedefinieerd in de centralizedLoggingMaxSize gedeeld door het aantal rolling databases dat is gedefinieerd in de maxRollingLoggingDatabases instelling. De database wordt hernoemd en er wordt een nieuwe database gemaakt. Standaard is deze functie uitgeschakeld. Als de gebruiker bijvoorbeeld een maximum grootte van 1 GB en 5 rolling databases had, dan is de maximum grootte voor alle rolling databases 200 MB.

Wanneer de database logboeken rolt, worden de gedownloade logboeken een uitgeklede versie met alles behalve de daadwerkelijke logboeken van de database en wordt gecentraliseerde logging tijdelijk uitgeschakeld. Als de databaserotatie plaatsvindt terwijl de gebruiker logboeken downloadt, wordt de downloadthread afgesloten en krijgt de gebruiker de logboeken die hij kon verzamelen en loggen een waarschuwing om de gebruiker te informeren dat de download is afgesloten vanwege de rotatie.
  • maxRollingLoggingDatabases: Het maximale aantal rollende databases. Wanneer het maximale aantal databases is bereikt, wordt de database met de oudste logs verwijderd.

  • enableCentralizedLoggingDownloadTimeout: true of false geeft aan of de time-outfunctie voor het downloaden van gecentraliseerde logboeken is ingeschakeld.

Deze functie sluit de stream voor het downloaden van logs na een ingestelde interval die is gedefinieerd in de gecentraliseerdLoggingDownloadTimeout`-instelling. Deze functie wordt alleen aanbevolen voor probleemoplossingsdoeleinden en is standaard uitgeschakeld.
  • centralizedLoggingDownloadTimeout: De tijd in milliseconden voor het downloaden van logs voordat het programma wordt afgesloten. Deze waarde is standaard ingesteld op 180000 (3 minuten).

  • engineInitLogFolder: De logmap die moet worden gebruikt tijdens de Engine-initialisatie, voordat de taak wordt uitgevoerd.

  • archiveJobsPastDuration: de duur in seconden waarna voltooide taken automatisch worden gearchiveerd.

  • archiveJobsPastCount: Het maximale aantal voltooide taken waarna de oudste taak automatisch wordt gearchiveerd.

  • server: Geeft de IP / poorten aan waarop moet worden geluisterd en het TLS-certificaat voor HTTPS-verbindingen.

Standaard luistert de service op HTTP op poort 80 op localhost, en op HTTPS op poort 443 alle IP-adressen. Om te voorkomen dat de server op een specifiek IP-adres luistert, wijzigt u 0.0.0.0 naar het vereiste IP-adres in het config.yml-bestand.
Als Scheduler wordt geüpgraded van een versie ouder dan 6.0, accepteert de server standaard alleen HTTP/1.1-verbindingen. Om HTTP/2-verbindingen in te schakelen, wijzigt u type: https in type: h2 in het config.yml-bestand.
  • webConfiguration: Geeft aan welke webinstellingen moeten worden toegepast op de webserver die wordt gebruikt voor de REST API, inclusief HSTS-, XSS-beveiligingen, CORS en CSP.

  • : De CORS-configuratie.

De Automate REST API is ontworpen om zowel toegankelijk te zijn via de webpagina die gehost wordt op de Scheduler-server, als via services en webpagina’s van derden. Om deze reden staat de standaard CORS-configuratie alle oorsprongen toe. Deze configuratie is veilig, aangezien elk verzoek aan de REST API geauthenticeerd moet worden met een Bearer-token. Als er behoefte is om de CORS-toegestane oorsprongen verder te beperken, kan een strenger beleid worden ingesteld door de standaard CORS-instellingen in het config.yml-bestand te bewerken.

Voorbeeld CORS-beleid dat de toegestane oorsprongen beperkt:

  cors:
    allowedOrigins: ["https://scheduler.example.com"]
  • logging: geeft de parameters aan van de logging die door de service wordt uitgevoerd. Deze logboeken bevatten ook de informatie die doorgaans wordt geregistreerd door Nuix Workstation. De locatie van de werkerlogboeken wordt gespecificeerd in de parameter nuixFlags.

  • applicationStore: geeft aan dat een aangepaste database wordt gebruikt voor het opslaan van de auditinformatie.

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

    • user: de database gebruikersnaam

    • password: het databasewachtwoord

    • url: de JDBC-verbindingsreeks, bijvoorbeeld jdbc:jtds:sqlserver://HOST:1433/DATABASE

    • properties: de verbindingseigenschappen.

Voorbeeld van Microsoft SQL-configuratie:

applicationStore:
  driverClass: net.sourceforge.jtds.jdbc.Driver
  user: automate-service
  password: SecretGoesHere
  url: jdbc:jtds:sqlserver://localhost:1433/automate
  properties:
    charSet: UTF-8
Als er geen gebruikersnaam en wachtwoord zijn opgegeven in de Microsoft SQL-opslagconfiguratie, wordt de verbinding uitgevoerd met behulp van Integrated Windows Authentication. Wanneer u op deze manier verbinding maakt met Microsoft SQL, moet de Automate Scheduler-service worden geconfigureerd om te worden uitgevoerd onder een account dat toegang heeft tot de Microsoft SQL-database.
  • utilizationStore: geeft aan dat een aangepaste database wordt gebruikt voor het opslaan van de operationele gebruiksgegevens.

  • loggingStore: geeft aan dat een aangepaste database wordt gebruikt voor het opslaan van logboeken.

De loggingStore is een circulaire buffer van alle platformlogboeken en zal naar verwachting een schrijfdoorvoer genereren. Het wordt niet aanbevolen om dit logboekarchief om te leiden naar een SQL-database.

Voorbeeldconfiguratie voor het verplaatsen van de loggingStore naar D:\Logs\Automate:

loggingStore:
  driverClass: org.sqlite.JDBC
  url: jdbc:sqlite:D:/Logs/Automate/logging.db
  properties:
    charSet: UTF-8
De verschillende hierboven genoemde winkels kunnen allemaal worden omgeleid naar één Microsoft SQL-database of, indien nodig, om databases te scheiden.
  • defaultUserSettings: Overschrijf de gebruikersinstellingen die van toepassing zijn wanneer er geen specifieke configuratie was ingesteld op een gebruikersprofiel.

Voorbeeldinstellingen om de toegestane parameterwaarden te definiëren die standaard worden ingevuld bij het maken van een nieuwe client of een nieuwe kwestie:

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 of false die aangeven of de toegestane parameterwaarden gedefinieerd in de gebruikersinterface of geretourneerd door scripts moeten worden gesorteerd en of ze de oorspronkelijke volgorde moeten behouden.

  • jobMaximumExecutionParametersLength: het aantal tekens dat uitvoeringsparameters kunnen hebben voordat de waarde wordt ingekort. Dit heeft alleen invloed op de prestaties van de front-end van de planner. Standaard is dit ingesteld op 200-tekens.

  • archivedJobCleanupEnabled: true of false geeft aan of de archieftaakopschoner moet worden uitgevoerd. Hiermee worden taken, logboeken van taakuitvoeringen en statistieken van het MIME-type van taakbewerkingen verwijderd nadat een gearchiveerde taak ouder is dan een bepaald aantal dagen. St`falseaard is de waarde `false.

  • archivedJobCleanupInterval: Het interval in uren voor hoe vaak de taakopruiming moet worden uitgevoerd. Standaard is dit ingesteld op 24 uur.

  • archivedJobRetentionDays: Aantal dagen dat een taak gearchiveerd moet worden voordat deze in aanmerking komt voor verwijdering. Standaard is dit ingesteld op 584 dagen (1,5 jaar).

  • synchronizeJobsOnAllMatters: true of false die aangeven of er maar één Job tegelijk op een kwestie mag draaien.

  • authTokenTtl: De duur in seconden waarna de gebruikersauthenticatietoken verloopt. De browser zal een verzoek indienen om het authenticatietoken te vernieuwen op de helft van de levensduur van het token. Standaard is dit ingesteld op 600 seconden.

  • disableAuthTokenExpiration: true of false om aan te geven dat de gebruikersauthenticatietoken niet verloopt. St`falseaard is dit ingesteld op `false.

  • : De duur in seconden voor het bijhouden van verlopen authenticatietokens. Bij een poging om toegang te krijgen tot Automatiseren met een verlopen authenticatietoken, wordt een vriendelijke foutmelding geretourneerd en wordt de huidige live gebruikerssessie ongeldig gemaakt. St`expiredAuthTokenTombstoneaard is dit ingesteld op `900.

  • downgradeWebWorkerToken: true of false waarmee wordt aangegeven dat de browser het Web Worker-token moet downgraden om het toegankelijk te maken voor scripts in de browser. St`falseaard is dit ingesteld op `false.

Met de standaardinstelling downgradeWebWorkerToken: false wordt de gebruiker uitgelogd bij het vernieuwen van het browservenster. Als u deze optie instelt op true, blijft de gebruikerssessie behouden wanneer het browservenster wordt vernieuwd, maar is het authenticatietoken toegankelijk via scripts in de browser, wat minder veilig is.
  • enforceSingleUserSession: true of false geeft aan of een gebruiker meer dan één sessie tegelijk kan hebben. Als deze optie op true is ingesteld, is er slechts één sessie toegestaan.

Als een gebruiker al is aangemeld en er wordt een nieuwe sessie voor dezelfde gebruiker gestart, wordt de oudere sessie afgemeld.
  • libraryFileMaxSize: De maximale grootte in bytes van bestanden die kunnen worden geüpload naar de bestandsbibliotheek, standaard 10000000.

De bestandsbibliotheek is ontworpen om configuratiebestanden en profielen op te slaan. Deze limiet is niet van toepassing op bestanden die zijn geüpload naar Data Repositories.
  • expireIdleUploadAfter: De duur in milliseconden waarna inactieve uploads naar Data Repositories verlopen, standaard 3600000 komt overeen met 1 uur.

  • uploadBufferMaxSize: De maximale buffergrootte in KiB die standaard wordt toegewezen tijdens uploads naar Data Repositories 8192. De buffergrootte kan maximaal 3 keer worden toegewezen voor elke bestandsupload en wordt alleen gebruikt voor de duur van de bestandsupload.

Bij het schrijven van gegevens naar een bestandsshare die is aangesloten via een netwerk met hoge latentie, kan het vergroten van de uploadBufferMaxSize de algehele overdrachtsprestaties verhogen ten koste van een groter geheugengebruik.
  • : Het algoritme dat st`uploadHashAlgorithmsaard wordt gebruikt voor hashing aan de serverzijde bij het uploaden van bestuploadHashAlgorithmsen naar Data Repositories `MD5. Gebruik de waarde None om hashing tijdens het uploaden uit te schakelen.

Het hashen van bestanden tijdens het uploaden vereist aanzienlijke CPU-bronnen op de Scheduler-server. Gebruik de rol Plannerproxy om deze berekening naar een andere server te verplaatsen.
  • enableUtilizationEndpoint: Schakel standaard de OData-service in Scheduler in true. Gebruik de waarde false om uit te schakelen.

  • utilizationErrorsSoftFail: Masker gebruiksgegevensdatabase schrijffouten naar de applicatie standaard false.

  • azureLocations: (Optioneel) De lijst met locaties om VM’s in uit te voeren. Voorbeelden van azureLocations-instellingen:

azureLocations: westus,eastus
  • azureVmSizes: (Optioneel) De lijst met VM-grootten. Voorbeelden van 'azureVmSizes'-instellingen:

azureVmSizes: Standard_M8ms,Standard_M16ms,Standard_M32ts

3.1.2. Omgevingsvariabelen Scheduler-service

De volgende omgevingsvariabelen kunnen worden geconfigureerd om instellingen in het Scheduler Service-configuratiebestand in te stellen of te overschrijven:

  • Database omleiding. Gebruik de volgende instellingen om de toepassing om te leiden naar een SQL-database:

    • AUTOMATE_STORE_APPLICATION_ENABLED: Stel in op true om in te schakelen

    • AUTOMATE_STORE_APPLICATION_DRIVER_CLASS: De coureursklasse, bijvoorbeeld org.postgresql.Driver

    • AUTOMATE_STORE_APPLICATION_URL: de JDBC-verbindingsreeks, bijvoorbeeld jdbc:postgresql://postgres.example.internal:5432/automateScheduler

    • AUTOMATE_STORE_APPLICATION_USERNAME: de database gebruikersnaam

    • AUTOMATE_STORE_APPLICATION_PASSWORD: het databasewachtwoord

    • AUTOMATE_STORE_APPLICATION_CHARSET: De tekenset van de database, bijvoorbeeld UTF-8

    • AUTOMATE_STORE_LOGGING_REDIRECT_TO_APPLICATION: Stel in op true om de gecentraliseerde logboekregistratie om te leiden naar dezelfde locatie als de toepassingswinkel

    • AUTOMATE_CENTRALIZED_LOGGING_ENABLED: Stel in op false om gecentraliseerde logboekregistratie uit te schakelen

    • AUTOMATE_STORE_UTILIZATION_REDIRECT_TO_APPLICATION: stel in op true om de gebruiksgegevens om te leiden naar dezelfde locatie als de applicatiewinkel

    • AUTOMATE_STORE_APPLICATION_SCHEDULER_MIN_CONNECTIONS: Het minimum aantal verbindingen dat open moet blijven

    • AUTOMATE_STORE_APPLICATION_SCHEDULER_MAX_CONNECTIONS: Het maximale aantal verbindingen dat open moet blijven

  • Authenticatie. Gebruik de volgende instellingen om de toegangsreferenties te configureren om u aan te melden bij de applicatie voor de initiële configuratie:

    • Interne gebruikersnaam/wachtwoord-authenticatie:

      • AUTOMATE_AUTH_INTERNAL_ENABLED: Stel in op true om in te schakelen

      • AUTOMATE_AUTH_INTERNAL_USERNAME: De gebruikersnaam om in te loggen

      • AUTOMATE_AUTH_INTERNAL_EMAIL: Het e-mailadres van de gebruiker

      • AUTOMATE_AUTH_INTERNAL_PASSWORD: Het wachtwoord om mee in te loggen.

    • Interne PBKDF2-authenticatie:

      • AUTOMATE_AUTH_INTERNAL_ENABLED: Stel in op true om in te schakelen

      • AUTOMATE_AUTH_INTERNAL_USERNAME: De gebruikersnaam om in te loggen

      • AUTOMATE_AUTH_INTERNAL_EMAIL: Het e-mailadres van de gebruiker

      • AUTOMATE_AUTH_INTERNAL_SALT: een base64-gecodeerde tekenreeks

      • AUTOMATE_AUTH_INTERNAL_ITERATIONS: het aantal hash-iteraties

      • AUTOMATE_AUTH_INTERNAL_HASH: de wachtwoord-hash berekend met behulp van het PBKDF2WithHmacSHA512-algoritme met een sleutellengte van 512 bits.

    • OIDC-authenticatie:

      • AUTOMATE_AUTH_OIDC_ENABLED: Stel in op true om in te schakelen

      • AUTOMATE_AUTH_OIDC_NAME: de naam van het authenticatiemechanisme

      • AUTOMATE_AUTH_OIDC_DESCRIPTION: De beschrijving van het authenticatiemechanisme

      • AUTOMATE_AUTH_OIDC_WELL_KNOWN_CONFIG_URI: De bekende configuratie-URI, bijvoorbeeld http://keycloak:8080/realms/default/.well-known/openid-configuration

      • AUTOMATE_AUTH_OIDC_SCOPE: De reikwijdte, bijvoorbeeld openid email profile

      • AUTOMATE_AUTH_OIDC_USERNAME_CLAIM: De gebruikersnaamclaim, bijvoorbeeld email

      • AUTOMATE_AUTH_OIDC_CLIENT_ID: de klant-ID

      • AUTOMATE_AUTH_OIDC_CLIENT_SECRET: Het klantgeheim

    • Derby Control-service:

      • AUTOMATE_DERBY_CONTROL_SERVICE_ENABLED: Stel in op true om in te schakelen

      • AUTOMATE_DERBY_CONTROL_SERVICE_NAME: De Derby Control-servicenaam

      • AUTOMATE_DERBY_CONTROL_SERVICE_DESCRIPTION: De servicebeschrijving van Derby Control

      • AUTOMATE_DERBY_CONTROL_SERVICE_URL: De Derby Control-basis-URL, bijvoorbeeld http://127.0.0.1:8999/DERBY-CONTROL

  • API-geheim voor meerdere servers. Gebruik de volgende instellingen om het API-geheim te configureren dat wordt gebruikt voor het beheer van verschillende engineservers:

    • AUTOMATE_API_SECRET: Sleutel gebruikt voor de authenticatie tussen Automate-componenten. Stel dezelfde willekeurige waarde in op alle Automate Scheduler-, Proxy- en Server-instanties.

  • Veiligheidsbeleid. Gebruik de volgende instellingen om een ​​beveiligingsbeleid te configureren:

    • AUTOMATE_SECURITY_POLICY_ENABLED: Stel in op true om in te schakelen

    • AUTOMATE_SECURITY_POLICY_NAME: De polisnaam

    • AUTOMATE_SECURITY_POLICY_DESCRIPTION: De polisbeschrijving

    • AUTOMATE_SECURITY_POLICY_PRINCIPALS: De lijst met opdrachtgevers waarop het beleid van toepassing is. De volgende instelling komt overeen met elke geverifieerde gebruiker: [{"identifierType":"BUILTIN","identifierName":"AUTHENTICATED_USER"}]

    • AUTOMATE_SECURITY_POLICY_PERMISSIONS: De beleidsmachtigingen, bijvoorbeeld ["VIEW","VIEW_SENSITIVE","MODIFY","CREATE","SUBMIT_JOB","DOWNLOAD_LOGS"]

    • AUTOMATE_SECURITY_POLICY_SCOPE_BUILTIN: De ingebouwde beleidsbereiken, bijvoorbeeld ["ALL_CLIENT_POOLS","ALL_CLIENTS","ALL_LIBRARIES","API_KEYS","COLLECTIONS","LEGAL_HOLDS","SCRIPTS","SCHEDULES","SECURITY","RESOURCES"]

    • AUTOMATE_SECURITY_POLICY_SCOPE: Definieer optioneel het volledige beleidsbereik, bijvoorbeeld [{"identifierType":"BUILTIN","identifierName":"RESOURCES"}]

  • Beveiligingsbeleid. Gebruik de volgende instellingen om een ​​Automate License te configureren:

    • AUTOMATE_LICENSE_ENABLED: Stel in op true om in te schakelen

    • AUTOMATE_LICENSE_ID: De licentie-ID

    • AUTOMATE_LICENSE_KEY: De licentiesleutel

    • AUTOMATE_LICENSE_DIAGNOSTIC_LEVEL: Het diagnostische niveau, bijvoorbeeld ENHANCED

  • Nuix CLS-licentie. Gebruik de volgende instellingen om een ​​Nuix CLS-licentie te configureren:

    • AUTOMATE_NUIX_CLS_LICENSE_ENABLED: Stel in op true om in te schakelen

    • AUTOMATE_NUIX_CLS_LICENSE_NAME: De licentienaam

    • AUTOMATE_NUIX_CLS_LICENSE_DESCRIPTION: De licentiebeschrijving

    • AUTOMATE_NUIX_CLS_LICENSE_FILTER: Het licentiewerkerfilter, bijvoorbeeld workstation

    • AUTOMATE_NUIX_CLS_LICENSE_DESCRIPTION: De licentiebeschrijving

    • AUTOMATE_NUIX_CLS_LICENSE_USERNAME: De CLS-gebruikersnaam

    • AUTOMATE_NUIX_CLS_LICENSE_PASSWORD: Het CLS-wachtwoord

  • Middelenpool. Gebruik de volgende instellingen om een ​​resourcegroep te configureren:

    • AUTOMATE_RESOURCE_POOL_ENABLED: Stel in op true om in te schakelen

    • AUTOMATE_RESOURCE_POOL_NAME: de naam van de resourcepool

    • AUTOMATE_RESOURCE_POOL_DESCRIPTION: De beschrijving van de bronnenpool

    • AUTOMATE_RESOURCE_POOL_AUTO_REGISTRATION_ENABLED: Stel in op true om automatische registratie in te schakelen.

    • AUTOMATE_RESOURCE_POOL_AUTO_REGISTRATION_ACCESS_KEY: De toegangssleutel voor automatische registratie. De Engine Servers moeten dezelfde sleutel gebruiken.

    • AUTOMATE_RESOURCE_POOL_AUTO_REGISTRATION_STRICT_IP: Optioneel, ingesteld op true om standaard registratie af te dwingen vanaf hetzelfde IP-adres als de doelserver false.

    • AUTOMATE_RESOURCE_POOL_AUTO_REGISTRATION_MIN_WORKERS: Optioneel, standaard het minimumaantal werknemers voor automatische registratie 1.

    • AUTOMATE_RESOURCE_POOL_AUTO_REGISTRATION_TARGET_WORKERS: Optioneel, de automatische registratie is standaard gericht op werknemers 2.

    • AUTOMATE_RESOURCE_POOL_AUTO_REGISTRATION_EXECUTION_MODE: Optioneel, standaard de automatische registratie-uitvoeringsmodus AUTOMATE_NUIX.

  • Uitvoeringsprofiel. Gebruik de volgende instellingen om een ​​uitvoeringsprofiel te configureren:

    • AUTOMATE_EXECUTION_PROFILE_ENABLED: Stel in op true om in te schakelen

    • AUTOMATE_EXECUTION_PROFILE_NAME: De naam van het uitvoeringsprofiel

    • AUTOMATE_EXECUTION_PROFILE_DESCRIPTION: De beschrijving van het uitvoeringsprofiel

    • AUTOMATE_EXECUTION_PROFILE_ENGINE_COMMAND_LINE_PARAMS: Optioneel, standaard de Engine-opdrachtregelparameters -Xmx16g -Dnuix.logdir=/var/log/nuix/automate -Duser.language=en -Duser.country=US.

    • AUTOMATE_EXECUTION_PROFILE_NUIX_ENGINE_FOLDER: Optioneel, standaard de map met binaire bestanden van de Nuix-engine /opt/nuix/engine.

    • AUTOMATE_EXECUTION_PROFILE_ENGINE_LOG_FOLDER: Optioneel, standaard de map Engine-logboek /var/log/nuix/automate.

    • AUTOMATE_EXECUTION_PROFILE_JAVA_FOLDER: Optioneel, de map Java-binaire bestanden, standaard leeg.

    • AUTOMATE_EXECUTION_PROFILE_PARAMETERS: Optioneel, een JSON-serialized Map<String,String> van parameter en waarden, standaard leeg.

    • AUTOMATE_EXECUTION_JOB_PROGRESS_MIN_PERCENTAGE: Optioneel, de minimale taakvoortgang voordat de taak wordt afgebroken, standaard 1.0.

    • AUTOMATE_EXECUTION_JOB_PROGRESS_TIMEOUT_HOURS: Optioneel, de time-out waarna de taak moet worden afgebroken als de voortgang van de taak niet wordt bereikt, standaard 48.0.

    • AUTOMATE_EXECUTION_OPERATION_PROGRESS_MIN_PERCENTAGE: Optioneel, de minimale voortgang van de bewerking voordat de taak wordt afgebroken, standaard 1.0.

    • AUTOMATE_EXECUTION_OPERATION_PROGRESS_TIMEOUT_HOURS: Optioneel, de time-out waarna de taak moet worden afgebroken als de voortgang van de bewerking niet wordt bereikt, standaard 24.0.

    • AUTOMATE_EXECUTION_SKIP_OPERATION_PROGRESS_MIN_PERCENTAGE: Optioneel: de miniumbewerking wordt standaard voortgezet voordat wordt geprobeerd de bewerking over te slaan 1.0.

    • AUTOMATE_EXECUTION_SKIP_OPERATION_PROGRESS_TIMEOUT_HOURS: Optioneel, de time-out waarna wordt geprobeerd de bewerking van de voortgang van de bewerking over te slaan, is standaard niet bereikt 12.0.

  • Gebruikersgegevensmap. Gebruik de volgende instellingen om het gedrag van de gebruikersgegevensmap te configureren:

    • AUTOMATE_USER_DATA_DIR_SCAN_INTERVAL: Stel de intervalduur in seconden in waarmee de map met gebruikersgegevens wordt gescand, zelfs als het besturingssysteem geen wijziging detecteert.

  • Om een ​​willekeurige instelling te overschrijven, converteert u de instellingsnaam naar hoofdletter snake case, voorafgegaan door Automate. Gebruik bijvoorbeeld voor het configureren van de downgradeWebWorkerToken-instelling de AUTOMATE_DOWNGRADE_WEB_WORKER_TOKEN-omgevingsvariabele.

3.1.3. Scheduler Proxy Service-instellingen

Dit bestand volgt de YAML-syntaxis en bevat de volgende parameters:

  • role: PROXY, geeft aan dat het Automate Scheduler Proxy-component wordt uitgevoerd;

  • apiSecret: Sleutel gebruikt voor de authenticatie tussen Automate-componenten. Stel dezelfde willekeurige waarde in op alle Automate Scheduler-, Proxy- en Server-instanties.

  • proxy: de details van de hoofdinstantie van de planner die de proxy gebruikt. De configuratie is beschikbaar in de volgende subsleutels:

    • baseUrl: De URL van de Scheduler-instantie.

    • whitelistedCertFingerprints: Vingerafdrukken van plannercertificaten die worden gebruikt voor verificatie bij het openen van een beveiligde verbinding.

  • allowedAuthenticationServices: De lijst met authenticatieservicenamen die via deze proxy kunnen worden gebruikt. Als deze instelling niet is gedefinieerd, worden alle authenticatieservices toegestaan ​​via de proxy.

Voorbeeld van proxyconfiguratie:

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

allowedAuthenticationServices:
  - Internal
  - Lab Azure AD
  • log4jConfigurationFile: het log4j-configuratiebestand.

  • server: Geeft de instellingen voor de webtoegangslogboeken aan, de HTTP-protocollen waarnaar moet worden geluisterd en het bijbehorende IP-, poort- en TLS-certificaat voor HTTPS-verbindingen.

  • webConfiguration: geeft aan welke webinstellingen moeten worden toegepast op de webserver die wordt gebruikt voor de REST API.

3.1.4. Instellingen voor Engine Server-service

Dit bestand volgt de YAML-syntaxis en bevat de volgende parameters:

  • role: ENGINE_SERVER, geeft aan dat het Automate Engine Server-component wordt uitgevoerd;

  • apiSecret: Sleutel gebruikt voor de authenticatie tussen Automate-componenten. Stel dezelfde willekeurige waarde in op alle Automate Scheduler-, Proxy- en Server-instanties.

  • nuixEnginePath: de locatie van de implementatie van Nuix Engine. Deze map moet rechtstreeks de submappen bin, lib en user-data bevatten.

  • log4jConfigurationFile: het log4j-configuratiebestand.

  • engineInitLogFolder: De tijdelijke locatie die door Engines wordt gebruikt voor het opslaan van configuratiebestanden en logboeken tijdens de initialisatiefase. Wanneer Jobs wordt uitgevoerd, zal de Engine de logboeken en configuratiebestanden opslaan op de locatie die is opgegeven in het uitvoeringsprofiel.

  • engineInitTimeout: De time-out in seconden die de Engine standaard mag initialiseren 120.

  • engineAbortTimeout: De time-out in milliseconden die de engine wacht om een ​​taak af te breken, is standaard 5000 (5 seconden)

  • server: Geeft de instellingen voor de webtoegangslogboeken aan, de HTTP-protocollen waarnaar moet worden geluisterd en het bijbehorende IP-, poort- en TLS-certificaat voor HTTPS-verbindingen.

  • webConfiguration: geeft aan welke webinstellingen moeten worden toegepast op de webserver die wordt gebruikt voor de REST API.

  • jobRunningLogMaxSize: Geeft het maximale aantal logboeken aan dat het logboek voor taakuitvoering standaard opslaat 20.

  • logging: geeft de parameters aan van de logging die door de service wordt uitgevoerd. Deze logboeken bevatten ook de informatie die doorgaans wordt geregistreerd door Nuix Workstation. De locatie van de werkerlogboeken wordt gespecificeerd in de parameter nuixFlags.

  • workerBrokerIP: Het IP-adres dat moet worden gebruikt voor het hosten van Worker Brokers bij het uitvoeren van Remote Workers.

  • workerBrokerStartPort: Het poortbereik begint voor Worker Brokers.

  • workerBrokerEndPort: Het poortbereik eindigt voor Worker Brokers.

Voorbeeldinstellingen voor het configureren van een Worker Broker op IP 10.0.0.1:

workerBrokerIP: 10.0.0.1
workerBrokerStartPort: 50000
workerBrokerEndPort: 50100
Als de workerBrokerIP-instelling niet beschikbaar is, start de server een broker op een st`workerBrokerIPaard netwerkadapter. In een omgeving waar servers meerdere netwerkadapters hebben, configureert u `workerBrokerIP op elke server met het IP-adres dat moet worden gebruikt door `workerBrokerIP`ere servers die externe taken samenvoegen om contact te maken met deze server.

3.1.5. Omgevingsvariabelen Engine Server-service

De volgende omgevingsvariabelen kunnen worden geconfigureerd om instellingen in het Engine Server Service-configuratiebestand in te stellen of te overschrijven:

  • Database omleiding. Gebruik de volgende instellingen om de toepassing om te leiden naar een SQL-database:

    • AUTOMATE_STORE_APPLICATION_ENABLED: Stel in op true om in te schakelen

    • AUTOMATE_STORE_APPLICATION_DRIVER_CLASS: De coureursklasse, bijvoorbeeld org.postgresql.Driver

    • AUTOMATE_STORE_APPLICATION_URL: de JDBC-verbindingsreeks, bijvoorbeeld jdbc:postgresql://postgres.example.internal:5432/automateEngineServer

    • AUTOMATE_STORE_APPLICATION_USERNAME: de database gebruikersnaam

    • AUTOMATE_STORE_APPLICATION_PASSWORD: het databasewachtwoord

    • AUTOMATE_STORE_APPLICATION_CHARSET: De tekenset van de database, bijvoorbeeld UTF-8

    • AUTOMATE_STORE_APPLICATION_SCHEDULER_MIN_CONNECTIONS: Het minimum aantal verbindingen dat open moet blijven

    • AUTOMATE_STORE_APPLICATION_SCHEDULER_MAX_CONNECTIONS: Het maximale aantal verbindingen dat open moet blijven

  • Automatische registratie. Gebruik de volgende instellingen om de Engine Server automatisch te registreren bij een Scheduler Resource Pool. De resourcepool moet worden geconfigureerd met de automatische registratiefunctie ingeschakeld:

    • AUTOMATE_REGISTRATION_ENABLED: Stel in op true om in te schakelen

    • AUTOMATE_REGISTRATION_SERVER_NAME: De naam van de Engine Server, bijvoorbeeld Server1

    • AUTOMATE_REGISTRATION_SERVER_URL: De URL waarmee de planner toegang heeft tot de Engine Server, bijvoorbeeld http://Server1.internal.local

    • AUTOMATE_REGISTRATION_SCHEDULER_URL: De Scheduler-URL, bijvoorbeeld http://Scheduler.internal.local

    • AUTOMATE_REGISTRATION_RESOURCE_POOL_ID: Optioneel, de resourcepool-ID waarmee u zich moet registreren. Standaard is dit de ID van de resourcegroep die in Scheduler is geconfigureerd met ENV-variabelen. Deze instelling hoeft alleen te worden opgegeven om u te registreren bij een andere resourcegroep.

    • AUTOMATE_REGISTRATION_ROLE_MAIN: Optioneel, stel in op true schakel de motor in om als hoofdmotor in de hulpbronnenpool te fungeren.

    • AUTOMATE_REGISTRATION_ROLE_REMOTE: Optioneel, ingesteld op true de engine inschakelen om te fungeren als een externe engine in de hulpbronnenpool.

    • AUTOMATE_REGISTRATION_RESOURCE_POOL_ACCESS_KEY: De toegangssleutel voor de bronnenpool. Zie dezelfde waarde die is geconfigureerd in de resourcegroep met de ENV-variabele.

  • Implementatie van meerdere servers. Gebruik de volgende instellingen voor implementatiescenario’s met meerdere servers:

    • AUTOMATISEREN_API_SECRET: Sleutel die wordt gebruikt voor de authenticatie tussen Automate-componenten. Stel dezelfde willekeurige waarde in op alle Automate Scheduler-, Proxy- en Server-instanties.

    • AUTOMATISEREN_SERVER_ID: Stel een uniek willekeurig ID in voor elke Engine Server.

  • Motorlogboekindeling

    • AUTOMATE_ENGINE_LOG_LAYOUT_JSON: Set to true om de Engine-logs te configureren in JSON-formaat. Let op, dit is niet van toepassing op de Scheduler- of Engine Server-logformaten, die rechtstreeks in hun respectievelijke config.yml worden geconfigureerd.

3.1.6. Instellingen OData-serverservice

Dit bestand volgt de YAML-syntaxis en bevat de volgende parameters:

  • role: ODATA_SERVER, geeft aan dat het onderdeel Automate OData Server wordt uitgevoerd;

  • internalCredentials: geeft aan dat inloggegevens die in het configuratiebestand zijn gedefinieerd, worden gebruikt voor verificatie. De configuratie is beschikbaar in de volgende subsleutels:

    • displayName: (Optioneel) De naam die wordt weergegeven op de aanmeldingspagina voor deze verificatiemethode.

    • Opmerking: (Optioneel) Beperk de beschikbaarheid van de interne authenticatie tot browsers van localhost. Als deze eigenschap niet is opgegeven, wordt deze st`restrictToLocalhostaard ingesteld op `false.

    • credentials: De lijst met inloggegevens.

De inloggegevens kunnen in beide PBKDF2-indelingen worden verstrekt, met behulp van:

  • username

  • email

  • , een base64-gecodeerde string

  • iterations, het aantal hash-iteraties

  • hash, berekend met behulp van het PBKDF2WithHmacSHA512-algoritme met een sleutellengte van 512 bits.

of in leesbare tekst, met behulp van:

  • username

  • email

  • password

Voorbeeld van interne authenticatieconfiguratie met 2 gebruikers:

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@
De interne authenticatiemethode vereist het opslaan van de gebruikersnamen en wachtwoorden of hashes in het configuratiebestand. Het wordt aanbevolen om deze methode te beperken tot localhost.
Stel de eigenschap restrictToLocalhost in op true om alleen inloggen met interne inloggegevens toe te staan bij het openen van Automate als localhost.
  • server: Geeft de instellingen voor de webtoegangslogboeken aan, de HTTP-protocollen waarnaar moet worden geluisterd en het bijbehorende IP-, poort- en TLS-certificaat voor HTTPS-verbindingen.

Standaard luistert de service op HTTP op poort 8081 op localhost, en op HTTPS op poort 8443 alle IP-adressen. Om te voorkomen dat de server op een specifiek IP-adres luistert, wijzigt u 0.0.0.0 naar het vereiste IP-adres in het config.yml-bestand.
  • webConfiguration: geeft aan welke webinstellingen moeten worden toegepast op de webserver die wordt gebruikt voor de REST API.

  • utilizationStore: geeft aan dat een aangepaste database wordt gebruikt voor het opslaan van de auditinformatie.

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

    • user: de database gebruikersnaam

    • password: het databasewachtwoord

    • url: de JDBC-verbindingsreeks, bijvoorbeeld jdbc:jtds:sqlserver://HOST:1433/DATABASE

    • properties: de verbindingseigenschappen.

Voorbeeld van Microsoft SQL-configuratie:

utilizationStore:
  driverClass: net.sourceforge.jtds.jdbc.Driver
  user: automate-service
  password: SecretGoesHere
  url: jdbc:jtds:sqlserver://localhost:1433/automate
  properties:
    charSet: UTF-8
Als er geen gebruikersnaam en wachtwoord zijn opgegeven in de Microsoft SQL-opslagconfiguratie, wordt de verbinding uitgevoerd met behulp van Integrated Windows Authentication. Wanneer u op deze manier verbinding maakt met Microsoft SQL, moet de Automate Scheduler-service worden geconfigureerd om te worden uitgevoerd onder een account dat toegang heeft tot de Microsoft SQL-database.

3.2. authenticatie

3.2.1. Nuix UMS

Als u de Nuix UMS-verificatiemethode gebruikt, configureert u de UMS-verificatieservice op de webpagina Automate, op het tabblad Instellingen onder Verificatieservices. Alle gebruikers die zijn gedefinieerd in de Nuix UMS kunnen inloggen op Automate. Het toegangsniveau van elke gebruiker wordt bepaald door het beveiligingsbeleid dat is gedefinieerd op de webpagina Automatiseren op het tabblad Instellingen.

3.2.2. LDAP

Als u de LDAP-verificatiemethode gebruikt, configureert u de LDAP-verificatieservice op de webpagina Automatiseren op het tabblad Instellingen onder Verificatieservices. Alle gebruikers die zijn gedefinieerd in de meegeleverde LDAP domainDN kunnen inloggen op Automate. Het toegangsniveau van elke gebruiker wordt bepaald door het beveiligingsbeleid dat is gedefinieerd op de webpagina Automatiseren op het tabblad Instellingen.

3.2.3. Intern

Als u de interne authenticatiemethode gebruikt, stelt u de internalCredentials-configuratie in het YAML-bestand in zoals aangegeven in Service Settings.

3.3. Toegang tot beveiligingsbeleid

Toegang tot Automate-bronnen wordt gedefinieerd op de Instellingen pagina, op het tabblad Beveiligingsbeleid. Met het standaardbeleid kan elke geverifieerde gebruiker alle bronnen bekijken en wijzigen, en taken met instellingen indienen.

3.4. Geheugen

3.4.1. Nuix-werknemers

Het geheugen van Nuix Workers kan worden gespecificeerd in de workflow Configuratie-bewerking of expliciet als een opdrachtregelparameter in de uitvoeringsprofielen, bijvoorbeeld:

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

3.4.2. Nuix Engine

Het geheugen van de Nuix Engine, equivalent aan het geheugen van het Nuix-werkstation als een opdrachtregelparameter in de uitvoeringsprofielen, bijvoorbeeld:

-Xmx2g
Elke Nuix Engine draait onder een aparte JVM en deelt geen geheugen met de andere Nuix Engines of de Automate-services.

3.5. Gedeelde gegevensbronnen

Automatiseer workflows worden uitgevoerd op de servers waarop het Automate Engine Server-component draait. Om ervoor te zorgen dat workflows toegang hebben tot cases en brongegevens vanaf een gedeelde locatie, moet u een UNC-pad of een toegewezen stationsletterpad opgeven dat toegankelijk is vanaf alle servers waarop het Automate Engine Server-component draait.

Standaard wordt de Automate Engine Server-service uitgevoerd onder het account Lokaal systeem en worden engines gestart onder hetzelfde gebruikersaccount.

Indien nodig kan een ander gebruikersaccount worden opgegeven in Uitvoeringsprofielen.

4. Probleemoplossen

4.1. Blader naar Automate Scheduler

Standaard luistert Automate Scheduler op 127.0.0.1 op poort 80 en alle IP-adressen op poort 443. Om toegang te krijgen tot de standaardinstallatie, bladert u naar het adres: http://localhost

4.2. Automatiseer service start niet

Automate Scheduler en Engine Server worden uitgevoerd als Windows-services. Als de services zijn gestart, controleer dan de logbestanden op C:\Temp\Log\automate-scheduler.log en C:\Temp\Log\automate-engine-server.log.

4.3. Login fout

Als de fout Fout bij het communiceren met de verificatieserver wordt weergegeven wanneer u probeert in te loggen, inspecteert u de logboeken om het probleem te bepalen dat Automate tegenkomt bij het communiceren met de authenticatieserver.

4.4. Het toevoegen van Automate Engine Server genereert de fout javax.net.ssl.SSLHandshakeException

Zorg ervoor dat de Java Runtime Environment van de nieuwste versie van Nuix Workstation die op elke Automate Scheduler-server is geïmplementeerd, het TLS-certificaat van de Automate Engine Server vertrouwt. Zie sectie Managing Certificates voor meer details.

5. Certificaten beheren

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

6. Gebruik en rapportage

De gebruiks- en rapportagegegevens worden geleverd als een OData V4-feed, als deze functie is ingeschakeld in de Automate-licentie.

De OData-feed ondersteunt alleen het opvragen van de metagegevens en het ophalen van alle gegevens uit de weergaven. OData-filters worden niet ondersteund.

De OData-feed is toegankelijk onder het volgende eindpunt, met behulp van basis- of Microsoft OAuth-verificatie:

  • /api/v2/reporting/odata

7. REST API-documentatie

Automate Scheduler is direct toegankelijk voor een browser of via de REST API. De documentatie van de API is beschikbaar in OpenAPI v3-formaat, onder /openapi.

Om bijvoorbeeld toegang te krijgen tot de API-documentatie in een standaardinstallatie van Automate Scheduler, bladert u naar http://localhost/openapi

8. Gecentraliseerde logboekregistratie

Gecentraliseerde logboekregistratie consolideert alle logboeken van Scheduler-, Engine Server-, Engine- en Worker-logboeken in de logboekdatabase die wordt beheerd door Scheduler.

Gecentraliseerde logboekregistratie is standaard ingeschakeld, wat betekent dat zowel het logbestand als het databaselogboek zullen bestaan. Om gecentraliseerde logboekregistratie uit te schakelen, zet u de enableCentralizedLogging-toets op false in het configuratiebestand YAML zoals aangegeven in het Service Settings-bestand.

Als gecentraliseerde logboekregistratie is uitgeschakeld, worden de functies voor het downloaden van taaklogboeken en het downloaden van systeemlogboeken uitgeschakeld.

Gecentraliseerde logboekregistratie verwijdert automatisch logboeken die ouder zijn dan de bewaarperiode. De standaardbewaarperiode is 30 dagen. Bewerk de centralizedLoggingRetention-toets in het YAML-bestand om de bewaartermijn te wijzigen.

Wanneer de grootte van de databaselogboeken de maximale databasegrootte overschrijdt, worden oudere logboeken verwijderd. Standaard is de maximale databasegrootte 1000000000 bytes (1 GB). Bewerk de centralizedLoggingMaxSize -toets in het YAML-bestand om de standaard max. Databasegrootte te wijzigen.

De werkelijke grootte van de gecentraliseerde database voor logboekregistratie kan de opgegeven maximale grootte overschrijden vanwege de overhead van de database en vertragingen bij het verwijderen van oude logboekregels.

9. Filepaths Inventory

9.1. Standaard bestandspaden

9.1.1. Planner

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

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

  • %programdata%\Nuix\Automate\Scheduler\stores: Persistentie en archivering van taakdetails, gebruik, audit, rapportage en gebruik

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

  • C:\Temp\logs\automate-scheduler.%d.log.zip: Vorige applicatielogbestanden

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

  • C:\Temp\logs\automate-scheduler-access.%d.log.zip: Vorige hoofdlogbestanden

  • C:\Temp\logs\Automate Scheduler.wrapper.log: Logboeken van servicewrapper

  • C:\Temp\logs\Automate Scheduler.err.log: Servicestandaard foutenlogboek

  • C:\Temp\logs\Automate Scheduler.out.log: Servicestandaard uitvoerlogboek

9.1.2. Engine Server

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

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

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

  • C:\Temp\logs\automate-engine-server.%d.log.zip: Vorige applicatielogbestanden

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

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

  • C:\Temp\logs\Automate Engine Server.wrapper.log: Logboeken van servicewrapper

  • C:\Temp\logs\Automate Engine Server.err.log: Servicestandaard foutenlogboek

  • C:\Temp\logs\Automate Engine Server.out.log: Servicestandaard uitvoerlogboek

9.1.3. Motor

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

  • C:\Temp\logs\automate-engine.aaaaaaaa-init.yml: Initiële configuratie

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

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

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

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

9.2. Logboeklocaties wijzigen

De standaard bestandspaden kunnen op de volgende locaties worden gewijzigd:

  • Hoofdlogboek van planner: werk de sectie logging bij vanaf C:\ProgramData\Nuix\Automate\Scheduler\config\config.yml

  • Planner-servicegerelateerde logboeken: werk de tags <workingdirectory> en <logpath> bij vanaf C:\Program Files\Nuix\Automate\Scheduler\Automate Scheduler.xml

  • Engine Log hoofdlogboek: Werk de sectie logging van C:\ProgramData\Nuix\Automate\EngineServer\config\config.yml bij

  • Engine Server-servicegerelateerde logboeken: werk de tags <workingdirectory> en <logpath> bij vanaf C:\Program Files\Nuix\Automate\EngineServer\Automate Engine Server.xml

  • Engine init log, configuratie en service gerelateerde logs: Update de sectie engineInitLogFolder vanaf C:\ProgramData\Nuix\Automate\EngineServer\config\config.yml

  • Taaklogboek en configuratie: werk het veld Log Folder bij en stel de opdrachtregelparameter -Dnuix.logdir=c:\Temp\Logs in het uitvoeringsprofiel in