Déni de responsabilité

Les informations contenues dans ce document sont fournies à titre informatif uniquement. Les produits décrits sont susceptibles d’être modifiés sans préavis, en raison du programme de développement continu du fabricant. Nuix ne fait aucune déclaration ni ne donne aucune garantie concernant ce document ou concernant les produits qui y sont décrits. Nuix ne sera pas responsable des dommages, pertes, coûts ou dépenses, directs, indirects ou accessoires, consécutifs ou spéciaux, découlant de ou liés à l’utilisation de ce document ou des produits décrits dans ce document.

© Nuix Canada Inc. 2024 Tous droits réservés

Introduction

Ce guide décrit l’installation de Automatiser. Ce document fonctionne comme une référence - utilisez la table des matières pour rechercher le sujet que vous découvrez.

Le logiciel Automate et cette documentation peuvent contenir des bogues, des erreurs ou d’autres limitations. Si vous rencontrez des problèmes avec le logiciel Automate ou avec cette documentation, veuillez contacter le support nuix.

Bien que nous acceptions les commentaires sur toutes les versions du produit, l’assistance est limitée à la dernière version majeure et à la dernière version mineure des canaux de publication trimestriels et annuels. Automate recommande de s’abonner aux notifications de mise à jour du produit et de consulter et d’appliquer les mises à jour dans un court laps de temps après leur mise à disposition.

Le logiciel nécessite une licence Automate valide. La licence est généralement limitée dans le temps et certaines fonctionnalités du logiciel nécessitent une édition de licence spécifique. Si vous rencontrez des problèmes avec la licence Automate ou si vous avez des questions spécifiques sur une fonctionnalité du produit, veuillez contacter le support nuix.

Styles utilisés dans ce guide

Remarque: Cette icône indique que des clarifications supplémentaires sont fournies, par exemple quelles sont les options valides.
Pointe: Cette icône vous permet de savoir que des informations particulièrement utiles sont fournies, peut-être un moyen d’utiliser l’application pour obtenir un certain comportement.
Avertissement: Cette icône met en évidence des informations qui peuvent vous aider à éviter un comportement indésirable.

  • Souligné: Ce style indique le nom d’un menu, d’une option ou d’un lien.

  • code: ce style indique le code qui doit être utilisé textuellement et peut faire référence à des chemins de fichiers, des noms de paramètres ou des requêtes de recherche Nuix.

1. Architecture

1.1. Composants

Plusieurs composants font partie d’un déploiement Automate :

  • Automatiser le planificateur : Reçoit les demandes des analystes ou des services d’entreprise pour la mise en file d’attente des tâches et distribue les tâches aux serveurs Automate Engine.

  • Automatiser le serveur de moteur : Reçoit les tâches d’Automate Scheduler, démarre les moteurs et exécute les tâches.

  • Moteur Nuix: Le moteur Nuix crée / ouvre des cas Nuix et effectue le travail requis dans les cas.

  • Source de licence Nuix: Une ou plusieurs sources de licences Nuix peuvent être utilisées, des types suivants:

    • Nuix NMS

    • Clé de licence Nuix

    • Licence Nuix Cloud

  • Source d’authentification: Le service qui sera utilisé pour authentifier les utilisateurs et déterminer l’appartenance au groupe. Cela peut être une combinaison des éléments suivants:

    • Nuix UMS: le serveur Nuix User Management

    • LDAP: Active Directory sur site

    • Azure AD: Microsoft Azure Active Directory

    • OIDC : un service d’authentification conforme à Open ID Connect

    • Interne : noms d’utilisateur et mots de passe définis en interne, pour la configuration initiale.

En outre, les composants suivants sont facultatifs:

  • Automatiser le serveur OData : renvoie les données d’utilisation à l’aide du protocole OData.

  • Automatiser le proxy : Décharge le téléchargement et le hachage des données du planificateur automatique principal.

  • Logiciel de Business Intelligence : Un outil logiciel qui interroge l’environnement Automate pour obtenir des métriques, analyse les données et fournit des tableaux de bord interactifs, tels que Microsoft Power BI ou Tableau.

  • Microsoft SQL: peut être utilisé pour remplacer la base de données Scheduler intégrée pour stocker les informations sur les travaux, la configuration et les journaux d’audit.

1.2. Déploiement

À l’exception d’Automate Engine Server qui doit être installé sur chaque serveur Nuix qui fera partie du déploiement Automate, tous les composants restants peuvent être déployés soit sur le même serveur, soit sur des serveurs dédiés.

Lors du déploiement du serveur OData Automate facultatif sur un serveur différent du serveur hébergeant Automate Scheduler, les données d’utilisation doivent être redirigées de la base de données intégrée vers une base de données Microsoft SQL.

1.2.1. Exemple d’architecture distribuée

Cet exemple d’architecture se compose d’un serveur dédié qui héberge Automate Scheduler, de plusieurs serveurs qui hébergent les serveurs Automate Engine et Nuix Engine, de serveurs dédiés pour Nuix NMS et Nuix UMS, et d’une connectivité avec Azure AD.

Exemple d’architecture distribuée

1.2.2. Exemple d’architecture autonome

Cet exemple d’architecture se compose d’un serveur unique qui héberge l’Automate Scheduler et l’Automate Engine Server, plusieurs moteurs Nuix, ainsi que Nuix NMS et Nuix UMS.

Exemple d’architecture autonome

1.3. Flux de trafic réseau

Les composants d’un déploiement Automate communiquent via HTTP. Pour configurer les ports TCP et les certificats TLS, veuillez consulter la section Configuration.

Flux de trafic
Source Destination Protocole (Port)

Navigateur Web d’Analyst

Automate Scheduler

HTTPS (TCP/443)

Navigateur Web d’Analyst

Azure AD

HTTPS (TCP/443)

Automate Scheduler

Automate Engine Server

HTTPS (TCP/443)

Automate Engine

Automate Scheduler

HTTPS (TCP/443)

Automate Scheduler

Nuix UMS

HTTPS (TCP/443)

Automate Scheduler

Azure AD

HTTPS (TCP/443)

Nuix Engine

Nuix NMS

HTTPS (TCP/27443)

2. Conditions préalables

Voir https://nuix.service-now.com/support?id=kb_article_view&sys_ko_id=7ef9b32b47cc96102d9c89cbd36d4368[https://nuix.service-now.com/support?id=kb_article_view&sys_ko_id=7ef9b32b47cc96102d9c89cbd36d4368 ]

3. Configuration

3.1. Paramètres de service

Les fichiers de configuration se trouvent aux emplacements suivants:

  • Automatiser le planificateur C:\ProgramData\Nuix\Automate\Scheduler\config\config.yml

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

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

De plus, certaines options de configuration du service de planificateur peuvent être définies à l’aide de variables d’environnement (voir la section Scheduler Service Environmental Variables pour plus de détails.)

3.1.1. Paramètres du service du planificateur

Ces fichiers suivent la syntaxe YAML et contiennent les paramètres suivants:

  • role: SCHEDULER, indiquant que le composant Automate Scheduler va s’exécuter ;

  • apiSecret : Clé utilisée pour l’authentification entre les composants Automate. Définissez la même valeur aléatoire sur toutes les instances Automate Scheduler, Proxy et Server.

  • internalCredentials: indique que les informations d’identification définies dans le fichier de configuration seront utilisées pour l’authentification. La configuration est fournie dans les sous-clés suivantes:

    • displayName: (Facultatif) Le nom à afficher dans la page de connexion pour cette méthode d’authentification.

    • restrictToLocalhost : (Facultatif) Limitez la disponibilité de l’authentification interne aux navigateurs de localhost. Si cette propriété n’est pas spécifiée, sa valeur par défaut est false.

    • usersEligibleLegalHoldAdministrator : (Facultatif) Rendez les utilisateurs internes éligibles pour les administrations de suspension légale. Si cette propriété n’est pas spécifiée, sa valeur par défaut est false.

    • usersEligibleLegalHoldCustodian : (Facultatif) Rendez les utilisateurs internes éligibles pour les dépositaires légaux. Si cette propriété n’est pas spécifiée, sa valeur par défaut est false.

    • credentials: la liste des informations d’identification.

Les informations d’identification peuvent être fournies au format PBKDF2, en utilisant :

  • username

  • email

  • salt, une chaîne encodée en base64

  • iterations, le nombre d’itérations de hachage

  • hash, calculé à l’aide de l’algorithme PBKDF2WithHmacSHA512 avec une longueur de clé de 512 bits.

ou en clair, en utilisant :

  • username

  • email

  • password

Exemple de configuration d’authentification interne avec 2 utilisateurs:

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@
La méthode d’authentification interne nécessite de stocker les noms d’utilisateur et les mots de passe ou les hachages dans le fichier de configuration. Il est recommandé de limiter cette méthode à localhost.
Définissez la propriété restrictToLocalhost sur true pour autoriser uniquement la connexion avec des informations d’identification internes lors de l’accès à Automate en tant qu’hôte local.

  • userSessionTimeout: durée en secondes d’inactivité après laquelle une session utilisateur expire.

  • nuixEnginePath: l’emplacement du déploiement de Nuix Engine. Ce dossier doit contenir directement les sous-dossiers bin, lib et user-data.

  • log4jConfigurationFile: Le fichier de configuration log4j.

  • enableCentralizedLogging: true ou false indiquant si la fonction de journalisation centralisée est activée.

Par défaut, cette fonctionnalité est activée, pour désactiver cette fonctionnalité, définissez la valeur sur false

  • centralizedLoggingRetention: La durée en jours pendant laquelle les journaux seront conservés.

  • centralizedLoggingMaxSize: La taille maximale de la base de données en octets avant un survol.

  • centralizedLoggingSizeCheckInterval : la durée en secondes après laquelle la base de données effectue une vérification de la taille.

  • enableRollingLoggingDatabases : Lorsque la base de données de journalisation est configurée pour les bases de données SQLite, elle sera roulée, par exemple lorsque les bases de données de journalisation atteindront la taille maximale définie dans le centralizedLoggingMaxSize divisée par le nombre de bases de données glissantes défini dans le paramètre maxRollingLoggingDatabases. La base de données sera renommée et une nouvelle base de données sera créée. Par défaut, cette fonctionnalité est désactivée. Par exemple, si l’utilisateur a une taille maximale de 1 Go et 5 bases de données dynamiques, la taille maximale de toutes les bases de données dynamiques sera de 200 Mo.

Lorsque la base de données diffuse les journaux, les journaux téléchargés seront une version allégée contenant tout sauf les journaux réels de la base de données et la journalisation centralisée sera temporairement désactivée. Si la rotation de la base de données se produit pendant que l’utilisateur télécharge des journaux, le fil de téléchargement se fermera et donnera à l’utilisateur les journaux qu’il a pu recueillir et enregistrera un avertissement pour informer l’utilisateur que le le téléchargement s’est terminé en raison de la rotation.

  • maxRollingLoggingDatabases : Le nombre maximal de bases de données glissantes. Lorsque le nombre maximal de bases de données est atteint, la base de données contenant les journaux les plus anciens sera supprimée.

  • enableCentralizedLoggingDownloadTimeout : true ou false indiquant si la fonction de délai d’expiration du téléchargement de journalisation centralisée est activée.

Cette fonctionnalité fermera le flux de téléchargement des journaux après un intervalle défini dans le paramètre centralizedLoggingDownloadTimeout`. Cette fonctionnalité est uniquement recommandée à des fins de dépannage et est désactivée par défaut.

  • centralizedLoggingDownloadTimeout : la durée en millisecondes nécessaire au téléchargement des journaux avant de quitter.

  • engineInitLogFolder: dossier de journal à utiliser lors de l’initialisation du moteur, avant d’exécuter le travail.

  • archiveJobsPastDuration: durée en secondes après laquelle les travaux terminés sont automatiquement archivés.

  • archiveJobsPastCount: nombre maximal de travaux terminés après lequel le travail le plus ancien est automatiquement archivé.

  • server: indique l’IP / les ports à écouter et le certificat TLS pour les connexions HTTPS.

Par défaut, le service écoute sur HTTP sur le port 80 sur localhost, et sur HTTPS sur le port 443 toutes les adresses IP. Pour restreindre l’écoute du serveur sur une adresse IP spécifique, remplacez 0.0.0.0 par l’adresse IP requise dans le fichier config.yml.
Si vous mettez à niveau Scheduler à partir d’une version antérieure à 6.0, le serveur n’acceptera que les connexions HTTP/1.1 par défaut. Pour activer les connexions HTTP/2, remplacez type: https par type: h2 dans le fichier config.yml.

  • webConfiguration : Indique les paramètres Web à appliquer au serveur Web utilisé pour l’API REST, y compris les protections HSTS, XSS, CORS et CSP.

  • cors : La configuration CORS.

L’API REST Automate est conçue pour être accessible à la fois par la page Web hébergée sur le serveur Scheduler, ainsi que par des services et des pages Web tiers. Pour cette raison, la configuration CORS par défaut autorise toutes les origines. Cette configuration est sécurisée, car chaque requête adressée à l’API REST doit être authentifiée avec un jeton Bearer. S’il est nécessaire de restreindre davantage les origines CORS autorisées, une politique plus stricte peut être mise en place en modifiant les paramètres CORS par défaut dans le fichier config.yml.

Exemple de stratégie CORS limitant les origines autorisées :

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

  • logging: indique les paramètres de la journalisation effectuée par le service. Ces journaux contiendront également les informations généralement enregistrées par Nuix Workstation. L’emplacement des journaux de travail est spécifié dans le paramètre nuixFlags.

  • applicationStore: indique qu’une base de données personnalisée est utilisée pour stocker les informations d’audit.

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

    • user: Le nom d’utilisateur de la base de données

    • password: Le mot de passe de la base de données

    • url: la chaîne de connexion JDBC, par exemple jdbc:jtds:sqlserver://HOST:1433/DATABASE

    • properties: Les propriétés de connexion.

Exemple de configuration Microsoft SQL:

applicationStore:
  driverClass: net.sourceforge.jtds.jdbc.Driver
  user: automate-service
  password: SecretGoesHere
  url: jdbc:jtds:sqlserver://localhost:1433/automate
  properties:
    charSet: UTF-8
Si aucun nom d’utilisateur et mot de passe ne sont fournis dans la configuration de la base de données Microsoft SQL, la connexion sera effectuée à l’aide de l’authentification Windows intégrée. Lors de la connexion à Microsoft SQL de cette manière, le service Automate Scheduler doit être configuré pour s’exécuter sous un compte ayant accès à la base de données Microsoft SQL.

  • utilizationStore: indique qu’une base de données personnalisée est utilisée pour stocker les données d’utilisation opérationnelle.

  • loggingStore: indique qu’une base de données personnalisée est utilisée pour stocker les journaux.

Le loggingStore est un tampon circulaire de tous les journaux de plate-forme et devrait générer un débit d’écriture. Il n’est pas recommandé de rediriger ce magasin de journalisation vers une base de données SQL.

Exemple de configuration déplaçant le loggingStore vers D:\Logs\Automate :

loggingStore:
  driverClass: org.sqlite.JDBC
  url: jdbc:sqlite:D:/Logs/Automate/logging.db
  properties:
    charSet: UTF-8
Les différents magasins répertoriés ci-dessus peuvent tous être redirigés vers une seule base de données Microsoft SQL ou vers des bases de données distinctes selon les besoins.

  • defaultUserSettings: Remplacez les paramètres utilisateur qui s’appliquent lorsqu’aucune configuration spécifique n’a été définie sur un profil utilisateur.

Exemples de paramètres pour définir les valeurs de paramètres autorisées qui sont renseignées par défaut lors de la création d’un nouveau client ou d’un nouveau sujet:

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 ou false indiquant si les valeurs du paramètre autorisé définies dans l’interface utilisateur ou renvoyées par les scripts doivent être triées et / ou si elles doivent conserver l’ordre d’origine.

  • jobMaximumExecutionParametersLength : Le nombre de caractères que les paramètres d’exécution peuvent avoir avant que la valeur ne soit coupée. Cela n’affecte que les performances du frontal du planificateur. Par défaut, ceci est défini sur 200 caractères.

  • archivedJobCleanupEnabled : true ou false indique si le nettoyeur d’archives doit être exécuté ou non. Ce nettoyeur supprime les tâches, les journaux d’exécution et les statistiques de type MIME des opérations une fois qu’une tâche archivée a dépassé un certain nombre de jours. Par défaut, la valeur est false.

  • archivedJobCleanupInterval : intervalle en heures pour l’exécution de la tâche de nettoyage. Par défaut, ce paramètre est réglé à 24 heures.

  • archivedJobRetentionDays : Nombre de jours pendant lesquels une tâche doit être archivée avant d’être supprimée. Par défaut, ce délai est de 584 jours (1 an et demi).

  • synchronizeJobsOnAllMatters: true ou false indiquant si un seul Job est autorisé à s’exécuter sur un sujet à un moment donné.

  • authTokenTtl : La durée en secondes après laquelle le jeton d’authentification de l’utilisateur expire. Le navigateur fera une demande pour actualiser le jeton d’authentification à la moitié de la durée de vie du jeton. Par défaut, ceci est défini sur 600 secondes.

  • disableAuthTokenExpiration : true ou false indiquant que le jeton d’authentification de l’utilisateur n’expire pas. Par défaut, il est défini sur false.

  • expiredAuthTokenTombstone : La durée en secondes pendant laquelle garder une trace des jetons d’authentification expirés. Lorsque vous tentez d’accéder à Automatiser avec un jeton d’authentification expiré, un message d’erreur convivial est renvoyé et la session utilisateur en direct actuelle est invalidée. Par défaut, ceci est défini sur 900.

  • downgradeWebWorkerToken : true ou false indiquant que le navigateur doit rétrograder le jeton Web Worker pour le rendre accessible par des scripts dans le navigateur. Par défaut, il est défini sur false.

Avec le paramètre par défaut de downgradeWebWorkerToken: false, lors de l’actualisation de la fenêtre du navigateur, l’utilisateur sera déconnecté. La définition de cette option sur true maintiendra la session utilisateur lorsque la fenêtre du navigateur est actualisée, mais rendra le jeton d’authentification accessible par des scripts dans le navigateur, qui est moins sécurisé.

  • enforceSingleUserSession : true ou false indiquant si un utilisateur peut avoir plusieurs sessions à la fois, si cette option est définie sur vrai, une seule session sera autorisée.

Si un utilisateur est déjà connecté et qu’une autre session est démarrée pour le même utilisateur, l’ancienne session sera déconnectée.

  • libraryFileMaxSize : La taille maximale en octets des fichiers pouvant être téléchargés dans la bibliothèque de fichiers, par défaut 10000000.

La bibliothèque de fichiers est conçue pour stocker les fichiers de configuration et les profils. Cette limite ne s’applique pas aux fichiers téléchargés vers les référentiels de données.

  • expireIdleUploadAfter : La durée en millisecondes après laquelle les téléchargements inactifs vers les référentiels de données expirent, par défaut 3600000 correspondant à 1 heure.

  • uploadBufferMaxSize : La taille maximale du tampon en KiB à allouer lors des téléchargements vers les Data Repositories, par défaut 8192. La taille de la mémoire tampon peut être allouée jusqu’à 3 fois pour chaque téléchargement de fichier et n’est utilisée que pendant la durée du téléchargement du fichier.

Lors de l’écriture de données sur un partage de fichiers connecté sur un réseau à latence élevée, l’augmentation de la taille du uploadBufferMaxSize peut augmenter les performances de transfert globales au prix d’une utilisation accrue de la mémoire.

  • uploadHashAlgorithms : L’algorithme à utiliser pour le hachage côté serveur lors du téléchargement de fichiers vers les référentiels de données, par défaut MD5. Pour désactiver le hachage pendant le téléchargement, utilisez la valeur None.

Le hachage des fichiers pendant le téléchargement nécessite des ressources CPU importantes sur le serveur Scheduler. Pour décharger ce calcul sur un autre serveur, utilisez le rôle Proxy du planificateur.

  • enableUtilizationEndpoint : Activez le service OData sur Scheduler, par défaut true. Pour désactiver, utilisez la valeur false.

  • utilizationErrorsSoftFail : Masque les erreurs d’écriture de la base de données d’utilisation dans l’application, par défaut false.

  • azureLocations : (Facultatif) La liste des emplacements dans lesquels exécuter les machines virtuelles. Exemples de paramètres "azureLocations" :

azureLocations: westus,eastus

  • azureVmSizes : (Facultatif) La liste des tailles de VM. Exemples de paramètres azureVmSizes :

azureVmSizes: Standard_M8ms,Standard_M16ms,Standard_M32ts

3.1.2. Variables d’environnement du service de planification

Les variables d’environnement suivantes peuvent être configurées pour définir ou écraser les paramètres configurés dans le fichier de configuration du service du planificateur :

  • Redirection de base de données. Utilisez les paramètres suivants pour rediriger l’application vers une base de données SQL :

    • AUTOMATE_STORE_APPLICATION_ENABLED : Réglez sur true pour activer

    • AUTOMATE_STORE_APPLICATION_DRIVER_CLASS : La classe de pilote, par exemple org.postgresql.Driver

    • AUTOMATE_STORE_APPLICATION_URL: la chaîne de connexion JDBC, par exemple jdbc:postgresql://postgres.example.internal:5432/automateScheduler

    • AUTOMATE_STORE_APPLICATION_USERNAME: Le nom d’utilisateur de la base de données

    • AUTOMATE_STORE_APPLICATION_PASSWORD: Le mot de passe de la base de données

    • AUTOMATE_STORE_APPLICATION_CHARSET : Le jeu de caractères de la base de données, par exemple UTF-8

    • AUTOMATE_STORE_LOGGING_REDIRECT_TO_APPLICATION : définissez sur true pour rediriger la journalisation centralisée vers le même emplacement que le magasin d’applications

    • AUTOMATE_CENTRALIZED_LOGGING_ENABLED : définir sur false pour désactiver la journalisation centralisée

    • AUTOMATE_STORE_UTILIZATION_REDIRECT_TO_APPLICATION : définissez sur true pour rediriger les données d’utilisation vers le même emplacement que le magasin d’applications

    • AUTOMATE_STORE_APPLICATION_SCHEDULER_MIN_CONNECTIONS : Le nombre minimum de connexions à garder ouvertes

    • AUTOMATE_STORE_APPLICATION_SCHEDULER_MAX_CONNECTIONS : Le nombre maximum de connexions à garder ouvertes

  • Authentification. Utilisez les paramètres suivants pour configurer les informations d’identification d’accès pour vous connecter à l’application pour la configuration initiale :

    • Authentification interne par nom d’utilisateur/mot de passe :

      • AUTOMATE_AUTH_INTERNAL_ENABLED : Réglez sur true pour activer

      • AUTOMATE_AUTH_INTERNAL_USERNAME : Le nom d’utilisateur avec lequel se connecter

      • AUTOMATE_AUTH_INTERNAL_EMAIL : L’adresse email de l’utilisateur

      • AUTOMATE_AUTH_INTERNAL_PASSWORD : Le mot de passe avec lequel vous connecter.

    • Authentification PBKDF2 interne :

      • AUTOMATE_AUTH_INTERNAL_ENABLED : Réglez sur true pour activer

      • AUTOMATE_AUTH_INTERNAL_USERNAME : Le nom d’utilisateur avec lequel se connecter

      • AUTOMATE_AUTH_INTERNAL_EMAIL : L’adresse email de l’utilisateur

      • AUTOMATE_AUTH_INTERNAL_SALT : Une chaîne codée en base64

      • AUTOMATE_AUTH_INTERNAL_ITERATIONS : le nombre d’itérations de hachage

      • AUTOMATE_AUTH_INTERNAL_HASH : Le hachage du mot de passe calculé à l’aide de l’algorithme PBKDF2WithHmacSHA512 avec une longueur de clé de 512 bits.

    • Authentification OIDC :

      • AUTOMATE_AUTH_OIDC_ENABLED : Réglez sur true pour activer

      • AUTOMATE_AUTH_OIDC_NAME : Le nom du mécanisme d’authentification

      • AUTOMATE_AUTH_OIDC_DESCRIPTION : La description du mécanisme d’authentification

      • AUTOMATE_AUTH_OIDC_WELL_KNOWN_CONFIG_URI : L’URI de configuration bien connu, par exemple http://keycloak:8080/realms/default/.well-known/openid-configuration

      • AUTOMATE_AUTH_OIDC_SCOPE : La portée, par exemple openid email profile

      • AUTOMATE_AUTH_OIDC_USERNAME_CLAIM : La revendication du nom d’utilisateur, par exemple email

      • AUTOMATE_AUTH_OIDC_CLIENT_ID: L’ID client

      • AUTOMATE_AUTH_OIDC_CLIENT_SECRET : Le secret du client

    • Service de contrôle Derby :

      • AUTOMATE_DERBY_CONTROL_SERVICE_ENABLED : Réglez sur true pour activer

      • AUTOMATE_DERBY_CONTROL_SERVICE_NAME : Le nom du service Derby Control

      • AUTOMATE_DERBY_CONTROL_SERVICE_DESCRIPTION : La description du service Derby Control

      • AUTOMATE_DERBY_CONTROL_SERVICE_URL : L’URL de base de Derby Control, par exemple http://127.0.0.1:8999/DERBY-CONTROL

  • Secret d’API multi-serveur. Utilisez les paramètres suivants pour configurer le secret d’API utilisé pour gérer différents serveurs de moteur :

    • AUTOMATE_API_SECRET : Clé utilisée pour l’authentification entre les composants Automate. Définissez la même valeur aléatoire sur toutes les instances Automate Scheduler, Proxy et Server.

  • Politique de sécurité. Utilisez les paramètres suivants pour configurer une politique de sécurité :

    • AUTOMATE_SECURITY_POLICY_ENABLED : Réglez sur true pour activer

    • AUTOMATE_SECURITY_POLICY_NAME : le nom de la stratégie

    • AUTOMATE_SECURITY_POLICY_DESCRIPTION : La description de la politique

    • AUTOMATE_SECURITY_POLICY_PRINCIPALS : la liste des directeurs auxquels la politique s’applique. Le paramètre suivant correspondra à n’importe quel utilisateur authentifié : [{"identifierType":"BUILTIN","identifierName":"AUTHENTICATED_USER"}]

    • AUTOMATE_SECURITY_POLICY_PERMISSIONS : Les autorisations de la politique, par exemple ["VIEW","VIEW_SENSITIVE","MODIFY","CREATE","SUBMIT_JOB","DOWNLOAD_LOGS"]

    • AUTOMATE_SECURITY_POLICY_SCOPE_BUILTIN : les étendues intégrées à la stratégie, par exemple ["ALL_CLIENT_POOLS","ALL_CLIENTS","ALL_LIBRARIES","API_KEYS","COLLECTIONS","LEGAL_HOLDS","SCRIPTS","SCHEDULES","SECURITY","RESOURCES"]

    • AUTOMATE_SECURITY_POLICY_SCOPE : Vous pouvez éventuellement définir le champ d’application complet de la stratégie, par exemple [{"identifierType":"BUILTIN","identifierName":"RESOURCES"}]

  • Politique de sécurité. Utilisez les paramètres suivants pour configurer une licence automatique :

    • AUTOMATE_LICENSE_ENABLED : Réglez sur true pour activer

    • AUTOMATE_LICENSE_ID : L’identifiant de la licence

    • AUTOMATE_LICENSE_KEY : La clé de licence

    • AUTOMATE_LICENSE_DIAGNOSTIC_LEVEL : Le niveau diagnostic, par exemple ENHANCED

  • Licence Nuix CLS. Utilisez les paramètres suivants pour configurer une licence Nuix CLS :

    • AUTOMATE_NUIX_CLS_LICENSE_ENABLED : Réglez sur true pour activer

    • AUTOMATE_NUIX_CLS_LICENSE_NAME : Le nom de la licence

    • AUTOMATE_NUIX_CLS_LICENSE_DESCRIPTION : La description de la licence

    • AUTOMATE_NUIX_CLS_LICENSE_FILTER : Le filtre des travailleurs de licence, par exemple workstation

    • AUTOMATE_NUIX_CLS_LICENSE_DESCRIPTION : La description de la licence

    • AUTOMATE_NUIX_CLS_LICENSE_USERNAME : Le nom d’utilisateur CLS

    • AUTOMATE_NUIX_CLS_LICENSE_PASSWORD : Le mot de passe CLS

  • Pool de ressources. Utilisez les paramètres suivants pour configurer un pool de ressources :

    • AUTOMATE_RESOURCE_POOL_ENABLED : Réglez sur true pour activer

    • AUTOMATE_RESOURCE_POOL_NAME : le nom du pool de ressources

    • AUTOMATE_RESOURCE_POOL_DESCRIPTION : La description du pool de ressources

    • AUTOMATE_RESOURCE_POOL_AUTO_REGISTRATION_ENABLED : Réglez sur true pour activer l’enregistrement automatique.

    • AUTOMATE_RESOURCE_POOL_AUTO_REGISTRATION_ACCESS_KEY : La clé d’accès à l’enregistrement automatique. Les serveurs moteurs doivent utiliser la même clé.

    • AUTOMATE_RESOURCE_POOL_AUTO_REGISTRATION_STRICT_IP : Facultatif, défini sur true pour appliquer l’enregistrement à partir de la même adresse IP que le serveur de destination, par défaut false.

    • AUTOMATE_RESOURCE_POOL_AUTO_REGISTRATION_MIN_WORKERS : Facultatif, les travailleurs minimum d’enregistrement automatique, par défaut 1.

    • AUTOMATE_RESOURCE_POOL_AUTO_REGISTRATION_TARGET_WORKERS : Facultatif, l’enregistrement automatique cible les travailleurs, par défaut 2.

    • AUTOMATE_RESOURCE_POOL_AUTO_REGISTRATION_EXECUTION_MODE : En option, le mode d’exécution de l’auto-enregistrement, par défaut AUTOMATE_NUIX.

  • Profil d’exécution. Utilisez les paramètres suivants pour configurer un profil d’exécution :

    • AUTOMATE_EXECUTION_PROFILE_ENABLED : Réglez sur true pour activer

    • AUTOMATE_EXECUTION_PROFILE_NAME : Le nom du profil d’exécution

    • AUTOMATE_EXECUTION_PROFILE_DESCRIPTION : La description du profil d’exécution

    • AUTOMATE_EXECUTION_PROFILE_ENGINE_COMMAND_LINE_PARAMS : Facultatif, les paramètres de ligne de commande du moteur, par défaut -Xmx16g -Dnuix.logdir=/var/log/nuix/automate -Duser.language=en -Duser.country=US.

    • AUTOMATE_EXECUTION_PROFILE_NUIX_ENGINE_FOLDER : Facultatif, le dossier des binaires du moteur Nuix, par défaut /opt/nuix/engine.

    • AUTOMATE_EXECUTION_PROFILE_ENGINE_LOG_FOLDER : Facultatif, le dossier du journal du moteur, par défaut /var/log/nuix/automate.

    • AUTOMATE_EXECUTION_PROFILE_JAVA_FOLDER : Facultatif, le dossier des binaires Java, vide par défaut.

    • AUTOMATE_EXECUTION_PROFILE_PARAMETERS : Facultatif, un Map<String,String> sérialisé JSON de paramètres et de valeurs, vide par défaut.

    • AUTOMATE_EXECUTION_JOB_PROGRESS_MIN_PERCENTAGE : Facultatif, la progression minimale du travail avant d’abandonner le travail, par défaut 1.0.

    • AUTOMATE_EXECUTION_JOB_PROGRESS_TIMEOUT_HOURS : Facultatif, le délai d’attente après lequel abandonner la tâche si la progression de la tâche n’a pas été atteinte, par défaut 48.0.

    • AUTOMATE_EXECUTION_OPERATION_PROGRESS_MIN_PERCENTAGE : Facultatif, progression minimale de l’opération avant d’abandonner le travail, par défaut 1.0.

    • AUTOMATE_EXECUTION_OPERATION_PROGRESS_TIMEOUT_HOURS : Facultatif, le délai d’attente après lequel abandonner le travail si la progression de l’opération n’a pas été atteinte, par défaut 24.0.

    • AUTOMATE_EXECUTION_SKIP_OPERATION_PROGRESS_MIN_PERCENTAGE : Facultatif, la progression minimale de l’opération avant de tenter de sauter l’opération, par défaut 1.0.

    • AUTOMATE_EXECUTION_SKIP_OPERATION_PROGRESS_TIMEOUT_HOURS : Facultatif, le délai d’attente après lequel tenter d’ignorer l’opération de progression n’a pas été atteint, par défaut 12.0.

  • Répertoire des données utilisateur. Utilisez les paramètres suivants pour configurer le comportement du répertoire des données utilisateur :

    • AUTOMATE_USER_DATA_DIR_SCAN_INTERVAL : Définissez la durée de l’intervalle en secondes pendant lequel le répertoire de données utilisateur sera analysé même si le système d’exploitation ne détecte pas de changement.

  • Pour remplacer un paramètre arbitraire, convertissez le nom du paramètre en majuscules, précédé de la mention Automate. Par exemple, pour configurer le paramètre downgradeWebWorkerToken, utilisez la variable d’environnement AUTOMATE_DOWNGRADE_WEB_WORKER_TOKEN.

3.1.3. Paramètres du service proxy du planificateur

Ce fichier suit la syntaxe YAML et contient les paramètres suivants :

  • role: PROXY, indiquant que le composant Automate Scheduler Proxy s’exécutera ;

  • apiSecret : Clé utilisée pour l’authentification entre les composants Automate. Définissez la même valeur aléatoire sur toutes les instances Automate Scheduler, Proxy et Server.

  • proxy: les détails de l’instance principale du planificateur que le proxy utilise. La configuration est fournie dans les sous-clés suivantes:

    • baseUrl: l’URL de l’instance du planificateur.

    • whitelistedCertFingerprints: Empreintes digitales du certificat du planificateur utilisées pour la vérification lors de l’ouverture d’une connexion sécurisée.

  • allowedAuthenticationServices : La liste des noms de services d’authentification qui peuvent être utilisés via ce Proxy. Si ce paramètre n’est pas défini, tous les services d’authentification seront autorisés via le proxy.

Exemple de configuration de proxy:

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

allowedAuthenticationServices:
  - Internal
  - Lab Azure AD

  • log4jConfigurationFile: Le fichier de configuration log4j.

  • server : Indique les paramètres des journaux d’accès Web, les protocoles HTTP à écouter et l’IP, le port et le certificat TLS correspondants pour les connexions HTTPS.

  • webConfiguration: indique les paramètres Web à appliquer au serveur Web utilisé pour l’API REST.

3.1.4. Paramètres du service de serveur de moteur

Ce fichier suit la syntaxe YAML et contient les paramètres suivants :

  • role: ENGINE_SERVER, indiquant que le composant Automate Engine Server va s’exécuter ;

  • apiSecret : Clé utilisée pour l’authentification entre les composants Automate. Définissez la même valeur aléatoire sur toutes les instances Automate Scheduler, Proxy et Server.

  • nuixEnginePath: l’emplacement du déploiement de Nuix Engine. Ce dossier doit contenir directement les sous-dossiers bin, lib et user-data.

  • log4jConfigurationFile: Le fichier de configuration log4j.

  • engineInitLogFolder: L’emplacement temporaire utilisé par les moteurs pour stocker les fichiers de configuration et les journaux pendant la phase d’initialisation. Lors de l’exécution de travaux, le moteur stocke les journaux et les fichiers de configuration à l’emplacement spécifié dans le profil d’exécution.

  • : Le délai d’attente en secondes que le moteur est autorisé à initialiser, par défaut 120.

  • engineAbortTimeout : Le délai d’attente en millisecondes pendant lequel le moteur attendra pour abandonner une tâche, par défaut 5000 (5 secondes)

  • server : Indique les paramètres des journaux d’accès Web, les protocoles HTTP à écouter et l’IP, le port et le certificat TLS correspondants pour les connexions HTTPS.

  • webConfiguration: indique les paramètres Web à appliquer au serveur Web utilisé pour l’API REST.

  • jobRunningLogMaxSize : Indique le nombre maximum de journaux que le journal en cours d’exécution stocke, par défaut 20.

  • logging: indique les paramètres de la journalisation effectuée par le service. Ces journaux contiendront également les informations généralement enregistrées par Nuix Workstation. L’emplacement des journaux de travail est spécifié dans le paramètre nuixFlags.

  • workerBrokerIP: l’adresse IP à utiliser pour l’hébergement de Worker Brokers lors de l’exécution de Remote Workers.

  • workerBrokerStartPort: La plage de ports démarre pour Worker Brokers.

  • workerBrokerEndPort: La fin de la plage de ports pour Worker Brokers.

Exemples de paramètres pour configurer un Worker Broker sur IP 10.0.0.1:

workerBrokerIP: 10.0.0.1
workerBrokerStartPort: 50000
workerBrokerEndPort: 50100
Si le paramètre workerBrokerIP n’est pas fourni, le serveur démarrera un courtier sur une carte réseau par défaut. Dans un environnement où les serveurs ont plusieurs adaptateurs réseau, configurez le workerBrokerIP sur chaque serveur avec l’adresse IP qui doit être utilisée par les autres serveurs participant à des travaux distants pour contacter ce serveur.

3.1.5. Variables d’environnement du service de serveur de moteur

Les variables d’environnement suivantes peuvent être configurées pour définir ou écraser les paramètres configurés dans le fichier de configuration Engine Server Service :

  • Redirection de base de données. Utilisez les paramètres suivants pour rediriger l’application vers une base de données SQL :

    • AUTOMATE_STORE_APPLICATION_ENABLED : Réglez sur true pour activer

    • AUTOMATE_STORE_APPLICATION_DRIVER_CLASS : La classe de pilote, par exemple org.postgresql.Driver

    • AUTOMATE_STORE_APPLICATION_URL: la chaîne de connexion JDBC, par exemple jdbc:postgresql://postgres.example.internal:5432/automateEngineServer

    • AUTOMATE_STORE_APPLICATION_USERNAME: Le nom d’utilisateur de la base de données

    • AUTOMATE_STORE_APPLICATION_PASSWORD: Le mot de passe de la base de données

    • AUTOMATE_STORE_APPLICATION_CHARSET : Le jeu de caractères de la base de données, par exemple UTF-8

    • AUTOMATE_STORE_APPLICATION_SCHEDULER_MIN_CONNECTIONS : Le nombre minimum de connexions à garder ouvertes

    • AUTOMATE_STORE_APPLICATION_SCHEDULER_MAX_CONNECTIONS : Le nombre maximum de connexions à garder ouvertes

  • Enregistrement automatique. Utilisez les paramètres suivants pour enregistrer automatiquement le serveur moteur dans un pool de ressources du planificateur. Le pool de ressources doit être configuré avec la fonctionnalité d’enregistrement automatique activée :

    • AUTOMATE_REGISTRATION_ENABLED : Réglez sur true pour activer

    • AUTOMATE_REGISTRATION_SERVER_NAME : Le nom du serveur moteur, par exemple Server1

    • AUTOMATE_REGISTRATION_SERVER_URL : L’URL sous laquelle le planificateur peut accéder au serveur moteur, par exemple http://Server1.internal.local

    • AUTOMATE_REGISTRATION_SCHEDULER_URL : L’URL du planificateur, par exemple http://Scheduler.internal.local

    • AUTOMATE_REGISTRATION_RESOURCE_POOL_ID : Facultatif, l’ID du pool de ressources avec lequel s’inscrire. Par défaut, l’ID du pool de ressources configuré dans le planificateur avec les variables ENV. Ce paramètre ne doit être fourni que pour s’inscrire dans un autre pool de ressources.

    • AUTOMATE_REGISTRATION_ROLE_MAIN : Facultatif, défini sur true pour permettre au moteur d’agir comme moteur principal dans le pool de ressources.

    • AUTOMATE_REGISTRATION_ROLE_REMOTE : facultatif, défini sur true pour permettre au moteur d’agir en tant que moteur distant dans le pool de ressources.

    • AUTOMATE_REGISTRATION_RESOURCE_POOL_ACCESS_KEY : La clé d’accès au pool de ressources. Obtenez la même valeur que celle configurée sur le pool de ressources avec la variable ENV.

  • Déploiement multi-serveurs. Utilisez les paramètres suivants pour les scénarios de déploiement multiserveur :

    • AUTOMATISER_API_SECRET : Clé utilisée pour l’authentification entre les composants Automate. Définissez la même valeur aléatoire sur toutes les instances Automate Scheduler, Proxy et Server.

    • AUTOMATISER_SERVER_ID : Définissez un ID aléatoire unique pour chaque serveur de moteur.

  • Disposition de journalisation du moteur

    • AUTOMATE_ENGINE_LOG_LAYOUT_JSON: Set to true pour configurer les journaux du moteur au format JSON. Notez que cela ne s’applique pas aux formats de journaux du planificateur ou du serveur du moteur, qui sont configurés directement dans leurs config.yml respectifs.

3.1.6. Paramètres du service du serveur OData

Ce fichier suit la syntaxe YAML et contient les paramètres suivants :

  • role: ODATA_SERVER, indiquant que le composant Automate OData Server va s’exécuter ;

  • internalCredentials: indique que les informations d’identification définies dans le fichier de configuration seront utilisées pour l’authentification. La configuration est fournie dans les sous-clés suivantes:

    • displayName: (Facultatif) Le nom à afficher dans la page de connexion pour cette méthode d’authentification.

    • restrictToLocalhost : (Facultatif) Limitez la disponibilité de l’authentification interne aux navigateurs de localhost. Si cette propriété n’est pas spécifiée, sa valeur par défaut est false.

    • credentials: la liste des informations d’identification.

Les informations d’identification peuvent être fournies au format PBKDF2, en utilisant :

  • username

  • email

  • salt, une chaîne encodée en base64

  • iterations, le nombre d’itérations de hachage

  • hash, calculé à l’aide de l’algorithme PBKDF2WithHmacSHA512 avec une longueur de clé de 512 bits.

ou en clair, en utilisant :

  • username

  • email

  • password

Exemple de configuration d’authentification interne avec 2 utilisateurs:

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@
La méthode d’authentification interne nécessite de stocker les noms d’utilisateur et les mots de passe ou les hachages dans le fichier de configuration. Il est recommandé de limiter cette méthode à localhost.
Définissez la propriété restrictToLocalhost sur true pour autoriser uniquement la connexion avec des informations d’identification internes lors de l’accès à Automate en tant qu’hôte local.

  • server : Indique les paramètres des journaux d’accès Web, les protocoles HTTP à écouter et l’IP, le port et le certificat TLS correspondants pour les connexions HTTPS.

Par défaut, le service écoute sur HTTP sur le port 8081 sur localhost, et sur HTTPS sur le port 8443 toutes les adresses IP. Pour restreindre l’écoute du serveur sur une adresse IP spécifique, remplacez 0.0.0.0 par l’adresse IP requise dans le fichier config.yml.

  • webConfiguration: indique les paramètres Web à appliquer au serveur Web utilisé pour l’API REST.

  • utilizationStore: indique qu’une base de données personnalisée est utilisée pour stocker les informations d’audit.

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

    • user: Le nom d’utilisateur de la base de données

    • password: Le mot de passe de la base de données

    • url: la chaîne de connexion JDBC, par exemple jdbc:jtds:sqlserver://HOST:1433/DATABASE

    • properties: Les propriétés de connexion.

Exemple de configuration Microsoft SQL:

utilizationStore:
  driverClass: net.sourceforge.jtds.jdbc.Driver
  user: automate-service
  password: SecretGoesHere
  url: jdbc:jtds:sqlserver://localhost:1433/automate
  properties:
    charSet: UTF-8
Si aucun nom d’utilisateur et mot de passe ne sont fournis dans la configuration de la base de données Microsoft SQL, la connexion sera effectuée à l’aide de l’authentification Windows intégrée. Lors de la connexion à Microsoft SQL de cette manière, le service Automate Scheduler doit être configuré pour s’exécuter sous un compte ayant accès à la base de données Microsoft SQL.

3.2. Authentification

3.2.1. Nuix UMS

Si vous utilisez la méthode d’authentification Nuix UMS, configurez le service d’authentification UMS dans la page Web Automatiser, dans l’onglet Paramètres, sous Services d’authentification. Tous les utilisateurs définis dans Nuix UMS pourront se connecter à Automate. Le niveau d’accès de chaque utilisateur est déterminé par les politiques de sécurité définies dans la page Web Automatiser, dans l’onglet Paramètres.

3.2.2. LDAP

Si vous utilisez la méthode d’authentification LDAP, configurez le service d’authentification LDAP dans la page Web Automatiser, dans l’onglet Paramètres, sous Services d’authentification. Tous les utilisateurs définis dans le LDAP fourni domainDN pourront se connecter à Automate. Le niveau d’accès de chaque utilisateur est déterminé par les politiques de sécurité définies dans la page Web Automatiser, dans l’onglet Paramètres.

3.2.3. Interne

Si vous utilisez la méthode d’authentification interne, définissez la configuration internalCredentials dans le fichier YAML comme indiqué dans Service Settings.

3.3. Stratégies de sécurité d’accès

L’accès aux ressources Automate est défini dans la page Paramètres, dans l’onglet Politiques de sécurité. La stratégie par défaut permet à tout utilisateur authentifié de visualiser et de modifier toutes les ressources, ainsi que de soumettre des travaux avec tous les paramètres.

3.4. Mémoire

3.4.1. Travailleurs Nuix

La mémoire de Nuix Workers peut être spécifiée soit dans l’opération de workflow, soit explicitement en tant que paramètre de ligne de comm*Configuration*e dans les profils d’exécution, par exemple:

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

3.4.2. Moteur Nuix

La mémoire du moteur Nuix, équivalente à la mémoire de la station de travail Nuix en tant que paramètre de ligne de commande dans les profils d’exécution, par exemple:

-Xmx2g
Chaque moteur Nuix s’exécutera sous une JVM distincte et ne partagera pas de mémoire avec les autres moteurs Nuix ou les services Automate.

3.5. Sources de données partagées

Les workflows automatisés sont exécutés sur les serveurs exécutant le composant Automate Engine Server. Pour garantir que les workflows peuvent accéder aux dossiers et aux données sources à partir d’un emplacement partagé, fournissez un chemin UNC ou un chemin de lettre de lecteur mappé accessible à partir de tous les serveurs exécutant le composant Automate Engine Server.

Par défaut, le service Automate Engine Server s’exécute sous le compte système local et démarre les moteurs sous le même compte utilisateur.

Un compte d’utilisateur différent peut être spécifié dans les profils d’exécution, selon les besoins.

4. Dépannage

4.1. Accéder au planificateur automatique

Par défaut, Automate Scheduler écoute sur 127.0.0.1 sur le port 80 et toutes les adresses IP sur le port 443. Pour accéder à l’installation par défaut, accédez à l’adresse : http://localhost

4.2. Le service automatisé ne démarre pas

Automate Scheduler et Engine Server s’exécutent en tant que services Windows. Si les services sont démarrés, inspectez les fichiers journaux à C:\Temp\Log\automate-scheduler.log et C:\Temp\Log\automate-engine-server.log.

4.3. Erreur d’identification

Si l’erreur Erreur de communication avec le serveur d’authentification s’affiche lors de la tentative de connexion, inspectez les journaux pour déterminer le problème rencontré par Automate lors de la communication avec le serveur d’authentification.

4.4. L’ajout d’Automate Engine Server génère une erreur javax.net.ssl.SSLHandshakeException

Assurez-vous que l’environnement d’exécution Java de la dernière version de Nuix Workstation déployé sur chaque serveur Automate Scheduler approuve le certificat TLS du serveur Automate Engine. Pour plus de détails, reportez-vous à la section Managing Certificates.

5. Gérer les certificats

Voir https://nuix.service-now.com/support?id=kb_article_view&sys_ko_id=fcd9bfe747cc96102d9c89cbd36d438f.

6. Utilisation et rapports

Les données d’utilisation et de création de rapports sont fournies sous forme de flux OData V4, si cette fonctionnalité est activée dans la licence Automate.

Le flux OData ne prend en charge que l’interrogation des métadonnées et la récupération de toutes les données des vues. Les filtres OData ne sont pas pris en charge.

Le flux OData est accessible sous le point de terminaison suivant, à l’aide de l’authentification Basic ou Microsoft OAuth:

  • /api/v2/reporting/odata

7. Documentation de l’API REST

Automate Scheduler est accessible soit directement depuis un navigateur, soit via l’API REST. La documentation de l’API est fournie au format OpenAPI v3, sous /openapi.

Par exemple, pour accéder à la documentation de l’API dans une installation standard d’Automate Scheduler, accédez à http://localhost/openapi

8. Journalisation centralisée

La journalisation centralisée consolide tous les journaux des journaux Scheduler, Engine Server, Engine et Worker dans la base de données de journalisation gérée par Scheduler.

La journalisation centralisée est activée par défaut, ce qui signifie que le fichier journal ainsi que le journal de la base de données existeront. Pour désactiver la journalisation centralisée, réglez la touche enableCentralizedLogging sur false dans le fichier de configuration YAML comme indiqué dans le fichier Service Settings.

Si la journalisation centralisée est désactivée, les fonctions de téléchargement des journaux de travaux et de téléchargement des journaux système seront désactivées.

La journalisation centralisée supprimera automatiquement les journaux plus anciens que la période de rétention. La période de conservation par défaut est 30 jours. Pour modifier la période de conservation, modifiez la clé centralizedLoggingRetention dans le fichier YAML.

Lorsque la taille des journaux de la base de données dépasse la taille maximale de la base de données, les journaux plus anciens seront supprimés. Par défaut, la taille maximale de la base de données est de 1000000000 octets (1 Go). Pour modifier la taille maximale par défaut de la base de données, éditez la touche centralizedLoggingMaxSize dans le fichier YAML.

La taille réelle de la base de données de journalisation centralisée peut dépasser la taille maximale spécifiée, en raison de la surcharge de la base de données et des retards dans la suppression des anciennes lignes de journal.

9. Inventaire des chemins de fichiers

9.1. Chemins de fichiers par défaut

9.1.1. Planificateur

  • C:\Program Files\Nuix\Automate: dossier d’installation

  • %programdata%\Nuix\Automate\Scheduler\config: dossier de configuration

  • %programdata%\Nuix\Automate\Scheduler\stores: persistance et archivage des détails du poste, utilisation, audit, reporting et utilisation

  • C:\Temp\logs\automate-scheduler.log : Journal des candidatures

  • C:\Temp\logs\automate-scheduler.%d.log.zip : fichiers journaux d’application précédents

  • C:\Temp\logs\automate-scheduler-access.log : journal d’accès au Web

  • C:\Temp\logs\automate-scheduler-access.%d.log.zip: Fichiers journaux principaux précédents

  • C:\Temp\logs\Automate Scheduler.wrapper.log: Journaux du wrapper de service

  • C:\Temp\logs\Automate Scheduler.err.log: journal des erreurs standard de service

  • C:\Temp\logs\Automate Scheduler.out.log: Journal de sortie standard de service

9.1.2. Serveur moteur

  • C:\Program Files\Nuix\Automate: dossier d’installation

  • %programdata%\Nuix\Automate\EngineServer\config: dossier de configuration

  • C:\Temp\logs\automate-engine-server.log : Journal des candidatures

  • C:\Temp\logs\automate-engine-server.%d.log.zip : fichiers journaux d’application précédents

  • C:\Temp\logs\automate-engine-server-access.log : journal d’accès au Web

  • C:\Temp\logs\automate-engine-server-access.%d.log.zip: Fichiers journaux principaux précédents

  • C:\Temp\logs\Automate Engine Server.wrapper.log: Journaux du wrapper de service

  • C:\Temp\logs\Automate Engine Server.err.log: journal des erreurs standard de service

  • C:\Temp\logs\Automate Engine Server.out.log: Journal de sortie standard de service

9.1.3. Moteur

  • C:\Temp\logs\automate-engine.aaaaaaaa-init.log: journal d’initialisation

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

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

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

  • C:\Temp\logs\automate-engine.aaaaaaaa-job.bbbbbbbb.log: Journal des travaux

  • C:\Temp\logs\automate-engine.aaaaaaaa-job.bbbbbbbb.yml: Configuration des tâches

9.2. Modification des emplacements des journaux

Les chemins de fichiers par défaut peuvent être modifiés à partir des emplacements suivants:

  • Journal principal du planificateur: mettez à jour la section

  • Journaux liés au service du planificateur: mettez à jour les balises <workingdirectory> et <logpath> à partir de C:\Program Files\Nuix\Automate\Scheduler\Automate Scheduler.xml

  • Journal principal du serveur moteur: mettez à jour la section logging à partir de C:\ProgramData\Nuix\Automate\EngineServer\config\config.yml

  • Journaux liés au service Engine Server: mettez à jour les balises <workingdirectory> et <logpath> à partir de C:\Program Files\Nuix\Automate\EngineServer\Automate Engine Server.xml

  • Journal d’initialisation du moteur, journaux de configuration et de service: mettez à jour la section engineInitLogFolder de C:\ProgramData\Nuix\Automate\EngineServer\config\config.yml

  • Journal des travaux et configuration: mettez à jour le champ Log Folder et définissez le paramètre de ligne de commande -Dnuix.logdir=c:\Temp\Logs dans le profil d’exécution