Démarrer le RoboServer

Un RoboServer peut être lancé de plusieurs manières :

  • En l'invoquant depuis la ligne de commande.

  • En l'exécutant comme un service. Voir Démarrage automatique des serveurs.

  • En exécutant le conteneur Docker. Voir le Guide de l'administrateur Kofax RPA pour plus d'informations.

  • En cliquant sur l'icône du programme RoboServer (ou sur l'icône Démarrer le programme Management Console qui démarre à la fois la Management Console et RoboServer). À des fins de démonstration et de test uniquement.

Pour invoquer un RoboServer à partir de la ligne de commande, ouvrez une fenêtre d'invite de commande, naviguez jusqu'au dossier bin dans le dossier d'installation Kofax RPA et saisissez :

RoboServer

Si tous les paramètres requis sont spécifiés dans le fichier de configuration C:Users\[Utilisateur]\AppData\Local\[Version]\Kofax RPA\Configuration\roboserver.settings, le RoboServer démarre.

Si l'un des paramètres nécessaires est manquant, le RoboServer indique une erreur et affiche l'aide à l'utilisation et les paramètres disponibles.

Paramètres RoboServer

La ligne de commande pour le démarrage d'un RoboServer peut inclure les paramètres suivants :

RoboServer [-client] [-MC] [-mcUrl <arg>] [-cl <arg>] [-cpuThreads <arg>] [-h] [-maxConcurrentRobots <arg>] [-maxQueuedRobots <arg>] [-ss <MC Shared Secret>] [-p <arg>] [-pauseAfterStartupError] [-s <arg>] [-sslPort <arg>] [-v] [-V]

Un RoboServer accepte les paramètres du tableau suivant. Notez que vous pouvez modifier tous les paramètres dans l'application Paramètres de RoboServer. Voir Configuration de RoboServer pour plus d'informations.

Paramètre

Description

-mcUrl<arg>

Indiquez à quelle Management Console vous souhaitez vous inscrire dans le format suivant :

http[s]://<nomdhote>:<numérodeport>

Exemple : -mcUrl http://monserveur:8080/ManagementConsole

Lors de l’utilisation d’une étape Document Transformation avec l’option Rappel dans un robot, utilisez le nom d’hôte ou l'adresse IP du RoboServer dans le paramètre -mcUrl. N'utilisez pas 'localhost', car le service Document Transformation ne pourra pas atteindre la Management Console et le robot de rappel ne sera pas mis en file d'attente.

-ss

--mcSharedSecret <code secret partagé MC>

Ce paramètre obligatoire spécifie le code secret partagé utilisé pour authentifier le RoboServer avec la Management Console. Le code secret partagé doit être copié à partir de la section Authentification du service de la Management Console. Voir Authentification du service pour plus d'informations.

-cl

--cluster <arg>

Ce paramètre optionnel enregistre automatiquement un RoboServer avec le cluster spécifié sur la Management Console. Dans l'exemple suivant, le RoboServer s'inscrit au sein du cluster Production.

Exemple : -cl Production

Exemple : -mcUrl http://monserveur:8080/ManagementConsole -ss <code secret partagé MC> -cl Production

-eh

--externalHost <numéro de port>

Spécifie explicitement le nom ou l'adresse IP de l'hôte RoboServer.

Ce paramètre doit être spécifié lorsque l'adresse de l'hôte est différente de ce qu'un RoboServer découvre sur la machine locale, comme lors d'une exécution avec NAT dans le cloud, ou lorsque vous exécutez-le RoboServer dans un conteneur Docker.

Exemple : -eh 10.10.0.123

-ep

--externalPort <numéro de port>

Spécifie explicitement le numéro de port de l'hôte RoboServer.

Ce paramètre doit être spécifié lorsque le port de l'hôte est différent de ce qu'un RoboServer découvre sur l'ordinateur local, par exemple comme lors d'une exécution avec NAT dans le cloud, ou lorsque vous exécutez le RoboServer dans un conteneur Docker.

-jmxPass

Définit le mot de passe JMX si vous surveillez un RoboServer avec l’application JMX qui requiert un mot de passe.

-v

--verbose

Ce paramètre optionnel permet à un RoboServer d'afficher l'état et les événements d'exécution.

-V

--version

Ce paramètre optionnel permet à RoboServer d'afficher le numéro de version, puis de sortir.

-h

--help

Affiche l'aide.

-pause après une erreur de démarrage

Pause si une erreur s'est produite au démarrage.

-s

--service <service-name:service-parameter>

Ce paramètre spécifie un service RQL ou JMX qu'un RoboServer doit lancer. Ce paramètre doit être spécifié au moins une fois, et peut être spécifié plusieurs fois pour lancer plusieurs services dans le même RoboServer. Les services disponibles dépendent de votre installation.

Exemple : --service socket:50000

Exemple : --service jmx:50100

Voir « Services disponibles » dans le tableau ci-dessous pour plus d'informations.

-p

--port <numéro de port>

C'est l'abréviation de -s socket:<port-number>

Exemple : --port 50000

-sslPort<arg>

Il s'agit d'une abréviation pour écrire -s ssl:<numéro de port>

-nd

--NoDoc

Ce paramètre optionnel désactive les demandes de documentation du robot à ce RoboServer.

-sn

--serverName

Il s'agit d'un paramètre facultatif qui définit le nom du serveur pour consigner les statistiques RoboServer, qui est ensuite affiché dans Kofax Analytics for RPA. Si vous ne spécifiez pas le nom du serveur, les statistiques sont collectées en fonction de l'adresse IP du serveur.

-ll

--licenseLimit <arg>

Ce paramètre définit le nombre maximal d'unités de licence qu'un RoboServer peut recevoir.

-client

Spécifie que le RoboServer doit s'exécuter en tant que client d'un cluster de Management Console. Non pris en charge en mode haute disponibilité.

Services disponibles

--service socket:<portNumber>

Spécifie que le RoboServer doit s'exécuter en tant que service d'un cluster de Management Console.

<portNumber> : Le numéro de port du service connecteur sur lequel écouter.

--service ssl:<portNumber>

Spécifie que RoboServer doit s'exécuter en tant que service d'un cluster Management Console et crée une connexion sécurisée.

<portNumber> : Le numéro de port du service connecteur sur lequel écouter.

--service jmx:<jmx_port_Number>,<jmx_rmi_url>

<jmx_port_Number> : Numéro de port pour le service JMX sur lequel écouter.

<jmx_rmi_url>: Hôte et port RMI optionnels pour le service JMX. À utiliser si vous devez vous connecter à travers un pare-feu.

Exemple : exemple.com:51001

Pour définir le type de connexion entre le RoboServer et la Management Console, sélectionnez l'un des paramètres suivants :

  • -client

  • --service socket:<portNumber>

  • --service ssl:<portNumber>

Exemples de lignes de commande qui connectent le RoboServer :

  • En tant que client d'un cluster de Management Console :

    -client -mcUrl http://localhost:8080/ManagementConsole -cluster <clientCluster> -ss <MC Shared Secret>
    clientCluster est le nom du cluster du type Connexion client créé dans la Management Console.

  • En tant que service à un cluster de Management Console :

    -service socket:50000 -mcUrl http://localhost:8080/ManagementConsole -cluster <serviceCluster> -ss <MC Shared Secret>
    <serviceCluster> est le nom du cluster du type Connexion de service créé dans la Management Console.
Pour définir le code secret partagé, vous pouvez utiliser l'application Paramètres de RoboServer. Pour obtenir plus d'informations, voir Configuration de RoboServer et Authentification du service.

À partir de Kofax RPA version 10, tous les RoboServers doivent s'enregistrer automatiquement sur la Management Console. Par conséquent, l'URL et le code secret partagé de la Management Console ainsi que le nom de cluster doivent être spécifiés au démarrage de la Management Console (soit sur la ligne de commande comme dans l'exemple suivant, soit en utilisant l'application Paramètres de RoboServer dans l'onglet Général, sous l'option S'inscrire sur une Management Console).

RoboServer.exe -mcUrl http://monserveur:8080/ManagementConsole -ss <code secret partagé MC> -cluster Production -service socket:50000

Démarrage automatique des serveurs

Si votre installation comprend une fonctionnalité de serveur, vous pouvez la configurer pour qu'elle démarre automatiquement les serveurs.

Par « fonctionnalité du serveur », on entend RoboServers et Management Console (serveur de licences). En fait, ces deux fonctionnalités sont fournies par le même programme serveur, RoboServer, en fonction des arguments qui lui sont fournis au démarrage.

La section Paramètres de RoboServer contient une description détaillée des arguments de la ligne de commande du programme RoboServer. Pour permettre au programme RoboServer d'exécuter des robots, spécifiez l'argument -service. De même, l'argument -MC permet d'activer la fonctionnalité Management Console (voir Management Console (Serveur de licences) dans le Guide d'installation).

Pour plus d'informations sur le démarrage de RoboServer et des autres composants RPA comme des services, voir « Exécuter les composants RPA en tant que services » dans le Guide de l'administrateur Kofax RPA.

Fermer le RoboServer

RoboServer peut être fermé à l'aide de l'outil de ligne de commande suivant. Exécutez ShutDownRoboServer sans arguments pour voir les différentes options permettant d'arrêter le serveur, en particulier comment gérer les robots actuellement exécutés sur le serveur.