A instalação da integração Vendelo no TOTVS Protheus é rotina padrão TOTVS e leva cerca de trinta minutos de trabalho manual. Este artigo descreve as etapas na ordem em que precisam acontecer, o que cada uma entrega e como validar o resultado. O roteiro técnico detalhado, com os artefatos e comandos, acompanha o kit de instalação entregue ao parceiro.
Índice
- Antes de começar
- As seis etapas
- Etapa 1: publicar a integração no ambiente
- Etapa 2: instância dedicada
- Etapa 3: agente de impressão
- Etapa 4: configuração no Vendelo
- Etapa 4b: campos de dicionário
- Etapa 5: validar
- Etapa 6: primeira carga
- O que passa a ser automático
- Boleto e DANFE: o que o cliente fornece
- Problemas comuns na instalação
- Perguntas frequentes
Antes de começar
Confira os pré-requisitos do ambiente antes de agendar: release, banco, ambiente de customização disponível, instância dedicada, usuário exclusivo, rede e janela de manutenção.
Não existe serviço da Vendelo a instalar no servidor do cliente. A integração roda na nuvem. O que fica no ambiente do cliente são os artefatos publicados no ambiente de customização e a instância que os expõe pelo REST padrão do Protheus.
As seis etapas
| # | Etapa | Responsável | Duração típica |
|---|---|---|---|
| 1 | Publicar a integração no ambiente de customização | Consultor TOTVS | 10 a 15 min |
| 2 | Configurar a instância dedicada | Consultor TOTVS | 10 min |
| 3 | Copiar o agente de impressão | Consultor TOTVS | 2 min |
| 4 | Configurar a empresa no Vendelo | Vendelo | Conforme levantamento |
| 5 | Validar | Consultor e Vendelo | 5 min |
| 6 | Primeira carga | Vendelo | Janela fora do horário de uso |
Etapa 1: publicar a integração no ambiente
Os artefatos da integração são publicados no ambiente de customização do cliente, pelo processo padrão TOTVS. O kit entregue ao parceiro traz os arquivos, a ordem de publicação e o comando de linha, para quem prefere fazer com os serviços parados.
O kit contém dois artefatos marcados como exclusivos de homologação. Eles existem só para montar ambiente de teste, escrevem cadastro direto e mexem em dicionário, e não podem ir para produção. A lista do que publicar está no kit, e a conferência é feita na validação.
Os recursos que dependem desses artefatos ficam indisponíveis em produção, e o Vendelo informa isso claramente em vez de executar. Se algum deles funcionar num ambiente de produção, o artefato foi publicado por engano e precisa ser removido.
Etapa 2: instância dedicada
A integração conversa com o Protheus por uma instância de aplicação dedicada, separada da que atende os usuários. A comunicação usa o servidor REST padrão do Protheus, nativo do AppServer: os artefatos publicados na Etapa 1 expõem as rotas da integração por esse serviço, sem middleware nem componente de terceiros. A configuração está no kit.
Um ponto exige atenção antes de subir o serviço: a configuração define qual é a empresa e a filial principal, e é essa filial que se torna a filial padrão no Vendelo. Conferir agora custa um minuto; trocar depois significa remapear o que já foi integrado.
Instância dedicada não é preciosismo. A carga inicial e o faturamento consomem processamento; separar da instância que atende os usuários evita que a integração afete quem está trabalhando.
Etapa 3: agente de impressão
O agente de impressão que acompanha o SmartClient precisa estar presente em cada instância que atende a integração, a principal e a dedicada.
Sem ele, todo PDF gerado pelo servidor falha, e o console mostra um erro de agente de impressão não encontrado. Isso derruba boleto, DANFE e o DANFE nativo de uma vez só. É um arquivo copiado, mas é o item que ninguém lembra até o cliente pedir o primeiro boleto.
Etapa 4: configuração no Vendelo
A configuração da empresa é aplicada pela Vendelo e depende de decisões levantadas com o cliente: endereço e credencial de acesso, regra fiscal padrão, comportamento do catálogo e do estoque, e o que deve acontecer quando um pedido é pago.
A credencial é entregue por canal seguro e armazenada em cofre de segredos. Ela nunca circula por e-mail, planilha ou arquivo de projeto.
Etapa 4b: campos de dicionário
Duas situações exigem campo criado no dicionário do cliente antes de o recurso ser habilitado. A especificação exata vem no kit.
| Recurso | O que exige | Sem isso |
|---|---|---|
| Solicitação de compra | O campo de identificação C1_XVDOUID (caractere, 32 ou maior) na tabela de solicitações (SC1) | Inclusão e alteração ficam bloqueadas, de propósito |
| Campos personalizados | O campo existir no dicionário e estar cadastrado no Vendelo | O campo simplesmente não circula |
Crie qualquer campo pelo Configurador ou UPDDISTR, em janela de manutenção, e confirme que a coluna física foi criada. Campo criado apenas por comando SQL fica fora do dicionário, e a gravação automática não o trata corretamente. Pior: campo de tipo data ou lógico criado assim derruba a gravação da tabela inteira, com um sintoma que aparece longe da causa, o pedido passando a ser gravado sem itens.
Etapa 5: validar
A validação leva poucos minutos e responde quatro perguntas:
O serviço responde? A verificação devolve a empresa e a filial em que a integração está operando.
A filial está correta? Confira se é a filial que deve ser a padrão do Vendelo.
A estrutura da integração está pronta? A preparação cria sozinha os objetos de que a integração precisa no banco, no dialeto correto, e informa o resultado. Ela mexe apenas em objetos próprios, nunca em tabela de negócio nem em dicionário.
O pacote de produção está limpo? Os recursos exclusivos de homologação precisam estar indisponíveis.
A verificação de estrutura é repetida automaticamente em ciclos curtos. Manutenção de dicionário pelo Configurador pode derrubar objetos da integração, e o ciclo seguinte reconstrói sozinho.
Etapa 6: primeira carga
Com tudo validado, execute a primeira carga pela tela Carregar dados do ERP, na fila de integração. Ela é a forma suportada de trazer o acervo do Protheus, permite escolher os grupos, definir a data de corte dos documentos e acompanhar o andamento. O passo a passo completo está no artigo Primeira carga do Protheus para o Vendelo.
Programe a primeira carga para o fim de semana ou fora do horário de uso. Ela consome recursos do Vendelo e do Protheus ao mesmo tempo.
O que passa a ser automático
- Manutenção dos objetos da integração no banco.
- Carga inicial completa, dos cadastros para os documentos, na ordem de dependência.
- Sincronização contínua do que muda no ERP.
- Localidades, formas de pagamento e vendedores com suas carteiras.
Boleto e DANFE: o que o cliente fornece
Boleto e DANFE dependem de uma rotina do próprio cliente. A integração a detecta em tempo de execução: basta publicá-la no ambiente de customização, sem nenhuma alteração no Vendelo.
| Recurso | O que o cliente fornece | Sem isso |
|---|---|---|
| Boleto | Rotina que devolve o boleto já emitido no layout homologado do banco | O recurso fica indisponível e o Vendelo informa |
| DANFE | Rotina que devolve a DANFE a partir da nota autorizada | O recurso fica indisponível e o Vendelo informa |
Problemas comuns na instalação
| Sintoma | Causa provável | Ação |
|---|---|---|
| Erro de conexão com o banco nas chamadas | DBAccess parado | Subir o DBAccess e reiniciar o serviço dedicado. As threads ficam com a conexão morta e não se recuperam sozinhas. |
| Nenhum PDF sai e o console acusa agente de impressão | Agente ausente | Etapa 3 |
| Alterações do ERP param de chegar | Objetos da integração derrubados por manutenção de dicionário | Aguardar o ciclo de verificação ou pedir a reconstrução |
| Funções da integração não encontradas | Artefato com erro de compilação derrubou o conjunto | Republicar conferindo o log de cada arquivo |
| Acentuação errada nos dados lidos | Acesso que não passou pela integração | Confirmar que nada consulta o banco por fora |
| Pedido de cliente novo recusado por falta de natureza | Ambiente cujo parâmetro fiscal exige natureza no cliente | Definir a natureza padrão na configuração da integração |
| Toda gravação falha acusando campo fora do dicionário | Coluna física existe sem registro no dicionário | Completar o dicionário ou remover a coluna |
| Depois de criar campo personalizado, todo pedido grava sem itens | Campo data ou lógico criado por SQL | Recriar pelo Configurador |
Perguntas frequentes
Preciso parar o Protheus para instalar?
Depende do método de publicação. Pela IDE, não. Por linha de comando, os serviços precisam estar parados. A criação de campo de dicionário exige modo exclusivo, então combine uma janela.
Como confirmo que o pacote de produção está correto?
Pelo comportamento: os recursos exclusivos de homologação precisam estar indisponíveis. É um teste rápido e conclusivo, e faz parte do checklist de entrada em produção.
A instalação mexe em dados do cliente?
Não. São criados objetos próprios da integração no banco e publicados artefatos no ambiente de customização. As tabelas de negócio só recebem gravação depois, quando um usuário emite um documento, sempre pelas rotinas oficiais do ERP.
O DBA prefere preparar o banco ele mesmo. É possível?
É. O kit traz os artefatos equivalentes por dialeto, e eles podem ser reexecutados sem efeito colateral. Antes de uma atualização de release TOTVS é possível desabilitá-los e reexecutar depois, ou simplesmente deixar a verificação automática reconstruir.
Faturamento automático demora alguns segundos. É normal?
É esperado. Faturamento e contabilização exigem montar o ambiente completo do ERP, o que custa alguns segundos por chamada. A operação continua síncrona e devolve o resultado.
Posso apontar o boleto para uma rotina que o cliente já tem?
Pode, e é o caminho recomendado, inclusive para uma rotina padrão do ERP. Basta indicá-la na configuração; nada é recompilado.
Depois de instalar, o que ainda é manual no dia a dia?
Nada de rotina. O trabalho manual volta quando alguém cria campo novo no dicionário, quando o cliente abre filial nova ou quando é preciso recarregar um grupo de dados.
Onde está o roteiro técnico completo?
No kit de instalação entregue ao parceiro, junto com os artefatos. Esta página descreve o processo e serve para planejar a implantação; o passo a passo detalhado acompanha o material técnico.
Próxima leitura
Primeira carga do Protheus para o Vendelo: Integração instalada, traga os dados: a primeira carga leva cadastros e documentos do Protheus para o Vendelo.
