Lire et examiner la documentation Automation Anywhere

Fermer les contenus

Contenus

Ouvrir les contenus

API d'exportation et d'importation de robots pour la gestion du cycle de vie des robots

  • Mis à jour le : 5/10/2019
    • 11.3.x
    • Gestion
    • Enterprise
    • Docs API

API d'exportation et d'importation de robots pour la gestion du cycle de vie des robots

Les API d'exportation et d'importation de robot :s permettent de personnaliser la solution de gestion du cycle de vie des robot :s d'une organisation pour assurer une automation sans interruption.

En général, l'utilisateur de la Enterprise Control Room doit compter sur d'autres moyens que la Enterprise Control Room (par exemple, l'e-mail) pour déployer des Robot de tâchess d'un environnement à un autre. À l'aide des API d'exportation/importation, vous pouvez facilement introduire une solution de Gestion du cycle de vie des robots (BLM) personnalisée, ce qui élimine tous les facteurs externes susceptibles de perturber le cycle de vie de l'automatisation.

En tant qu'utilisateur de la Enterprise Control Room disposant de l'autorisation d'exportation de robots et de téléchargement de robots, vous pouvez exporter un robot et ses fichiers dépendants. De même, en tant qu'utilisateur disposant de l'autorisation d'importation de robots et de chargement de robots, vous pouvez importer ce robot et ses fichiers dépendants.

Par exemple, vous pouvez déplacer les robot :s validés comme étant prêts pour la production de la phase de préproduction à la phase de production.

Vous pouvez utiliser l'API REST d'exportation/importation de la Enterprise Control Room pour gérer les Robot de tâchess d'automatisation, notamment les fichiers dépendants dans différents environnements (développement, test, acceptation et production) en fonction des besoins de votre organisation en matière d'automatisation.

Reportez-vous aux articles relatifs aux robots d'exportation et d'importation pour utiliser les fonctionnalités de l'interface utilisateur de la Enterprise Control Room.

Fonctionnalités et avantages

  • Contrôle d'accès sur Gestion du cycle de vie des robots en fonction des rôles
  • Exportation automatique des dépendances (fichiers et robots)
  • Audit et traçabilité sur l'environnement source et cible pour garantir la conformité
  • Notification par e-mail en cas de réussite ou d'échec de l'exportation et de l'importation

Exporter

  • L'utilisateur de la Enterprise Control Room dont les informations d'identification sont utilisées pour l'authentification doit disposer de l'autorisation Exporter des robots
  • L'utilisateur de la Enterprise Control Room, dont les informations d'identification sont utilisées pour l'authentification, doit disposer de l'autorisation Télécharger sur les robot :s, de l'autorisation minimale Exécuter sur les Méta robots, ainsi que sur les dépendances en cours d'exportation.
  • Si le contrôle de version est activé dans la Enterprise Control Room source, la version de production des robots et des dépendances à exporter doit être définie.
  • Le compte d'utilisateur utilisé pour exécuter les services de la Enterprise Control Room doit avoir accès à l'emplacement où le package est exporté, par exemple l'emplacement réseau (lecteur partagé) ou le serveur de la Enterprise Control Room.

Importer

  • L'utilisateur de la Enterprise Control Room dont les informations d'identification sont utilisées pour l'authentification doit disposer de l'autorisation Importer des robots.
  • L'utilisateur de la Enterprise Control Room dont les informations d'identification sont utilisées pour l'authentification doit disposer de l'autorisation Télécharger sur les robot :s et les dépendances en cours d'importation.
  • L'utilisateur de la Enterprise Control Room qui exécute l'utilitaire pour importer plusieurs robots doit avoir accès au fichier de package exporté fourni par Automation Anywhere.

Points de terminaison de l'API

  • Exportation : <Enterprise Control Room URL>/v1/blm/export

    Par exemple, https://crdevenv.com:81/v1/alm/export

  • Importation : <Enterprise Control Room URL>/v1/blm/import

    Par exemple, https://crtestenv.com:82/v1/alm/import

En utilisant les points de terminaison ci-dessus de l'API d'importation/exportation BLM, vous pouvez exporter et importer un seul robot et toutes ses dépendances.

Exporter un robot

Exportez un seul robot avec ses fichiers dépendants à l'aide de l'API d'exportation fournie par Automation Anywhere :

  1. Utilisez la méthode POST pour générer un jeton à l'aide du point de terminaison http(s)://<hostname:port>/v1/authentication. Pour cela, fournissez l'instance de la Enterprise Control Room à savoir Nom du serveur / Nom d'hôte / IP et numéro de port.

    Par exemple, https://crdevenv.com:81/v1/authentication

  2. Utilisez la méthode POST et indiquez les paramètres des informations d'identification dans les données du corps. Reportez-vous à l'exemple :

    {

    "username":"cradmin",

    "password":"cr@admin"

    }

  3. Cliquez sur Lire/Démarrer.
  4. L'API d'exportation BLM utilise le jeton d'authentification obtenu à l'aide de l'API d'authentification. Le jeton d'authentification doit être transmis en tant qu'une des entrées d'en-tête à l'API d'exportation BLM.
  5. Renseignez les paramètres filePath, destinationPath et packageName dans les données du corps pour exporter un robot :. La liste suivante fournit la description des paramètres :
    • filePath : ce paramètre permet d'indiquer le chemin d'accès au fichier qui se termine par le nom du robot à exporter
    • destinationPath : ce paramètre permet d'indiquer le chemin de destination où le package exporté doit être stocké
    • packageName : ce paramètre permet d'indiquer le nom à affecter au package exporté

      Reportez-vous à l'exemple :

      {

      "filePath":"Automation Anywhere\\My Tasks\\Finance\\Account Reconciliation.atmx",

      "destinationPath":"tempshare\\datashare\\Finance Department",

      "packageName":"Finance package"

      }

  6. Cliquez sur Lire/Démarrer.
  7. Vous pouvez utiliser plusieurs sources pour afficher les résultats de l'exportation :
    • les données de la réponse qui comprennent les paramètres packagePath et checksum ;
    • des pages du journal d'audit (page de destination et page d'informations) ;
    • un e-mail lorsque vous recevez une notification de succès ou d'échec, si l'option est configurée.

Importer un robot

Une fois que le robot : a été exporté vers un lecteur réseau ou le chemin d'accès de la machine de la Enterprise Control Room, un autre utilisateur autorisé peut importer ce package vers une autre Enterprise Control Room à l'aide de l'API d'importation.

  1. Utilisez la méthode POST pour générer un jeton à l'aide du point de terminaison http(s)://<hostname:port>/v1/authentication. Entrez l'instance de la Enterprise Control Room sous la forme Nom du serveur / Nom d'hôte / IP et le numéro de port.

    Par exemple, https://crtestenv.com:82/v1/authentication

  2. Utilisez la méthode POST et indiquez les paramètres des informations d'identification dans les données du corps.

    Reportez-vous à l'exemple :

    {

    "username":"cradmin2",

    "password":"cr@admin"

    }

  3. Cliquez sur Lire/Démarrer.
  4. L'API d'importation BLM utilise le jeton d'authentification obtenu à l'aide de l'API d'authentification. Le jeton d'authentification doit être transmis en tant qu'une des entrées d'en-tête à l'API d'importation BLM.
  5. Lorsque les informations d'identification ont été authentifiées, renseignez les paramètres tels que package path et checksum générés sous forme de jetons lors de l'exportation dans les données du corps.

    Reportez-vous à l'exemple :

    {

    "packagePath":"tempshare\\datashare\\Finance Department\\Finance Package_20171221-154403.aapkg",

    "checksum":"ZLyQ+Lbu2N+beEuXf6qd2Qi9uwi3BZxApn57C7mYjKQ="

    }

Conseil : Vous pouvez copier la réponse de l'API d'exportation BLM et la transférer directement sous la forme d'une entrée à l'API d'importation BLM si le chemin d'accès au package est identique et accessible à l'utilisateur de l'API d'importation BLM.

Codes de réponse de l'API

Code d'état Http(s) Réponse - Description Action corrective
200 Package créé avec succès NA
400 Paramètre de demande non valide Réessayer avec des paramètres valides
404 Fichier introuvable Assurez-vous que le fichier/robot est présent dans la Enterprise Control Room
501 Erreur d'autorisation Assurez-vous de disposer de l'autorisation d'exportation/importation de robots ou de chargement/téléchargement

Utilitaire API d'exportation et d'importation

Pour exporter et importer plusieurs robots, vous pouvez utiliser l'utilitaire fourni par Automation Anywhere qui comprend des fichiers batch et jar*.

*Java version 1.8 et supérieure.

Exportation de robots

Vous pouvez exporter plusieurs robots depuis un référentiel de la Enterprise Control Room à l'aide de l'utilitaire d'exportation de la solution de gestion du cycle de vie des robots (BLM) de la Enterprise Control Room. La méthode pour exporter des Robot de tâchess à partir du référentiel de la Enterprise Control Room à l'aide d'un fichier batch est expliquée ci-dessous :

  1. Ouvrez le fichier batch d'exportation BLM, qui comprend les commandes et les paramètres de l'API nécessaires à l'exportation des robot :s depuis la Enterprise Control Room. Ce fichier fournit également des exemples de paramètres pour faciliter l'utilisation.
    Remarque : Cet utilitaire utilise l'API d'exportation BLM, en arrière-plan pour exporter plusieurs robot :s. Reportez-vous aux conditions préalables. Fichier batch d'exportation BLM
    Conseil : Il est recommandé de créer une copie du fichier batch avant de commencer le processus d'exportation.
  2. Vous devez à présent fournir les paramètres suivants dans le fichier pour exporter les Robot de tâchess et les fichiers dépendants :
    • Une instance de la Enterprise Control Room en tant que paramètre source_CR.

      Par exemple, http://stagingCR-mydomain.com:8081/

    • Vos informations d'identification de connexion à la Enterprise Control Room, à savoir les paramètres username et password.

      Par exemple, username: Mike, password: Mike@123

    • Les noms de fichiers des Robot de tâchess en tant que paramètre export_files. Vous pouvez spécifier les robot :s/fichiers séparés par une virgule.

      Par exemple, Automation Anywhere\My Tasks\\Finance Bots\\Account Reconciliation_master.atmx,Automation Anywhere\\My Tasks\\Finance REM Bots\\Comparison Data.atmx

    • Le nom du chemin de référentiel des Robot de tâchess en tant que paramètre export_directories. Cette option permet d'exporter un grand nombre de robot :s depuis des dossiers.

      Par exemple, Automation Anywhere\\My Tasks\\Utilities Bots\\312018, Automation Anywhere\\My Tasks\\Sample Tasks\\Analytics Tasks

    • Les noms de fichier CSV avec leur chemin d'accès en tant que paramètre export_CSVs. Utilisez cette option si vous voulez exporter des robot :s/fichiers depuis un fichier .csv/.txt. externe.
      • Vous pouvez combiner des noms de fichiers, des répertoires et des fichiers csv pour exporter plusieurs fichiers à partir de plusieurs sources.

        Par exemple, Automation Anywhere\My Tasks\Finance\Bank Account Reconciliation.atmx, Automation Anywhere\My Tasks\Banking\Audit Certification Generation.atmx, Automation Anywhere\My Méta robots\Import Customer Data.mbot, Automation Anywhere\My Docs\daily sales data.xlsx

      • Vous devez transmettre au moins un paramètre et laisser les valeurs vides pour ceux qui ne sont pas requis.

        Par exemple, SET export_CSVs=""

    • Nom du package en tant que paramètre package_name. Ce fichier est enregistré sous forme compressée et sera utilisé pour importer les robot :s dans une autre instance de la Enterprise Control Room.

      Par exemple, Bank Account Reconciliation

    • Chemin de destination du package en tant que paramètre package_path.
      Remarque : Il peut s'agir d'un lecteur partagé ou du chemin d'accès à la machine de la Enterprise Control Room pour lequel l'utilisateur du service de la Enterprise Control Room doit disposer de l'autorisation en écriture.
      Par exemple,\\\\network_share\\BLM Export Packages
  3. Exécutez le fichier batch pour lancer la commande d'exportation.
  4. Vérifiez que le package est créé à l'emplacement spécifié en tant que paramètre package_path.

    Ce package sera utilisé par l'utilisateur de la Enterprise Control Room pour importer les robot :s dans une autre instance de la Enterprise Control Room.

Exemple de code

SET source_CR=<Enterprise Control Room URL>

SET username=<Enterprise Control Room Username>

SET password=<Enterprise Control Room Password>

SET export_files="<Comma separated list of bots to be exported>"

SET export_directories="<Comma separated list of directories to be exported>"

SET export_CSVs="<Comma separated list of CSVs whose content are to be exported>"

SET package_name=<Name of the export package>

SET package_path=<Path at which package will be exported>

java -jar %utility_path% -Oexport -H%source_CR% -U%username% -P%password% -N%package_name% -K%package_path% -F%export_files% -D%package_path% -C%export_CSVs%

pause

@Écho off

REM *****************************EXEMPLES DE PARAMÈTRES***************************************

REM SET source_CR=http://123.456.78.90:8080

REM SET username=Mike

REM SET password=Mike@123

REM SET export_files="Automation Anywhere\\My Tasks\\Finance Bots\\Account Reconciliation_master.atmx,Automation Anywhere\\My Tasks\\Finance REM Bots\\Comparison Data.atmx"

REM SET export_directories="Automation Anywhere\\My Tasks\\Utilities Bots\\312018"

REM SET export_CSVs="D:\BLM\Account Reconciliation Bots.csv"

REM SET package_name=Bank Account Reconciliation

REM SET package_path=\\\\network_share\\BLM Export Packages

REM SET utility_path=D:\BLM\BLM_Export_Import_Utility-1.0.jar

Importation de robots

Vous pouvez importer plusieurs robots dans un référentiel de la Enterprise Control Room à l'aide de l'utilitaire d'importation de la solution de gestion du cycle de vie des robots (BLM) de la Enterprise Control Room. La méthode pour importer des Robot de tâchess dans le référentiel de la Enterprise Control Room à l'aide du fichier batch est expliquée ci-dessous :

  1. Ouvrez le fichier batch d'importation BLM qui comprend les commandes et les paramètres de l'API nécessaires à l'importation des robot :s dans la Enterprise Control Room. Ce fichier fournit également des exemples de paramètres pour faciliter l'utilisation.
    Conseil : Il est recommandé de créer une copie du fichier batch avant de lancer le processus d'importation.
  2. Vous devez à présent fournir les paramètres suivants dans le fichier pour importer les Robot de tâchess et les fichiers dépendants :
    1. L'instance de la Enterprise Control Room cible en tant que paramètre target_CR.

      Par exemple, http://prodCR-mydomain.com:80/

    2. Vos informations d'identification de connexion à la Enterprise Control Room en tant que paramètres username et password.

      Par exemple, username: John.Smith, password: John@123

    3. Le nom du chemin absolu du package d'exportation en tant que paramètre package_path.

      Par exemple, \\\\network_share\\BLM Export Packages

  3. Exécutez le fichier batch pour lancer la commande d'importation.
  4. Vous pouvez vérifier que les robot :s sont importés dans le référentiel des robot :s de la Enterprise Control Room depuis la liste des robot :s/fichiers exportés ou importés dans le fichier BLM Logs.log. Ce fichier est enregistré dans le même dossier que l'utilitaire (fichier .jar).

Exemple de code

SET target_CR = <Target Enterprise Control Room URL>

SET username=<Enterprise Control Room Username>

SET password=<Enterprise Control Room Password>

SET package_path=<Absolute path of the export package>

java -jar %utility_path% -Oimport -S%package_path% -U%username% -P%password% -H%target_CR%

pause

@Écho off

REM *****************************EXEMPLES DE PARAMÈTRES***************************************

REM SET target_CR=http://987.654.32.10:8080

REM SET username=John

REM SET password=John@123

REM SET package_path=\\\\network_share\\BLM Export Packages

REM SET utility_path=D:\BLM\BLM_Export_Import_Utility-1.0.jar

Journaux d'audit

Une entrée d'audit est consignée dans la page Journal d'audit de la Enterprise Control Room lorsque vous exportez ou importez des robots.

Envoyer le commentaire