Protheus no VSCode

Extensão que permite configurar ambientes Protheus diretamente pelo VSCode com apenas um click.

Pré-requisitos

1. VSCode 1.103.0 (julho/2025) ou superior
2. SQL Server 2022 Developer
   1. Autenticação do Windows habilitada (padrão)
   2. Procolo Shared Memory habilitado (padrão)
3. Conexão com a VPN

O SQL Server não pode ter um alias chamado "localhost" forçando o uso do protocolo TCP/IP

Gestão de ambientes

Releases

1. 12.1.2310
2. 12.1.2410
3. 12.1.2510
4. 12.1.2610

Tipos de ambiente

• Desenvolvimento
• Desenvolvimento + Automação
• Expedição contínua
• Mercado Internacional
• Teste Sistêmico e outros

Tipo de ambiente x artefatos

Pacote LIB e Pacote ADVPR → Os pacotes são aplicados automaticamente ao instalar/atualizar o ambiente

RPO Automação (D-1) → Refere-se ao RPO D-1 disponibilizado pelo time automação no Arte que já tem todas as suites do ADVPR compiladas

Processo

Ao criar um ambiente a extensão vai:

• Criar toda a estrutura de pastas necessária
• Baixar, instalar e configurar o DBAccess
• Baixar e instalar driver ODBC
• Configurar ODBC
• Criar banco de dados e restaurar backup da base congelada
• Baixar e instalar appserver, webapp, RPO
• Configurar arquivo INI com porta multiprotocolo, REST etc.
  • Se o arquivo INI já existe, ele não é alterado
• Baixar e aplicar pacote da LIB (conforme tipo de ambiente)
• Baixar e aplicar pacote ADVPR (conforme tipo de ambiente)
• Adicionar novo ambiente à extensão Totvs Developer Studio (TDS)
• Atualizar os includes automaticamente ao criar o primeiro ambiente ou enquanto ainda não houver um download concluído com sucesso

Observações

Na criação do primeiro ambiente Protheus:

• Será instalado o driver "SQL Server ODBC Driver 17" para a comunicação do DBAccess com o SQL Server
• Será instalado o módulo SqlServer do Powershell para execução de scripts no SQL Server 2022
• Será instalada a stored procedure sp_Kill, responsável por encerrar todas as conexões abertas com determinado o banco de dados (que poderá ser usada nos comandos de restauração de backup do banco de dados, por exemplo)
• Serão baixados os includes de Tec, Framework e Engenharia

Os dados dos ambientes locais são armazenados em arquivos JSON na pasta .protheusvsc do usuário, permitindo compartilhamento com outras IDEs compatíveis.

Recursos

• Gestão de ambientes

  • Adicionar e remover ambientes Protheus
  • Iniciar, reiniciar, parar o ambiente (usando o terminal integrado do VSCode)
  • Restaurar backup da base congelada
  • Abrir arquivos appserver.ini e console.log
  • Limpar o arquivo console.log de ambientes parados
  • Ativar e desativar REST
  • Listar e alterar portas de ambientes parados
  • Mudar o License Server de todos os ambientes locais
  • Atualização do DBAccess
  • Atualização do Protheus
    • Atualização de todos os artefatos
    • Atualização do RPO
    • Atualização da base congelada
    • Atualização de metadata (UPDDISTR)
  • Abrir WebApp no navegador
  • Abrir launcher/SIGAMDI usando a porta multiprotocolo do appserver.ini

• Gestão de includes

  • Atualizar os includes globais pelo comando Protheus: Atualizar includes, disponível na paleta de comandos e no menu da visão de ambientes
  • Instalar os includes do TLPP Core e baixar as versões mais recentes dos pacotes de Engenharia e Framework disponíveis no Arte
  • Atualizar includes de produto pelo comando Protheus: Atualizar includes do arquivo, disponível no menu de contexto de arquivos PRW/PRX e TLPP

O gerenciamento de includes é controlado pela configuração protheusvscode.manageIncludes, desabilitada por padrão. Ao criar o primeiro ambiente, a extensão pergunta se o usuário deseja habilitá-la.

• Gestão de backups de banco de dados

  • Criar, restaurar e excluir backups de Banco de Dados SQL Server
  • Exportar banco de dados para arquivo .bak
  • Importar banco de dados a partir de arquivo .bak ou .mdf

• Gestão de RPO

  • Criar, restaurar e excluir backups de RPO
  • Exportar e importar RPOs em ambientes locais e em containers

• Aplicação de pacote

  • Download do arte e aplicação do pacote
    • Roda o UPDISTR se o pacote incluir atualização de dicionário de dados
    • Recurso útil para aplicação do pacote da expedição contínua, Lib ou ADVPR mais recentes com um click

• Atualização de dicionário

  • Roda o UPDDIST com qualquer arquivo sdfbra.txt selecionado, pelo próprio VSCode

• Monitor de Erros

  • Lê ocorrências de THREAD ERROR nos arquivos console.log
  • Agrupa erros por ambiente
  • Permite atualizar a leitura dos logs
  • Permite ocultar erros individuais ou todos os erros listados
  • Permite limpar o console.log de todos os ambientes parados

Recursos experimentais

Os recursos experimentais ficam ocultos por padrão e podem ser habilitados pela configuração protheusvscode.experimentalFeatures.

• Criação de ambiente Protheus em containers com Docker ou Podman
• Seleção do runtime de containers pela configuração protheusvscode.containerRuntime
• Seleção de release e uso de RPO local na criação do ambiente
• Iniciar, parar, reiniciar e remover ambientes com container
• Ativar e desativar REST
• Abrir console.log, appserver.ini e compose.yaml
• Mostrar o terminal do ambiente com container
• Preservar alterações manuais no compose.yaml ao iniciar ou reiniciar o ambiente

Esta extensão foi criada como um projeto pessoal. Não tem nenhum vínculo direto ou indireto com a TOTVS®, qualquer uma de suas franquias ou qualquer um de seus representantes.