Flux dans VS Code

Installez et configurez l'extension UiPath pour Visual Studio Code pour créer, déboguer et déployer des flux à partir de votre espace de travail local.

De quoi il s'agit

L'extension UiPath pour Visual Studio Code vous permet de créer, de déboguer et de déployer des flux à partir de VS Code. Elle fournit un éditeur visuel pour les fichiers .flow , vous connecte à UiPath, et empaquète et publie votre travail sur Orchestrator.

La zone de dessin, les nœuds, les variables et le débogage fonctionnent de la même manière que dans Studio Web. Cette page couvre les spécificités de VS Code: l’installation de l’extension, la connexion et la création du package à partir de votre espace de travail local. Pour savoir comment créer des flux, consultez le reste de ce guide, en commençant par votre premier flux.

Avant de commencer

Vous avez besoin des éléments suivants:

• Code VS 1.110.0 ou supérieur.
• Un compte UiPath.
• Node.js et npm disponibles sur votre PATH Lors de la première connexion, l'extension installe la UiPath CLI (uip) avec npm (npm install -g @uipath/cli@1.0.0).
• Accès au réseau de votre environnement UiPath.

Remarque :

Dans les espaces de travail distants (sous-système Windows pour Linux, SSH, espaces de code ou conteneurs de développement), l'extension s'exécute sur l'hôte distant. La UiPath CLI doit être installée là, et non sur votre machine locale.

Installer l’extension

1. Installez UiPath Maestro à partir de la VS Code Marketplace ou du registre Open VSX.
2. Recharger VS Code lorsque vous y êtes invité.
3. Sélectionnez l’icône UiPath dans la barre d’activité pour ouvrir la vue UiPath.

La vue UiPath comporte trois sections:

• Connect affiche votre statut de connexion, votre environnement et votre locataire.
• L'explorateur de solutions répertorie les solutions, les projets et les flux dans votre espace de travail.
• Ressources répertorie les dossiers et les ressources Orchestrator pour le locataire sélectionné une fois que vous vous connectez.

Se connecter

L'extension vous connecte en processus à l'aide de la bibliothèque d'authentification UiPath groupée pour exécuter un flux de navigateur OAuth/Proof Key pour Code Exchange. L’extension ne stocke jamais vos jetons.

1. Dans la section Se connecter , sélectionnez Se connecter.
2. Si la CLI n’est pas encore installée, acceptez l’invite pour l’installer. L'extension exécute npm install -g @uipath/cli@1.0.0.
3. Votre navigateur s’ouvre pour terminer la connexion. La bibliothèque d'authentification reçoit le rappel sur le port localhost 8104.
4. Après votre autorisation, revenez à VS Code. Votre session s’actualise automatiquement à partir de ce moment.

Pour vous déconnecter, sélectionnez Sign Out (Déconnexion) dans la section Connecter . Cela vous déconnecte du processus et efface la session mise en cache.

Remarque :

La connexion utilise le port 8104 sur localhost pour le rappel OAuth. Si la connexion échoue, un processus obsolète peut contenir le port. Libérez-le et réessayez. Sur macOS ou Linux, exécutez lsof -ti :8104 | xargs kill -9. Sur Windows, exécutez netstat -ano | findstr :8104 pour trouver l'ID du processus, puis taskkill /F /PID <id>.

Sélectionnez votre environnement et votre locataire

Une fois connecté, choisissez où vous travaillez.

1. Exécuter UiPath: sélectionnez Environnement pour confirmer votre environnement. La valeur par défaut est Cloud.
2. Exécuter UiPath: sélectionnez Locataire pour choisir votre locataire ou votre organisation.

La section Ressources vous permet ensuite de parcourir les dossiers et les ressources pour le locataire sélectionné.

Résultat: la section Ressources est renseignée avec les dossiers et les ressources Orchestrator pour votre locataire sélectionné.

Créer ou ouvrir un flux

• Exécutez Flux: nouveau flux (Ctrl/Cmd+Alt+N) pour créer un nouveau fichier .flow .
• Ouvrez un fichier .flow existant à partir de l'Explorateur, ou exécutez Flux: Ouvrir Flux (Ctrl/Cmd+Alt+O).
• Lorsqu'une solution est ouverte, sélectionnez Ajouter un flux dans la barre de titre de l'explorateur de solutions pour ajouter un flux au projet actif.

Le fichier s'ouvre dans l'éditeur de flux visuels. Créez, connectez des nœuds et configurez-les exactement comme vous le feriez dans Studio Web.

Créer le package et déployer

Vous publiez à partir de VS Code en empaquetant votre espace de travail en tant que solution UiPath et en le déployant sur Orchestrator. Référez-vous à Déployer un flux pour connaître le déploiement.

• UiPath: le package crée une solution .uipx à partir de l'espace de travail actuel.
• UiPath: le déploiement télécharge une solution packagée dans Orchestrator.
• UiPath: Package et déploiement exécute les deux étapes ensemble.
• UiPath: changer de cible de déploiement modifie le dossier de destination.

Par défaut, l'extension active le déploiement après un déploiement réussi. Pour déployer sans activer, désactivez le paramètre uipath.autoActivateDeployment .

Pour exécuter le même package à partir de la UiPath CLI, exécutez UiPath: Generate.env File. Cela va saisir un fichier .env compatible avec uip.

Débogage

Le débogage dans VS Code achemine vers votre locataire Cloud sélectionné. Exécutez un flux depuis l'éditeur et regardez l'exécution dans la vue de débogage en direct, qui génère un organigramme d'exécution Si mesure qui se met à jour au fur et à mesure de la progression de l'exécution. Reportez-vous à la section Déboguer efficacement pour savoir comment lire une exécution et résoudre les défaillances.

Commandes et raccourcis clavier

Exécutez n'importe quelle commande de la Palette de commandes (Ctrl/Cmd+Shift+P). Les raccourcis de l'éditeur de flux s'appliquent uniquement lorsqu'un fichier .flow est l'éditeur actif.

Éditeur de flux

Commande	Liaison par défaut
Flux: nouveau flux	Ctrl/Cmd+Alt+N
Flux: Ouvrir le flux	Ctrl/Cmd+Alt+O
Flux: Enregistrer le flux	Ctrl/Cmd+S
Flux: Enregistrer le flux sous	Ctrl/Cmd+Shift+S
Flux: Annuler	Ctrl/Cmd+Z
Flux: Rétablir	Ctrl+Y / Cmd+Shift+Z
Flux: Zoom avant	Ctrl/Cmd+=
Flux: Zoom arrière	Ctrl/Cmd+-
Flux: Réinitialiser Zoom	Ctrl/Cmd+0
Flux: Ajuster à l'écran	Ctrl/Cmd+Shift+F
Flux: Valider le flux	Ctrl/Cmd+Shift+V
Flux: exporter le flux	Aucun (None)

UiPath Platform

Commande	Description
UiPath : se connecter	Connectez-vous à UiPath.
UiPath: se déconnecter	Déconnectez-vous et effacez la session mise en cache.
UiPath: sélectionnez l'environnement	Choisissez l'environnement UiPath.
UiPath: sélectionnez un locataire	Choisissez le locataire ou l’organisation.
UiPath: Package	Créez une .uipx solution à partir de l'espace de travail.
UiPath: Déployer	Chargez une solution packagée dans Orchestrator.
UiPath: package et déploiement	Empaquetez et déployez en une seule étape.
UiPath: changer de cible de déploiement	Modifiez le dossier de destination.
UiPath: Générer un fichier.env Fichier	Écrivez un fichier .env compatible CLI.
UiPath: actualiser	Actualiser l’arborescence Connecter.
UiPath: Afficher le journal de sortie	Ouvrez le canal de sortie UiPath.
UiPath: Premiers pas	Ouvrez la présentation pas à pas.

Pour obtenir l’ensemble complet de raccourcis de zone de dessin, consultez la section Raccourcis clavier.

Paramètres

Configurez l'extension dans les paramètres VS Code.

uipath.environment

L’environnement UiPath utilisé lors de la connexion. La valeur par défaut est cloud. Une session CLI existante est prioritaire si elle pointe vers un autre emplacement.

uipath.autoActivateDeployment

Active le déploiement d’une solution après un déploiement réussi. La valeur par défaut est true.

uipath.cli.path

Un chemin absolu vers le fichier binaire de la UiPath CLI (uip). Laissez ce champ vide pour trouver uip sur votre PATH. Définissez ce paramètre lorsque la CLI est installée à un emplacement qui ne se trouve pas sur votre PATH.

uipath.telemetry.enabled

Envoie une télémétrie d’utilisation anonymisée. La valeur par défaut est true. L'extension respecte également telemetry.telemetryLevel globale de VS Code. La désactivation de l'un ou l'autre des paramètres désactive la télémétrie.

Résolution des problèmes

La connexion échoue

La connexion échoue lorsque le port de rappel OAuth est occupé ou que la CLI a perdu sa session.

• Port en cours d'utilisation. La CLI utilise le port 8104 sur localhost pour le rappel. Si un processus obsolète le détient, libérez le port et reconnectez-vous. Sur macOS ou Linux, exécutez lsof -ti :8104 | xargs kill -9. Sur Windows, exécutez netstat -ano | findstr :8104, puis taskkill /F /PID <id>.
• Session obsolète. Exécutez UiPath: Déconnectez-vous, puis UiPath: Se connecter à nouveau pour forcer une nouvelle connexion.
• Lisez le journal. Exécutez UiPath: Afficher le journal de sortie et vérifiez le canal de sortie UiPath pour les erreurs de connexion.

La CLI est introuvable

L'extension se développe au niveau de uip. Si le fichier binaire ne peut pas être trouvé, la connexion et le packaging échoueront.

1. Confirmez que la CLI est installée en exécutant uip --version dans un terminal.
2. Si uip ne se trouve pas sur votre PATH, définissez uipath.cli.path sur le chemin absolu du fichier binaire.
3. Si la CLI n’est pas du tout installée, exécutez UiPath: connectez-vous et acceptez l’invite d’installation, ou installez-la manuellement avec npm install -g @uipath/cli@1.0.0 Cela nécessite Node.js et npm sur votre PATH.

Les espaces de travail distants ne voient pas la CLI

Dans WSL, SSH, les espaces de code et les espaces de travail de conteneur de développement, l'extension s'exécute sur l'hôte distant, et non sur votre machine locale. Le binaire uip doit être installé sur cet hôte. Une CLI installée sur votre machine Windows ou macOS locale n'est pas visible par l'extension. Installez la CLI dans l’espace de travail distant, puis reconnectez-vous.

Le déploiement ne s’active pas

Par défaut, l'extension active un déploiement après un déploiement réussi. Si un déploiement effectue le téléchargement mais ne s'active pas, confirmez que uipath.autoActivateDeployment est activé.

Pages liées

• Votre premier flux
• Déployer un flux
• Déboguer efficacement