Guía de importación automática de BBDD y generación de envío

Descripción y alcance funcional

Permite agregar un contacto a un perfil existente en el sistema, incluyendo toda la información personalizada que en este se haya definido. Si el contacto existe (dirección de email) los campos personalizados proporcionados serán actualizados. La información existente en los campos personalizados que no sean suministrados se mantendrá inalterable.

El proceso tiene por objeto la automatización de la importación de bases y consecuente creación de envíos en ICOMM, a partir de la información proveniente de sistemas externos integrados a través del mismo.

El flujo se inicia cuando el cliente deposita un par de archivos (los requeridos para la correcta creación del envío) en una carpeta definida de un repositorio SFTP. Cada N minutos (tiempo acordado y pre-definido), en forma automática se verifica la existencia de archivos por procesar. Una vez que los archivos son
procesados, se eliminan de la ubicación original, almacenando una copia local en los servidores de ICOMM. Estas copias se guardan por 30 días.

Repositorio SFTP

El repositorio es un repositorio SFTP y cuenta con la seguridad requerida para poder llevar adelante este tipo de integraciones. Por cualquier consulta, escribir a support@icommkt.com. En el espacio definido, es conveniente generar una subcarpeta de uso exclusivo para este proceso.

Proceso de Entrada

Nomenclatura de Archivos
Tal como se mencionó en la sección de Alcance Funcional, por cada envío que se quiera disparar en forma automática, se requieren dos archivos:

[NOMBRE_ARCHIVO].xml= donde NOMBRE_ARCHIVO representa el nombre de la campaña/envío. Por ejemplo, EJEMPLO_CLIENTE_BIENVENIDA.xlm
[NOMBRE_ARCHIVO].csv= donde NOMBRE_ARCHIVO representa el nombre del perfil que se creará en la plataforma para asociar a dicho envío. Por ejemplo, EJEMPLO_CLIENTE_BIENVENIDA.csv

El nombre de ambos archivos debe COINCIDIR para que el proceso pueda completarse en forma integral.

Estructura de los archivos

[NOMBRE_ARCHIVO].xml

<?xml version="1.0" encoding="UTF-8"?>
-<ArchivoXML>
<Email></Email>
<FromName></FromName>
<ReplyEmail></ReplayEmail>
<StartDate></StartDate>
<Subject></Subject>
<PreHeader></PreHeader>
<HtmlMessage></HtmlMessage>
<Group></Group>
<Action></Action>
<Campaign></Campaign>
<ViralMarketing></VIralMarketing>
<SocialNetworks></SocialNetworks>
<Testing></Testing>
<SendGoogleAnalytics></SendGoogleAnalytics>
</ArchivoXML>

Email*: FROM EMAIL (debe ser un remitente declarado en la plataforma sobre el dominio de la instancia)
FromName: Remitente del envío (si no se envía toma el default declarado para cada instancia)
ReplyMail: Reply TO Email (debe ser una cuenta de reply declarada en la plataforma sobre el dominio de la instancia)
StartDate: Fecha de inicio del envío YYYY-MM-DD HH24:MI:SS (default: AHORA + 10 minutos)
Subject*: Asunto del envío. La nomenclatura para la personalización de campos en el HTML de la pieza y/o en el subject es: <*NOMBRE_CAMPO*>. Por cualquier duda al respecto, consultar la documentación de ICOMM.
PreHeader*: PreHeader del envío
HtmlMessage*: URL de la pieza HTML a enviar. La nomenclatura para la personalización de campos en el HTML de la pieza y/o en el subject es: NOMBRE_CAMPO>. Por cualquier duda al respecto, consultar la documentación de ICOMM.
Group*: Nombre del Perfil a enviar (debe ser igual al nombre del archivo CSV y al XML)
Action*: Nombre de la configuración de envío (debe ser igual al nombre del archivo CSV y al XML)
Campaign*: Nombre de la campaña asociada al envío
ViralMarketing: true/false si se activa la opción de "Enviar a un amigo"
SocialNetworks: si se desea activar la opción de compartir en redes sociales. Debe contener un string separado por comas de los siguientes valores ->

1 - Facebook
2 - Twitter
3 - Linkedin
4 - GooglePlus
5 - Pinterest
6 - Whatsapp
Enviar vacío en caso de no desear incluir el logo de ninguna red social (default: vacío)

Testing: true/false si desean marcar al envío como TESTING en la plataforma (default: false)
SendGoogleAnalytics: true/false si desean incluir los tags de google analytics en los links de las piezas de forma automática según lo realiza la plataforma (default: false)

[NOMBRE_ARCHIVO].csv
El archivo CSV contiene la estructura del perfil o base de datos a la que se le enviará la pieza. En todos los casos, se debe incluir como requerido el campo email. Cualquier otro campo personalizado en la pieza, debe estar presente como campo en el archivo CSV.
Email*: EMAIL de destino

Circuito del Proceso

A partir de la información contenida en el par de archivos ya definidos, el proceso realizará las siguientes acciones:

Cada N minutos se verifica en la carpeta referida anteriormente, la existencia de nuevos archivos para procesar. En caso de existir archivos, se procede con los pasos siguientes aquí detallados. En caso negativo, el proceso entra en stand by hasta el cumplimiento del siguiente intervalo de N minutos.

En caso de existir archivos, se crea el perfil con la estructura definida en la primera línea del archivo CSV (es requerido que el archivo contenga los encabezados pertinentes en la primera fila). En caso de ser un perfil previamente existente, se verifica que no existan columnas nuevas a incorporar y en tal
caso se las anexa a la estructura actual.

Se importan los datos incluídos en el archivo CSV dentro del perfil creado en el paso anterior.

Se obtiene la URL de la pieza a enviar del atributo HTMLMESSAGE del archivo XML y se procede a crear el newsletter dentro de la plataforma asignando el NOMBRE_ARCHIVO como referencia del nombre del mismo. En caso de existir una versión previa de una pieza con dicho nombre, el sistema coteja el contenido del HTML actual en relación al último importado para verificar si fuera necesario generar una nueva versión del newsletter. En tal caso y de existir variaciones, se genera un NOMBRE_ARCHIVO_v[N] como nombre de referencia y según corresponda.

Se genera el envío con los parámetros establecidos en el file XML. De no poder obtener el atributo STARTDATE del mismo, el envío se programa 10 minutos hacia adelante (es recomendable igualmente por cuestiones de garantía de finalización de las etapas anteriores, que NUNCA se programa un envío con Fecha y Hora anteriores a los siguientes 10 minutos).

El procesamiento es en tiempo real y el envío queda seteado en la plataforma. En todos los casos, accediendo a la plataforma se pueden visualizar los objetos creados, así como los resultados de las importaciones (ver documentación de ICOMM) e ir siguiendo en tiempo real los resultados de cada uno de los envíos. El chequeo de archivos está programado para realizarse cada 10 minutos y una vez que los files son procesados, se borran del repositorio SFTP.

Actualizado el: 09/03/2023