Móvil: MANUAL DE USUARIO Replicación DOCUMENTO PÚBLICO e-evolution

Transcripción

1 MANUAL DE USUARIO Replicación DOCUMENTO PÚBLICO e-evolution

2 TÍTULO: SUBTÍTULO: VERSIÓN: ARCHIVO: TOTAL DE PÁGINAS: 22 ESTADO DE PLANTILLA: VERSIÓ N Información General Manual de Usuario Replicación ManualReplicacion.doc Actualizado Historial de Revisiones FECHA AUTOR DESCRIPCIÓN Antonio Cañaveral Elaboración del Documento DOCUMENTO PÚBLICO e-evolution

3 Contenido del Manual Información General... 2 Historial de Revisiones... 2 Contenido del Manual... 3 Esquematización de la Replicación... 4 Instalando ActiveMQ Para Replicar Adempiere... 5 Conceptos de Exporter e Importer... 7 Export Processor Type... 8 Export Processor... 8 Import Processor Type... 9 Import Processor... 9 Ejemplo de Configuración de Una Replicación Para Una Compañía Formatos de Exportación Características y Parámetros de la Línea del Formato de Exportación Tipos de Línea de Formato de Exportación Estrategia de Replicación Replicando Tablas Replicando Documentos Preparar la Compañía para la Replicación ANEXO1: Formato de Esquematización de la Replicación en una Compañía ANEXO 2: Formato de Programación de Una Estrategia de Replicación DOCUMENTO PÚBLICO e-evolution

4 Esquematización de la Replicación SERVIDOR LOCAL 1 SERVIDOR CENTRAL DE TVENTAS JMS Local 1 EXPORTER IMPORTER JMS Central EXPORTER IMPORTER SERVIDOR LOCAL 2 JMS Local 2 EXPORTER IMPORTER DOCUMENTO PÚBLICO e-evolution

5 Instalando ActiveMQ Para Replicar Adempiere Para la replicación actualmente Adempiere utiliza ActiveMQ. ActiveMQ es un broquer de mensajería open source, distribuido por Apache Software Foundation. Se lo puede encontrar en La configuración e instalación de ActiveMQ se lo encuentra en los manuales de usuario de la aplicación. ( El único tip de instalación que se debe tener en cuenta es la adición de la librería necesaria para el uso de la base de datos. Es necesario copiar el.jar de Postgres a la carpeta lib de ActiveMQ. ( Para el correcto funcionamiento con Adempiere se utiliza ActiveMQ en el modo de persistencia de mensajes por medio de una base de datos. Es por ello que se debe crear una base de datos en el servidor al que se quiera instalar la replicación con el nombre estándar de ActiveMQ. Para ello iniciamos la sesión de pgadmin en el servidor que deseemos añadir la base de datos y pulsando el botón derecho en el objeto Databases elegimos la opción NewDataBase... En el cuadro de diálogo ponemos el nombre de la nueva base de datos (ActiveMQ) y continuamos. Una vez creada la base de datos, tenemos que modificar el archivo de configuración de ActiveMQ DOCUMENTO PÚBLICO e-evolution

6 para que use persistencia de mensajes. ( El nuevo archivo de configuración debería tener el siguiente aspecto: <beans> <bean class="org.springframework.beans.factory.config.propertyplaceholderconfigurer"/> <broker usejmx="true" xmlns=" <!-- <persistenceadapter> <journaledjdbc journallogfiles="5" datadirectory="${basedir}/activemq-data" datasource="#postgres-ds"/> </persistenceadapter> --> <!-- Or if you want to use pure JDBC without a journal --> <persistenceadapter> <jdbcpersistenceadapter datasource="#postgres-ds"/> </persistenceadapter> <transportconnectors> <transportconnector uri="tcp://desarrollo.tventas.com:61616" /> </transportconnectors> <networkconnectors> <!-- <networkconnector uri="multicast://default?initialreconnectdelay=100" /> <networkconnector uri="static://(tcp://desarrollo.tventas.com:61616)" /> --> </networkconnectors> </broker> <!-- Postgres DataSource Setup --> <bean id="postgres-ds" class="org.postgresql.ds.pgpoolingdatasource"> <property name="servername" value="desarrollo.tventas.com"/> <property name="databasename" value="activemq"/> <property name="portnumber" value="5432"/> <property name="user" value="adempiere"/> <property name="password" value="adempiere"/> <property name="datasourcename" value="postgres"/> <property name="initialconnections" value="1"/> <property name="maxconnections" value="10"/> </bean> </beans> El bean llamado postgres-ds define los parámetros de acceso a la nueva base de datos creada en el servidor de replicación. DOCUMENTO PÚBLICO e-evolution

7 Conceptos de Exporter e Importer Para la replicación en Adempiere el Sistema cuenta con 2 conceptos, Exporter que es donde pone los mensajes que va a replicar e Importer que es de donde va a tomar los mensajes replicados. Para entender mejor esto, tenemos que abstraernos al punto de vista de uno de los servidores, en nuestro caso usaremos el servidor central. El servidor central necesita replicar a todos los locales un Producto nuevo. Para ello genera un mensaje en el formato XML adecuado y lo coloca en el servidor ActiveMQ marcado como Exporter, es decir el que va a exportar los datos del servidor central. En Adempiere toda la configuración de la Replicación se encuentra en el menú Administración del Sistema -> Datos -> Replication Data DOCUMENTO PÚBLICO e-evolution

8 Export Processor Type Define el nombre del Exporter y el paquete de java que va a usar para generar el mensaje XML A este elemento se le asociarán todos los parámetros que configuremos para el nuevo Exporter. Export Processor Define el host donde se hospeda ActiveMQ en nuestro caso, el servidor central. El puerto por defecto de ActiveMQ es el DOCUMENTO PÚBLICO e-evolution

9 Los parámetros principales del Exporter son: clientid: Define el nombre del cliente de mensajería. isdeliverymodepersistent: (true o false) Indica si la comunicación se realizará con persistencia. topicname: Nombre del Tópico al que se va a subscribir el broquer, en este caso el Exportador protocol: tcp timetolive: Tiempo de vida del mensaje en milisegundos. Para infinito se pone 0. El servidor central necesita conectarse a los Exportadores de los otros locales, para obtener los mensajes generados por ellos, para esto creamos Importers. Import Processor Type Define el nombre del Importer y el paquete de java que va a usar para interpretar el mensaje XML Import Processor Los Imports se ejecutan en el servidor de aplicaciones (JBoss) de esta manera podemos ejecutarlo en background y con una recurrencia (frecuencia), por si se cae la conexión. DOCUMENTO PÚBLICO e-evolution

10 Ponemos el tipo de frecuencia de ejecución del importer, día, hora o minuto y la frecuencia. Esto nos sirve como contingencia por si hay una caída del servidor o de las comunicaciones. Días para guardar el registro nos indica por cuanto tiempo debemos almacenar el log. También se configura el host y el puerto del equipo remoto de donde vamos a tomar la información. Los parámetros principales del Exporter son: topicname: Nombre del Tópico al que se va a subscribir el broquer, en este caso el Exportador protocol: tcp isdurablesubscription: (true o false) Indica si la comunicación se realizará con persistencia. subscriptionname: Nombre de la Subscripción del Tópico clientid: Define el nombre del cliente de mensajería. Como conclusiones podemos destacar: Un Servidor debe tener al menos un Exporter el que va a generar los mensajes a Exportar. Un Servidor puede tener más de un Importer, dependiendo de donde queremos obtener la información. DOCUMENTO PÚBLICO e-evolution

11 Ejemplo de Configuración de Una Replicación Para Una Compañía Como ejemplo estableceremos los parámetros de configuración para una compañía que tiene un servidor central en Quito y 2 locales en ciudades diferentes de Ecuador. Servidor Central (Quito) Exporter topicname Protocol isdeliverymodepersisten t QuitoTopic tcp true timetolive clientid Importers Ambato QuitoID Ibarra topicname AmbatoTopic topicname IbarraTopic protocol tcp protocol tcp isdurablesubscription true isdurablesubscription true subscriptionname QuitoSubscription subscriptionname QuitoSubscription clientid QuitoID clientid QuitoID DOCUMENTO PÚBLICO e-evolution

12 Servidor Ambato Exporter topicname Protocol isdeliverymodepersistent AmbatoTopic tcp true timetolive clientid Importer topicname protocol isdurablesubscription subscriptionname clientid Quito AmbatoID QuitoTopic tcp true AmbatoSubscription AmbatoID Servidor Ibarra Exporter topicname Protocol isdeliverymodepersistent IbarraTopic tcp true timetolive clientid Importer topicname protocol isdurablesubscription subscriptionname clientid Quito IbarraID QuitoTopic tcp true IbarraSubscription IbarraID DOCUMENTO PÚBLICO e-evolution

13 Formatos de Exportación Como se había mencionado antes, Adempiere comunica la información mediante mensajes XML, transmitiéndose por medio de los broquers de mensajería (ActiveMQ) Para que los mensajes sean entendidos tanto por el emisor y el receptor, hay que establecer un formato en ambos lados, para definir cómo se van a comunicar los datos. Actualmente contamos con la funcionalidad de poder replicar incluso a nivel de campos, es decir, para enviar un registro de cualquier tabla, podemos obviar la información irrelevante y enviar solo lo necesario. Para definir un Formato de Exportación de una tabla específica abrimos la opción de menú ExportFormat. Para nuestro ejemplo usaremos la tabla producto. Actualmente la versión con la que trabaja la replicación es la 3.2.0, esto quiere decir que cualquier registro marcado con otra versión, no será replicado. Seleccionamos la tabla que vamos a replicar. En esta ventana podemos incluso especificar una condición para disparar la réplica en el campo Cláusula Where SQL. DOCUMENTO PÚBLICO e-evolution

14 Las líneas del formato de exportación describen a los campos de la tabla, van a ser replicados aquellos que estén marcados como activos. En este caso serán: descripción, nombre, código, cliente, organización, categoría del impuesto, unidad de medida y categoría del producto. Cabe mencionar que los campos obligatorios estándar del sistema (creado, creado por, actualizado, actualizado por) no tienen que ser replicados, porque se generarán en el destino. DOCUMENTO PÚBLICO e-evolution

15 Características y Parámetros de la Línea del Formato de Exportación Para cada línea del Formato de Exportación, o lo que es lo mismo, para cada campo a replicar de la tabla seleccionada, hay que colocar los datos de Nombre del Campo, Clave de Búsqueda, Columna de la Tabla. El campo posición indica el orden en el que se genera el archivo de exportación. El campo Entrada Obligatoria denota si el elemento que estamos exportando es un campo requerido en la tabla. El campo IsPartUniqueIndex establece la clave principal del registro a exportar, tomando en cuenta las siguientes especificaciones: Una tabla de Adempiere siempre tiene un campo clave, secuencial de un registro, por ejemplo para la tabla productos, este campo sería m_product_id. En distintas bases de datos este secuencial puede variar incrementalmente según el número de registros que se inserten. El identificador del producto Pelota en otra base de datos puede ser Pelota, por lo que para identificar el registro en el conjunto de bases de datos en vez de tomar m_product_id como índice único deberíamos tomar a Name como tal, ya que es éste el que identifica el registro. Siguiendo estos parámetros este campo nos indica que elementos van a formar parte del índice único de la tabla. DOCUMENTO PÚBLICO e-evolution

16 Tipos de Línea de Formato de Exportación XML Element: El campo es un elemento dentro del archivo XML, este tipo se usa para campos con valores específicos, como Nombre, Descripción, Monto, Clave de Búsqueda, etc... Un Elemento puede formar parte del índice único. El esquema XML que genera es el siguiente: <Producto> </Producto> <Descripcion>Datos de la Descripción</Descripcion> XML Attribute: Al igual que el anterior, es un elemento dentro del archivo XML, este tipo se usa para campos con valores específicos, como Nombre, Descripción, Monto, Clave de Búsqueda, etc... Un Atributo NO puede formar parte del índice único. El esquema XML que genera es el siguiente: <Producto Descripcion=Datos de la Descripción/> DOCUMENTO PÚBLICO e-evolution

17 Referenced EXP Format: El campo que se va a exportar requiere de otro formato de exportación para generar los datos necesarios. Siguiendo con el principio de índice único anteriormente descrito, cuando queramos por ejemplo exportar una cliente cuyo id interno no tiene por que ser igual en la base de datos de destino, requeriremos el formato de exportación de ese cliente, para incrustarlo en nuestro formato actual. Se usa comúnmente para Catálogos, Socios de Negocio, Productos, etc... El formato XML resultante es el siguiente: <Producto> </Producto> <Ref_Cliente> <Nombre>TELEVISION Y VENTAS TELEVENT S.A.</Nombre> </Ref_Cliente> Embedded EXP Format: Al igual que el anterior, el formato Embebido, referencia a otro formato de exportación por el principio de índice único, la principal diferencia es que este tipo se lo usa exclusivamente para referenciar campos padres de una tabla, por ejemplo, al exportar la línea de una orden, en el campo C_Order se usará un Embedded EXP Format, para ligarlo con la cabecera de la Orden. El formato XML que genera es igual al anterior. DOCUMENTO PÚBLICO e-evolution

18 Estrategia de Replicación La Estrategia de Replicación es la forma de configurar nuestro Exporter, definiendo QUE y COMO se van a generar los mensajes hacia nuestro broquer Exportador. Para crear una estrategia de replicación es necesario darle un nombre, y definir el Exporter que previamente hemos creado. En la estrategia de replicación se definen las Tablas y los Documentos que se van a Exportar desde nuestro sistema. Replicando Tablas Para cada Tabla que se vaya a replicar es indispensable definir el Tipo de Replicación (ver Tipos de Replicación). Hay que añadir todas las tablas necesarias que el Exportador tenga que replicar. DOCUMENTO PÚBLICO e-evolution

19 Replicando Documentos Al igual que las Tablas, tenemos que especificar que documentos vamos a Exportar. Especificar que tabla es la que gestiona ese documento y el Tipo de Replicación adecuado para el documento. Tipos de Replicación Mezclar; Importar: El tipo de replicación mezclar se utiliza para que la Tabla o Documento se propague una vez recibido en destino. Comúnmente utilizado para propagar desde una local hacia todos los locales por ejemplo un Cliente. Sólo Publicación: Este tipo de replicación es la estándar que transmite la información desde origen hacia el destino. Ninguno: Sin funcionalidad definida, actualmente funciona como Sólo Publicación DOCUMENTO PÚBLICO e-evolution

20 Preparar la Compañía para la Replicación Para que la compañía utilice la replicación previamente preparada, es necesario activar dicha funcionalidad en Adempiere. Para ello nos movemos al menú Administración del Sistema -> Reglas de la Compañía -> Compañía En la configuración de la compañía es necesario poner la estrategia de replicación que se va a utilizar y la clase para el Exportador: org.adempiere.model.exportmodelvalidator DOCUMENTO PÚBLICO e-evolution

21 ANEXO1: Formato de Esquematización de la Replicación en una Compañía SERVIDOR 1 Exporter topicname Protocol isdeliverymodepersistent timetolive clientid Importer Importer topicname protocol isdurablesubscription topicname protocol isdurablesubscription subscriptionname clientid subscriptionname clientid SERVIDOR 2 Exporter topicname Protocol isdeliverymodepersistent timetolive clientid Importer Importer topicname protocol isdurablesubscription topicname protocol isdurablesubscription subscriptionname clientid subscriptionname clientid SERVIDOR 3 Exporter topicname Protocol isdeliverymodepersistent timetolive clientid Importer Importer topicname protocol isdurablesubscription topicname protocol isdurablesubscription subscriptionname clientid subscriptionname clientid SERVIDOR 4 Exporter topicname Protocol isdeliverymodepersistent timetolive clientid Importer Importer topicname protocol isdurablesubscription topicname protocol isdurablesubscription subscriptionname clientid subscriptionname clientid DOCUMENTO PÚBLICO e-evolution

22 ANEXO 2: Formato de Programación de Una Estrategia de Replicación TIPOS (Nomenclatura): M Mezclar P Publicación N Ninguno ESTILOS (Valores): TABLA DOCUMENTO ESTILO DE REPLICACION DOCUMENTO TABLA TIPO DOCUMENTO PÚBLICO e-evolution