Configurer le traitement en arrière-plan
Autres langues
Comment connecter un jeton d'API Nuix Discover pour que Claira puisse exécuter des analyses en lot en arrière-plan, réutiliser un jeton dans vos dossiers en un clic, et le remplacer, le déconnecter ou le retirer.
Configurer le traitement en arrière-plan
Le traitement en arrière-plan permet à Claira d'exécuter une analyse en lot côté serveur. Vous la démarrez comme n'importe quelle analyse en lot, mais vous n'avez pas besoin de garder Nuix Discover ouvert pendant l'exécution : Claira termine le travail en arrière-plan et vous envoie un courriel lorsque c'est terminé. Vous pouvez également lancer d'autres analyses en arrière-plan en parallèle.
Le traitement en arrière-plan n'est pas disponible dans Claira Private.
Le traitement en arrière-plan a besoin d'un jeton d'API Discover connecté au dossier : le jeton d'API personnel d'un utilisateur Nuix Discover, que Claira utilise pour lire les documents et écrire le codage pendant que personne n'a le dossier ouvert. Un dossier obtient son jeton de l'une de deux façons :
- En un clic, lorsque Claira détient déjà un jeton que vous pouvez utiliser : le jeton d'API de votre organisation, qu'un administrateur de l'organisation définit une seule fois dans le portail d'administration, ou un jeton que vous avez enregistré dans un autre dossier. Voir Connecter en un clic.
- En collant un jeton : créez un utilisateur Nuix Discover dédié à Claira, générez un jeton d'API personnel pour cet utilisateur et collez le jeton dans les paramètres de Claira. Les étapes 1 à 4 ci-dessous décrivent la marche à suivre.
La réutilisation en un clic est offerte lorsque votre organisation utilise le portail d'administration. Sans lui, chaque dossier connecte son propre jeton en le collant.
Pourquoi un utilisateur dédié ?
Lorsque vous exécutez une analyse en lot au premier plan aujourd'hui, Claira utilise votre session Discover pour écrire le codage dans le dossier. Cette session disparaît dès que vous fermez l'onglet du navigateur, ce qui convient pour de courtes analyses mais pas pour un traitement de nuit.
Le traitement en arrière-plan conserve un jeton d'API Nuix Discover à long terme côté Claira afin qu'elle puisse écrire le codage des heures ou des jours après que vous ayez cliqué sur Démarrer. Chaque écriture provenant d'une analyse en arrière-plan apparaît dans le journal d'audit de Discover au nom du compte Discover auquel appartient le jeton, et Claira vous indique de quel compte il s'agit avant que vous connectiez un jeton. Si vous connectez votre propre jeton d'API personnel, ces écritures apparaissent sous votre nom.
Pour garder un journal d'audit clair, nous recommandons d'attribuer le jeton à un utilisateur dédié (par exemple, claira-service@votre-cabinet.com) plutôt qu'à un examinateur réel. Lorsque votre organisation utilise le portail d'administration, un administrateur de l'organisation peut définir une seule fois le jeton de cet utilisateur comme jeton d'API Discover de l'organisation, et chaque dossier peut alors le connecter en un clic.
Connecter en un clic
Ouvrez les paramètres de Claira et, sous Paramètres de l'équipe, cliquez sur Traitement en arrière-plan. Lorsque Claira détient un jeton que vous pouvez utiliser dans ce dossier, la section le propose à la place du formulaire de collage :
- Le jeton d'API de votre organisation : affiche Se connecte en tant que et le nom du compte, ainsi que Ajouté par l'administrateur de votre organisation. Choisissez Utiliser le jeton de l'organisation. Lorsque votre organisation en a un, c'est toujours la première proposition.
- Votre jeton d'API : un jeton que vous avez enregistré dans un autre dossier de votre organisation. Il affiche le compte au nom duquel il se connecte et, lorsque d'autres dossiers l'utilisent déjà, combien (par exemple Utilisé dans 3 autres dossiers), et rappelle que les écritures en arrière-plan apparaissent dans Discover au nom de ce compte. Choisissez Utiliser votre jeton d'API. Si vous avez enregistré des jetons pour plus d'un compte Discover, le bouton les liste selon le compte au nom duquel chacun se connecte.
- Utiliser plutôt votre jeton d'API connecte votre propre jeton lorsque le jeton de l'organisation est proposé en premier, et Coller un autre jeton d'API ouvre le formulaire de collage décrit à l'étape 4.
Claira vérifie le jeton auprès de ce dossier avant de le connecter. Une fois qu'il est connecté, Connecté. Le traitement en arrière-plan est disponible dans ce dossier. s'affiche, et la section montre le jeton connecté (voir Ce que la section affiche une fois un jeton connecté).
Seule la personne qui a ajouté un jeton se le voit proposer. Un collègue qui ouvre un autre dossier voit ses propres jetons et le jeton de l'organisation, jamais le vôtre. Un jeton que Discover n'accepte plus n'est jamais proposé.
Si le compte ne peut pas ouvrir ce dossier. L'utilisateur Discover du jeton doit être membre du dossier. S'il ne l'est pas, rien n'est connecté et Claira nomme le compte : demandez à un administrateur Discover d'ajouter ce compte au dossier (étape 2), puis réessayez.
Lorsque rien n'est proposé. Si votre organisation utilise le portail d'administration mais n'a pas encore de jeton d'organisation, le formulaire de collage ajoute L'administrateur de votre organisation peut ajouter un jeton d'API unique pour tous les dossiers dans le portail d'administration. Si votre organisation n'autorise que son propre jeton d'API et qu'il n'est pas encore configuré, la section l'indique et vous invite à communiquer avec l'administrateur de votre organisation ; il n'y a pas de formulaire de collage.
Étape 1 : Créer un utilisateur de service dans Nuix Discover
- Depuis Portal Home, ouvrez Users.
- Créez un nouvel utilisateur : par exemple
claira-service@votre-cabinet.com. - Attribuez-lui un mot de passe robuste et conservez-le en lieu sûr (vous n'en aurez besoin qu'une fois, pour générer le jeton API à l'étape suivante).
Étape 2 : Ajouter l'utilisateur de service au dossier
- Ouvrez Case Setup pour le dossier dans lequel vous souhaitez activer le traitement en arrière-plan.
- Cliquez sur Users et ajoutez l'utilisateur de service que vous venez de créer.
- Accordez à l'utilisateur de service suffisamment de permissions pour lire les documents et appliquer le codage à vos champs de destination. Un rôle d'administrateur de dossier est l'option la plus simple ; un rôle de codage uniquement fonctionne également.
Un jeton ne peut être connecté qu'aux dossiers que son utilisateur peut ouvrir. Si votre organisation utilise un seul jeton d'organisation, ajoutez l'utilisateur de service à chaque dossier où vous voulez le traitement en arrière-plan ; le portail d'administration indique combien de vos dossiers actifs le jeton peut ouvrir.
Étape 3 : Générer un jeton API personnel
- Connectez-vous à Nuix Discover en tant qu'utilisateur de service.
- Ouvrez le menu utilisateur et suivez les instructions de votre déploiement Discover pour générer un jeton API personnel. (Si votre portail n'offre pas cette option, demandez à votre administrateur Nuix d'activer les jetons API personnels pour votre environnement.)
- Copiez le jeton. Il s'agit d'une longue chaîne qui ne sera affichée qu'une seule fois, alors conservez-la en lieu sûr.
Étape 4 : Coller le jeton dans Claira
- Ouvrez Claira dans Discover sur le dossier où vous souhaitez activer le traitement en arrière-plan.
- Ouvrez les paramètres de Claira et, sous Paramètres de l'équipe, cliquez sur Traitement en arrière-plan pour ouvrir la section. Tant qu'elle est fermée, la section indique si un jeton est connecté. Si la section propose un jeton que vous pouvez utiliser, vous pouvez plutôt le connecter en un clic ; pour en coller un malgré tout, choisissez Coller un autre jeton d'API.
- Collez le jeton dans le champ Jeton API personnel. Lorsque votre organisation utilise le portail d'administration et permet de réutiliser son propre jeton, Proposer aussi ce jeton d'API dans mes autres dossiers apparaît sous le champ, déjà cochée. Laissez-la cochée pour vous faire proposer ce jeton, en un clic, dans vos autres dossiers de l'organisation ; décochez-la pour réserver le jeton à ce dossier.
- Cliquez sur Vérifier et enregistrer. Le lien Comment générer un jeton API personnel dans Nuix Discover à côté du bouton ouvre l'étape 3 de cette page.
- Claira vérifie le jeton auprès de Nuix et s'assure qu'il appartient à ce portail Discover et qu'il peut ouvrir ce dossier. Si le jeton est refusé, Claira en donne la raison dans votre langue et précise que rien n'a été enregistré, par exemple lorsque Discover n'a pas accepté le jeton, que le jeton appartient à un autre portail Discover ou que son compte ne peut pas ouvrir ce dossier. Si votre organisation n'autorise que son propre jeton d'API, un jeton collé n'est pas enregistré : utilisez plutôt le jeton de l'organisation.
Coller un jeton que vous avez déjà enregistré dans un autre dossier ne crée pas de deuxième copie : Claira connecte celui qu'elle détient déjà.
C'est terminé. Désormais, toute personne disposant de l'accès à l'analyse en lot dans ce dossier verra une case à cocher Exécuter en tant que tâche en arrière-plan dans la fenêtre de confirmation d'analyse en lot.
Ce que la section affiche une fois un jeton connecté
Une fois un jeton connecté, la section affiche une seule ligne : une coche, Compte connecté, le compte Discover au nom duquel le jeton se connecte et la date de la dernière vérification du jeton. Un badge indique à qui appartient le jeton :
- Jeton de l'organisation : le jeton d'API de votre organisation, défini dans le portail d'administration.
- Votre jeton : un jeton que vous avez ajouté.
- Ajouté par suivi d'un nom : un jeton ajouté par un collègue.
Lorsque le même jeton est aussi connecté à d'autres dossiers, la ligne indique combien, par exemple Aussi utilisé dans 2 autres dossiers.
Lancer une analyse en arrière-plan
- Sélectionnez vos documents et lancez une analyse en lot comme vous le feriez habituellement.
- Dans la fenêtre de confirmation, cochez Exécuter en tant que tâche en arrière-plan. La case apparaît pour tous les types d'analyse (Texte, Image, Audio, Vidéo et Auto), pour les analyses à champ unique comme Multi-Code. Si vous avez sélectionné un modèle que le traitement en arrière-plan ne peut pas exécuter, l'analyse en arrière-plan utilise à la place le modèle par défaut de Claira, et la fenêtre vous l'indique.
- Cliquez sur Démarrer l'analyse en lot. La tâche apparaît immédiatement dans Tâches en lot avec un badge Arrière-plan et une ligne d'état telle que « Création de la tâche ». Une analyse Image, Audio, Vidéo ou Auto téléverse d'abord ses fichiers depuis votre navigateur : voir Les analyses image, audio, vidéo et Auto téléversent d'abord leurs fichiers.
- Fermez l'onglet si vous le souhaitez (pour une analyse Image, Audio, Vidéo ou Auto, une fois ses fichiers téléversés). Lorsque la tâche se termine, Claira envoie un courriel à la personne qui l'a lancée (ou à tous les utilisateurs du dossier, selon vos préférences de courriel). Le courriel indique quelle tâche s'est terminée et où : le nom et le numéro de la tâche, le nom du dossier, le statut final et la durée de l'exécution, ainsi que le champ dans lequel les réponses ont été écrites et le décompte des documents (succès, ignorés, en erreur). Ouvrez votre dossier pour examiner les résultats.
Les analyses de toute taille fonctionnent de la même façon : les très grandes exécutions sont automatiquement découpées et poursuivies côté serveur, et les résultats sont enregistrés dans votre dossier au fur et à mesure, et vous n'avez donc jamais rien à relancer.
Connecter un jeton depuis une analyse ou la Migration de champs
Vous n'avez pas à passer d'abord par les paramètres. Lorsqu'un dossier n'a pas encore de jeton d'API et que Claira en détient un que vous pouvez utiliser, les endroits qui ont besoin d'un jeton le proposent directement, avec le même bouton que la section des paramètres (Utiliser le jeton de l'organisation ou Utiliser votre jeton d'API) :
- Analyse en lot. Dans la fenêtre de confirmation, la section Exécution indique Exécuter en arrière-plan avec le jeton d'API de votre organisation (ou Exécuter en arrière-plan avec votre jeton d'API) et explique qu'une fois le compte connecté, l'analyse peut continuer après la fermeture de Discover.
- Envoyer en arrière-plan. Pendant une analyse en direct, Envoyer en arrière-plan demande Connecter un jeton d'API et envoyer en arrière-plan ?, nomme le compte que Claira connectera, et Connecter et envoyer le connecte et transfère l'analyse en arrière-plan en une seule étape.
- Migration de champs. La migration de champs s'exécute sur le serveur et a besoin d'un jeton d'API pour le dossier : son avis propose donc le jeton à connecter avant de continuer.
Lorsqu'il n'y a rien à proposer, ces mêmes endroits indiquent Le traitement en arrière-plan n'est pas configuré pour ce dossier, avec un bouton Ouvrir les paramètres qui ouvre la section Traitement en arrière-plan avec le champ du jeton prêt pour le collage.
Les analyses image, audio, vidéo et Auto téléversent d'abord leurs fichiers
Une analyse Texte est confiée aux serveurs immédiatement. Une analyse Image, Audio, Vidéo ou Auto a besoin du fichier propre à chaque document : Claira téléverse donc d'abord ces fichiers depuis votre navigateur. La fenêtre de confirmation l'indique lorsque vous cochez Exécuter en tant que tâche en arrière-plan.
- Après que vous avez cliqué sur Démarrer l'analyse en lot, la carte d'analyse en lot affiche Téléversement des fichiers de la tâche #NNN, avec un décompte tel que « 120 fichiers téléversés sur 500 » et un bouton Suspendre le téléversement.
- Laissez Claira ouverte jusqu'à la fin du téléversement.
- Une fois les fichiers téléversés, l'analyse s'exécute en arrière-plan et la confirmation habituelle La tâche #NNN s'exécute en arrière-plan s'affiche : vous pouvez désormais fermer Claira ou Nuix Discover en toute sécurité. Le courriel de fin de tâche fonctionne comme pour toute analyse en arrière-plan.
Si le téléversement est interrompu. Si Claira est fermée ou si le téléversement est suspendu, la tâche attend dans Tâches en arrière-plan en cours avec l'état Téléversement et une ligne telle que « En attente des fichiers : 120 téléversés sur 500 ». Toute personne travaillant dans le dossier peut choisir Terminer le téléversement sur cette ligne, dans Historique des tâches d'analyse en lot ou dans les détails de la tâche pour téléverser le reste depuis son propre navigateur. Les fichiers déjà téléversés sont conservés, et les documents que cette personne ne peut pas ouvrir dans Nuix Discover sont ignorés et ne sont pas facturés. Si personne ne termine le téléversement dans les 24 heures, Claira lance l'analyse avec les fichiers dont elle dispose ; les documents restants ne sont ni analysés ni facturés. Si aucun fichier n'a été téléversé, la tâche est annulée et entièrement remboursée. Annuler une tâche à l'état Téléversement l'abandonne, puisqu'il n'y a encore aucun résultat à conserver.
Pour les limites de fichiers, la tarification et ce qui arrive à un fichier inutilisable, voir Exécuter les analyses média en arrière-plan.
Remplacer, déconnecter ou retirer un jeton
Chacune de ces actions commence par le bouton à trois points Options du compte connecté au bout de la ligne Compte connecté.
Remplacer le jeton
Si vous devez un jour faire tourner le jeton d'API (par exemple parce que le mot de passe de l'utilisateur de service a été modifié), répétez l'étape 3 pour générer un nouveau jeton. Choisissez ensuite Remplacer le jeton, collez le nouveau jeton et cliquez sur Vérifier et enregistrer. Le jeton connecté reste en place jusqu'à ce que le nouveau soit vérifié. Annuler ferme le formulaire sans rien changer.
Lorsque le jeton vous appartient et que d'autres dossiers l'utilisent aussi, le formulaire demande où appliquer le nouveau :
- Mettre à jour les {count} dossiers qui l'utilisent (le choix par défaut) remplace votre jeton partout : chaque dossier qui y est connecté utilise le nouveau immédiatement. Le nouveau jeton doit se connecter au nom du même compte Discover ; sinon, rien ne change dans vos autres dossiers et Claira vous invite à choisir Ce dossier uniquement ou à coller un jeton pour ce compte.
- Ce dossier uniquement connecte le nouveau jeton à ce dossier seulement. Vos autres dossiers conservent le jeton qu'ils avaient.
Déconnecter un jeton de ce dossier
Choisissez Déconnecter de ce dossier. Comme cela touche tout le monde dans le dossier, Claira vous demande d'abord de confirmer : le traitement en arrière-plan s'arrête dans ce dossier jusqu'à ce que quelqu'un connecte un jeton. Les tâches en arrière-plan en cours dans le dossier sont suspendues immédiatement, en conservant leur progression, et la personne qui a lancé chacune d'elles reçoit un courriel indiquant qu'elle est en pause parce que le jeton d'API utilisé par le dossier a été retiré ou déconnecté ; une fois qu'un jeton est de nouveau connecté, utilisez Reprendre sur ces tâches dans Tâches en lot. La déconnexion ne touche que ce dossier : votre jeton reste enregistré pour vos autres dossiers, et un jeton d'organisation reste disponible pour être connecté de nouveau. Déconnecté de ce dossier. le confirme.
Retirer votre jeton de tous les dossiers
Si vous avez ajouté le jeton, Retirer mon jeton d'API de tous les dossiers le déconnecte de chaque dossier qui l'utilise et supprime la copie de Claira. La confirmation indique combien de dossiers l'utilisent, et que le traitement en arrière-plan s'arrête dans ces dossiers jusqu'à ce que quelqu'un connecte un autre jeton. Les tâches en arrière-plan en cours dans ces dossiers sont suspendues de la même façon. Seule la personne qui a ajouté un jeton peut le retirer de tous les dossiers ; toute autre personne peut plutôt le déconnecter du dossier en cours.
Claira ne supprime jamais un jeton de son propre chef, et le retirer dans Claira ne le révoque pas dans Nuix Discover : Discover continue d'accepter le jeton jusqu'à ce que vous le révoquiez là aussi.
Lorsque Discover n'accepte plus un jeton
Si un jeton est révoqué ou expire dans Nuix Discover, Claira le remarque la prochaine fois qu'une tâche en arrière-plan l'utilise. La section Traitement en arrière-plan affiche alors Action requise, et la ligne indique Discover n'accepte plus ce jeton d'API.
- Les tâches en arrière-plan sont suspendues ; rien n'est perdu. Les tâches des dossiers qui utilisent le jeton s'arrêtent là où elles sont et apparaissent comme Incomplète dans Tâches en lot ; ce qu'elles ont déjà écrit dans Discover est conservé. La personne qui a lancé chacune d'elles reçoit un courriel indiquant qu'elle est en pause. Une nouvelle analyse en arrière-plan est refusée jusqu'au remplacement du jeton, mais une analyse peut toujours s'exécuter dans votre navigateur tant que Discover reste ouvert.
- La migration de champs n'est pas suspendue. Une migration de champs en cours à ce moment se termine en échec, avec un message indiquant que Discover n'accepte plus le jeton d'API utilisé par ce dossier. Les copies qu'elle n'avait pas encore faites restent non faites.
- Remplacez-le une seule fois. Choisissez Remplacer le jeton et collez un nouveau jeton pour le même compte. Le remplacer dans un dossier règle aussi les autres dossiers qui l'utilisent.
- Puis reprenez. Ouvrez Tâches en lot et utilisez Reprendre sur chaque tâche suspendue : elle continue là où elle s'était arrêtée. La reprise est refusée tant que le dossier n'a pas de jeton fonctionnel.
Lorsque le jeton refusé est celui de votre organisation, la section indique que les tâches en arrière-plan de ce dossier sont suspendues et que les administrateurs de votre organisation ont reçu un courriel leur demandant de le remplacer dans le portail d'administration. Voir Lorsque Discover refuse le jeton.
Qui peut connecter un jeton
Lorsque votre organisation applique les rôles Claira à partir du portail d'administration :
- Connecter un jeton que Claira détient déjà (en un clic) exige Connecter un jeton d'API enregistré à un dossier. Chaque Utilisateur l'a par défaut.
- Coller un nouveau jeton exige Coller un nouveau jeton d'API dans un dossier.
- Déconnecter de ce dossier exige Déconnecter le jeton d'API d'un dossier.
- Retirer votre propre jeton de tous les dossiers n'exige aucune permission : vous pouvez toujours retirer un jeton que vous avez ajouté.
Tant que l'application des permissions n'est pas activée, toute personne qui a accès à Claira dans le dossier peut faire tout cela.
Ce qui est écrit dans le dossier
Une analyse en arrière-plan écrit exactement ce que la même analyse au premier plan aurait écrit. Pour une exécution à champ unique, la réponse de chaque document est écrite dans le champ de destination que vous avez choisi, dans le format demandé par votre invite. Pour une exécution Multi-Code, les valeurs de chaque document sont écrites dans chacun de vos champs Multi-Code configurés, comme au premier plan ; si certains champs n'ont pas pu être écrits pour un document, le journal des documents de la tâche dans Tâches en lot indique lesquels. Si vous avez coché Écrire la requête dans le journal des requêtes de chaque document au démarrage de l'analyse, chaque document codé reçoit aussi la même entrée de journal des requêtes qu'une analyse au premier plan. Les examinateurs peuvent lire les résultats directement dans le dossier, ou exporter les champs et continuer à partir de là.
Cette page vous a aide?
Continuer la lecture
Besoin d'aide supplémentaire?
Contactez notre équipe de support à support@claira.to — nous sommes là pour vous aider.