Ansvarsfraskrivelse

Materialet i dette dokument er kun til informationsformål. De produkter, den beskriver, kan ændres uden forudgående varsel på grund af producentens løbende udviklingsprogram. Nuix giver ingen erklæringer eller garantier med hensyn til dette dokument eller med hensyn til produkterne beskrevet heri. Nuix er ikke ansvarlig for nogen skader, tab, omkostninger eller udgifter, direkte, indirekte eller tilfældige, følgevirkninger eller specielle, der opstår som følge af eller relateret til brugen af ​​dette materiale eller de heri beskrevne produkter.

© Nuix Canada Inc. 2024 Alle rettigheder forbeholdes

Introduktion

Denne vejledning beskriver installationen af Automatisere. Dette dokument fungerer som en reference - brug indholdsfortegnelsen til at se efter det emne, du finder ud af.

Automate-softwaren og denne dokumentation kan indeholde fejl, fejl eller andre begrænsninger. Hvis du støder på problemer med Automate-softwaren eller med denne dokumentation, bedes du kontakte nuix support.

Selvom vi accepterer feedback på alle versioner af produktet, er support begrænset til den seneste større og den seneste mindre version fra de kvartalsvise og årlige udgivelseskanaler. Automate anbefaler, at du abonnerer på meddelelser om produktopdateringer og gennemgår og anvender opdateringerne inden for kort tid efter, at de bliver tilgængelige.

Softwaren kræver en gyldig Automate-licens. Licensen er typisk tidsbegrænset, og visse funktioner i softwaren kræver en specifik licensudgave. Hvis du støder på problemer med Automate-licensen, eller hvis du har specifikke spørgsmål om en produktfunktion, bedes du kontakte nuix support.

Styles brugt i denne vejledning

Bemærk: Dette ikon angiver, at der gives yderligere afklaringer, for eksempel hvad de gyldige indstillinger er.
Tip: Dette ikon lader dig vide, at der leveres noget særlig nyttigt lethed, måske en måde, hvorpå du kan bruge applikationen til at opnå en bestemt opførsel.
Advarsel: Dette ikon fremhæver oplysninger, der kan hjælpe dig med at undgå en uønsket opførsel.

  • Understregede: Denne stil angiver navnet på en menu, mulighed eller link.

  • code: Denne stil angiver kode, der skal bruges ordret, og kan henvise til filstier, parameternavne eller Nuix-søgeforespørgsler.

1. Arkitektur

1.1. komponenter

Adskillige komponenter er en del af en automatiseret implementering:

  • Automatiser skemalægger: Modtager anmodninger fra analytikerne eller fra virksomhedstjenester om job i kø og sender jobs til Automate Engine-serverne.

  • Automatiser Engine Server: Modtager jobs fra Automate Scheduler, starter Engines og kører jobs.

  • Nuix-motor: Nuix-motoren opretter / åbner Nuix-sager og udfører det krævede arbejde i sagerne

  • Nuix-licenskilde: En eller flere Nuix-licenskilder kan bruges af følgende typer:

    • Nuix NMS

    • Nuix License Dongle

    • Nuix Cloud License

  • Godkendelseskilde: Tjenesten, der vil blive brugt til at autentificere brugere og bestemme gruppemedlemskab. Dette kan være en kombination af følgende:

    • Nuix UMS: Nuix-brugeradministrationsserveren

    • LDAP: Lokalt Active Directory

    • Azure AD: Microsoft Azure Active Directory

    • OIDC: En Open ID Connect-kompatibel godkendelsestjeneste

    • Internt: Internt definerede brugernavne og adgangskoder, til indledende konfiguration.

Derudover er følgende komponenter valgfri:

  • Automatiser OData Server: Returnerer brugsdata ved hjælp af OData-protokollen.

  • Automatiser proxy: Aflæser dataupload og hashing fra den primære Automate Scheduler.

  • Business Intelligence-software: Et softwareværktøj, der forespørger i Automate-miljøet for målinger, analyserer dataene og leverer interaktive dashboards, såsom Microsoft Power BI eller Tableau.

  • Microsoft SQL: Kan bruges til at erstatte den indbyggede Scheduler-database til lagring af jobinformation, konfiguration og revisionslogfiler.

1.2. Deployment

Med undtagelse af Automate Engine Server, som skal installeres på hver Nuix-server, der vil være en del af Automate-implementeringen, kan alle resterende komponenter installeres enten på den samme server eller på dedikerede servere.

Når du implementerer den valgfri Automate OData Server på en anden server end serveren, der hoster Automate Scheduler, skal brugsdataene omdirigeres fra den indlejrede database til en Microsoft SQL-database.

1.2.1. Eksempel distribueret arkitektur

Denne eksempelarkitektur består af en dedikeret server, som er vært for Automate Scheduler, adskillige servere, som er vært for Automate Engine Servers og Nuix Engines, dedikerede servere til Nuix NMS og Nuix UMS og tilslutning til Azure AD.

Eksempel distribueret arkitektur

1.2.2. Eksempel på standalone-arkitektur

Denne eksempelarkitektur består af en enkelt server, som er vært for Automate Scheduler og Automate Engine Server, flere Nuix Engines samt Nuix NMS og Nuix UMS.

Eksempel på enkeltstående arkitektur

1.3. Netværkstrafikstrøm

Komponenter i en automatiseret implementering kommunikerer via HTTP. Se afsnit Configuration for at konfigurere TCP-porte og TLS-certifikater.

Trafikstrøm
Kilde Destination Protokol (Port)

Analytikerwebbrowser

Automatisk planlægning

HTTPS (TCP/443)

Analyst webbrowser

Azure AD

HTTPS (TCP/443)

Automatiser planlægger

Automater motorserver

HTTPS (TCP/443)

Automater motor

Automater planlægger

HTTPS (TCP/443)

Automatisk planlægning

Nuix UMS

HTTPS (TCP/443)

Automatiseringsplanlægning

Azure AD

HTTPS (TCP/443)

Nuix Engine

Nuix NMS

HTTPS (TCP/27443)

2. Forudsætninger

Se 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. Serviceindstillinger

Konfigurationsfilerne findes på følgende steder:

  • Automatiser skemalægger C:\ProgramData\Nuix\Automate\Scheduler\config\config.yml

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

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

Derudover kan visse Scheduler Service-konfigurationsindstillinger indstilles ved hjælp af miljøvariabler (se afsnit Scheduler Service Environmental Variables for flere detaljer).

3.1.1. Indstillinger for planlægningsservice

Disse filer følger YAML Syntax og indeholder følgende parametre:

  • role: SCHEDULER, hvilket indikerer, at Automate Scheduler-komponenten vil køre;

  • apiSecret: Nøgle bruges til godkendelse mellem Automate-komponenter. Indstil den samme tilfældige værdi på alle Automate Scheduler, Proxy og Server-forekomster.

  • internalCredentials: Angiver, at legitimationsoplysninger, der er defineret i konfigurationsfilen, bruges til godkendelse. Konfigurationen findes i følgende undernøgler:

    • displayName: (Valgfrit) Navnet, der skal vises på login-siden til denne godkendelsesmetode.

    • restrictToLocalhost: (Valgfrit) Begræns tilgængeligheden af den interne godkendelse til browsere fra localhost. Hvis denne egenskab ikke er angivet, er den som standard false.

    • usersEligibleLegalHoldAdministrator: (Valgfrit) Gør interne brugere kvalificerede til juridisk hold-administration. Hvis denne egenskab ikke er angivet, er den som standard false.

    • usersEligibleLegalHoldCustodian: (Valgfrit) Gør interne brugere kvalificerede til juridiske hold-depoter. Hvis denne egenskab ikke er angivet, er den som standard false.

    • credentials: listen over legitimationsoplysninger.

Legitimationsoplysningerne kan leveres i enten PBKDF2-format ved hjælp af:

  • username

  • email

  • salt, en base64-kodet streng

  • iterations, antallet af hash-iterationer

  • hash, beregnet ved hjælp af PBKDF2WithHmacSHA512-algoritmen med en nøglelængde på 512 bit.

eller i klartekst ved hjælp af:

  • username

  • email

  • password

Eksempel på intern godkendelseskonfiguration med 2 brugere:

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@
Den interne godkendelsesmetode kræver lagring af brugernavne og adgangskoder eller hashes i konfigurationsfilen. Det anbefales at begrænse denne metode til localhost.
Indstil egenskaben restrictToLocalhost til true for kun at tillade login med interne legitimationsoplysninger, når du får adgang til Automate som lokal vært.

  • userSessionTimeout: Varigheden i sekunder af inaktivitet, hvorefter en brugersession udløber.

  • nuixEnginePath: Placeringen af installationen af Nuix Engine. Denne mappe skal indeholde bin, lib og user-data undermapper direkte.

  • log4jConfigurationFile: Log4j-konfigurationsfilen.

  • enableCentralizedLogging: true eller false angiver, om den centraliserede logfunktion er aktiveret.

Som standard er denne funktion aktiveret, hvis du vil deaktivere denne funktion, skal du indstille værdien til false

  • centralizedLoggingRetention: Varigheden i dage, hvor logfilerne opbevares.

  • centralizedLoggingMaxSize: Den maksimale databasestørrelse i byte før en rollover.

  • centralizedLoggingSizeCheckInterval: Varigheden i sekunder, hvorefter databasen udfører en størrelseskontrol.

  • enableRollingLoggingDatabases: Når logning databasen er konfigureret til SQLite vil databaser blive rullet, for eksempel når log databasen når den maksimale størrelse defineret i centralizedLoggingMaxSize divideret med antallet af rullende databaser defineret i maxRollingLoggingDatabases indstillingen. Databasen vil blive omdøbt, og en ny database vil blive oprettet. Som standard er denne funktion deaktiveret. For eksempel, hvis brugeren havde en maksimal størrelse på 1 GB og 5 rullende databaser, så er den maksimale størrelse for alle de rullende databaser 200 MB.

Når databasen ruller logfiler, vil de downloadede logfiler være en strippet version, der indeholder alt undtagen de faktiske logfiler fra databasen, og centraliseret logning vil blive deaktiveret midlertidigt. Hvis databaserotationen finder sted, mens brugeren downloader logfiler, afsluttes downloadtråden og giver brugeren de logfiler, som den var i stand til at indsamle, og logger en advarsel for at informere brugeren om, at overførslen er afsluttet på grund af rotationen.

  • maxRollingLoggingDatabases: Det maksimale antal rullende databaser. Når det maksimale antal databaser er nået, slettes databasen med de ældste logfiler.

  • enableCentralizedLoggingDownloadTimeout: true eller false angiver, om den centraliserede logning download timeout funktion er aktiveret.

Denne funktion vil lukke streamen for download af logfiler efter et indstillet interval defineret i centralizedLoggingDownloadTimeout` indstillingen. Denne funktion anbefales kun til fejlfindingsformål og er deaktiveret som standard.

  • centralizedLoggingDownloadTimeout: Mængden af ​​tid i millisekunder til at downloade logfiler før du afslutter, som standard er denne værdi sat til 180000 (3 minutter).

  • engineInitLogFolder: Den logmappe, der skal bruges under motorinitialiseringen, før du kører job.

  • archiveJobsPastDuration: Varigheden i sekunder, hvorefter de færdige job automatisk arkiveres.

  • archiveJobsPastCount: Det maksimale antal færdige job, hvorefter det ældste job automatisk arkiveres.

  • server: Angiver IP / porte, der skal lytte til, og TLS-certifikatet for HTTPS-forbindelser.

Som standard lytter tjenesten på HTTP på port 80 på localhost, og på HTTPS på port 443 alle IP-adresser. For at begrænse serveren til at lytte på en bestemt IP-adresse skal du ændre 0.0.0.0 til den påkrævede IP-adresse i config.yml-filen.
Hvis du opgraderer Scheduler fra en version før 6.0, accepterer serveren kun HTTP/1.1-forbindelser som standard. For at aktivere HTTP/2-forbindelser skal du ændre type: https til type: h2 i config.yml-filen.

  • webConfiguration: Angiver, hvilke webindstillinger der skal anvendes på den webserver, der bruges til REST API, inklusive HSTS, XSS-beskyttelse, CORS og CSP.

  • cors: CORS-konfigurationen.

Automate REST API er designet til at blive tilgået både af den webside, der er hostet på Scheduler-serveren, såvel som fra tredjepartstjenester og -websider. Af denne grund tillader standard CORS-konfigurationen alle oprindelser. Denne konfiguration er sikker, da hver anmodning til REST API skal godkendes med et bærer-token. Hvis der er behov for yderligere at begrænse CORS tilladte oprindelser, kan en strengere politik indføres ved at redigere standard CORS-indstillingerne i config.yml-filen.

Eksempel på CORS-politik, der begrænser de tilladte oprindelser:

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

  • logging: Angiver parametrene for den logging, der udføres af tjenesten. Disse logfiler vil også indeholde de oplysninger, der typisk er logget af Nuix Workstation. Placeringen af arbejderlogfilerne er specificeret i nuixFlags-parameteren.

  • applicationStore: Angiver, at en brugerdefineret database bruges til at gemme revisionsinformationen.

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

    • user: Brugernavnet til databasen

    • password: Databaseadgangskoden

    • url: JDBC-forbindelsesstrengen, for eksempel jdbc:jtds:sqlserver://HOST:1433/DATABASE

    • properties: Forbindelsesegenskaber.

Eksempel på 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
Hvis et brugernavn og en adgangskode ikke er angivet i Microsoft SQL Store-konfigurationen, vil forbindelsen blive udført ved hjælp af integreret Windows-godkendelse. Når du opretter forbindelse til Microsoft SQL på denne måde, skal Automate Scheduler-tjenesten konfigureres til at køre under en konto, der har adgang til Microsoft SQL-databasen.

  • utilizationStore: Angiver, at en brugerdefineret database bruges til at gemme de operationelle udnyttelsesdata.

  • loggingStore: Angiver, at en brugerdefineret database bruges til lagring af logfiler.

loggingStore er en cirkulær buffer for alle platformslogfiler og forventes at generere en skrivegennemstrømning. Det anbefales ikke at omdirigere denne logføring til en SQL-database.

Eksempel på konfiguration, der flytter loggingStore til D:\Logs\Automate:

loggingStore:
  driverClass: org.sqlite.JDBC
  url: jdbc:sqlite:D:/Logs/Automate/logging.db
  properties:
    charSet: UTF-8
De forskellige butikker, der er anført ovenfor, kan alle omdirigeres til en enkelt Microsoft SQL-database eller til separate databaser efter behov.

  • defaultUserSettings: Overskriv brugerindstillingerne, der gælder, når der ikke blev indstillet nogen specifik konfiguration i en brugerprofil.

Eksempelindstillinger for at definere de tilladte parameterværdier, der som standard udfyldes, når du opretter en ny klient eller et nyt spørgsmål:

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 eller false angiver, om de tilladte parameterværdier defineret i brugergrænsefladen eller returneres af scripts skal sorteres, og om de skal opretholde den oprindelige rækkefølge.

  • jobMaximumExecutionParametersLength: Antallet af tegn, som udførelsesparametre kan have, før værdien bliver trimmet. Dette påvirker kun ydeevnen af planlæggerens frontend. Som standard er dette indstillet til 200 tegn.

  • archivedJobCleanupEnabled: true eller false angiver, om arkivjoboprydningen skal køre eller ej, hvilket sletter job, jobudførelseslogfiler og statistikker for jobh`falselingens mime-type, når et arkiveret job er ældre end et bestemt antal dage. Som stfalseard er værdien `false.

  • archivedJobCleanupInterval: Intervallet i timer for, hvor ofte jobrekrydningsopgaven skal køre. Som standard er dette indstillet til 24 timer.

  • archivedJobRetentionDays: Antal dage et job skal arkiveres, før det kan slettes. Som standard er dette indstillet til 584 dage (1½ år).

  • synchronizeJobsOnAllMatters: true eller false angiver, om kun et job har lov til at køre på et stof på et givet tidspunkt.

  • authTokenTtl: Varigheden i sekunder, hvorefter brugergodkendelsestokenet udløber. Browseren vil fremsætte en anmodning om at opdatere godkendelsestokenet ved halvdelen af tokenets levetid. Som standard er dette indstillet til 600 sekunder.

  • disableAuthTokenExpiration: true eller false angiver, at brugergodkendelsestokenet ikke udløber. Som st`falseard er dette indstillet til `false.

  • expiredAuthTokenTombstone: Varigheden i sekunder, for hvilken der skal holdes styr på udløbne godkendelsestokens. Når du forsøger at få adgang til Automatisere med et udløbet godkendelsestoken, returneres en venlig fejlmeddelelse, og den aktuelle live brugersession er ugyldig. Som standard er dette indstillet til 900.

  • downgradeWebWorkerToken: true eller false angiver, at browseren skal nedgradere Web Worker-tokenet for at gøre det tilgængeligt med scripts i browseren. Som st`falseard er dette indstillet til `false.

Med standardindstillingen downgradeWebWorkerToken: false vil brugeren blive logget ud, når browservinduet opdateres. Indstilling af denne indstilling til true vil opretholde brugersessionen, når browservinduet opdateres, men gør godkendelsestoken tilgængelig for scripts i browseren, hvilket er mindre sikkert.

  • enforceSingleUserSession: true eller false angiver, om en bruger kan have mere end én session ad gangen. Hvis denne indstilling er indstillet til sand, vil kun én session være tilladt.

Hvis en bruger allerede er logget ind, og en anden session startes for den samme bruger, logges den ældre session ud.

  • libraryFileMaxSize: Den maksimale størrelse i bytes af filer, der kan uploades til filbiblioteket, som standard 10000000.

Filbiblioteket er designet til at gemme konfigurationsfiler og profiler. Denne grænse gælder ikke for filer, der uploades til datalagre.

  • expireIdleUploadAfter: Varigheden i millisekunder, hvorefter inaktive uploads til Data Repositories udløber, som standard 3600000 svarende til 1 time.

  • uploadBufferMaxSize: Den maksimale bufferstørrelse i KiB, der skal tildeles under uploads til datalagre, som standard 8192. Bufferstørrelsen kan tildeles op til 3 gange for hver filupload og bruges kun under filuploadens varighed.

Når du skriver data til en fildeling, der er forbundet over et netværk med høj latens, kan en forøgelse af størrelsen af uploadBufferMaxSize øge den samlede overførselsydelse på bekostning af øget hukommelsesforbrug.

  • uploadHashAlgorithms: Algoritmen, der skal bruges til hashing på serversiden, når filer uploades til Data Repositories, som standard MD5. For at deaktivere hashing under upload skal du bruge værdien None.

Hashing af filer under upload kræver betydelige CPU-ressourcer på Scheduler-serveren. Brug Scheduler Proxy-rollen for at overføre denne beregning til en anden server.

  • enableUtilizationEndpoint: Aktiver OData-tjenesten på Scheduler som standard true. Brug værdien false for at deaktivere.

  • utilizationErrorsSoftFail: Maskere brugsdatadatabase skrivefejl til applikationen, som standard false.

  • azureLocations: (Valgfrit) Listen over steder at køre VM’er på. Eksempel på indstillinger for azureLocations:

azureLocations: westus,eastus

  • azureVmSizes: (Valgfrit) Listen over VM-størrelser. Eksempel på "azureVmSizes"-indstillinger:

azureVmSizes: Standard_M8ms,Standard_M16ms,Standard_M32ts

3.1.2. Scheduler Service Miljøvariabler

Følgende miljøvariabler kan konfigureres til at indstille eller overskrive indstillinger, der er konfigureret i Scheduler Service-konfigurationsfilen:

  • Database omdirigering. Brug følgende indstillinger til at omdirigere applikationen til en SQL-database:

    • AUTOMATE_STORE_APPLICATION_ENABLED: Indstil til true for at aktivere

    • AUTOMATE_STORE_APPLICATION_DRIVER_CLASS: Førerklassen, for eksempel org.postgresql.Driver

    • AUTOMATE_STORE_APPLICATION_URL: JDBC-forbindelsesstrengen, for eksempel jdbc:postgresql://postgres.example.internal:5432/automateScheduler

    • AUTOMATE_STORE_APPLICATION_USERNAME: Brugernavnet til databasen

    • AUTOMATE_STORE_APPLICATION_PASSWORD: Databaseadgangskoden

    • AUTOMATE_STORE_APPLICATION_CHARSET: Databasens tegnsæt, for eksempel UTF-8

    • AUTOMATE_STORE_LOGGING_REDIRECT_TO_APPLICATION: Indstil til true for at omdirigere den centraliserede logning til samme placering som applikationsbutikken

    • AUTOMATE_CENTRALIZED_LOGGING_ENABLED: Indstil til false for at deaktivere centraliseret logning

    • AUTOMATE_STORE_UTILIZATION_REDIRECT_TO_APPLICATION: Indstil til true for at omdirigere brugsdataene til samme placering som applikationslageret

    • AUTOMATE_STORE_APPLICATION_SCHEDULER_MIN_CONNECTIONS: Det mindste antal forbindelser, der skal holdes åbne

    • AUTOMATE_STORE_APPLICATION_SCHEDULER_MAX_CONNECTIONS: Det maksimale antal forbindelser, der skal holdes åbne

  • Godkendelse. Brug følgende indstillinger til at konfigurere adgangsoplysningerne til at logge på applikationen til den indledende konfiguration:

    • Intern brugernavn/adgangskodegodkendelse:

      • AUTOMATE_AUTH_INTERNAL_ENABLED: Indstil til true for at aktivere

      • AUTOMATE_AUTH_INTERNAL_USERNAME: Brugernavnet til at logge ind med

      • AUTOMATE_AUTH_INTERNAL_EMAIL: Brugerens e-mailadresse

      • AUTOMATE_AUTH_INTERNAL_PASSWORD: Adgangskoden til at logge ind med.

    • Intern PBKDF2-godkendelse:

      • AUTOMATE_AUTH_INTERNAL_ENABLED: Indstil til true for at aktivere

      • AUTOMATE_AUTH_INTERNAL_USERNAME: Brugernavnet til at logge ind med

      • AUTOMATE_AUTH_INTERNAL_EMAIL: Brugerens e-mailadresse

      • AUTOMATE_AUTH_INTERNAL_SALT: En base64-kodet streng

      • AUTOMATE_AUTH_INTERNAL_ITERATIONS: Antallet af hash-iterationer

      • AUTOMATE_AUTH_INTERNAL_HASH: Kodeords-hashen beregnet ved hjælp af PBKDF2WithHmacSHA512-algoritmen med en nøglelængde på 512 bits.

    • OIDC-godkendelse:

      • AUTOMATE_AUTH_OIDC_ENABLED: Indstil til true for at aktivere

      • AUTOMATE_AUTH_OIDC_NAME: Godkendelsesmekanismens navn

      • AUTOMATE_AUTH_OIDC_DESCRIPTION: Beskrivelse af godkendelsesmekanismen

      • AUTOMATE_AUTH_OIDC_WELL_KNOWN_CONFIG_URI: Den velkendte konfigurations-URI, for eksempel http://keycloak:8080/realms/default/.well-known/openid-configuration

      • AUTOMATE_AUTH_OIDC_SCOPE: Omfanget, for eksempel openid email profile

      • AUTOMATE_AUTH_OIDC_USERNAME_CLAIM: Påstanden om brugernavnet, for eksempel email

      • AUTOMATE_AUTH_OIDC_CLIENT_ID: Klient-ID

      • AUTOMATE_AUTH_OIDC_CLIENT_SECRET: Klienthemmeligheden

    • Derby kontrol service:

      • AUTOMATE_DERBY_CONTROL_SERVICE_ENABLED: Indstil til true for at aktivere

      • AUTOMATE_DERBY_CONTROL_SERVICE_NAME: Derby Control-tjenestens navn

      • AUTOMATE_DERBY_CONTROL_SERVICE_DESCRIPTION: Derby Control-tjenestebeskrivelsen

      • AUTOMATE_DERBY_CONTROL_SERVICE_URL: Derby Control-base-URL, for eksempel http://127.0.0.1:8999/DERBY-CONTROL

  • Multi-server API-hemmelighed. Brug følgende indstillinger til at konfigurere API-hemmeligheden, der bruges til at administrere forskellige motorservere:

    • AUTOMATE_API_SECRET: Nøgle bruges til godkendelse mellem Automate-komponenter. Indstil den samme tilfældige værdi på alle Automate Scheduler, Proxy og Server-forekomster.

  • Sikkerhedspolitik. Brug følgende indstillinger til at konfigurere en sikkerhedspolitik:

    • AUTOMATE_SECURITY_POLICY_ENABLED: Indstil til true for at aktivere

    • AUTOMATE_SECURITY_POLICY_NAME: Politikens navn

    • AUTOMATE_SECURITY_POLICY_DESCRIPTION: Politikbeskrivelsen

    • AUTOMATE_SECURITY_POLICY_PRINCIPALS: Listen over hovedstole, som politikken gælder for. Følgende indstilling passer til enhver godkendt bruger: [{"identifierType":"BUILTIN","identifierName":"AUTHENTICATED_USER"}]

    • AUTOMATE_SECURITY_POLICY_PERMISSIONS: Politikens tilladelser, for eksempel ["VIEW","VIEW_SENSITIVE","MODIFY","CREATE","SUBMIT_JOB","DOWNLOAD_LOGS"]

    • AUTOMATE_SECURITY_POLICY_SCOPE_BUILTIN: Politikens indbyggede omfang, f.eks. ["ALL_CLIENT_POOLS","ALL_CLIENTS","ALL_LIBRARIES","API_KEYS","COLLECTIONS","LEGAL_HOLDS","SCRIPTS","SCHEDULES","SECURITY","RESOURCES"]

    • AUTOMATE_SECURITY_POLICY_SCOPE: Definer eventuelt de fulde politikomfang, for eksempel [{"identifierType":"BUILTIN","identifierName":"RESOURCES"}]

  • Sikkerhedspolitik. Brug følgende indstillinger til at konfigurere en automatiseringslicens:

    • AUTOMATE_LICENSE_ENABLED: Indstil til true for at aktivere

    • AUTOMATE_LICENSE_ID: Licens-id’et

    • AUTOMATE_LICENSE_KEY: Licensnøglen

    • AUTOMATE_LICENSE_DIAGNOSTIC_LEVEL: Det diagnostiske niveau, for eksempel ENHANCED

  • Nuix CLS-licens. Brug følgende indstillinger til at konfigurere en Nuix CLS-licens:

    • AUTOMATE_NUIX_CLS_LICENSE_ENABLED: Indstil til true for at aktivere

    • AUTOMATE_NUIX_CLS_LICENSE_NAME: Licensnavnet

    • AUTOMATE_NUIX_CLS_LICENSE_DESCRIPTION: Licensbeskrivelsen

    • AUTOMATE_NUIX_CLS_LICENSE_FILTER: Licensarbejderfilteret, for eksempel workstation

    • AUTOMATE_NUIX_CLS_LICENSE_DESCRIPTION: Licensbeskrivelsen

    • AUTOMATE_NUIX_CLS_LICENSE_USERNAME: CLS-brugernavnet

    • AUTOMATE_NUIX_CLS_LICENSE_PASSWORD: CLS-adgangskoden

  • Ressourcepulje. Brug følgende indstillinger til at konfigurere en ressourcepulje:

    • AUTOMATE_RESOURCE_POOL_ENABLED: Indstil til true for at aktivere

    • AUTOMATE_RESOURCE_POOL_NAME: Ressourcepuljens navn

    • AUTOMATE_RESOURCE_POOL_DESCRIPTION: Ressourcepuljens beskrivelse

    • AUTOMATE_RESOURCE_POOL_AUTO_REGISTRATION_ENABLED: Indstil til true for at aktivere automatisk registrering.

    • AUTOMATE_RESOURCE_POOL_AUTO_REGISTRATION_ACCESS_KEY: Adgangsnøglen til automatisk registrering. Motorserverne skal bruge den samme nøgle.

    • AUTOMATE_RESOURCE_POOL_AUTO_REGISTRATION_STRICT_IP: Valgfrit, indstillet til true for at gennemtvinge registrering fra den samme IP-adresse som destinationsserveren som standard false.

    • AUTOMATE_RESOURCE_POOL_AUTO_REGISTRATION_MIN_WORKERS: Valgfrit, automatisk registrering min. arbejdere, som standard 1.

    • AUTOMATE_RESOURCE_POOL_AUTO_REGISTRATION_TARGET_WORKERS: Valgfrit, den automatiske registrering målretter som standard arbejdere 2.

    • AUTOMATE_RESOURCE_POOL_AUTO_REGISTRATION_EXECUTION_MODE: Valgfri, udførelsestilstand for automatisk registrering, som standard AUTOMATE_NUIX.

  • Udførelsesprofil. Brug følgende indstillinger til at konfigurere en eksekveringsprofil:

    • AUTOMATE_EXECUTION_PROFILE_ENABLED: Indstil til true for at aktivere

    • AUTOMATE_EXECUTION_PROFILE_NAME: Udførelsesprofilens navn

    • AUTOMATE_EXECUTION_PROFILE_DESCRIPTION: Beskrivelsen af ​​udførelsesprofilen

    • AUTOMATE_EXECUTION_PROFILE_ENGINE_COMMAND_LINE_PARAMS: Valgfrit, Engine-kommandolinjeparametrene, som standard -Xmx16g -Dnuix.logdir=/var/log/nuix/automate -Duser.language=en -Duser.country=US.

    • AUTOMATE_EXECUTION_PROFILE_NUIX_ENGINE_FOLDER: Valgfrit, Nuix-motorens binære mappe, som standard /opt/nuix/engine.

    • AUTOMATE_EXECUTION_PROFILE_ENGINE_LOG_FOLDER: Valgfrit, motorlogmappen, som standard /var/log/nuix/automate.

    • AUTOMATE_EXECUTION_PROFILE_JAVA_FOLDER: Valgfri, Java binære mapper, som standard tom.

    • AUTOMATE_EXECUTION_PROFILE_PARAMETERS: Valgfrit, et JSON-serialiseret kort<String,String> af parameter og værdier, som standard tomt.

    • AUTOMATE_EXECUTION_JOB_PROGRESS_MIN_PERCENTAGE: Valgfrit, minimum jobfremskridt før afbrydelse af jobbet, som standard 1.0.

    • AUTOMATE_EXECUTION_JOB_PROGRESS_TIMEOUT_HOURS: Valgfrit, den timeout, hvorefter jobbet skal afbrydes, hvis jobfremskridtet ikke blev opnået, som standard 48.0.

    • AUTOMATE_EXECUTION_OPERATION_PROGRESS_MIN_PERCENTAGE: Valgfrit, minimum operationsforløb før afbrydelse af jobbet, som standard 1.0.

    • AUTOMATE_EXECUTION_OPERATION_PROGRESS_TIMEOUT_HOURS: Valgfrit, den timeout, hvorefter jobbet skal afbrydes, hvis operationens fremskridt ikke blev opnået, som standard 24.0.

    • AUTOMATE_EXECUTION_SKIP_OPERATION_PROGRESS_MIN_PERCENTAGE: Valgfrit, minimumsoperationens fremskridt, før du forsøger at springe handlingen over, som standard 1.0.

    • AUTOMATE_EXECUTION_SKIP_OPERATION_PROGRESS_TIMEOUT_HOURS: Valgfrit, den timeout, hvorefter forsøget på at springe operationen over, blev ikke opnået, som standard 12.0.

  • Brugerdata Dir. Brug følgende indstillinger til at konfigurere User Data Dir-adfærden:

    • AUTOMATE_USER_DATA_DIR_SCAN_INTERVAL: Indstil til intervalvarigheden i sekunder, hvormed brugerdatadirigenten skal scannes, selvom operativsystemet ikke registrerer en ændring.

  • For at overskrive en vilkårlig indstilling skal du konvertere indstillingsnavnet til store bogstaver i slange, efterfulgt af Automate. Brug f.eks. miljøvariablen AUTOMATE_DOWNGRADE_WEB_WORKER_TOKEN til at konfigurere indstillingen downgradeWebWorkerToken.

3.1.3. Tidsindstillinger for planlægningsproxy

Denne fil følger YAML-syntaksen og indeholder følgende parametre:

  • role: PROXY, hvilket indikerer, at Automate Scheduler Proxy-komponenten vil køre;

  • apiSecret: Nøgle bruges til godkendelse mellem Automate-komponenter. Indstil den samme tilfældige værdi på alle Automate Scheduler, Proxy og Server-forekomster.

  • proxy: Detaljerne i den vigtigste planlægningsinstans, som proxyen bruger. Konfigurationen findes i følgende undernøgler:

    • baseUrl: URL’en til planlæggerinstansen.

    • whitelistedCertFingerprints: Fingeraftryk fra planlægningscertifikat, der bruges til verifikation, når du åbner en sikker forbindelse.

  • allowedAuthenticationServices: Listen over godkendelsestjenestenavne, der kan bruges gennem denne proxy. Hvis denne indstilling ikke er defineret, vil alle godkendelsestjenester blive tilladt gennem proxyen.

Eksempel på proxy-konfiguration:

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

allowedAuthenticationServices:
  - Internal
  - Lab Azure AD

  • log4jConfigurationFile: Log4j-konfigurationsfilen.

  • server: Angiver indstillingerne for webadgangslogfiler, HTTP-protokollerne, der skal lyttes på, og det tilsvarende IP-, port- og TLS-certifikat for HTTPS-forbindelser.

  • webConfiguration: Angiver hvilke webindstillinger, der skal anvendes på den webserver, der bruges til REST API.

3.1.4. Engine Server Service Indstillinger

Denne fil følger YAML-syntaksen og indeholder følgende parametre:

  • role: ENGINE_SERVER, hvilket indikerer, at Automate Engine Server-komponenten vil køre;

  • apiSecret: Nøgle bruges til godkendelse mellem Automate-komponenter. Indstil den samme tilfældige værdi på alle Automate Scheduler, Proxy og Server-forekomster.

  • nuixEnginePath: Placeringen af installationen af Nuix Engine. Denne mappe skal indeholde bin, lib og user-data undermapper direkte.

  • log4jConfigurationFile: Log4j-konfigurationsfilen.

  • engineInitLogFolder: Den midlertidige placering, der bruges af motorer til lagring af konfigurationsfiler og logfiler under initialiseringsfasen. Når Job kører, gemmer motoren logfiler og konfigurationsfiler på det sted, der er angivet i udførelsesprofilen.

  • engineInitTimeout: Den timeout i sekunder, som motoren må initialisere som standard 120.

  • engineAbortTimeout: Timeoutet i millisekunder, som motoren venter med at afbryde et job, er standard 5000 (5 sekunder)

  • server: Angiver indstillingerne for webadgangslogfiler, HTTP-protokollerne, der skal lyttes på, og det tilsvarende IP-, port- og TLS-certifikat for HTTPS-forbindelser.

  • webConfiguration: Angiver hvilke webindstillinger, der skal anvendes på den webserver, der bruges til REST API.

  • jobRunningLogMaxSize: Angiver det maksimale antal logfiler, som det kørende job gemmer som standard 20.

  • logging: Angiver parametrene for den logging, der udføres af tjenesten. Disse logfiler vil også indeholde de oplysninger, der typisk er logget af Nuix Workstation. Placeringen af arbejderlogfilerne er specificeret i nuixFlags-parameteren.

  • workerBrokerIP: IP-adressen, der skal bruges til at være vært for Worker Brokers, når du kører Remote Workers.

  • workerBrokerStartPort: Portområdet starter for Worker Brokers.

  • workerBrokerEndPort: Portens ende for Worker Brokers.

Prøveindstillinger til konfiguration af en arbejdsmægler på IP 10.0.0.1:

workerBrokerIP: 10.0.0.1
workerBrokerStartPort: 50000
workerBrokerEndPort: 50100
Hvis indstillingen workerBrokerIP ikke er angivet, starter serveren en mægler på en st`workerBrokerIPardnetværksadapter. I et miljø, hvor servere har flere netværkskort, skal du konfigurere `workerBrokerIP på hver server med den IP-adresse, der skal bruges af `workerBrokerIP`re servere, der slutter sig til eksterne job for at kontakte denne server.

3.1.5. Engine Server Service Miljøvariabler

Følgende miljøvariabler kan konfigureres til at indstille eller overskrive indstillinger, der er konfigureret i Engine Server Service-konfigurationsfilen:

  • Database omdirigering. Brug følgende indstillinger til at omdirigere applikationen til en SQL-database:

    • AUTOMATE_STORE_APPLICATION_ENABLED: Indstil til true for at aktivere

    • AUTOMATE_STORE_APPLICATION_DRIVER_CLASS: Førerklassen, for eksempel org.postgresql.Driver

    • AUTOMATE_STORE_APPLICATION_URL: JDBC-forbindelsesstrengen, for eksempel jdbc:postgresql://postgres.example.internal:5432/automateEngineServer

    • AUTOMATE_STORE_APPLICATION_USERNAME: Brugernavnet til databasen

    • AUTOMATE_STORE_APPLICATION_PASSWORD: Databaseadgangskoden

    • AUTOMATE_STORE_APPLICATION_CHARSET: Databasens tegnsæt, for eksempel UTF-8

    • AUTOMATE_STORE_APPLICATION_SCHEDULER_MIN_CONNECTIONS: Det mindste antal forbindelser, der skal holdes åbne

    • AUTOMATE_STORE_APPLICATION_SCHEDULER_MAX_CONNECTIONS: Det maksimale antal forbindelser, der skal holdes åbne

  • Automatisk registrering. Brug følgende indstillinger til automatisk at registrere Engine Server til en Scheduler Resource Pool. Ressourcepuljen skal konfigureres med den automatiske registreringsfunktion aktiveret:

    • AUTOMATE_REGISTRATION_ENABLED: Indstil til true for at aktivere

    • AUTOMATE_REGISTRATION_SERVER_NAME: Navnet på Engine Server, for eksempel Server1

    • AUTOMATE_REGISTRATION_SERVER_URL: Den URL, som Scheduler kan få adgang til Engine Server som f.eks. http://Server1.internal.local

    • AUTOMATE_REGISTRATION_SCHEDULER_URL: Planlæggerens URL, for eksempel http://Scheduler.internal.local

    • AUTOMATE_REGISTRATION_RESOURCE_POOL_ID: Valgfrit, det ressourcepulje-id, der skal registreres med. Som standard er ID’et for ressourcepuljen konfigureret i Scheduler med ENV-variabler. Denne indstilling skal kun angives for at tilmelde dig en anden ressourcepulje.

    • AUTOMATE_REGISTRATION_ROLE_MAIN: Valgfrit, indstillet til true gør det muligt for motoren at fungere som en hovedmotor i ressourcepuljen.

    • AUTOMATE_REGISTRATION_ROLE_REMOTE: Valgfrit, indstillet til true gør det muligt for motoren at fungere som en fjernmotor i ressourcepuljen.

    • AUTOMATE_REGISTRATION_RESOURCE_POOL_ACCESS_KEY: Ressourcepuljen adgangsnøgle. Se den samme værdi, som blev konfigureret i ressourcepuljen med ENV-variablen.

  • Multi-server implementering. Brug følgende indstillinger til scenarier for implementering af flere servere:

    • AUTOMATISERE_API_SECRET: Nøgle bruges til godkendelse mellem Automate-komponenter. Indstil den samme tilfældige værdi på alle Automate Scheduler, Proxy og Server-forekomster.

    • AUTOMATISERE_SERVER_ID: Indstil et unikt tilfældigt ID for hver Engine Server.

  • Motorlogning layout

    • AUTOMATE_ENGINE_LOG_LAYOUT_JSON: Set to true for at konfigurere Engine-logfilerne til at være i JSON-format. Bemærk, dette gælder ikke for Scheduler- eller Engine Server-logformaterne, som er konfigureret direkte i deres respektive config.yml.

3.1.6. OData Server Service Indstillinger

Denne fil følger YAML-syntaksen og indeholder følgende parametre:

  • role: ODATA_SERVER, hvilket indikerer, at Automate OData Server-komponenten vil køre;

  • internalCredentials: Angiver, at legitimationsoplysninger, der er defineret i konfigurationsfilen, bruges til godkendelse. Konfigurationen findes i følgende undernøgler:

    • displayName: (Valgfrit) Navnet, der skal vises på login-siden til denne godkendelsesmetode.

    • restrictToLocalhost: (Valgfrit) Begræns tilgængeligheden af den interne godkendelse til browsere fra localhost. Hvis denne egenskab ikke er angivet, er den som standard false.

    • credentials: listen over legitimationsoplysninger.

Legitimationsoplysningerne kan leveres i enten PBKDF2-format ved hjælp af:

  • username

  • email

  • salt, en base64-kodet streng

  • iterations, antallet af hash-iterationer

  • hash, beregnet ved hjælp af PBKDF2WithHmacSHA512-algoritmen med en nøglelængde på 512 bit.

eller i klartekst ved hjælp af:

  • username

  • email

  • password

Eksempel på intern godkendelseskonfiguration med 2 brugere:

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@
Den interne godkendelsesmetode kræver lagring af brugernavne og adgangskoder eller hashes i konfigurationsfilen. Det anbefales at begrænse denne metode til localhost.
Indstil egenskaben restrictToLocalhost til true for kun at tillade login med interne legitimationsoplysninger, når du får adgang til Automate som lokal vært.

  • server: Angiver indstillingerne for webadgangslogfiler, HTTP-protokollerne, der skal lyttes på, og det tilsvarende IP-, port- og TLS-certifikat for HTTPS-forbindelser.

Som standard lytter tjenesten på HTTP på port 8081 på localhost, og på HTTPS på port 8443 alle IP-adresser. For at begrænse serveren til at lytte på en bestemt IP-adresse skal du ændre 0.0.0.0 til den påkrævede IP-adresse i config.yml-filen.

  • webConfiguration: Angiver hvilke webindstillinger, der skal anvendes på den webserver, der bruges til REST API.

  • utilizationStore: Angiver, at en brugerdefineret database bruges til at gemme revisionsinformationen.

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

    • user: Brugernavnet til databasen

    • password: Databaseadgangskoden

    • url: JDBC-forbindelsesstrengen, for eksempel jdbc:jtds:sqlserver://HOST:1433/DATABASE

    • properties: Forbindelsesegenskaber.

Eksempel på 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
Hvis et brugernavn og en adgangskode ikke er angivet i Microsoft SQL Store-konfigurationen, vil forbindelsen blive udført ved hjælp af integreret Windows-godkendelse. Når du opretter forbindelse til Microsoft SQL på denne måde, skal Automate Scheduler-tjenesten konfigureres til at køre under en konto, der har adgang til Microsoft SQL-databasen.

3.2. Godkendelse

3.2.1. Nuix UMS

Hvis du bruger Nuix UMS -godkendelsesmetoden, skal du konfigurere UMS -godkendelsestjenesten på websiden Automatiser under fanen Indstillinger under Autentificeringstjenester. Alle brugere, der er defineret i Nuix UMS, kan logge på Automatisering. Adgangsniveauet for hver bruger bestemmes af de sikkerhedspolitikker, der er defineret på siden Automatiser på fanen Indstillinger.

3.2.2. LDAP

Hvis du bruger LDAP -godkendelsesmetoden, skal du konfigurere LDAP -godkendelsestjenesten på webstedet Automatiser under fanen Indstillinger under Autentificeringstjenester. Alle brugere, der er defineret i den leverede LDAP domainDN, kan logge på Automatisering. Adgangsniveauet for hver bruger bestemmes af de sikkerhedspolitikker, der er defineret på siden Automatiser på fanen Indstillinger.

3.2.3. Indre

Hvis du bruger den interne godkendelsesmetode, skal du indstille internalCredentials-konfigurationen i YAML-filen som angivet i Service Settings.

3.3. Adgang til sikkerhedspolitikker

Adgang til automatiske ressourcer er defineret på Indstillinger-siden i fanen Sikkerhedspolitikker. Standardpolitikken giver enhver godkendt bruger mulighed for at se og ændre alle ressourcer samt indsende job med eventuelle indstillinger.

3.4. Hukommelse

3.4.1. Nuix-arbejdere

Nuix Workers hukommelse kan specificeres enten i arbejdsgangen Konfiguration-operationen eller eksplicit som en kommandolinjeparameter i eksekveringsprofiler, for eksempel:

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

3.4.2. Nuix-motor

Hukommelsen af Nuix Engine svarer til hukommelsen i Nuix Workstation som en kommandolinjeparameter i eksekveringsprofiler, for eksempel:

-Xmx2g
Hver Nuix Engine vil køre under en separat JVM og vil ikke dele hukommelse med de andre Nuix Engines eller Automate-tjenesterne.

3.5. Delte datakilder

Automatisere arbejdsgange udføres på de servere, der kører Automate Engine Server-komponenten. For at sikre, at arbejdsgange kan få adgang til sager og kildedata fra en delt placering, skal du angive en UNC-sti eller en kortlagt drevbogstavsti, som er tilgængelig fra alle servere, der kører Automate Engine Server-komponenten.

Som standard kører Automate Engine Server-tjenesten under den lokale systemkonto og starter Engines under den samme brugerkonto.

En anden brugerkonto kan specificeres i eksekveringsprofiler efter behov.

4. Fejlfinding

4.1. Gå til Automate Scheduler

Som standard lytter Automate Scheduler på 127.0.0.1 på port 80 og alle IP-adresser på port 443. For at få adgang til standardinstallationen skal du gå til adressen: http://localhost

4.2. Automatisk service starter ikke

Automatiser Scheduler og Engine Server kører som Windows-tjenester. Hvis tjenesterne er startet, skal du kontrollere logfilerne ved C:\Temp\Log\automate-scheduler.log og C:\Temp\Log\automate-engine-server.log.

4.3. Login fejl

Hvis fejlen Fejl ved kommunikation med godkendelsesserveren vises, når du forsøger at logge ind, skal du inspicere logfilerne for at finde ud af, hvilket problem Automate støder på, når du kommunikerer med godkendelsesserveren.

4.4. Tilføjelse af Automate Engine Server giver javax.net.ssl.SSLHandshakeException fejl

Sørg for, at Java Runtime Environment fra den seneste version af Nuix Workstation installeret på hver Automate Scheduler-server har tillid til TLS-certifikatet fra Automate Engine Server. Se afsnit Managing Certificates for flere detaljer.

5. Håndtering af certifikater

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

6. Brug og rapportering

Udnyttelses- og rapporteringsdataene leveres som et OData V4-feed, hvis denne funktion er aktiveret i Automate-licensen.

OData-feedet understøtter kun forespørgsel om metadataene og hentning af alle data fra visningerne. OData-filtre understøttes ikke.

OData-feedet kan tilgås under følgende slutpunkt ved hjælp af Basic- eller Microsoft OAuth-godkendelse:

  • /api/v2/reporting/odata

7. REST API-dokumentation

Automate Scheduler kan tilgås enten direkte for en browser eller ved hjælp af REST API. Dokumentationen for API’et er leveret i OpenAPI v3-format, under /openapi.

For at få adgang til API-dokumentationen i en standardinstallation af Automate Scheduler skal du for eksempel gå til http://localhost/openapi

8. Centraliseret logning

Centraliseret logføring samler alle logfiler fra Planlægger, Motorserver, Motor og Arbejdslogfiler i loggningsdatabasen, der administreres af Planlægger.

Centraliseret logning er som st`YAMLard aktiveret, hvilket betyder, at både logfilen såvel som databaseloggen vil eksistere. For at deaktivere centraliseret logning skal du indstille `enableCentralizedLogging-tasten til false i konfigurationsfilen som angivet i Service Settings-filen.

Hvis centraliseret logning er deaktiveret, deaktiveres funktionerne til download joblog og download system logs.

Centraliseret logning sletter automatisk logfiler, der er ældre end opbevaringsperioden. Standardopbevaringsperioden er 30 dage. For at ændre opbevaringsperioden skal du redigere centralizedLoggingRetention-tasten i YAML-filen.

Når databaselogstørrelsen overstiger den maksimale databasestørrelse, slettes ældre logfiler. Som standard er den maksimale databasestørrelse 1000000000 bytes (1 GB). For at ændre standard maks. Databasestørrelse skal du redigere centralizedLoggingMaxSize-tasten i YAML-filen.

Den faktiske centraliserede logbogsdatabasestørrelse kan overstige den specificerede maksimale størrelse på grund af databaseoverhead og forsinkelser i sletning af gamle loglinjer.

9. Filepaths Inventory

9.1. Standard filepaths

9.1.1. Scheduler

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

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

  • %programdata%\Nuix\Automate\Scheduler\stores: Persistens og arkivering af jobdetaljer, udnyttelse, revision, rapportering og udnyttelse

  • C:\Temp\logs\automate-scheduler.log: Ansøgningslog

  • C:\Temp\logs\automate-scheduler.%d.log.zip: Tidligere applikationslogfiler

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

  • C:\Temp\logs\automate-scheduler-access.%d.log.zip: Tidligere hovedlogfiler

  • C:\Temp\logs\Automate Scheduler.wrapper.log: Serviceindpakningslogfiler

  • C:\Temp\logs\Automate Scheduler.err.log: Servicestandard fejllogg

  • C:\Temp\logs\Automate Scheduler.out.log: Service-standardoutputlog

9.1.2. Motorserver

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

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

  • C:\Temp\logs\automate-engine-server.log: Ansøgningslog

  • C:\Temp\logs\automate-engine-server.%d.log.zip: Tidligere applikationslogfiler

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

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

  • C:\Temp\logs\Automate Engine Server.wrapper.log: Serviceindpakningslogfiler

  • C:\Temp\logs\Automate Engine Server.err.log: Servicestandard fejllogg

  • C:\Temp\logs\Automate Engine Server.out.log: Service-standardoutputlog

9.1.3. motor

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

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

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

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

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

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

9.2. Ændring af logplaceringer

Standard filepaths kan ændres fra følgende placeringer:

  • Planlægningens hovedlog: Opdater sektionen logging fra C:\ProgramData\Nuix\Automate\Scheduler\config\config.yml

  • Tidsrelaterede logfiler til scheduler: Opdater tags <workingdirectory> og <logpath> fra C:\Program Files\Nuix\Automate\Scheduler\Automate Scheduler.xml

  • Motorserver hovedlog: Opdater afsnittet logging fra C:\ProgramData\Nuix\Automate\EngineServer\config\config.yml

  • Logservices relaterede logs til Motorserver: Opdater tags <workingdirectory> og <logpath> fra C:\Program Files\Nuix\Automate\EngineServer\Automate Engine Server.xml

  • Motorinit-log, konfiguration og service-relaterede logfiler: Opdater afsnittet engineInitLogFolder fra C:\ProgramData\Nuix\Automate\EngineServer\config\config.yml

  • Joblog og konfiguration: Opdater feltet Log Folder og indstil kommandolinjeparameteren -Dnuix.logdir=c:\Temp\Logs i udførelsesprofilen