Lire et examiner la documentation Automation Anywhere

Fermer les contenus

Contenus

Ouvrir les contenus

API d'exportation et importation d'une configuration de la gestion de la charge de travail

  • Mis à jour le : 5/10/2019

    API d'exportation et importation d'une configuration de la gestion de la charge de travail

    En tant qu'administrateur ou utilisateur de la Enterprise Control Room disposant des autorisations d'exportation et importation de robot :s, vous pouvez exporter et importer la configuration de la charge de travail afin de déplacer des configurations validées d'un environnement à un autre.

    Par exemple, vous pouvez déplacer les files d'attente ayant été vérifiées comme étant prêtes 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 l'automatisation dans différents environnements, tels que le développement, le test, l'acceptation et la production en fonction des besoins en automatisation de votre organisation.

    Fonctionnalités et avantages

    • Contrôle d'accès basé sur les rôles dans le module de gestion de la charge de travail
    • Audit et traçabilité sur l'environnement source et cible pour garantir la conformité

    Prérequis

    Exportation

    • L'utilisateur de la Enterprise Control Room dont les informations d'identification sont utilisées pour l'authentification doit être administrateur ou disposer de l'autorisation Exporter des robots
    • Pour pouvoir exporter une file d'attente, l'utilisateur de la Enterprise Control Room doit en être l'administrateur ou le propriétaire.
    • Les détails des propriétaires, consommateurs et participants de la file d'attente ne faisant pas partie de l'exportation, vous devez les ajouter manuellement après l'importation, le cas échéant.
    • Le compte d'utilisateur utilisé pour exécuter les services de la Enterprise Control Room doit disposer de l'autorisation d'accès en lecture/écriture au dossier dans lequel le package est exporté, c'est-à-dire le chemin d'accès à l'application, qui peut être un emplacement réseau (lecteur partagé) ou une machine locale.

      Par exemple :

      C:\Users\Public\Documents\Server Files\wlm-files\export

    • Un maximum de 200 files d'attente peut être exporté dans un package.
    • Les files d'attente en mode brouillon ne peuvent pas être exportées.
    • Toute l'opération d'exportation échouera si l'une des exportations de file d'attente échoue.

    Importation

    • 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'administrateur de la file d'attente de la Enterprise Control Room peut importer toutes les files d'attente.
    • L'utilisateur de la Enterprise Control Room qui utilise les API pour importer plusieurs robots doit disposer de l'autorisation d'accès en lecture/écriture au dossier dans lequel le fichier de package exporté doit être fourni par Automation Anywhere, c'est-à-dire le chemin d'accès à l'application qui peut être un emplacement réseau (lecteur partagé) ou une machine locale.

      Par exemple :

      C:\Users\Public\Documents\Server Files\wlm-files\import

    • L'utilisateur qui importe le package devient le propriétaire de la file d'attente importée par défaut. Ajoutez manuellement des participants, consommateurs ou propriétaires supplémentaires aux files d'attente importées, le cas échéant.
    • Si une catégorie de file d'attente est déjà créée par une importation précédente, les importations suivantes utiliseront cette catégorie de file d'attente tant que tous les noms et types de colonne correspondent.

    Points de terminaison de l'API

    1. Exportation : <Enterprise Control Room URL>/v1/wlm/queues

      Par exemple, https://crdevenv.com:81/v1/wlm/queues

    2. Importation : <Enterprise Control Room URL>/v1/wlm/queues

      Par exemple :

      https://crtestenv.com:82/v1/wlm/queues

    À l'aide des points de terminaison ci-dessus de l'API d'exportation et importation de configurations de la gestion des charges de travail, vous pouvez exporter et importer des files d'attente.

    Exportation de files d'attente

    Pour exporter des files d'attente à l'aide de l'API d'exportation fournie par Automation Anywhere procédez comme suit :

    1. À l'aide de la méthode POST, générez un jeton au moyen 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.

      Par exemple :

      {

      "username":"Mike.Lee",

      "password":"1234567890"

      }

    3. Cliquez sur Lire/Démarrer/Envoyer.
    4. L'API d'exportation des charges de travail 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 des charges de travail.
    5. Indiquez les paramètres de demande X-Authorization, Accept et queue-ids en en-têtes.

      Par exemple :

      {

      "X-Authorization":"jeton d'autorisation émis par la Enterprise Control Room après la connexion",

      "Accept":"application/json/file",

      "queue-ids":"1,2,3,4,5"

      }

    6. Cliquez sur Lire/Démarrer/Envoyer
    7. L'action est réussie lorsque l'état de la réponse est 200 OK.
    8. Copiez le nom du package à partir du cadre de réponse. Vous pouvez l'utiliser pour importer le package de file d'attente.
      Conseil : Assurez-vous que le package d'importation comporte l'extension appropriée : .wlmpkg

      Par exemple, copiez le nom de fichier saisi dans content-disposition :

      cache-control → no-cache, no-store, max-age=0, must-revalidate

      content-disposition → attachment; filename=WorkloadPackage_20180524_180900.wlmpkg

      content-length → 887

      content-type → application/aapkg

      date → Thu, 24 May 2018 12:39:00 GMT

      expires → 0

      pragma → no-cache

      x-frame-options → SAMEORIGIN

    Importation de files d'attente

    Une fois que le package de file d'attente est exporté vers un lecteur réseau ou un chemin d'accès de 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 pour les informations d'identification dans les données de la demande.

      Reportez-vous à l'exemple :

      {

      "username":"Tom.Watson",

      "password":"1234567890"

      }

    3. Cliquez sur Lire/Démarrer/Envoyer.
    4. L'API d'importation des charges de travail 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 des charges de travail.
    5. Indiquez les paramètres de demande X-Authorization et Content-Type en en-têtes.

      Par exemple :

      "X-Authorization":"jeton d'autorisation émis par la Enterprise Control Room après la connexion",

      "Content-Type":"multipart/form-data"

    6. Maintenant, fournissez les paramètres Content-Disposition: form-data; name="upload"; filename="{file name}" pour importer le package de file d'attente dans le corps de la demande.

      Par exemple :

      Content-Disposition: form-data;

      name="upload"; filename="{WorkloadPackage_20180524_180900.wlmpkg}"

    7. Cliquez sur Lire/Démarrer/Envoyer.
    8. L'action est réussie lorsque l'état de la réponse est 200 OK.

    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 la file d'attente est présente dans la Enterprise Control Room
    501 Erreur d'autorisation Assurez-vous de disposer de l'autorisation requise

    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 files d'attente.

    Envoyer le commentaire