Linha Microsiga Protheus

Árvore de páginas



Objetivo

(informação) O objeto deste documento é trazer as informações necessárias para a configuração e o uso da integração entre o Importador XML e o TOTVS Transmite.

Importante - Integração Importador x TOTVS Transmite

Integração Importador XML x TOTVS Transmite

Novos agendamentos separando processos e melhoria de performance:

  • SCHEDIMPTRA: Responsável pela requisição e leitura do recibos enviado pelo TOTVS Transmite
  • SCHEDUPDTRA: Responsável pela atualização de status no TOTVS Transmite

Obs: Ao configurar os 2 novos agendamentos o COLAUTOREAD ficara responsável apenas pela importação de XMLs via pasta IN, caso contrario continua responsável pela leitura da pasta IN e todo processo de requisição, leitura e atualização do TOTVS Transmite.

    Conteúdo

    Este documento possui o intuito de ser um guia para os clientes, analistas e desenvolvedores, que utilizam ou que querem aderir na sua rotina de trabalho as funcionalidades que são disponibilizadas pelo integração do Importador XML x TOTVS Transmite.   


    Processo de Check-list

    Para que a integração entre o Importador XML e TOTVS Transmite funcione corretamente, preparamos um Checklist dos requisitos mínimos que devem ser validados para o correto funcionamento da integração. 


    [Imagem para ilustrar as etapas do Checklist]

    *Clique na imagem para ampliar.

    Integração (Processo macro):

    Abaixo uma imagem ilustrativa do processo de integração entre o Importador XML e TOTVS Transmite.


    [Imagem para ilustrar a integração Importador XML e TOTVS Transmite]

    *Clique na imagem para ampliar.

    Descrição das Etapas do Processo

    (aviso) Observação:   


    [Imagem para ilustrar o Fluxo integração Importador XML e TOTVS Transmite]



    Descrição das Etapas do Processo

    (aviso) Observação: Para um melhor aproveitamento e entendimento da integração entre o Importador XML e TOTVS Transmite é importante que o usuário tenha o conhecimento prévio  



    Etapas
    Importador XML x TOTVS Transmite

    Descrição do Processo

    TOTVS Transmite

    Descrição do Processo 

    Importador XML

    Descrição do Processo

    TEC




    PASSO 1

    Configuração da integração Importador XML x Totvs Transmite


    Parâmetros:

    • MV_IMPXML (Habilitado Importador XML)
    • MV_XMLCID (Client Id Transmite)
    • MV_XMLCSEC (Client Secret Transmite)
    • MV_APITRAN (Ambiente Transmite)
    • MV_NGINN (Pasta IN)
    • MV_NGLIDOS (Pasta Lidos)
    • MV_DOCIMP (Tipo documentos a serem importados)

    Wizard:

    Através do Wizard é possível configurar todos os parâmetros descritos acima e informar as filiais do Importador XML que serão integradas junto ao Totvs Transmite (Gravando na DHW)

    PASSO 2

    Agendamento COLAUTOREAD
    • Inicia verificando se possui XMLs na pasta IN (MV_NGINN)

    PASSO 3

    Agendamento SCHEDIMPTRA
    • Feita a chamado do EndPoint no Totvs Transmite para requisitar os XMLs "pendentes" para integração com Importador XML

    Importante: Para correto funcionamento do EndPoint, é preciso ter:

    • Tabela DHW com o vinculo entre as filiais do Protheus e Totvs Transmite
    • Parâmetro: MV_DOCIMP e MV_DTINITR

    PASSO 4

    Agendamento SCHEDIMPTRA

    Totvs Transmite recebe requisição solicitada pelo Importador XML e retorna ao Protheus os "Recibos"

    Importante: Totvs Transmite retorno um recibo por tipo de documento (MV_DOCIMP)

    PASSO 5

    Agendamento SCHEDIMPTRA
    		Protheus (Importador XML) recebe os "Recibos" do Totvs Transmite e os grava na tabela DHY

    PASSO 6

    Agendamento SCHEDIMPTRA
    		Com os "Recibos" na tabela DHY é feito a chamada de outro EndPoint no Totvs Transmite para gravar o XMLs no Importador XML (Tabela CKO) 

    PASSO 7

    Agendamento SCHEDIMPTRA

    Totvs Transmite recebe requisição solicitada pelo Importador XML e retorna ao Protheus um arquivo em Encode64 com todos os XMLs daquele "Recibo"

    PASSO 8

    Agendamento SCHEDIMPTRA
    		Protheus (Importador XML) recebe o Encode64 com os XMLs e vai fazer o Decode64 (TEC) O Decode64 é feito e seu retorno gera um arquivo .ZIP

    PASSO 9

    Agendamento SCHEDIMPTRA
    		Com o arquivo .ZIP gerado através do Decode64, é necessário fazer a descompactação desse arquivo. A descompactação do arquivo .ZIP é feito pela função FUnZip

    PASSO 10

    Agendamento SCHEDIMPTRA
    		Os arquivos descompactados serão salvos dentro da pasta (\transmite\) e feita a leitura dos XMLs gravando na tabela CKO

    PASSO 11

    Agendamento SCHEDUPDTRA
    		Após a gravação na tabela CKO, o Importador XML chama o EndPoint do Totvs Transmite para fazer as atualizações de status do documento no Totvs Transmite

    PASSO 12

    Agendamento SCHEDUPDTRA

    		 Totvs Transmite recebe requisição solicitada pelo Importador XML com a chave do documento e faz a atualização dos status no Totvs Transmite.

    PASSO 12

    Agendamento SCHEDCOMCOL
    		Protheus (Importador XML) lê os XMLs da tabela CKO e os envia para o Monitor, caso não encontre nenhuma inconsistência. 
    • Tabelas:
    Tabela Descrição
    DHW Configuração Grupo/Empresa que integra com o Totvs Transmite
    DHY Grava os Ids para consulta dos XML importados do Totvs Transmite
    DHZ Histórico de Ids com erros e já importados no Importador XML
    CKOCOL Registros do XMLs importados
    SDS

    Cabeçalho do documento no monitor
    SDT Itens do documento no monitor


    • Fontes envolvidos:
    Fontes Descrição
    COLXCFG Wizard de configuração TOTVS Colaboração / Importador XML
    COLAUTOREAD Rotina para importar XMLs na CKOCOL
    COMTRANSMITE Classe/Objeto para importação dos XML originados via TOTVS Transmite
    COMXCOL Monitor
    MATA140I

    Importa NFE/NFS do TOTVS Colaboração / Importador XML
    MATA116I Importa CTE/CTEOS do TOTVS Colaboração / Importador XML
    WIZIMP Wizard Integração Importador XML x TOTVS Transmite
    IMPTRATOOL Ferramenta de Analise Integração Importador XML x TOTVS Transmite
    SCHEDIMPTRA Agendamento requisição e leitura dos recibos
    SCHEDUPDTRA Agendamento atualização status no TOTVS Transmite

    Pode-se utilizar o Wizard como facilitador da configuração.

    Link: IX09 - Wizard Configuração

    • Tabela DHW
    Campo: Tipo: Tamanho: Formato: Contexto: Propriedade: Usado: Descrição:
    DHW_GRPEMP C 2 (Tamanho da Grupo de Empresa) @! Real Alterar Sim Grupo Empresa            
    DHW_FILEMP C 8 (Tamanho da Filial) @! Real Alterar Sim Filial Empresa
    DHW_CGC    C 14 @! Real Alterar Sim CGC (CNPJ/CPF)
    DHW_IE     C 14 @! Real Alterar Sim Inscrição Estadual
    DHW_UF     C 2 @! Real Alterar Sim Estado
    DHW_CODFIL C 40 @! Real Alterar Sim Código Filial no Transmite
    Índices:
    DHW_FILIAL+DHW_GRPEMP+DHW_FILEMP                                                                                                                                

    DHW_FILIAL+DHW_CGC+DHW_IE                                                                                                                                       
    DHW_FILIAL+DHW_CODFIL                                                                                                                                           
    • Tabela DHY
    Campo: Tipo: Tamanho: Formato: Contexto: Propriedade: Usado: Descrição:
    DHY_CODFIL C 40 @! Real Alterar Sim Código Filial no Transmite         
    DHY_TPXML  C 5 @! Real Alterar Sim Tipo XML (NFE/NFS/CTE/CTEOS)
    DHY_ID        C 36 @! Real Alterar Sim Id Recibo Transmite
    DHY_STATUS    C 1 @! Real Alterar Sim Status (0-Pendente/1-Ok/2-Erro)
    DHY_DTID    D 8
    		Real Alterar Sim Data Importação ID Recibo
    DHY_FILTRO C 200 @! Real Alterar Sim Filtro requisição
    DHY_TENT N 14 @999,999,999,999,99 Real Alterar Sim Tentativas
    DHY_MESSAG C 220 @! Real Alterar Sim Mensagem de retorno do TOTVS Transmite
    Índices:
    DHY_FILIAL+DHY_CODFIL+DHY_TPXML+DHY_ID                                                                                                                          
    DHY_FILIAL+DHY_TPXML+DHY_FILTRO


    • Tabela DHZ
    Campo: Tipo: Tamanho: Formato: Contexto: Propriedade: Usado: Descrição:
    DHZ_CODFIL C 40 @! Real Alterar Sim Código Filial no TOTVS Transmite         
    DHZ_TPXML  C 5 @! Real Alterar Sim Tipo XML (NFE/NFS/CTE/CTEOS)
    DHZ_ID        C 36 @! Real Alterar Sim Id Recibo Transmite
    DHZ_STATUS    C 1 @! Real Alterar Sim Status (0-Pendente/1-Ok/2-Erro)
    DHZ_DTID D 8
    		Real Alterar Sim Data Importação
    DHZ_FILTRO C 200 @! Real Alterar Sim Filtro requisição
    DHZ_TENT N 14 @999,999,999,999,99 Real Alterar Sim Tentativas
    DHZ_DTLID D 8
    		Real Alterar Sim Data Lido Recibo
    DHZ_MESSAG C 220 @! Real Alterar Sim Mensagem de retorno do TOTVS Transmite
    Índices:
    DHZ_FILIAL+DHZ_CODFIL+DHZ_TPXML+DHZ_ID                                                                                                                          
    DHZ_FILIAL+DHZ_TPXML+DHZ_FILTRO


    • Tabela CKO
    Campo: Tipo: Tamanho: Formato: Contexto: Propriedade: Usado: Descrição:
    CKO_CHVDOC C 44 @! Real Visualizar Sim Chave Documento      
    CKO_ORIGEM C 10 @! Real Alterar Sim Origem
    CKO_STRAN  C 1 @! Real Alterar Sim Status Transmite (1-Pendente/2-CKO/3-SF1)
    CKO_ERRTRA M

    		Real Alterar Sim Erro status Transmite
    CKO_RECIBO C 36 @! Real  Alterar Sim Recibo do TOTVS Transmite
    • Parâmetros utilizados na integração.
    Parâmetro Tipo Conteúdo Descrição Observação
    MV_IMPXML L T Habilita integração Importador XML Parâmetro deve ser T para que integração com o TOTVS Transmite funcione.
    MV_DOCIMP C NFE/NFS/CTE/CTO Tipo de XML a serem importados pela integração Importador XML x TOTVS Transmite
    MV_XMLCID C
    		Client ID do TOTVS Transmite

    Informação virá do TOTVS Transmite. Para obter a credencial:

    • Na página Inicial do Transmite
    • Clicar no símbolo (interrogação) 
    • Opção - Obter Credenciais
    MV_XMLCSEC C
    		Client Secret do TOTVS Transmite

    Informação virá do TOTVS Transmite

    Para obter a credencial:

    • Na página Inicial do Transmite
    • Clicar no símbolo (interrogação) 
    • Opção - Obter Credenciais
    MV_XMLDIAS N 30 Range dias para importar documentos do TOTVS Transmite.

    Data Inicio: Data de hoje - MV_XMLDIAS (30)

    Data Final: Data de hoje
    MV_NGINN C
    		Caminho para importar XMLs pelo Importador XML

    Tratamento continuara funcionando mesmo com a integração com o TOTVS Transmite ativa

    Obs: Ambientes Linux deixar nomenclatura minúscula
    MV_NGLIDOS C
    		Caminho para onde o XMLs lidos da pasta IN serão armazenados.

    Tratamento continuara funcionando mesmo com a integração com o Totvs Transmite ativa

    Obs1: Ambientes Linux deixar nomenclatura minúscula

    Obs2: Documentos originados via Totvs Transmite, não serão salvos na pasta LIDOS, pois XML's já são armazenados no Totvs Transite.
    MV_APITRAN C production Indica ambiente do Totvs Transmite (production / staging / development) Default: production
    MV_DTINITR D 20230101 Data de inicio da integração do Importador XML x TOTVS Transmite

    Obs: Se não informar será solicitado TODOS documentos no TOTVS Transmite, caso tenha informado, somente a partir da data será selecionado documentos no TOTVS Transmite


    • Imagens da configuração dos parâmetros no Wizard:

     

    • Deve-se informar qual Grupo/Filial estará integrada com o TOTVS Transmite. Para que assim somente XMLs pertencentes ao mesmo Grupo/Filial sejam importados.

    Observação: Ao selecionar Grupo/Filial, o mesmo devera conter o seu Código Filial do TOTVS Transmite. Informação estará na tabela DHW (DHW_CODFIL)


    • Imagem da configuração de Grupo/Filial no Wizard.

    No Importador XML é necessário criar agendamentos das rotinas responsáveis pela importação e gravação do XML no Monitor (Protheus).

    Para realizar o cadastro dos agendamentos é necessário o seguinte:

    • SIGACFG -> AMBIENTE -> SCHEDULE -> SCHEDULE (Agendamento -> Cadastro): 
      • Informar usuário (Ex: 000000 - Administrador)

      • Rotina (tabela abaixo)

        Agendamento

        Descrição

        		 Recorrência Configuração Consumo Licença
        COLAUTOREAD Para importar XML's através da pasta IN (MV_NGINN) e gravar informações na tabela CKO 48 (00:30 min)

        Configurar apenas uma filial por grupo de empresa que ocorrera a importação

        Ex: T1 / D MG 01
              T2 / D SP 01

        Obs: Dessa forma ao importar XML será analisado se documento pertence a qualquer filial de cada grupo de empresa.

        		 Por Empresa
        SCHEDIMPTRA Para requisitar e ler recibos retornados do TOTVS Transmite 144 (00:10 min)

        Configurar apenas uma filial por grupo de empresa que ocorrera a importação

        Ex: T1 / D MG 01
              T2 / D SP 01

        Obs: Dessa forma ao importar XML será analisado se documento pertence a qualquer filial de cada grupo de empresa.

        		 Por Empresa
        SCHEDUPDTRA Para atualizar status de documentos no TOTVS Transmite 72 (00:20 min)

        Configurar apenas uma filial por grupo de empresa que ocorrera a importação

        Ex: T1 / D MG 01
              T2 / D SP 01

        Obs: Dessa forma ao atualiza status será analisado toda a CKO, com documentos de todos grupos e filiais importados.

        		 Por Empresa
        SCHEDCOMCOL

        Ler os XML's da CKO e importar para o monitor (SDS e SDT)

        		 288 (00:05 min)

        Configurar TODOS os grupos e filiais que documentos possam pertencer para que sera importado para o monitor no grupo e filial correto

        Ex: T1 / D MG 01

              T1 / D MG 02

              T2 / D SP 01

              T2 / D SP 02

        		 Por Filial
      • Modulo: (Ex: 02 - Compras)
      • Deixar habilitado
    • SIGACFG -> AMBIENTE -> SCHEDULE -> SCHEDULE (Agent -> Cadastro): 
      • Incluir o Grupo de empresa/Empresa que contem configurado os agendamentos.

    Para que funcione corretamente os agendamentos é necessário que após toda configuração, o Agent e o Schedule sejam ativados.


    Lista de documentos importados pela integração Totvs Transmite x Importador XML

    Documento Código Tipo Requisição

    NF-e

    		 109

    Recebimento

    NFS-e

    		 319

    Recebimento

    CT-e

    		 214

    Recebimento
    CTEOS 273 Recebimento



    Importante

    Importador XML integrado com TOTVS Transmite: Documentos NFS serão importados.

    Importador XML NÃO integrado com TOTVS Transmite: Documentos NFS NÃO serão importados

    FAQs - Integração Importador XML x Totvs Transmite

    IX08013 - Importador XML x Totvs Transmite - Performance