Passer au contenu principal
L’interface de ligne de commande peut être utilisée pour effectuer les opérations suivantes sur le Processing Server :
  • initialisation et arrêt du serveur
  • ajout, configuration et suppression de stations
  • mise à jour des jeux de données
  • gestion des dossiers actifs
  • gestion des diagnostics
Les commandes du Processing Server doivent être saisies comme suit : ‘FlexiBrSvc Please [command]’. Au lieu de taper ‘FlexiBrSvc Please ’ à chaque commande, vous pouvez activer le mode de commande à l’aide de FlexiBrSvc Please obey. Pour désactiver le mode de commande, utilisez FlexiBrSvc Please quit. Pour obtenir de l’aide sur l’une des commandes ci-dessus, utilisez help [command]. Les commandes pouvant être utilisées avec le Processing Server sont décrites ci-dessous.

Définition des identifiants d’authentification

  • set basicauthstring=<username>:<password> – définit les identifiants d’authentification Basic pour le Processing Server et les Processing Stations. L’utilisateur dont les identifiants sont indiqués dans cette commande doit avoir le rôle Processing Server. Pour supprimer les identifiants d’authentification actuellement utilisés, utilisez une chaîne vide : ‘set basicauthstring=’. Pour afficher les identifiants actuellement utilisés, utilisez ‘view’ (si aucun identifiant n’a été indiqué, une chaîne vide sera renvoyée). Remarque : les identifiants d’authentification Basic ne peuvent être indiqués que lorsque le Processing Server et les Processing Stations ne sont pas en cours d’exécution. Si des identifiants non valides sont indiqués, le Processing Server et les Processing Stations ne démarreront pas.

Gestion du serveur

  • set <param>=<value> – attribue une valeur à un paramètre. Pour afficher tous les paramètres disponibles, utilisez ‘view’. Pour afficher toutes les valeurs autorisées pour un paramètre, utilisez ‘set <param>=?’.
  • start server – initialise le Processing Server.
  • stop server [timeout] – arrête le Processing Server.
Pour définir une période pendant laquelle le serveur doit terminer les tâches en cours, utilisez le paramètre [timeout]. Si ce paramètre n’est pas défini, le serveur s’arrête immédiatement.

Gestion des stations

  • add station <location> – ajoute une nouvelle station à <location>.
  • list stations – affiche des informations sur les stations existantes.
  • remove station <station>|* – supprime une station. Pour supprimer toutes les stations, utilisez ’*’.
Cette commande nécessite d’indiquer le nom de la station et son emplacement, ou son UUID.
  • set station <station> <param>=<value> – attribue une valeur à un paramètre. Pour afficher tous les paramètres disponibles, utilisez ‘view’. Pour afficher toutes les valeurs autorisées, utilisez ‘set station <station> <param>=?’.
Pour attribuer une valeur à toutes les stations, utilisez ’*’ à la place du nom de la station.
  • start station <<station>|*> [/Async] – tente d’initialiser une station. Utilisez ’*’ pour tenter d’initialiser toutes les stations.
Cette commande nécessite d’indiquer le nom de la station et son emplacement, ou son UUID.
Pour éviter que d’autres commandes ne soient bloquées si la station spécifiée n’a pas été initialisée, utilisez le paramètre [/Async]
  • stop station <<station>|*> [timeout] – arrête une station. Pour arrêter toutes les stations, utilisez ’*’.
Cette commande nécessite d’indiquer le nom de la station et son emplacement, ou son UUID. Pour définir une durée pendant laquelle le serveur doit terminer les tâches initialisées, utilisez le paramètre [timeout].
  • view <station>|* – affiche des informations détaillées sur une station. Pour afficher des informations sur toutes les stations, utilisez ’*’. Si aucune station n’a été spécifiée, cette commande affiche des informations sur le serveur.

Gestion des groupes de stations

  • set station <<station> StationGroup=<group name> – ajoute une station au groupe.
  • set station <<station> StationGroup= – retire une station du groupe.
Pour connaître le groupe auquel appartient une station, utilisez la commande view <station>|*.

Gestion des projets

  • update dataset <project> [document definition] [data set] – met à jour un jeu de données. Pour indiquer le chemin complet du projet, utilisez <project> (par exemple : https://app-server/f24d…/Banking&#95;eng). Si aucun nom de Document Definition ni de jeu de données n’est indiqué, toutes les Document Definitions et tous les jeux de données seront mis à jour.

Gestion des dossiers actifs

  • list hotfolders <project> – affiche des informations détaillées sur tous les dossiers actifs pour lesquels l’option est activée.
  • set hotfolder <project> Enabled/Disabled – active ou désactive le traitement des dossiers actifs pour un projet. Pour afficher tous les projets disponibles, utilisez ‘view’.

Diagnostic des processus

Le système de profilage est conçu pour la surveillance de bas niveau des processus internes de Processing Server et de Processing Station. Si le profilage est activé, le Processing Server commencera à collecter des statistiques sur ses propres processus internes ainsi que sur ceux des Processing Stations. Cette fonction est désactivée par défaut. Le Processing Server enregistrera les données collectées dans le dossier suivant du système de fichiers : %ProgramData%\ABBYY\FlexiCapture\12.0\FlexiBr[Svc]\Profiling. La fréquence à laquelle les données collectées sont enregistrées sur le disque est définie par la clé de registre suivante : ProfilingManagerSaveWindowProfilingReportPeriod dans HKEY_LOCAL_MACHINE\SOFTWARE[Wow6432Node]ABBYY\FlexiCapture\12.0\FlexiBr​ (en millisecondes ; la valeur par défaut est 3600000).
  • reset total profiling report – réinitialise le rapport de profilage complet. Après utilisation de cette commande pour effacer le rapport de profilage, celui-ci n’inclura que la période suivant l’exécution de la commande.
  • save total profiling report <path> – enregistre le rapport de profilage complet dans le dossier spécifié.
  • save window profiling report <path> – enregistre le rapport de profilage pour la période spécifiée dans le dossier indiqué.
  • set profiling disabled – désactive le profilage.
  • set profiling enabled – active le profilage.