Como acessar o Terminal IRIS: um guia completo para usuários do Visual Studio Code

Introdução

Como a InterSystems anunciou recentemente a descontinuação do suporte ao InterSystems Studio a partir da versão 2023.2 em favor do desenvolvimento exclusivo de extensões para o IDE do Visual Studio Code (VSC), acreditando que este oferece uma experiência superior em comparação com o Studio, vários desenvolvedores migraram ou estão começando a usar o VSC. Vários talvez tenham se perguntado sobre como abrir o terminal para realizar operações, já que o VSC não tem um painel de saída como o Studio nem um recurso integrado para abrir o terminal IRIS, exceto baixando os plug-ins desenvolvidos pela InterSystems.

Resumo

• Introdução 
• Soluções
  
  • Para usuários com, no mínimo, IRIS 2020.1 ou IRIS 2021.1.2  – Use Web Terminal
  • Para usuários com, no mínimo, IRIS 2023.2 – Use WebSocket Terminal
  • Para usuários com o IRIS baseado em Docker
  • Para usuários com versões do IRIS anteriores à 2023.2 trabalhando em suas máquinas locais
  • Para usuários programando no IRIS com base em um servidor remoto usando uma conexão SSH

Soluções

Há várias maneiras de abrir o terminal no VSC, dependendo da configuração específica que você estiver usando. Resumi aqui as melhores soluções para qualquer situação:

Para usuários com, no mínimo, IRIS 2020.1.1 ou IRIS 2021.1.2 – Use Web Terminal

Usuários que têm, no mínimo, o IRIS 2020.1.1 ou IRIS 2021.1.2 e podem instalar extensões externas (alguém pode não ter permissão para isso devido à política da empresa em relação a aplicativos de terceiros) podem achar útil a extensão Web Terminal para VSC. Para quem não sabe, Web Terminal é um terminal baseado na Web para os produtos da InterSystems desenvolvidos com ObjectScript (por exemplo, IRIS, Caché, Ensemble, HealthShare e TrakCare) que permite usar uma versão mais avançada do terminal dentro do navegador (página do projeto). Essa extensão do VSC possibilita inicializar um terminal baseado na Web diretamente do VSC, com um simples clique.

Para abrir o Web Terminal, clique em: InterSystems Tools (Ferramentas da InterSystems)  > selecione um namespace > clique em um dos seguintes ícones (, ) para abrir o Web Terminal em um painel de terminal do VSC ou no navegador (pressione Alt para mudar o ícone padrão):

Para usuários com, no mínimo, IRIS 2023.2 – Use WebSocket Terminal

Usuários com, no mínimo, IRIS 2023.2 podem se beneficiar do novo recurso "WebSocket Terminal" incluso na versão mais recente das extensões do VSC e não precisam de alternativas adicionais.

Para abrir o WebSocket Terminal, clique em: InterSystems Tools > selecione um namespace > clique no ícone ao lado do correspondente ao Web Terminal.

Para usuários com IRIS baseado em Docker

Quem trabalha com ambientes do IRIS no Docker e usa o VSC pode iniciar uma sessão de terminal diretamente no ambiente do Docker.  

Clique na voz do Docker na Barra de status e selecione Open Terminal in Docker (Abrir terminal no Docker).

Quero agradecer @Evgeny Shvarov pela foto e explicação sobre esse ponto.

Para usuários com versões do IRIS anteriores à 2023.2 trabalhando nas suas máquinas locais

Para usuários que trabalham com uma versão do IRIS executada na máquina local, é possível configurar um terminal do IRIS dedicado no VSC:

1. 1. Abra o arquivo settings.json. Você pode encontrá-lo de várias maneiras, por exemplo, clicando em View (Ver) > Command Palette (Paleta de comandos) > digite: "settings" (configurações) > Open User Settings (JSON) (Abrir configurações do usuário)
   2. Adicione o seguinte código em "terminal.integrated.profiles.windows":

"terminal.integrated.profiles.windows":{

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

}

Observação: insira o caminho correto do seu irissession.exe.

c. Para abrir o terminal a partir do VSC, navegue até: Terminal > New Terminal (Novo terminal) > Launch Profile… (Inicializar perfil) > IRIS Terminal.

d. Uma voz "IRIS Terminal" deve agora estar disponível no menu Terminal:

Para usuários programando no IRIS com base em um servidor remoto usando uma conexão SSH 

Para quem trabalha em uma versão do IRIS baseada em um servidor remoto (por exemplo, o servidor de uma empresa) acessível por conexão SSH (por exemplo, usando PuTTY), é possível usar a extensão Remote - SSH VSC para conectar o VSC diretamente ao servidor. Para fazer isso:

1. 1. Instale a extensão Remote - SSH: Editing Configuration Files no VSC;
   2. Clique no ícone "Remote Explorer" (Explorador remoto)  na barra lateral;
   3. Selecione "Open SSH Config File" (Abrir arquivo de configuração SSH)

e abra o arquivo de configuração com o caminho: C:\Users\<username>\.ssh\config

1. 4. Insira o seguinte código no arquivo de configuração: 

Host my-putty-connection

    HostName < IP address or server name >

    User < username >

    IdentityFile < private key path on your local machine >

    Port < port > 

O endereço IP e a porta correspondem ao nome do host e à porta especificada em PuTTY, o nome de usuário é a credencial de usuário usada para acessar o servidor remoto, e IdentityFile é o caminho do arquivo para a chave privada de PuTTY.

Observação:  o formato original da chave privada gerada por PuTTY (.ppk) não pode ser lido pelo VSC. Para estabelecer uma conexão entre o VSC e o servidor remoto via PuTTY, você precisa duplicar a chave privada original e converter a nova versão no formato .pem. Para fazer a conversão:

1. Inicialize o aplicativo PuTTYgen
2. No menu File (Arquivo), clique em "Load private key" (Carregar chave privada)
3. Selecione sua chave privada no formato .ppk e escolha "Open" (Abrir)
4. No menu Conversions (Conversões), clique em "Export OpenSSH Key (force new file format)", ou "Exportar chave OpenSSH (forçar novo formato de arquivo)".
5. Defina um novo nome com a extensão .pem e clique no botão Save (Salvar).
6. Vincule o caminho para esse novo arquivo .pem ao parâmetro IdentifyFile no VSC
   1. Salve o arquivo. Depois de alguns segundos, a nova conexão deve aparecer no painel Remote Explorer;
   2. Clique em "Connect in New Window..." (Conectar em uma nova janela...) para abrir a conexão SSH em uma nova janela do VSC:
7.  Selecione o sistema operacional da sua máquina remota (somente no primeiro acesso)
8. Na nova janela, acesse: Terminal > New Terminal (ou use os atalhos Ctrl + ò ou Ctrl + Shift + ò).
9. Agora você está conectado à máquina remota e pode usar seu Terminal IRIS dentro do VSC.

Observação: essa operação só funciona se você iniciar a conexão remota via PuTTY antes, e não funciona se PuTTY for encerrado ou não estiver conectado ao servidor remoto. Essa operação não inicializa PuTTY, só permite que o VSC se conecte ao túnel estabelecido por PuTTY.

Para iniciar uma conexão PuTTY pelo VSC, você pode utilizar um arquivo de lote (no Windows). O arquivo connect_remote.bat fornecido usa o comando Plink, incluso em PuTTY, para iniciar uma sessão:

@echo off

set SESSION="<your saved session name>"

plink -load %SESSION%

Para iniciar a sessão, basta digitar .\connect_remote.bat no terminal do VSC para abrir a conexão remota e inserir suas credenciais.

Observação: com este último método, você ganha acesso a uma versão do terminal compatível com todos os atalhos do VSC! Bem-vindo de volta, Ctrl+V, e adeus, Shift+Insert 🎉