Accès au terminal IRIS : un guide complet pour les utilisateurs de Visual Studio Code

Introduction

Depuis qu'InterSystems a récemment annoncé l'arrêt du support d'InterSystems Studio à partir de la version 2023.2 au profit du développement exclusif d'extensions pour l'IDE Visual Studio Code (VSC), estimant que ce dernier offre une expérience supérieure par rapport à Studio, beaucoup d'entre nous, développeurs, avons changé ou commencé à utiliser VSC. Beaucoup se sont peut-être demandé comment ouvrir le Terminal pour effectuer des opérations, car VSC n'a pas de panneau de sortie comme Studio, ni de fonctionnalité intégrée pour ouvrir le terminal IRIS, sauf en téléchargeant les plugins développés par InterSystems.

Sommaire

• Introduction 
• Solutions
  • Pour les utilisateurs disposant d'au moins IRIS 2020.1 ou IRIS IRIS 2021.1.2 – Utiliser le terminal Web
  • Pour les utilisateurs disposant au minimum d'Iris 2023.2 - Utiliser le terminal WebSocket
  • Pour les utilisateurs avec IRIS basé sur Docker
  • Pour les utilisateurs disposant de versions d'IRIS antérieures à 2023.2 travaillant sur leur ordinateur local
  • Pour les utilisateurs codant sur IRIS basé sur un serveur distant utilisant une connexion SSH

• Solutions

Il existe différentes manières d'ouvrir le terminal dans VSC, en fonction de la configuration spécifique que vous utilisez, j'ai résumé ici les meilleures solutions pour chaque situation :

Pour les utilisateurs disposant d'au moins IRIS 2020.1 ou IRIS IRIS 2021.1.2 – Utiliser le terminal Web
 

Les utilisateurs disposant d'au moins IRIS 2020.1.1 ou IRIS 2021.1.2 et autorisés à installer des extensions externes (certains ne le sont peut-être pas en raison de la politique de leur entreprise concernant les applications tierces) pourraient trouver utile
Web Terminal extension for VSC. Pour ceux qui ne connaissent pas, le Web Terminal est un terminal Web pour les produits InterSystems construits avec ObjectScript (par exemple, IRIS, Caché, Ensemble, HealthShare, TrakCare) qui permet d'utiliser une version plus avancée du terminal dans le navigateur
(Page du projet ici). Cette extension VSC permet de lancer un terminal Web directement depuis VSC, d'un simple clic.

Pour ouvrir le Terminal Web, cliquez sur: InterSystems Tools  > sélectionner un namespace > cliquer sur l'une des icônes suivantes (, ) pour ouvrir le Terminal Web sur le panneau de terminaux VSC ou sur le navigateur (appuyez sur Alt pour modifier l'icône par défaut) :

 

 

Pour les utilisateurs disposant au minimum d'Iris 2023.2 - Utiliser le terminal WebSocket
 

Les utilisateurs disposant d'au moins IRIS 2023.2 peuvent profiter de la nouvelle fonctionnalité « WebSocket Terminal » incluse dans la dernière version des extensions VSC et n'ont pas besoin de solutions de contournement supplémentaires.

Pour ouvrir le Terminal WebSocket, cliquez sur : InterSystems Tools > sélectionner un namespace > cliquez sur l'icône à côté du Terminal Web
one.

Edit : Pour plus d'informations, consultez l'article intéressant que @Brett Saviano a écrit à ce sujet !

How to run ObjectScript commands in the VS Code integrated terminal

Pour les utilisateurs avec IRIS basé sur Docker

Ceux qui travaillent avec des environnements IRIS dans Docker et utilisent VSC peuvent démarrer une session de terminal directement dans l'environnement Docker.

cliquer sur les informations Docker dans la barre de statut, et choisir Ouvrit un terminal dans Docker.

Je tiens à remercier @Evgeny Shvarov pour la photo et l'explication sur ce point.

Pour les utilisateurs disposant de versions d'IRIS antérieures à 2023.2 travaillant sur leur ordinateur local
 

Pour les utilisateurs qui travaillent avec une version d'IRIS exécutée sur leur ordinateur local, il est possible de configurer un terminal IRIS dédié au sein de VSC :

1. 1. Open the settings.json file. You can find it in several ways, for example by clicking on View > Command Palette > type: “settings” > Open User Settings (JSON)
   2. Add the following code under "terminal.integrated.profiles.windows":

"terminal.integrated.profiles.windows":{

    "IRIS Terminal": {
    
        "path": [
    
            "C:\\InterSystems\\IRISHealth\\bin\\irissession.exe"
        ],
    
        "args": ["IRISHEALTH"],
    
        "icon": "terminal-cmd"
    } 

}

Note: Insérez le bon path pour votre irissession.exe.

c. Pour ouvrir le terminal à partir de VSC, accédez à: Terminal > Nouveau Terminal > Lancer le Profil… > IRIS Terminal.

d. Une option 'IRIS Terminal' devrait maintenant être disponible dans le menu Terminal:

 

Pour les utilisateurs codant sur IRIS basé sur un serveur distant utilisant une connexion SSH 

Pour ceux qui travaillent sur une version d'IRIS basée sur un serveur distant (par exemple, un serveur d'entreprise) accessible via une connexion SSH (par exemple, en utilisant PuTTY), il est possible d'utiliser l'extension Remote - SSH VSC pour connecter VSC directement au serveur. Pour le faire:

1. 1. Installer l'extension VSC Remote - SSH: Editing Configuration Files ;
   2. Cliquer sur l'icône “Explorateur distant”  dans la barre latérale;
   3. Choisir “Ouvrir fichier configuration SSH”

  

et ouvrir le fichier de configuration avec le path: C:\Users\<username>\.ssh\config

1. 4. Insérez le code suivant dans le fichier de configuration 

Host my-putty-connection

    HostName < IP address or server name >

    User < username >

    IdentityFile < private key path on your local machine >

    Port < port > 

L'adresse IP et le port correspondent au nom d'hôte et au port spécifiés dans PuTTY, le nom d'utilisateur est le login de l'utilisateur utilisé pour accéder au serveur distant et IdentityFile est le chemin d'accès au fichier de votre clé privée PuTTY.

Note: Le format original de la clé privée générée par PuTTY (.ppk) ne peut pas être lu par VSC. Pour établir une connexion entre VSC et le serveur distant via PuTTY, vous devez dupliquer la clé privée d'origine et convertir la nouvelle version au format .pem. Pour faire la conversion :

1. Lancez l'application PuTTYgen
2. Sous le menu Fichier, cliquez sur Charger la clé privée
3. Sélectionnez votre clé privée au format .ppk, puis choisissez Ouvrir
4. Sous le menu Conversions, cliquez sur Exporter la clé OpenSSH (forcer un nouveau format de fichier).
5. Définissez un nouveau nom avec l'extension .pem et cliquez sur le bouton Enregistrer.
6. Liez le chemin de ce nouveau fichier .pem au paramètre IdentifyFile dans VSC
   1. Enregistrez le fichier. Après quelques secondes, la nouvelle connexion devrait apparaître dans le panneau Explorateur distant;
   2. Cliquez sur "Se connecter dans une nouvelle fenêtre..." pour ouvrir la connexion SSH dans une nouvelle fenêtre VSC:
7.  Sélectionnez le système d'exploitation de votre machine distante (uniquement lors du premier accès)
8. Dans la nouvelle fenêtre, accédez à: Terminal > Nouveau Terminal (ou utilisez les raccourcis Ctrl + ò ou Ctrl + Shift + ò).
9. Vous êtes maintenant connecté à la machine distante et pouvez utiliser son terminal IRIS dans VSC.

Note: Cette opération ne fonctionne que si vous avez déjà initié votre connexion à distance via PuTTY et ne fonctionne pas lorsque PuTTY est fermé ou lorsque vous n'êtes pas connecté au serveur distant. Cette opération ne lance pas PuTTY, elle permet seulement à VSC de se connecter au tunnel établi par PuTTY.

Pour initier une connexion PuTTY via VSC, vous pouvez utiliser un fichier batch (sous Windows). Le fourni connect_remote.bat file utilise la commande Plink, incluse avec PuTTY, pour démarrer une session:

@echo off

set SESSION="<your saved session name>"

plink -load %SESSION%

To start the session, simply type .\connect_remote.bat in VSC terminal to open the remote connection and insert your credentials.

Pour démarrer la session, tapez simplement .\connect_remote.bat.fr dans le terminal VSC pour ouvrir la connexion distante et insérer vos identifiants.

Note: Cette dernière méthode vous donne accès à une version Terminal qui prend en charge tous les raccourcis VSC.