Objetivo
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.
Contenido
Este documento tiene el propósito de ser un guía para los clientes, analistas y desarrolladores, que 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.
Proceso de Check-list
Para que la integración entre el Importador XML y el TOTVS Transmite funcione correctamente, preparamos un Checklist de los requisitos mínimos que deben validarse para el correcto funcionamiento de la integración.
[Imagen para ilustrar las etapas del Checklist]
*Haga clic en la imagen para ampliar.
Integración (Proceso macro):
A continuación, una imagen ilustrativa del proceso de integración entre el Importador XML y el TOTVS Transmite.
[Imagen para ilustrar la integración Importador XML y TOTVS Transmite]
*Haga clic en la imagen para ampliar.
Descripción de las etapas del proceso
Observación:
[Imagen para ilustrar el Flujo integración Importador XML y TOTVS Transmite]
Descripción de las etapas del proceso
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 |
Descripción del proceso TOTVS Transmite |
Descripción del proceso Importador XML |
Descripción del proceso TEC |
|---|---|---|---|
PASO 1 Configuración de la integración Importador XML vs. Totvs Transmite |
Parámetros:
Wizard: 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 |
Importante: Para el correcto funcionamiento del EndPoint, es necesario tener:
|
||
PASO 3 Programación en agenda COLAUTOREAD |
Totvs Transmite recibe la requisición solicitada por el Importador XML y devuelve al Protheus los "Recibos" Importante: Totvs Transmite devuelve un recibo por tipo de documento (MV_DOCIMP) |
||
PASO 4 Programación en agenda COLAUTOREAD |
Protheus (Importador XML) recibe los "Recibos" del Totvs Transmite y los graba en la tabla DHY |
||
PASO 5 Programación en agenda COLAUTOREAD |
Con los "Recibos" 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) |
||
PASO 6 Programación en agenda COLAUTOREAD |
Totvs Transmite recibe la requisición solicitada por el Importador XML y devuelve al Protheus un archivo en Encode64 con todos los XML de aquel "Recibo" |
||
PASO 7 Programación en agenda COLAUTOREAD |
Protheus (Importador XML) recibe el Encode64 con los XML y hace el Decode64 (TEC) |
El Decode64 se realiza y su devolución generará una archivo .ZIP |
|
PASO 8 Programación en agenda COLAUTOREAD |
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 SCHEDCOMCOL |
Protheus (Importador XML) lee los XML de la tabla CKO y los envía al Monitor, si no encuentra ninguna inconsistencia. |
- Tablas:
Tabla |
Descripción |
|---|---|
DHW |
Configuración Grupo/Empresa que integra con el Totvs Transmite |
DHY |
Graba los Id para consulta de los XML importados del Totvs Transmite |
DHZ |
Historial de Id con errores e importados al Importador XML |
CKOCOL |
Registros de los XML importados |
SDS |
Encabezado del documento en el monitor |
SDT |
Ítems del documento en el monitor |
- Fuentes involucrados:
Fuentes |
Descripción |
|---|---|
COLXCFG |
Wizard de configuración TOTVS Colaboración / Importador XML |
COLAUTOREAD |
Rutina para importar XML en la CKOCOL |
COMTRANSMITE |
Clase/Objeto para importación de los XML originados mediante el TOTVS Transmite |
COMXCOL |
Monitor |
MATA140I |
Importa FactE/FactS del TOTVS Colaboración / Importador XML |
MATA116I |
Importa CTE/CTEOS del TOTVS Colaboración / Importador XML |
Puede utilizarse el Wizard como facilitador de la configuración.
Enlace: IX09 - Wizard Configuración
- Tabla DHW
| Campo: | Tipo: | Tamaño: | Formato: | Contexto: | Propiedad: | Utilizado: | Descripción: |
|---|---|---|---|---|---|---|---|
| DHW_GRPEMP | C | 2 (Tamaño del Grupo de empresa) | @! | Real | Modificar | Sí | Grupo empresa |
| DHW_FILEMP | C | 8 (Tamaño de la sucursal) | @! | Real | Modificar | Sí | Sucursal empresa |
| DHW_CGC | C | 14 | @! | Real | Modificar | Sí | RGPJ/RCPF (Registro de Contribuyente Persona Jurídica/Registro de Contribuyente Persona Física) |
| DHW_IE | C | 14 | @! | Real | Modificar | Sí | Inscripción estatal |
| DHW_UF | C | 2 | @! | Real | Modificar | Sí | Estado/Provincia/Región |
| DHW_CODFIL | C | 40 | @! | Real | Modificar | Sí | Código sucursal en el Transmite |
| Índices: |
|---|
| DHW_FILIAL+DHW_GRPEMP+DHW_FILEMP |
DHW_FILIAL+DHW_CGC+DHW_IE |
| DHW_FILIAL+DHW_CODFIL |
- Tabla DHY
| Campo: | Tipo: | Tamaño: | Formato: | Contexto: | Propiedad: | Utilizado: | Descripción: |
|---|---|---|---|---|---|---|---|
| DHY_CODFIL | C | 40 | @! | Real | Modificar | Sí | Código sucursal en el Transmite |
| DHY_TPXML | C | 5 | @! | Real | Modificar | Sí | Tipo XML (NFE/NFS/CTE/CTEOS) |
| DHY_ID | C | 36 | @! | Real | Modificar | Sí | Id Recibo Transmite |
| DHY_STATUS | C | 1 | @! | Real | Modificar | Sí | Estatus (0-Pendiente/1-Ok/2-Error) |
| DHY_DTID | D | 8 | Real | Modificar | Sí | Fecha importación ID Recibo | |
| DHY_FILTRO | C | 200 | @! | Real | Modificar | Sí | Filtro requisición |
| DHY_TENT | N | 14 | @999,999,999,999,99 | Real | Modificar | Sí | Intentos |
| Índices: |
|---|
| DHY_FILIAL+DHY_CODFIL+DHY_TPXML+DHY_ID |
| DHY_FILIAL+DHY_TPXML+DHY_FILTRO |
- Tabla DHZ
| Campo: | Tipo: | Tamaño: | Formato: | Contexto: | Propiedad: | Utilizado: | Descripción: |
|---|---|---|---|---|---|---|---|
| DHZ_CODFIL | C | 40 | @! | Real | Modificar | Sí | Código sucursal en el TOTVS Transmite |
| DHZ_TPXML | C | 5 | @! | Real | Modificar | Sí | Tipo XML (NFE/NFS/CTE/CTEOS) |
| DHZ_ID | C | 36 | @! | Real | Modificar | Sí | Id Recibo Transmite |
| DHZ_STATUS | C | 1 | @! | Real | Modificar | Sí | Estatus (0-Pendiente/1-Ok/2-Error) |
| DHZ_DTID | D | 8 | Real | Modificar | Sí | Fecha importación | |
| DHZ_FILTRO | C | 200 | @! | Real | Modificar | Sí | Filtro requisición |
| DHZ_TENT | N | 14 | @999,999,999,999,99 | Real | Modificar | Sí | Intentos |
| DHZ_DTLID | D | 8 | Real | Modificar | Sí | Fecha leído recibo |
| Índices: |
|---|
| DHZ_FILIAL+DHZ_CODFIL+DHZ_TPXML+DHZ_ID |
| DHZ_FILIAL+DHZ_TPXML+DHZ_FILTRO |
- Tabla CKO
| Campo: | Tipo: | Tamaño: | Formato: | Contexto: | Propiedad: | Utilizado: | Descripción: |
|---|---|---|---|---|---|---|---|
| CKO_CHVDOC | C | 44 | @! | Real | Visualizar | Sí | Clave documento |
| CKO_ORIGEM | C | 10 | @! | Real | Modificar | Sí | Origen |
| CKO_STRAN | C | 1 | @! | Real | Modificar | Sí | Estatus Transmite (1-Pendiente/2-CKO/3-SF1) |
| CKO_ERRTRA | M | Real | Modificar | Sí | Error estatus Transmite |
- Parámetros utilizados en la integración.
Parámetro |
Tipo |
Índice |
Descripción |
Observación |
|---|---|---|---|---|
MV_IMPXML |
L |
T |
Habilita integración Importador XML |
Parámetro debe ser T para que la integración con el TOTVS Transmite funcione. |
MV_DOCIMP |
C |
NFE/NFS/CTE |
Tipo de XML que se importará mediante la integración Importador XML vs. TOTVS Transmite |
|
MV_XMLCID |
C |
Client ID del TOTVS Transmite |
La información vendrá del TOTVS Transmite. Para obtener la credencial:
|
|
MV_XMLCSEC |
C |
Client Secret del TOTVS Transmite |
La información vendrá del TOTVS Transmite. Para obtener la credencial:
|
|
MV_XMLDIAS |
N |
30 |
Rango días para importar documentos del TOTVS Transmite. |
Fecha inicial Fecha de hoy - MV_XMLDIAS (30) Fecha final: Fecha de hoy |
MV_XMLHIST |
L |
.F. |
Graba historial de Id importados y/o con errores. |
El historial se graba en la tabla DHZ. |
MV_NGINN |
C |
Camino para importar XML por el Importador XML |
El tratamiento continuará funcionando inclusive con la integración con el TOTVS Transmite activa Obs: Entornos Linux, dejar nomenclatura minúscula |
|
MV_NGLIDOS |
C |
Camino donde los XML leídos de la carpeta IN se almacenarán. |
El tratamiento continuará funcionando inclusive con la integración con el TOTVS Transmite activa Obs1: Entornos Linux, dejar nomenclatura minúscula |
|
MV_APITRAN |
C |
production |
Indica entorno del Totvs Transmite (production / staging / development) |
Default: production |
MV_TRAEXP |
L |
T |
T = Solamente documentos no integrados con el ERP / F = Todos documentos. |
Estándar: T |
MV_TRAXML |
C |
\transmite\ |
Directorio que se creará dentro de la carpeta in (MV_NGINN) para lectura de los XML importados por medio del TOTVS Transmite. |
Es obligatorio que esté informado el parámetro MV_NGINN. Obs: Entornos Linux, dejar nomenclatura minúscula |
- Imágenes de la configuración de los parámetros en el Wizard:
- Informe qué Grupo/Sucursal estará integrado con el TOTVS Transmite. Para que solamente se importen los XML pertenecientes a este mismo Grupo/Filial.
Observación: Al seleccionar Grupo/Sucursal, este debe tener su Código sucursal del TOTVS Transmite. La información estará en la tabla DHW (DHW_CODFIL)
- Imagen de la configuración de Grupo/Sucursal en el Wizard.
En el Importador XML es necesario crear programaciones en agenda de las rutinas responsables por la importación y grabación del XML en el Monitor (Protheus).
Para realizar el registro de las programaciones en agenda, es necesario lo siguiente:
- SIGACFG -> ENTORNO -> SCHEDULE -> SCHEDULE (Programación en agenda -> Registro):
- Informar usuario (Ej: 000000 - Administrador)
Rutina (siguiente tabla)
Programación en agenda
Descripción
COLAUTOREAD Para importar XML y grabar informaciones en la tabla CKO SCHEDCOMCOL Leer los XML de la CKO e importar al monitor (SDS y SDT)
- Empresa/Sucursal: Empresa que se utilizará para importar los XML
- Modulo: (Ej: 02 - Compras)
- Dejar habilitado
- Informar recurrencia: Definir el tiempo en que los XML se importarán y grabarán.
Observación: Sugerimos que no deje siempre activo, defina la ejecución de tiempo en tiempo, jx: 30 minutos
- SIGACFG -> AMBIENTE -> SCHEDULE -> SCHEDULE (Agent -> Registro):
- Incluir el Grupo de empresa/Empresa que tiene configuradas las programaciones en agenda.
Para que funcionen correctamente las programaciones en agenda es necesario que después de toda configuración, el Agent y el Schedule se activen.
Lista de documentos importados por la integración Totvs Transmite vs. Importador XML
| Documento | Código | Tipo requisición |
|---|---|---|
e-Fact |
109 | Cobranza |
e-FactS |
319 | Cobranza |
e-CT |
214 | Cobranza |
| CTEOS | 273 | Cobranza |
Importante
Importador XML integrado con TOTVS Transmite: Documentos FactS se importarán.
Importador XML NO integrado con TOTVS Transmite: Documentos FactS NO se importarán
FAQ - Integración Importador XML v. Totvs Transmite
IX08013 - Importador XML vs. Totvs Transmite - Desempeño
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas