3. Índice
INTRODUCCIÓN AL TALLER SDK DE CONTPAQ I PÁGINA
VISIÓN GENERAL ................................................................................... 1
CAPÍTULO 1. CONOCIENDO EL SDK PÁGINA
CONCEPTOS GENERALES ............................................................................ 1-2
EL SDK DE CONTPAQ WINDOWS ................................................................ 1-3
FUNCIONAMIENTO DEL SDK DE CONTPAQ I ............................................... 1-4
BENEFICIOS Y LIMITANTES DE DESARROLLO .................................................. 1-6
ALCANCE DEL DESARROLLO DE MÓDULOS .................................................... 1-7
CAPÍTULO 2. TRABAJANDO CON EL SDK ......................................................... PÁGINA
INSTALANDO EL SDK DE CONTPAQ I ........................................................ 2-8
INTERFAZ CON CONTPAQ I ....................................................................... 2-9
UTILIZANDO DBFWIN32.DLL Y POLDLL32 ....................................... 2-9
UTILIZANDO SDK DE CONTPAQ I ....................................................... 2-11
ALTA Y CONSULTA DEL CATALOGO DE CUENTAS DE CONTPAQ I ................... 2-13
4.
5. Introducción al Taller SDK de CONTPAQ i®
Visión General
Objetivo general Al finalizar este taller, el participante conocerá qué es el SDK de CONTPAQ i y la
compatibilidad existente para desarrollar accesorios con esta herramienta.
Además, identificará lo que se puede hacer con el SDK, así como la forma de migrar los
módulos o aplicaciones desarrolladas que ya funcionan con SDK ContPAQW a SDK
CONTPAQ i .
Beneficios Entre los beneficios que obtendrá durante este taller se encuentran:
• Mayor conocimiento sobre el uso y aplicación de esta herramienta
• Identificar los componentes
Expectativa del Durante este taller se espera del participante:
participante
• Disposición al aprendizaje
• Retroalimentación
• Actitud positiva
• Actitud entusiasta hacia el trabajo
Estructura del El taller está integrado por dos grandes módulos: el primero contiene todos los conceptos
taller necesarios para entender qué es el SDK y, el segundo, incluye demostraciones que le
ayudarán a comprender mejor este tema.
Información del documento
Fecha de elaboración 03 de octubre de 2006
Fecha última modificación 13 de octubre de 2006
Sugerencias o comentarios capacitacion@compac.com.mx
www.masnegocioenmenostiempo.com
Ligas de interés
www.contaqtame.com.mx
Página
1
6.
7. Capítulo 1
Conociendo el SDK
Conceptos generales
Qué es el SDk Software Development Kit por sus siglas en inglés SDK.
Es una serie de recursos que permiten interactuar a nivel programación a través de funciones
ó métodos con la Base de Datos del sistema CONTPAQ i, asegurando su integridad y
consistencia.
Beneficios del Al utilizar el SDK podrá tener acceso de lectura y escritura a las Bases de Datos de las
SDK empresas instaladas en CONTPAQ i desde un accesorio o aplicación externa; garantizando
la integridad y consistencia de la información así como la concurrencia de las aplicaciones en
un ambiente multiusuario.
Qué son las Las reglas de negocio son validaciones aplicadas con el fin de evitar inconsistencias en la
reglas de información y respetar la lógica conceptual de la aplicación.
negocio
Aplicación de las Estas validaciones se aplican sobre:
reglas de
negocio • El ingreso de datos
• La integridad referencial
• Procesos permitidos entre los módulos del sistema
Página
1-1
8. El SDK de ContPAQ Windows®
Introducción En este tema se explican las generalidades del SDK de ContPAQ Windows.
Función El SDK de ContPAQ Windows permite dar de alta pólizas y cuentas en el catálogo.
Nota: Éste se encuentra disponible sólo al instalar ContPAQ Windows.
Archivos que lo El SDK de ContPAQ Windows está compuesto por los siguientes archivos:
componen
Archivo Descripción
Poldll32.dll Insertar, modificar y eliminar pólizas.
Catadll32.dll Insertar, modificar y eliminar cuentas.
Funciones genéricas de lectura/escritura.
Dbfwin32.dll Nota: Básicamente estas funciones permiten: ir al inicio, fin,
siguiente, anterior registro de un archivo; buscar registro y leer
datos; crear y modificar tablas.
Funciones de muy bajo nivel de acceso a la base de datos.
C4dll32.dll
Nota: Permiten la lectura y escritura.
Nota: Estos archivos se incluyen sólo al instalar ContPAQ Windows.
Más información Si requiere más información sobre las funciones del SDK de ContPAQ Windows envíe un
correo electrónico a desarrollo@compac.com.mx.
Página
1-2
9. Funcionamiento del SDK de CONTPAQ i
Cómo funciona La comunicación entre la plataforma de CONTPAQ i y el accesorio ó aplicación de un tercero
se realiza a través de un componente COM, que a su vez tiene Dll´s auxiliares.
Este componente COM funciona como intermediario entre la aplicación o módulo con la
plataforma.
Observe el siguiente gráfico para comprender mejor el funcionamiento del SDK:
Componente En la siguiente tabla se listan las características de un componente COM y una Dll para
COM vs Dll comprender mejor la diferencia entre ambas:
Qué es
Componente COM Dll
Modelo de Objeto Componente Librería de ligado dinámico.
(COM = Component Object Model) (Dll = Data Link Library)
Arquitectura de Software (de Microsoft)
que permite construir aplicaciones a Librería de funciones ejecutables o datos que
partir de componentes (módulos) de pueden ser usados por una aplicación Windows.
software binarios.
Continúa en la siguiente página
Página
1-3
10. Funcionamiento del SDK de CONTPAQ i, Continuación
Componente COM vs Dll (continúa)
Qué es
Componente COM Dll
Comúnmente una Dll provee una o más
funciones comunes y los programas las
Estos componentes de software proveen
acceden creando una liga estática o dinámica.
servicios a través de interfaces.
Liga estática = se establece al compilar el
Interfaz = grupo de métodos (funciones)
programa.
y propiedades relacionados.
Liga dinámica = es creada por el programa
conforme éste se va ejecutando.
Componentes del EL SDK de CONTPAQ i está compuesto por:
SDK • Documentación que incluye: especificación de requerimientos mínimos para su uso,
referencia de programación de aplicaciones, reglas de negocio.
• La referencia de programación de aplicaciones incluye ejemplos en determinados
lenguajes. (Para clarificar el acceso y uso del componente COM).
• Instalador del SDK. Instalador independiente para distribuir aplicaciones a los clientes.
Nota: el SDK también está disponible al instalar CONTPAQ i.
• Dll´s que conforman el SDK de ContPAQ Windows que proveen la compatibilidad con
CONTPAQ i.
Página
1-4
11. Beneficios y limitantes de desarrollo
Introducción En este tema se muestran los beneficios y las limitantes de desarrollar aplicaciones utilizando
el SDK de CONTPAQ i.
Componente En la siguiente tabla se comparan los beneficios contra las limitantes del desarrollo de
COM aplicaciones utilizando el componente COM:
Beneficios Limitantes
Reglas de negocio validadas por el
SDK Dependiente del lenguaje -capacidad de cargar un
Conexión a varias empresas a la vez componente COM
Instalador independiente
Documentación y ayuda dentro del
mismo componente
Migración de módulos desarrollados con el
Creación, modificación, borrado de
Poldll32, Catadll32 y DBfwin32 de ContPAQ
catálogos y documentos (Pólizas)
Windows, requiere reprogramar
Soporta el acceso remoto
Dll´s con Las Dll’s compatibles con CONTPAQ i son: Poldll32, Catadll32 y Dbfwin32.
compatibilidad
Consulte la siguiente tabla para conocer los beneficios y limitantes del uso de Dll’s:
CONTPAQ i
Beneficios Limitantes
Dependiente del lenguaje - capacidad de cargar
Reglas de negocio validadas por el
de manera dinámica un Dll y tener acceso a su
SDK
funcionalidad
Conexión a varias empresas a la vez Documentación independiente
La compatibilidad soporta sólo lectura de
Son instalados por instalador
catálogos y creación, modificación y borrado de
independiente del SDK de CONTPAQ i
pólizas
Migración con un mínimo de cambios a
los módulos desarrollados con el
Poldll32, Catadll32 y Dbfwin32 de No se le agregará mayor funcionalidad
ContPAQ Windows
Soporta el acceso remoto
Archivos que se Al instalar el SDK de CONTPAQ i se crea la carpeta Cliente en la ruta:
instalan <C:Archivos de programaCompacContPAQ>
Dentro de ella se crean entradas en el registro para SDKContPAQNG.dll. Consulte la
siguiente tabla para conocer los archivos restantes que se instalan, así como una breve
descripción:
Archivo Descripción
Contiene el SDK de CONTPAQ i y sus reglas
ContPAQ_NG_DLL.dll
de negocio
SDKContPAQNG.dll (COM.DLL) Funciones, métodos y propiedades
Programa configuración del acceso como cliente
ContPAQ_NG_Config.exe
de CONTPAQ i
• C4dll32.dll
• catadll32.dll
Son Dll`s con compatibilidad CONTPAQ i
• poldll32.dll
• dbfwin32.dll
Página
1-5
12. Alcance del desarrollo de módulos
Introducción En este tema conocerá los alcances del desarrollo de módulos utilizando tanto el
componente COM , así como del uso de las Dll’s.
Desarrollo con Consulte la siguiente tabla para conocer las acciones que las funciones del componente
componente COM de CONTPAQ i permiten realizar, así como lo que no está soportado en este momento:
COM
Componente COM
Permite… Restringe…
Consultas
Crear sesiones de Empresas
Ejemplo: No se puede ejecutar un listado
Alta, modificación, borrado en Ejecutar procesos:
catálogos (cuentas, conceptos,
segmentos de negocio, diarios • Verificación de pólizas
especiales, tipos de póliza) • Reconstrucción de saldos
• Alta, modificación, borrado de
documentos (pólizas)
Prepólizas
• Uso de funciones de la hoja
electrónica
Desarrollo con El alcance del desarrollo de módulos utilizando Dll’s con compatibilidad con CONTPAQ i son:
Dll’s
• Establecer conexión con la empresa.
• Alta, modificación y borrado de documentos (pólizas).
• Accesos de lectura a través del Dbfwin32.
Nota: Recuerde que las Dll’s disponibles son: Poldll32, Catadll32 y Dbfwin32.
Requerimientos Para desarrollar módulos utilizando el SDK de CONTPAQ i es necesario considerar los
para desarrollar siguientes requerimientos:
• Instalar el SDK de CONTPAQ i
• Lenguaje de programación con capacidad de cargar un componente COM o Dll’s
• Espacio disponible en disco duro de 157 MB
Evolución de los Dentro de Computación en Acción, se espera que cada módulo desarrollado cuente con su
SDK’s propio SDK, de forma que se utilice un componente COM para cada uno de los productos.
Página
1-6
13. Capítulo 2
Trabajando con el SDK
Ejercicio: Instalando el SDK de CONTPAQ i
Problemática El objetivo de este ejercicio es que el participante practique la instalación del SDK de
CONTPAQ i en su máquina y verifique que dicha instalación puede realizarse de forma
independiente a la aplicación de CONTPAQ i.
Ejercicio Realice los pasos indicados en la tabla para instalar el SDK de CONTPAQ i en su
computadora:
Paso Ejercicio
1 Ejecute desde el CD el archivo de instalación del SDK de CONTPAQ i.
2 Si se encuentra trabajando con una máquina como terminal, entonces capture la
dirección IP del servidor a donde se conectará dicho equipo y haga clic en el
botón Siguiente.
Nota: Para este taller, solicite la dirección IP al instructor.
3 Seleccione el directorio donde se instalarán los programas.
Conserve la ruta asignada por omisión: <C:Archivos de programaCompac> y
haga clic en el botón Siguiente para iniciar la instalación.
Resultado: Iniciará el proceso de instalación.
4 Verifique que la instalación se haya efectuado correctamente.
Busque en la ruta <C:Archivos de programaCompacContPAQCliente> los
archivos indicados en la tabla y en la columna Marcar indique con una los
archivos que sí aparecen en la ruta:
Archivo Marcar
ContPAQ_NG_DLL.dll _____________
SDKContPAQNG.dll _____________
ContPAQ_NG_Config.exe _____________
C4dll32.dll _____________
catadll32.dll _____________
poldll32.dll _____________
dbfwin32.dll _____________
Importante: Cuando requiera modificar la configuración o cambiar la dirección IP, podrá
hacerlo habilitando la ventana Configuración de Aplicaciones Compac. Esta se localiza
dentro del grupo de programas Compac – CONTPAQ i (local)
Página
2-1
14. Interfaz con CONTPAQ i
Utilizando Dbfwin32 y Poldll32
Introducción En este tema se utilizará una aplicación externa para capturar pólizas, conectarse a
CONTPAQ i e enviar esta información.
Requisitos Para realizar la interfaz con CONTPAQ i es necesario:
• Tener instalado CONTPAQ i
• Tener las Dll’s Dbfwin32.dll y Poldll32.dll, incluidas en el SDK de CONTPAQ i. (Se
instala con CONTPAQ i o puede ser instalado de manera independiente a partir de
la versión 1.1.1)
Archivos a Para realizar la interfaz, se debe contar con los siguientes archivos:
utilizar • DemoConexionCONTPAQi.exe
• DemoConexionCONTPAQi.xls
Importante:
• Los archivos exe y xls son programas educativos donde algunas variables están
limitadas.
Ejemplo Sólo envía información para el 2006.
• Las interfaces fueron realizadas de la siguiente forma:
o exe = Ejecutable en delphi 3 (PASCAL),cargando las dlls Dbfwin32.dll y
Poldll32.dll
o xls = Archivo en Excel®, cargando las dlls Dbfwin32.dll y Poldll32.dll
(Utilizando VISUAL BASIC FOR APPLICATIONS y macros)
Realizando la Realice el procedimiento de la tabla para practicar la interfaz con CONTPAQ i:
interfaz
Paso Acción
1 Ejecute el archivo DemoConexionCONTPAQi.exe que se localiza dentro del
CD.
2 En el campo “Alias” modifique el nombre de la Base de Datos para direccionar
la empresa con la que se desea realizar la interfaz.
3 Haga clic en el botón Conectarse.
Resultado: Se desplegará la ventana de Acceso a CONTPAQ i.
4 Capture el encabezado de la póliza y el detalle de los movimientos.
Importante:
• Si está trabajando de forma simultánea con otros usuarios, recuerde
que cada uno enviará información al mismo servidor. Asegúrese de
enviar información distinta para evitar problemas al servidor.
Ejemplo: Registre y envíe pólizas con difefentes números.
• Asegúrese de seleccionar cuentas previamente creadas, de tipo
afectables.
• Haga clic en el botón para desplegar el catálogo de cuentas de
CONTPAQ i, así facilitará la búsqueda y captura de cuentas.
Continúa en la siguiente página
Página
2-2
15. Utilizando Dbfwin32 y Poldll32, Continuación
Realizando la interfaz (continúa)
Paso Acción
5 Verifique que la póliza quede cuadrada.
Notas:
• Los programas exe y xls sólo validan la captura pero no validan datos
correctos.
• El SDK de CONTPAQ i valida que las reglas de negocio se cumplan. Esto
facilita la labor al crear nuevas aplicaciones.
6 Haga clic en el botón Enviar Póliza.
Resultado: Se desplegará una ventana confirmando el envío de la póliza.
7 Haga clic en el botón Ok para cerrar la ventana.
8 Ingrese a CONTPAQ i para verificar que la póliza efectivamente está registrada
en el sistema.
Ahora es más facil generar aplicaciones que trabajen conjuntamente y se
conecten con CONTPAQ i.
Nota: Aunque en este procedimiento sólo se hayan enviado pólizas, la
potencialidad del SDK de CONTPAQ i está abierta para interactuar con toda la
base de datos de CONTPAQ i.
9 Una vez que ha consultado la póliza creada desde el archivo exe haga clic en el
botón Desconectarse y salir.
Resultado: Se liberará la memoria utilizada para la conexión (Dll’s ).
Importante: Al trabajar con las aplicaciones creadas por el usuario es importante
ejecutar este paso; de esta forma se evitarán inconsistencia en la memoria de la
máquina.
10 Si lo desea, practique la captura de pólizas y envío de información a CONTPAQ i
utilizando el archivo DemoConexionCONTPAQi.xls siguiendo los pasos del
2 al 9, descritos en esta tabla.
Notas técnicas Al utilizar aplicaciones de terceros, es recomendable que considere los siguientes puntos
para lograr la conexión con CONTPAQ i:
Puntos Acción
1 Cargar las Dll’s Dbfwin32.dll y Poldll32.dll (loadlibrary).
2 Conocer las funciones que el usuario puede utilizar en dichas Dll’s:
• Login
• IniciaPolizaEnLote
• ActualizaPoliza
• CommitPolizaEnLote
• FinalizaPolizaEnLote
• EjecutaBusquedaCuenta
• LogOut
3 Asegúrese de desconectarse de CONTPAQ i.
Página
2-3
16. Utilizando SDK de CONTPAQ i
Introducción En este tema se utilizará una aplicación externa para capturar pólizas, conectarse a
CONTPAQ i e enviar esta información.
Requisitos Para realizar la interfaz con CONTPAQ i es necesario:
• Tener instalado el SDK de CONTPAQ i. (Se instala con CONTPAQ i o puede ser
instalado de manera independiente a partir de la versión 1.1.1).
Archivos a Para realizar la interfaz, se debe contar con el archivo:
utilizar DemoConexionCONTPAQi_SDKCOM.xls
Importante:
• El archivo xls es un programa educativo donde algunas variables están limitadas.
Ejemplo Sólo envía información para el 2006.
• La interfaz fue realizada de la siguiente forma:
o xls = Archivo en Excel®, cargando componente COM (Utilizando
VISUAL BASIC FOR APPLICATIONS y macros).
Realizando la Realice el procedimiento de tabla para practicar la interfaz con CONTPAQ i:
interfaz
Paso Acción
1 Ejecute el archivo DemoConexionCONTPAQi_SDKCOM.xls que se
localiza dentro del CD.
2 En el campo “Alias” modifique el nombre de la Base de Datos para direccionar
la empresa con la que se desea realizar la interfaz.
3 Haga clic en el botón Conectarse.
Resultado: Se desplegará la ventana de Acceso a CONTPAQ i.
4 Capture el encabezado de la póliza y el detalle de los movimientos.
Importante:
• Si está trabajando de forma simultánea con otros usuarios, recuerde
que cada uno enviará información al mismo servidor. Asegúrese de
enviar información distinta para evitar problemas al servidor.
Ejemplo: Registre y envíe pólizas con diferentes números.
• Asegúrese de seleccionar cuentas previamente creadas, de tipo
afectables.
• Haga clic en el botón para desplegar el catálogo de cuentas de
CONTPAQ i, así facilitará la búsqueda y captura de cuentas.
5 Verifique que la póliza quede cuadrada.
Notas:
• Los programas exe y xls sólo validan la captura pero no validan datos
correctos.
• El SDK de CONTPAQ i valida que las reglas de negocio se cumplan. Esto
facilita la labor al crear nuevas aplicaciones.
Continúa en la siguiente página
Página
2-4
17. Utilizando SDK de CONTPAQ i, Continuación
Realizando la interfaz (continúa)
Paso Acción
6 Haga clic en el botón Enviar Póliza.
Resultado: Se desplegará una ventana confirmando el envío de la póliza.
7 Haga clic en el botón Ok para cerrar la ventana.
8 Ingrese a CONTPAQ i para verificar que la póliza efectivamente está registrada
en el sistema.
Ahora es más fácil generar aplicaciones que trabajen conjuntamente y se
conecten con CONTPAQ i.
Nota: Aunque en este procedimiento sólo se hayan enviado pólizas, la
potencialidad del SDK de CONTPAQ i está abierta para interactuar con toda la
base de datos de CONTPAQ i.
9 Una vez que ha consultado la póliza creada desde el archivo exe haga clic en el
botón Desconectarse y salir.
Resultado: Se liberará la memoria utilizada para la conexión.
Importante: Al trabajar con las aplicaciones creadas por el usuario es importante
ejecutar este paso; de esta forma se evitarán inconsistencia en la memoria de la
máquina.
Notas técnicas Al utilizar aplicaciones de terceros, es recomendable que considere los siguientes puntos
para lograr la conexión con CONTPAQ i:
Puntos Acción
1 Cargar componente COM.
2 Conocer los objetos, funciones y atributos contenidos en el componente COM:
• TSdkSesion
• TSdkPoliza
• TSdkCuenta
• TSdkDiario
• TSdkSegmentoNegocio
• TSdkConcepto
etcétera
3 Asegúrese de desconectarse de CONTPAQ i.
Página
2-5
18. Alta y consulta del catálogo de cuentas de CONTPAQ i
Introducción En este tema se utilizará una aplicación externa para consultar y dar de alta cuentas
contables, conectarse a CONTPAQ i y enviar dicha información.
Requisitos Para realizar la interfaz con CONTPAQ i es necesario:
• Tener instalado CONTPAQ i
• Tener las Dll’s Dbfwin32.dll y Poldll32.dll, incluidas en el SDK de CONTPAQ i. (Se
instala con CONTPAQ i o puede ser instalado de manera independiente a partir de
la versión 1.1.1)
Archivos a Para realizar la interfaz, se debe contar con el siguiente archivo:
utilizar
• DemoCatalogoCtas.exe
Importante:
• El archivo exe es un programa educativo donde algunas variables están limitadas.
Ejemplo Sólo envía información para el 2006.
• La interfaz fue realizada de la siguiente forma:
o exe = Archivo ejecutable cargando componente COM
(Utilizando VISUAL BASIC 6 ).
Consultando Realice el procedimiento de tabla para consultar cuentas registradas en el catálogo de
cuentas cuentas de CONTPAQ i:
Paso Acción
1 Ejecute el archivo Setup.exe que se localiza dentro del CD.
Resultado: Se iniciará la instalación de la aplicación que permite la consulta y
creación de cuentas, creado con el componente COM.
2 Una vez instalado, del botón Inicio, opción Todos los programas, grupo
CONTPAQ i SDK haga clic en DemoCatalogoCuentas – Ejemplo.
3 Ingrese al sistema con el usuario y clave de acceso asignado.
4 Seleccione la base de datos con la que se realizará la conexión.
Resultado: Se desplegará la ventana Catálogo de cuentas.
5 Capture en el campo “Código” la cuenta que desea consultar.
6 Haga clic en el botón Buscar.
Resultado: Si la cuenta existe, se desplegarán los datos de la misma. Si no está
registrada, se desplegará un mensaje indicando que no existe la cuenta
especificada.
7 Verifique que la informacion desplegada concuerde con la informacion registrada
en CONTPAQ i.
Continúa en la siguiente página
Página
2-6
19. Alta y consulta del catálogo de cuentas de CONTPAQ i,
Continuación
Creando cuentas Realice este procedimiento para crear nuevas cuentas contables y verificar su registro en el
catálogo de CONTPAQ i:
Paso Acción
1 Dentro de la ventana Catálogo de cuentas, haga clic en el botón Nueva cuenta.
Resultado: Observe que el botón Buscar se deshabilita y se activa el botón
Guardar.
2 Capture los datos de la cuenta como el código y nombre; así como los datos que
la identificarán como la fecha de alta, la cuenta de la que será subcuenta, el tipo
y si se trata de una cuenta de mayor; además, indique el segmento de negocio,
la moneda que se asignará y el digito agrupador.
3 Al finalizar la captura, guarde los cambios haciendo clic en el botón Guardar.
Resultado: Se desplegará un mensaje informando que la cuenta fue creada con
éxito. Se deshabilita el botón Guardar y se activa el botón Buscar y la ventana
queda lista para un nueva búsqueda.
4 Si desea capturar otra cuenta, haga clic en el botón Nueva cuenta.
5 Verifique que la cuenta recién creada efectivamente se registró en el catálogo de
cuentas de CONTPAQ i.
Página
2-7
