Para poder hacer un envío a través del integrador necesitamos contar con tres archivos. Un archivo CSV (excel delimitado por comas) donde estará la lista de todos los destinatarios; un archivo XML quien dará determinados parámetros como el subjetc, email from, email replay, entre otros; y un HTML que forma la pieza dentro del correo.

Para que el envío se ejecute correctamente es una condición necesaria que estos tres archivos lleven el mismo nombre, y así se complementen para concretar el envío.

Prioridades:

+ XML de la acción
+ XML config
+ File o nombre de los archivos

Parámetros que se configuran dentro del XML: 

<ArchivoXML> 
....<Email>embluecomunicaciones@embluemail.com</Email>  
</ArchivoXML>

Email: Si ocurre algún error durante la operación se notificará a esta dirección. Si esta etiqueta no está completa no realizará en envío. Esta etiqueta va SIEMPRE en el archivo CONFIG.xml, de otra manera no se va a enviar la notificación del error.

Vacía: no realiza en envío (ej. <Email></Email>)

Inexistente: no realiza el envío (ej. no aparece en el XML)

No la encuentra en el CONFIG: no realiza el envío.

 

.

<ArchivoXML> 
....<Confirm>true</Confirm>  
</ArchivoXML>

.

Confirm: especifica si se confirma el envío o no.

Vacía: confirma el envío (ej. <Confirm></Confirm>)

OFF: confirma el envío (ej. <email>OFF</email>)

Inexistente: toma el que fue seteado en el config. (no aparece la etiqueta en el xml)

No la encuentra en el CONFIG: confirma el envío.

False: el envío se arma pero no se confirma (ej. <confirm>false</confirm>)
.

 

<ArchivoXML> 
....<Return>true</Return>  
</ArchivoXML>

.

.Return: esta etiqueta especifica si devuelve o no el archivo OUT que es la respuesta al procesamiento del archivo. Se define con true o false.

Vacía: devuelve el OUT (ej. <return></return>)

False: no devuelve el OUT (ej. <return>false</return>)

OFF:  devuelve el OUT (ej. <return>OFF</return>)

Inexistente: toma el que fue seteado en el config.

 

<ArchivoXML> 
....<Subject>Nombre del asunto</Subject>  
</ArchivoXML>

.

Subject: asunto del mensaje. Si no está completo por default tomará el nombre del CSV como asunto del envío.

Vacía: nombre del CSV (ej. <subject></subject>)

OFF: nombre del CSV (ej. <subject>OFF</subject>)

Inexistente: toma el que fue seteado en el config. (no aparece la etiqueta en el xml)

No la encuentra en el CONFIG: nombre del CSV.

.

<ArchivoXML> 
....<HtmlMessage>true</HtmlMessage>  
</ArchivoXML>

.

Html Message: puede agregarse la URL del mensaje hosteado, pero si existe un archivo HTML lo toma como prioridad.

Vacía: no existe la etiqueta pero está vacía no se realiza el envío. (ej. <HtmlMessage></HtmlMessage>)

False: no se realiza el envío (ej. <HtmlMessage>false</HtmlMessage>)

Inexistente: toma el que fue seteado en el config. (no aparece la etiqueta en el xml)

Nota: Si se sube un archivo HTML, esta etiqueta no debe ser usada.

No la encuentra en el CONFIG: no se realiza el envío...

.

<ArchivoXML> 
....<Group>Nombre del Grupo</Group>  
</ArchivoXML>

.

Group: ID del grupo o cadena que sirve para especificar el nombre del grupo o  para crear uno nuevo. Si existe un signo (+) anexa los contactos, caso contrario reemplaza. Si existe un signo (#) crea grupos automáticos, es decir, únicos en nombre con la siguiente nomenclatura: NOMBRE_YYYYMMDD. Si la etiqueta está vacía se creará automáticamente un grupo con el nombre del file (nombre del CSV). Si a la etiqueta se le agrega un OFF (<Group>OFF</Group>) no se crea el grupo ni se realiza el envío.

Vacía: crea un grupo con el nombre del file (ej. <Group></Group>)

False: crea un grupo con el nombre false (ej. <Group>false</Group>)

OFF: no se crea el grupo y tampoco se genera el envío (ej. <Group>OFF</Group>)

Inexistente: toma el que fue seteado en el config. (no aparece la etiqueta en el xml). Si en el config tampoco está la etiqueta de grupo crea uno nuevo con el nombre del file. Si está el OFF no crea grupo ni genera envío.

No la encuentra en el CONFIG: crean un nuevo grupo con el nombre del file.

False: crea un grupo con el nombre “false” (ej. <Group>false</Group>)
.

<ArchivoXML> 
....<Witness>3465</Witness>  
</ArchivoXML>

 

Witness: Se agrega el ID de una dirección de correo para que lleguen los envíos de “testigo”. La finalidad es tener un registro de lo enviado para poder corroborar que la acción se ha ejecutado correctamente. Si la etiqueta queda vacía o es inexistente el envío se realiza de la misma manera. Es opcional, no sucede ningún cambio en el caso de que no sea completada. Ejemplo: <Witness>3465</Witness>

Vacía:  no envía el mail testigo (ej. <Witness></Witness>)

OFF:  no envía el mail testigo (ej. <Witness>OFF</Witness>)

Inexistente: toma el que fue seteado en el config. (no aparece la etiqueta en el xml)

No la encuentra en el CONFIG: no realiza el envío testigo.

<ArchivoXML> 
....<Action>Envíos de Ejemplo</Action>  
</ArchivoXML>

.

Action: cadena que sirve para especificar el nombre de la acción o para crear una nueva . Si existe un signo (#) crea acciones automáticas, es decir, únicos en nombre con la siguiente nomenclatura: NOMBRE_YYYYMMDD. Si a la etiqueta se le agrega un OFF se crea el grupo, se cargan los contactos a emBlue pero no se realiza en envío. Si la etiqueta es vacío o inexistente toma el nombre por default que es el nombre del file.

Vacía: realiza el envío con el nombre del file (ej. <action></action>)

False: crea una acción con el nombre “false” (ej. <action>false</action>)

OFF:  no realiza el envío (ej. <action>OFF</action>)

Inexistente: toma el que fue seteado en el config. (no aparece la etiqueta en el xml)

No la encuentra en el CONFIG: realiza el envío con el nombre del file.

.

<ArchivoXML> 
....<Campaign>Promociones de enero</Campaign>  
</ArchivoXML>

.

Campaign: Sirve para especificar la campaña donde se alojará la acción de envío. ID de la campaña o cadena que sirve para especificar el nombre de la campaña o para crear uno nuevo. Si la etiqueta es inexistente o está vacía . Si existe un signo (#) crea campañas automáticas, es decir, únicas en nombre con la siguiente nomenclatura: NOMBRE_YYYYMMDD. Set tiene prioridad sobre Config.

ID: Si la campaña ya existe se puede poner el ID de la misma para crear la accion ahi dentro. (ej. <Campaign>233</Campaign>)

String: Crea una campaña nueva con el nombre deseado. Al mismo se puede agregar un # que representa el timestamp del momento de la ejecución. (ej. <Campaign>Promocion Enero #</Campaign> y como resultado quedará “Promocion Enero 14_01_2016”)

Vacía: crea una campaña a con el nombre “Integrador” (ej. <Campaign></Campaign>)

 

<ArchivoXML> 
....<Save>true</Save>  
</ArchivoXML>

.

Save: activando esta función con “true” el XML queda persistente. Es decir se puede utilizar para otra acciones agregando sólo el CSV. Si la etiqueta está vacía o es inexistente el XML no quedará como persistente, por default quedará en “false”.
.

<ArchivoXML> 
....<Date>20160328102300</Date>  
</ArchivoXML>

.

Date: se puede agregar la fecha de envío en el siguiente formato yyyyMMddhhmmss. Si la etiqueta es inexistente o vacía el la acción se ejecuta de inmediato. Por ejemplo, <Date>20150825100000</Date>.

 

<ArchivoXML>
        <SenderId>1234</SenderId>
</ArchivoXML>

.

SenderId: se puede agregar el ID del sender. Si la etiqueta es inexistente o vacía se creará la acción pero no se realizará el envío. Por ejemplo, <SenderId>2016</SenderId>.

 

<ArchivoXML>
        <SplitTest>B|261|testB|||20</SplitTest>
</ArchivoXML>

 

SplitTest: se puede realizar el envío con splitTest desde el integrador estableciendo dentro de la etiqueta <splitTest> las opciones en el siguiente orden: Muestra, Id Sender, Asunto del envío y por último el porcentaje de la muestra (entre 5% y 30%). Ejemplos:

A/B: <splitTest>B|261|testB|||20</splitTest>

A/B/C: <splitTest>B|261|testB|||C|262|testC|||30</splitTest>

 

<ArchivoXML>
        <Detail>true</Detail>
</ArchivoXML>

 

Detail: establece el nivel de detalle del archivo OUT, si está seteado en true el nivel de detalle será mayor. Esta ligado directamente al estado de la etiqueta <Return> para que funcione ambas deben estar en true.

 

<ArchivoXML>
        <Formats>sex=4|||country=3|||date=1</Formats >
</ArchivoXML>

 

Formats: permite alterar alguno de los formatos del CSV para que los reconozca emBlue. Cada campo dentro de la etiqueta se separa con 3 “|” consecutivas. Por ejemplo, <Formats>sex=4|||country=3|||date=1</Formats >.

 

<ArchivoXML><DisableMessageOptions>socialHeader,socialFooter,onlineHeader,onlineFooter,legalesFooter,datosFooter,suscribirHeader,suscribirFooter</DisableMessageOptions>
</ArchivoXML>

 

DisableMessageOptions: se puede quitar los links a redes sociales, los legales, datos del footer y los links para suscripción. Cada item puede quitarse por separado, la sentencia de ejemplo oculta todas las opciones antes mencionadas. <DisableMessageOptions>socialHeader,socialFooter,onlineHeader,onlineFooter,legalesFooter,

datosFooter,suscribirHeader,suscribirFooter</DisableMessageOptions>

 

Ejemplo de Archivo XML:

<ArchivoXML>
<Email>embluecomunicaciones@embluemail.com</Email>
<Confirm>true</Confirm>
<Detail>true</Detail>
<Return>true</Return>
<Subject>${1#nombre}, ${26#asunto} y ganate ${28#producto}</Subject>
<HtmlMessage>http://storage3.embluemail.com/clientes/empresa/integrador_emblue3/IN_wp_test.html</HtmlMessage>
<SenderId>4581</SenderId>
<SplitTest>B|233|testB|||C|234|testC|||20</SplitTest>
<Formats>country=1</Formats>
<Group></Group>

<Witness>180073;180075</Witness>
<Action>Test Integrador</Action>
<Campaign>13114</Campaign>
<Save>true</Save>
<Date>20160328102300</Date> 
<DisableMessageOptions>SocialHeader;SocialFooter;LegalesFooter</DisableMessageOptions>
</ArchivoXML>

.
.
Tabla de prioridades:

Etiqueta Default Valores Config XML XML de un envío
Vacío Inexistente Etiqueta OFF Vacío Inexistente Etiqueta OFF
Email Obligatorio email valido
Out bulk insert (false) true o false / 1 o 0 default default default default
Group Nombre de file Id o cadena default default Sin grupo y no genera envío default CONFIG.XML default
Campaign Integrador Id o cadena default default default default CONFIG.XML default
Action Nombre de file cadena default default no genera envíos default CONFIG.XML no genera envíos
Subject nombre de file cadena default default defaut default CONFIG.XML default
HtmlMessage archivo file HTML cadena default default default default CONFIG.XML default
EmailFromID predeterminado id default default default default CONFIG.XML default
NameFromID predeterminado id default default default default CONFIG.XML default
ReplyTold predeterminado id default default default default CONFIG.XML default
DisableMessageOption vacío cadena default default default default CONFIG.XML
Date inmediato cadena default default default defaul CONFIG.XML default
Confirm ok (true) true o false / 1 o 0 default default default default CONFIG.XML default