Commandes de ressource machine Blue Prism
Ce document contient une liste des commandes disponibles lors de la communication avec l'écouteur de ressource machine Blue Prism. Ces commandes sont utilisées par Blue Prism pour ses communications réseau et sont disponibles pour les clients tiers via une interface HTTP.
Utilisation recommandée
Lors de l'apprentissage de ces commandes, il est intéressant de les tester pendant la lecture du document. Vous pouvez procéder de la manière suivante :
- Démarrez un écouteur de ressource machine Blue Prism à l'aide de la commande :
automate.exe /public /resourcepc
telnet localhost 8181
Référence des commandes
Autorisation : Authentifié
Utilise l'authentification du jeton pour créer une session en attente avec un ID de processus donné : « createas <token> <procid> », créer une session en attente pour une file d'attente donnée avec un ID de processus donné : « createas <token> <procid> <queueident> » ou créer une session en attente en utilisant le nom du processus : « createas name <token> <name> ». La réponse est « SESSION CRÉÉE : <sessionid> » ou un code d'erreur.
Autorisation : Authentifié
Utilise l'authentification du jeton pour supprimer une session en attente : « deleteas <token> <sessionid> ». La réponse est « SESSION SUPPRIMÉE » ou un code d'erreur.
Autorisation : Authentifié
Utilise l'authentification du jeton pour démarrer une session : « startas <token> <sessionid> » ou démarrer la dernière session créée sur cette connexion : « startas last <token> ». La réponse est « DÉMARRÉE » ou un code d'erreur.
Autorisation : Toute
Obtenez un jeton d'autorisation à l'aide des identifiants fournis. Utilisez « getauthtoken <userid> <password> » Cette méthode est disponible pour les solutions personnalisées conçues pour les réseaux sécurisés. Elle n'est pas utilisée par Blue Prism dans le cadre d'opérations normales.
Autorisation : Authentifié
« action <sessionid> <actionname> » pour exécuter une action sur la session spécifiée ou « action last <actionname> » pour exécuter une action sur la dernière session créée sur cette connexion. La réponse est « DÉMARRÉE » ou un code d'erreur.
Autorisation : Authentifié ou Local
Indique la disponibilité actuelle de cette ressource machine pour exécuter davantage de processus. La réponse est « DISPONIBILITÉ:niveau » dans laquelle « niveau » est l'une des quatre valeurs suivantes :
Aucun : indique qu'aucun processus ne peut être exécuté pour le moment, car un processus exclusif est déjà en cours d'exécution (ou en attente).
Arrière-plan : indique que seul un processus d'arrière-plan peut être exécuté, car il existe déjà un processus de premier plan (ou en attente).
Premier plan : indique qu'un processus d'arrière-plan ou de premier plan peut être exécuté, car aucun processus de premier plan ou exclusif n'est en cours d'exécution (ou en attente).
Exclusif : indique que n'importe quel type de processus peut être exécuté (y compris un processus exclusif), car aucun processus n'est en cours d'exécution (ou en attente).
Autorisation : Authentifié ou Local
Vérifiez si des sessions sont en attente/cours d'exécution. Répond oui ou non.
Autorisation : Authentifié
Obtenir des capacités de ressources
Autorisation : Authentifié ou Local
Obtenez une liste des connexions actives impliquant cette ressource machine. Cette liste est divisée en deux sections, intitulées ENTRANTE et SORTANTE. La liste entrante affiche les connexions à cette ressource (comme adresse distante et nom d'utilisateur authentifié) et la liste sortante affiche les connexions ouvertes par cette ressource aux autres ressources (aucune, à moins que la ressource soit un contrôleur de pool).
Autorisation : Authentifié
Signifie qu'il s'agit d'une connexion du contrôleur d'un pool. Cette commande est utilisée en interne entre les ressources machines uniquement.
Autorisation : Authentifié
« create <procid> » pour créer une session en attente avec un ID de processus donné, « create <procid> <queueident> » pour créer une session en attente pour une file d'attente donnée avec un ID de processus donné ou « create name <name> » pour créer une session en attente en utilisant le nom du processus. La réponse est « SESSION CRÉÉE : <session id> » ou un code d'erreur. Utilisez createas à la place lorsque la gestion des sessions appliquant les permissions de contrôle des réglages utilisateur est activée
Autorisation : Authentifié
Supprimez une session en attente - « delete <sessionid> ». Utilisez deleteas à la place lorsque la gestion des sessions appliquant les permissions de contrôle des réglages utilisateur est activée
Autorisation : Authentifié
Utilisez « getparams <sessionid> » pour obtenir les paramètres de démarrage utilisés pour démarrer un processus. Le processus doit déjà être lancé, mais pas nécessairement sur la ressource à partir de laquelle la demande est effectuée. La réponse est PARAMS : suivi des paramètres au format XML, AUCUN si aucun paramètre n'est présent ou bien une description de l'erreur.
Autorisation : Toute
Utilisez « internalauth <token> » pour effectuer l'authentification basée sur un jeton. Cela utilise un jeton à usage unique généré et enregistré dans la base de données pour confirmer l'identité de l'utilisateur qui se connecte, pour atténuer les attaques par détection et relecture et pour permettre une connexion directe dans un environnement AD. Le logiciel Blue Prism n'utilise que cette méthode. Les logiciels autres que Blue Prism peuvent utiliser AutomateC pour générer un jeton.
Autorisation : Authentifié ou Local
Dressez la liste des membres du pool pour lesquels cette ressource machine est le contrôleur. Exemple de réponse :
MEMBRES - 2 9efb8f78-0777-4d28-aaa3-6fbd5da70f36 PC1 21e960d0-140a-488c-b09d-d3d7257bae54 PC2
Les valeurs rapportées sont l'ID et le nom de la ressource.
Autorisation : Authentifié
Utilisez « outputs <sessionid> » (ou « outputs last ») pour obtenir les paramètres de sortie d'un processus ou d'une action effectuée avec succès, ou la raison de l'échec d'un processus ou d'une action qui a échoué. L'exécution d'actions d'objet métier rétablit également l'état inactif de l'objet et doit être utilisée avant qu'une autre action ne soit lancée. La réponse est « SORTIES : » suivi des paramètres de sortie de la session terminée, au format XML.
Autorisation : Toute
Utilisez « password <pwd> » pour terminer l'authentification après une commande « user ». Pour plus d'informations, consultez la documentation sur « user ».
Autorisation : Authentifié ou Local
Renvoie le message « pong ». Utilisé pour les diagnostics.
Autorisation : Authentifié
Déterminez de quel pool cette ressource est membre/contrôleur. La réponse sera « Pas dans un pool », « Contrôleur du <pool name> » ou « Membre de <pool name> ».
Autorisation : Authentifié
Fournit une liste des processus qui peuvent être exécutés. La sortie se présente sous la forme d'un processus par ligne, formaté comme suit :
xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx - Processus un xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx - Processus deux
La valeur du premier champ est l'identificateur unique du processus. Ceci est utilisé en conjonction avec la commande « create » pour créer une session en attente pour un processus.
Autorisation : Authentifié
Définit le userid avec lequel le membre du pool exécutera la session
Autorisation : Toute
Fermez cette session. Le client est déconnecté. Le serveur continue de fonctionner.
Autorisation : Authentifié
setvar <sessionid> [<varname>] type « <value> » « <description> »
Définit la valeur d'une variable de session dans une session. Si l'opération est réussie, la réponse est « DÉFINIE » ou un code d'erreur.
Autorisation : Authentifié ou Local
Fermez la ressource machine. Utilisez le paramètre optionnel « waitforsessions » pour attendre que les sessions en cours d'exécution soient terminées avant de fermer. Utilisez le paramètre « loginagent » pour ignorer la demande d'arrêt si la ressource machine n'est pas utilisée par l'agent d'ouverture de session.
Autorisation : Authentifié
« start <sessionid> » pour démarrer une session ou « start last » pour démarrer la dernière session créée sur cette connexion. La réponse est « DÉMARRÉE » ou un code d'erreur. Utilisez startas à la place lorsque la gestion des sessions appliquant les permissions de contrôle des réglages utilisateur est activée
Autorisation : Authentifié
Définissez les paramètres de démarrage à utiliser pour la session suivante créée sur cette connexion. Les paramètres sont fournis au format XML. La réponse est « PARAMÈTRES DÉFINIS ».
Autorisation : Authentifié ou Local
Récupère une liste des sessions en attente et en cours d'exécution sur la ressource machine. La sortie se présente sous la forme d'une session par ligne, formatée comme suit :
UNITÉ RESSOURCE - EN ATTENTE 9efb8f78-0777-4d28-aaa3-6fbd5da70f36 - EN ATTENTE 21e960d0-140a-488c-b09d-d3d7257bae54 Exécution totale : 2
La valeur du dernier champ est l'identificateur unique de la session.
Autorisation : Authentifié
Utilisez « stop <sessionid> » pour arrêter le processus en cours. Des paramètres supplémentaires optionnels « <userid> <resourceid> » peuvent être spécifiés comme une paire si ces informations doivent être enregistrées dans la session. Le resourceid peut être remplacé par « name <resource name> ». La réponse est « ARRÊT » ou un code d'erreur.
Autorisation : Toute
Démarrez l'authentification basée sur le nom d'utilisateur ou le mot de passe. Utilisez « user <userid> » pour définir l'ID utilisateur ou « user name <name> » pour définir l'utilisateur se servant du nom d'utilisateur. La commande « mot de passe » doit ensuite suivre pour terminer la séquence d'authentification. Cette méthode d'authentification est disponible pour les diagnostics et les solutions personnalisées conçues pour les réseaux sécurisés. Elle n'est pas utilisée par Blue Prism dans le cadre d'opérations normales.
Autorisation : Authentifié
Dressez la liste de tous les utilisateurs. Un utilisateur est affiché par ligne, dans le format suivant :
xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx - Utilisateur un xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx - Utilisateur deux
La valeur du premier champ est l'identificateur unique de l'utilisateur.
Autorisation : Authentifié
Obtient toutes les variables de la session en cours et leurs valeurs pour l'ID de session donné. Exemple de réponse : VARIABLES:2
[CasesWorked] number 212 [Exceptions] number 4
Autorisation : Authentifié
Activez ou désactivez les mises à jour des variables de session. Sélectionnez « activer » ou « désactiver ». La réponse est « DÉFINIE » ou un code d'erreur.
Autorisation : Toute
Obtenir des informations sur la version, la réponse est le numéro de version du protocole interne.