Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.



Painel
titleObjetivo

(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.

Importador XML x TOTVS Transmite

slide

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.

Deck of Cardswarning
effectDuration0.5
idcabecalho
effectTypeslide
titleImportante - Integração Importador x TOTVS Transmite
Integração
Card
defaulttrue
effectDuration0.5
idtransmite
label
titleTransmite
effectType
tudo-sobre
Deck of Cards
effectDuration0.5
id
cabecalho
effectTypeslide
Introducao
Card
defaulttrue
effectDuration0.5
id
transmite
labelImportador XML x TOTVS Transmite
titleTransmite
effectTypeslide
Deck of Cards
effectDuration0.5
idtudo-sobre
effectTypeslide
Card
defaulttrue
effectDuration0.5
idIntroducao
labelIntrodução
titleIntrodução
effectTypeslide
Column

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.   


Painel
titleProcesso de Check-list

Para que a integração entre o Importador XML e TOTVS Transmitefuncione 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.

Painel
titleIntegraçã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.

Card
defaulttrue
effectDuration0.5
idFluxograma
labelFluxograma / Etapas do Processo
titleFluxograma
effectTypeslide
Deck of Cards
effectDuration0.5
idFluxo
effectTypeslide
Card
defaulttrue
effectDuration0.5
idFluxograma
labelFluxograma
titleFluxograma
effectTypeslide
Painel
titleDescrição das Etapas do Processo

(aviso) Observação:   


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



Card
defaulttrue
effectDuration0.5
idEtapas
labelEtapas
titleEtapas
effectTypeslide
Painel
titleDescriçã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_TRAXML DOCIMP (Pasta a ser criada dentro da Pasta IN - MV_NGINN)
  • MV_DOCIMP (Tipo documentos a serem importados)
  • 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)Após leitura da pasta IN (MV_NGINN), é feita

PASSO 3

Agendamento SCHEDIMPTRA


  • Feita a chamado do EndPoint no Totvs Transmite
 para
  • 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_
XMLDIAS
  • DTINITR

PASSO 34

Agendamento COLAUTOREADSCHEDIMPTRA

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 45

Agendamento COLAUTOREADSCHEDIMPTRA


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

PASSO 56

Agendamento COLAUTOREADSCHEDIMPTRA


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 67

Agendamento COLAUTOREADSCHEDIMPTRA

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



PASSO 78

Agendamento COLAUTOREADSCHEDIMPTRA


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 89

Agendamento COLAUTOREADSCHEDIMPTRA


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 910

Agendamento COLAUTOREADSCHEDIMPTRA


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

PASSO 1011

Agendamento COLAUTOREADSCHEDUPDTRA


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 1112

Agendamento COLAUTOREADSCHEDUPDTRA

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 SCHEDCOMCOlSCHEDCOMCOL


Protheus (Importador XML) lê os XMLs da tabela CKO e os envia para o Monitor, caso não encontre nenhuma inconsistência. 
Card
effectDuration0.5
idTabelas
labelTabelas / Fontes
titleTabelas
effectTypeslide
  • Tabelas:
TabelaDescrição
DHWConfiguração Grupo/Empresa que integra com o Totvs Transmite
DHYGrava os Ids para consulta dos XML importados do Totvs Transmite
DHZHistórico de Ids com erros e já importados no Importador XML
CKOCOLRegistros do XMLs importados
SDS

Cabeçalho do documento no monitor

SDTItens do documento no monitor


  • Fontes envolvidos:
FontesDescrição
COLXCFGWizard de configuração TOTVS Colaboração / Importador XML
COLAUTOREADRotina para importar XMLs na CKOCOL
COMTRANSMITEClasse/Objeto para importação dos XML originados via TOTVS Transmite
COMXCOLMonitor
MATA140I

Importa NFE/NFS do TOTVS Colaboração / Importador XML

MATA116IImporta CTE/CTEOS do TOTVS Colaboração / Importador XML
WIZIMPWizard Integração Importador XML x TOTVS Transmite
IMPTRATOOLFerramenta de Analise Integração Importador XML x TOTVS Transmite
SCHEDIMPTRAAgendamento requisição e leitura dos recibos
SCHEDUPDTRAAgendamento atualização status no TOTVS Transmite
Card
effectDuration0.5
idConfiguração
labelConfiguração
Card
effectDuration0.5
idConfiguração
labelConfiguração
titleConfiguração
effectTypeslide
Deck of Cards
effectDuration0.5
idFuncionalidades
effectTypeslide
Card
defaulttrue
effectDuration0.5
idWizard
labelWizard
titleWizard
effectTypeslide

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

Link: IX09 - Wizard Configuração

Card
defaulttrue
effectDuration0.5
idDicionario
labelDicionário
titleDicionario
effectTypeslide
  • Tabela DHW
Campo:Tipo:Tamanho:Formato:Contexto:Propriedade:Usado:Descrição:
DHW_GRPEMPC2 (Tamanho da Grupo de Empresa)@!RealAlterarSimGrupo Empresa            
DHW_FILEMPC8 (Tamanho da Filial)@!RealAlterarSimFilial Empresa
DHW_CGC   C14@!RealAlterarSimCGC (CNPJ/CPF)
DHW_IE    C14@!RealAlterarSimInscrição Estadual
DHW_UF    C2@!RealAlterarSimEstado
DHW_CODFILC40@!RealAlterarSimCó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_CODFILC40@!RealAlterarSimCódigo Filial no Transmite         
DHY_TPXML C5@!RealAlterarSimTipo XML (NFE/NFS/CTE/CTEOS)
DHY_ID       C36@!RealAlterarSimId Recibo Transmite
DHY_STATUS   C1@!RealAlterarSimStatus (0-Pendente/1-Ok/2-Erro)
DHY_DTID   D8
RealAlterarSimData Importação ID Recibo
DHY_FILTROC200@!RealAlterarSimFiltro requisição
DHY_TENTN14@999,999,999,999,99RealAlterarSimTentativas
DHY_MESSAGC220@!RealAlterarSimMensagem 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_CODFILC40@!RealAlterarSimCódigo Filial no TOTVS Transmite         
DHZ_TPXML C5@!RealAlterarSimTipo XML (NFE/NFS/CTE/CTEOS)
DHZ_ID       C36@!RealAlterarSimId Recibo Transmite
DHZ_STATUS   C1@!RealAlterarSimStatus (0-Pendente/1-Ok/2-Erro)
DHZ_DTIDD8
RealAlterarSimData Importação
DHZ_FILTROC200@!RealAlterarSimFiltro requisição
DHZ_TENTN14@999,999,999,999,99RealAlterarSimTentativas
DHZ_DTLIDD8
RealAlterarSimData Lido Recibo
DHZ_MESSAGC220@!RealAlterarSimMensagem de retorno do TOTVS Transmite
Índices:
DHZ_FILIAL+DHZ_CODFIL+
Í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_CHVDOCC44@!RealVisualizarSimChave Documento      
CKO_ORIGEMC10@!RealAlterarSimOrigem
CKO_STRAN C1@!RealAlterarSimStatus Transmite (1-Pendente/2-CKO/3-SF1)
CKO_ERRTRAM

RealAlterarSimErro status Transmite
CKO_RECIBOC36@!Real AlterarSimRecibo do TOTVS Transmite
Card
effectDuration0.5
idParâmetros
labelParâmetros
titleParâmetros
effectTypeslide
  • Parâmetros utilizados na integração.
XMLHIST
ParâmetroTipoConteúdoDescriçãoObservação
MV_IMPXMLLTHabilita integração Importador XMLParâmetro deve ser T para que integração com o TOTVS Transmite funcione.
MV_DOCIMPCNFE/NFS/CTE/CTOTipo de XML a serem importados pela integração Importador XML x TOTVS Transmite
MV_XMLCIDC
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_XMLCSECC
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_XMLDIASN30Range dias para importar documentos do TOTVS Transmite.

Data Inicio: Data de hoje - MV_XMLDIAS (30)

Data Final: Data de hoje


MV_NGINNL.F.Salva histórico de Ids importados e/ou com erros.O histórico é salvo na tabela DHZ.C
Caminho para importar XMLs pelo MV_NGINNCCaminho 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_NGLIDOSC
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

ObsObs1: 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_APITRANCproductionIndica ambiente do Totvs Transmite (production / staging / development)Default: production
MV_TRAEXPDTINITRLDTT = Somente documentos não integrados com o ERP / F = Todos documentos.Default: T
MV_TRAXMLC\transmite\Diretório que será criado dentro da pasta in (MV_NGINN) para leitura dos XML importados via TOTVS Transmite.

Obrigatório ter preenchido parâmetro MV_NGINN.

Obs: Ambientes Linux deixar nomenclatura minúscula

20230101Data 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:

Image Added

Image Removed Image Added  Image Removed

Card
effectDuration0.5
idEmpresa
labelGrupo/Filial
titleEmpresa
effectTypeslide
  • 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.

Image RemovedImage Added

  • Empresa/Filial: Empresa que serão utilizadas para importarem os XML's
  • Modulo: (Ex: 02 - Compras)
  • Deixar habilitado
  • Card
    defaulttrue
    effectDuration0.5
    idAgendamento
    labelAgendamento
    titleAgendamento
    effectTypeslide

    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ênciaConfiguraçãoConsumo Licença
        COLAUTOREADPara importar XML's
        e gravar informações na tabela CKO
    SCHEDCOMCOL

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

    através da pasta IN (MV_NGINN) e gravar informações na tabela CKO48 (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
    SCHEDIMPTRAPara requisitar e ler recibos retornados do TOTVS Transmite144 (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
    SCHEDUPDTRAPara atualizar status de documentos no TOTVS Transmite72 (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 habilitadoInformar recorrência: Definir o tempo em que os XML serão importados e gravados.
    Observação: Sugerimos que não deixa sempre ativo, defina a execução de tempo em tempo, Ex: 30 minutos
    • 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.


    Card
    effectDuration0.5
    idDocImportados
    labelDocumentos Importados
    titleDocumentos Importados
    effectTypeslide

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

    DocumentoCódigoTipo Requisição

    NF-e

    109

    Recebimento

    NFS-e

    319

    Recebimento

    CT-e

    214

    Recebimento

    CTEOS273Recebimento



    Aviso
    titleImportante

    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

    Card
    effectDuration0.5
    idFAQs
    labelFAQs
    titleFAQs
    effectTypeslide

    FAQs - Integração Importador XML x Totvs Transmite

    IX08013 - Importador XML x Totvs Transmite - Performance



    Card
    defaulttrue
    effectDuration0.5
    idSuporte
    labelSuporte
    effectTypeslide

    Materiais Auxiliares

    Importador XML - Guia de Referencia (SIGACOM)


    HTML
    <!-- esconder o menu --> <style> div.theme-default .ia-splitter #main { margin-left: 0px; } .ia-fixed-sidebar, .ia-splitter-left { display: none; } #main { padding-left: 10px; padding-right: 10px; overflow-x: hidden; } .aui-header-primary .aui-nav, .aui-page-panel { margin-left: 0px !important; } .aui-header-primary .aui-nav { margin-left: 0px !important; } </style>



    HTML
    <style>
    
    .aui-tabs.horizontal-tabs>.tabs-menu>.menu-item.active-tab a, .aui-tabs.horizontal-tabs>.tabs-menu>.menu-item.active-tab a:link, .aui-tabs.horizontal-tabs>.tabs-menu>.menu-item.active-tab a:visited, .aui-tabs.horizontal-tabs>.tabs-menu>.menu-item.active-tab a:focus, .aui-tabs.horizontal-tabs>.tabs-menu>.menu-item.active-tab a:hover, .aui-tabs.horizontal-tabs>.tabs-menu>.menu-item.active-tab a:active {
    color: white;
    }
    
    .aui-tabs.horizontal-tabs>.tabs-menu>.menu-item.active-tab a::after {
    background: white; !important}
    Composition Setup
    deck.tab.inactive.background = #e7e7e7
    deck.tab.active.background = #252626