Painel

title	Objetivo

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 El objetivo de este documento es ofrecer las informaciones necesarias para la configuración y el uso de la integración entre el Importador XML y el TOTVS Transmite.

Deck of Cards

effectDuration	0.5
id	cabecalho
effectType	slide

Card

default	true
effectDuration	0.5
id	transmite
label	Importador XML x vs. TOTVS Transmite
title	Transmite
effectType	slide

Deck of Cards

effectDuration	0.5
id	tudo-sobre
effectType	slide

Card

default	true
effectDuration	0.5
id	IntroducaoIntroducción
label	IntroduçãoIntroducción
title	IntroduçãoIntroducción
effectType	slide

Column

Conteúdo

Índice

Este documento possui o intuito tiene el propósito de ser um guia un guía para os los clientes, analistas e desenvolvedoresy desarrolladores, que utilizam ou que querem aderir na sua rotina de trabalho as funcionalidades que são disponibilizadas pelo integração do Importador XML x utilizan o que quieren adherir, en su rutina de trabajo, a las funcionalidades que se ponen a disposición por medio de la integración del Importador XML vs. TOTVS Transmite.

Painel

title	Processo Proceso de Check-list

Para que a integração la integración entre o el Importador XML e y el TOTVS Transmite funcione corretamentecorrectamente, preparamos um un Checklist dos de los requisitos mínimos que devem ser validados para o correto funcionamento da integraçãodeben validarse para el correcto funcionamiento de la integración.

[Imagem para ilustrar as etapas do Checklist]

*

Clique na imagem

Haga clic en la imagen para ampliar.

Painel

title	Integração Integración (Processo Proceso macro):

Abaixo uma imagem ilustrativa do processo de integração entre o Importador XML e A continuación, una imagen ilustrativa del proceso de integración entre el Importador XML y el TOTVS Transmite.

[

Imagem

Imagen para ilustrar

a integração

la integración Importador XML

e

y TOTVS Transmite]

*

Clique na imagem

Haga clic en la imagen para ampliar.

Card

default	true
effectDuration	0.5
id	FluxogramaFlujograma
label	Fluxograma Flujograma / Etapas do Processodel proceso
title	FluxogramaFlujograma
effectType	slide

PASSO 12

Agendamento

Deck of Cards

effectDuration	0.5
id	FluxoFlujo
effectType	slide

Card

default	true
effectDuration	0.5
id	Fluxograma
label	FluxogramaFlujograma
title	Fluxograma
effectType	slide

Painel

title	Descrição das Etapas do ProcessoDescripción de las etapas del proceso

Observação Observación:

[

Imagem

Imagen para ilustrar

o Fluxo integração

el Flujo integración Importador XML

e

y TOTVS Transmite]

Card

default	true
effectDuration	0.5
id	Etapas
label	Etapas
title	Etapas
effectType	slide

Painel

title	Descrição das Etapas do ProcessoDescripción de las etapas del proceso

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 Observación: Para un mejor aprovechamiento y entendimiento de la integración entre el Importador XML y el TOTVS Transmite es importante que el usuario tenga el conocimiento previo

Etapas Importador XML

x

vs. TOTVS Transmite

Descrição do Processo

Descripción del proceso

TOTVS Transmite

Descrição do Processo

Descripción del proceso

Importador XML

Descrição do Processo

Descripción del proceso

TEC

PASSO 1

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

PASO 1

Configuración de la integración Importador XML vs. Totvs Transmite

Parâmetros

Parámetros:

MV_IMPXML (Habilitado Importador XML)
MV_XMLCID (Client Id Transmite)
MV_XMLCSEC (Client Secret Transmite)
MV_APITRAN (

Ambiente

Entorno Transmite)
MV_NGINN (

Pasta

Carpeta IN)
MV_NGLIDOS (

Pasta Lidos

Carpeta Leídos)
MV_TRAXML (

Pasta a ser criada dentro da Pasta

Carpeta que se creará dentro de la Carpeta IN - MV_NGINN)
MV_DOCIMP (Tipo documentos

a serem importados

que se importarán)

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

Por medio del Wizard es posible configurar todos los parámetros descritos anteriormente e informar las sucursales del Importador XML que se integrarán al Totvs Transmite (Grabando en la DHW)

PASO 2

Programación en agenda COLAUTOREAD

Inicia verificando si tiene XML en la carpeta

Inicia verificando se possui XMLs na pasta

IN (MV_NGINN)

Após leitura da pasta

Después de la lectura de la carpeta IN (MV_NGINN),

é feita a chamado do EndPoint no

se realiza la llamada del EndPoint en el Totvs Transmite para requisitar

os XMLs pendentes para integração com

los XML pendientes para integración con el Importador XML

Importante: Para

correto funcionamento do EndPoint, é preciso ter:

el correcto funcionamiento del EndPoint, es necesario tener:

Tabla DHW con el vínculo entre las sucursales del Protheus y Totvs Transmite
Parámetro

Tabela DHW com o vinculo entre as filiais do Protheus e Totvs Transmite

Parâmetro

: MV_DOCIMP e MV_XMLDIAS

PASSO

PASO 3

Agendamento

Programación en agenda COLAUTOREAD

Totvs Transmite

recebe requisição solicitada pelo Importador XML e retorna ao Protheus os

recibe la requisición solicitada por el Importador XML y devuelve al Protheus los "Recibos"

Importante:

Totvs Transmite retorno um

Totvs Transmite devuelve un recibo por tipo de documento (MV_DOCIMP)

PASSO


PASO 4

Agendamento

Programación en agenda COLAUTOREAD

Protheus (Importador XML)

recebe os

recibe los "Recibos"

do

del Totvs Transmite

e os grava na tabela

y los graba en la tabla DHY

PASSO

PASO 5

Agendamento

Programación en agenda COLAUTOREAD

Com os

Con los "Recibos"

na tabela DHY é feito a chamada de outro EndPoint no Totvs Transmite para gravar o XMLs no Importador XML (Tabela

en la tabla DHY se realiza la llamada de otro EndPoint en el Totvs Transmite para grabar los XML en el Importador XML (Tabla CKO)

PASSO

PASO 6

Agendamento

Programación en agenda COLAUTOREAD

Totvs Transmite

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

recibe la requisición solicitada por el Importador XML y devuelve al Protheus un archivo en Encode64 con todos los XML de aquel "Recibo"

PASSO


PASO 7

Agendamento

Programación en agenda COLAUTOREAD

Protheus (Importador XML)

recebe o Encode64 com os XMLs e vai fazer o

recibe el Encode64 con los XML y hace el Decode64 (TEC)

O Decode64 é feito e seu retorno gera um arquivo

El Decode64 se realiza y su devolución generará una archivo .ZIP

PASSO

PASO 8

Agendamento

Programación en agenda COLAUTOREAD

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

	Con el archivo .ZIP generado por medio del Decode64, es necesario descomprimir este archivo.	La descompresión del archivo .ZIP se realiza por medio de la función FUnZip
PASO 9 Programación en agenda COLAUTOREAD		Los archivos descomprimidos se grabarán dentro de la carpeta (MV_TRAXML) y se realizará la lectura de los XML grabando en la tabla CKO
PASO 10 Programación en agenda COLAUTOREAD		Después de la grabación en la tabla CKO, el Importador XML llama al EndPoint del Totvs Transmite para hacer las actualizaciones de estatus del documento en el Totvs Transmite
PASO 11 Programación en agenda COLAUTOREAD	Totvs Transmite recibe la requisición solicitada por el Importador XML con la clave del documento y realiza la actualización de los estatus en el Totvs Transmite.
PASO 12 Programación en agenda

PASSO 9

Agendamento COLAUTOREAD

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

PASSO 10

Agendamento COLAUTOREAD

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 11

Agendamento COLAUTOREAD

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

SCHEDCOMCOL

Protheus (Importador XML)

lê os XMLs da tabela CKO e os envia para o Monitor, caso não encontre nenhuma inconsistência

lee los XML de la tabla CKO y los envía al Monitor, si no encuentra ninguna inconsistencia.

Card

effectDuration	0.5
id	Tabelas
label	Tabelas Tablas / FontesFuentes
title	Tabelas
effectType	slide

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

Card

effectDuration	0.5
id	Configuração
label	ConfiguraçãoConfiguración
title	Configuração
effectType	slide

Deck of Cards

effectDuration	0.5
id	Funcionalidades
effectType	slide

Card

default	true
effectDuration	0.5
id	Wizard
label	Wizard
title	Wizard
effectType	slide

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

Link: IX09 - Wizard Configuração

Card

default	true
effectDuration	0.5
id	Dicionario
label	DicionárioDiccionario
title	Dicionario
effectType	slide

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

Í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

Í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

Card

effectDuration	0.5
id	ParâmetrosParámetros
label	ParâmetrosParámetros
title	ParâmetrosParámetros
effectType	slide

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	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 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 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_XMLHIST	L	.F.	Salva histórico de Ids importados e/ou com erros.	O histórico é salvo na tabela DHZ.
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_TRAEXP	L	T	T = Somente documentos não integrados com o ERP / F = Todos documentos.	Default: T
MV_TRAXML	C	\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

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

Card

effectDuration	0.5
id	Empresa
label	Grupo/FilialSucursal
title	Empresa
effectType	slide

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.

Card

default	true
effectDuration	0.5
id	AgendamentoProgramación en agenda
label	AgendamentoProgramación en agenda
title	AgendamentoProgramación en agenda
effectType	slide

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
  COLAUTOREAD Para 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)
- Empresa/Filial: Empresa que serão utilizadas para importarem os XML's
- Modulo: (Ex: 02 - Compras)
- Deixar habilitado
- Informar 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

effectDuration	0.5
id	DocImportados
label	Documentos Importadosimportados
title	Documentos Importadosimportados
effectType	slide

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

Aviso

title	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

Card

effectDuration	0.5
id	FAQsFAQ
label	FAQsFAQ
title	FAQsFAQ
effectType	slide

FAQs - Integração Importador XML x Totvs Transmite

IX08013 - Importador XML vs. Totvs Transmite - Desempeño

Card

default	true
effectDuration	0.5
id	SuporteSoporte
label	SuporteSoporte
effectType	slide

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

Atalhos

Árvore de páginas

Versões comparadas

Versão antiga 2

Nova versão 3

Chave

Índice

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

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

FAQs - Integração Importador XML x Totvs Transmite

Atalhos

Árvore de páginas

Histórico da Página

Versões comparadas

Versão antiga 2

Nova versão 3

Chave

Índice

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

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

FAQs - Integração Importador XML x Totvs Transmite