Datahub – Fichero de configuración – Splio - Base de Conocimiento

Información general

En este artículo se explica en detalle la estructura del fichero de configuración utilizado para definir los comandos del Datahub.

Considera este articulo como un compendio: en vez de leerlo de principio a fin, utilízalo para encontrar la información que necesites. El articulo contiene enlaces para que sea más fácil llegar a las opciones de configuración para cada tabla/alcance.

Consulta el tutorial sobre el fichero de configuración para ver ejemplos.

Encontrarás un ejemplo de un fichero para este alcance al final del artículo.

Requisitos previos

Un conocimiento básico o medio de la sintaxis JSON.
Un contacto en Splio para validar tu archivo de configuración.
Un editor de texto o código.

Utiliza tu editor de texto o código preferido para crear y editar los ficheros de configuración. Se recomienda un editor que pueda validar la sintaxis JSON, ya que te ayudará a detectar los errores más básicos, como la falta de comas, comillas o paréntesis. Si no conoces ningún software, puedes utilizar JSON Editor Online, que es un software gratuito y está disponible directamente en su página web.

Definición del fichero de configuración

El fichero de configuración es un archivo de texto que se ajusta al formato JavaScript Object Notation (JSON).

Nombre del fichero	<universo>_imports_config.json
Codificación	UTF-8 sin BOM
Formato	JSON

Los placeholders de la siguiente definición, que deben sustituirse por nombres y valores reales, se encuentran entre diples («<>»); las partes opcionales están entre corchetes («[]») y los puntos suspensivos («. . .») remplazan las repeticiones.

{
   "<universe>":{
     "<scope1>":{
       "<sub-sequence1>":{
         "<configoption11>":"<value11>"[,
         "<configoption12>":"<value12>"[, . . . ] ]
       }[,
       "<sub-sequence2>":{
         "<configoption21>":"<value21>"[,
         "<configoption22>":"<value22>"[, . . . ] ]
       }[, . . . ] ]
     }[,
     "<scope2>":{
       "<sub-sequence3>":{
         "<configoption31>":"<value31>"[, 
         "<configoption32>":"<value32>"[, . . . ] ]
       }[,
       "<sub-sequence4>":{
         "<configoption41>":"<value41>"[,
         "<configoption42>":"<value42>"[, . . . ] ]
       }[, . . . ] ]
     }[, . . . ] ]
   }
 }

Universo

El fichero debe contener un solo objeto «<universe>». El nombre de este objeto debe coincidir con el nombre de tu universo Splio y debe ser parte del nombre del fichero.

Alcance

El universo debe contener al menos un objeto «<scope>». Los alcances son las tablas o los eventos de cada tabla que se pueden importar a la base de datos Splio.

Están disponibles los siguientes alcances:

contacts
products
stores
orders
abandonedcarts
ordersitems
masterreward, earnreward, burnreward (correspondientes a la tabla de Rewards)
creditpoints (correspondiente a la tabla de Loyalty)
events
deletecontacts
cardcode ((correspondiente a la tabla de Loyalty)
tier change

Solo el alcance de Contactos tiene un correspondiente alcance de Borrado de contactos.

Subsecuencia

Cada alcance debe contener uno o más objetos «sub-sequence>». Las subsecuencias se utilizan para definir los ficheros de importación, que siempre pertenecen a una subsecuencia específica dentro de un alcance. Las subsecuencias representan varias fuentes de datos (p. ej., bases externas) o importaciones dentro del mismo alcance realizadas por distintas razones.

Todas las opciones de configuración se definen dentro de subsecuencias.

Alcances y opciones de configuración

Los siguientes apartados enumeran las opciones de configuración disponibles dentro de cada alcance.

Contactos

Consulta aquí para más información sobre contactos.

Las siguientes opciones de configuración están disponibles para el alcance de contactos:

Opción de configuración	Obligatorio	Tipo de valor	Notas de descripción/uso
report recipients	Sí	lista de direcciones de email	Las direcciones de email de todos los destinatarios para recibir el informe cuando la importación se haya completado.
alert recipients	Sí	lista de direcciones de email	Las direcciones de email de todos los destinatarios para recibir alertas durante la importación.
overwrite with empty values	No	0 (no, por defecto) / 1 (sí)	Si se establece en «1» (sí), los valores existentes se machacarán con NULL cuando el campo en el fichero que se importa está vacío.
default cellphone prefix	Sí	numérico	Un prefijo (código del país) para añadir a todos los números de teléfono locales encontrados en el archivo. No se añadirá a los números que ya presenten un código de país.
init lists	Sí	lista de valores numéricos	Una lista que debe incluir las ids numéricas de todas las listas de Splio que deban inicializarse (es decir, vaciarse) antes de la importación.
create contacts	No	0 (no) / 1 (sí, por defecto)	Permite crear nuevos contactos durante la importación. Activada por defecto. Al desactivarla puedes prevenir que un determinado archivo de importación cree nuevos contactos.
update contacts	No	0 (no) / 1 (sí, por defecto)	Permite actualizar contactos existentes según el archivo de importación. Activada por defecto. Al desactivarla, puedes asegurarte de que ningún registro de contactos se actualice al importar este archivo. Puedes usarla automáticamente para suscribir contactos a listas.

Sugerencia: si no deseas vaciar (inicializar) ninguna lista, pon: «init lists»: \[].

Productos

Los productos representan los artículos que los contactos pueden comprar.

Consulta aquí para más información sobre productos.

Las siguientes opciones de configuración están disponibles para productos:

Opción de configuración	Obligatorio	Tipo de valor	Notas de descripción/uso
report recipients	Sí	lista de direcciones de email	Las direcciones de email de todos los destinatarios para recibir el informe cuando la importación se haya completado.
alert recipients	Sí	lista de direcciones de email	Las direcciones de email de todos los destinatarios para recibir alertas durante la importación.
overwrite with empty values	No	0 (no, por defecto) / 1 (sí)	Si se establece en «1» (sí), los valores existentes se sustituirán por NULL cuando se actualice un registro desde el archivo y el campo del archivo esté vacío.
create products	No	0 (no) / 1 (sí, por defecto)	Permite crear nuevos productos durante la importación. Activada por defecto. Al desactivarla puedes prevenir que un determinado archivo de importación cree productos.
update products	No	0 (no) / 1 (sí, por defecto)	Permite actualizar productos existentes según el archivo de importación. Activada por defecto. Al desactivarla puedes prevenir que los registros de productos se actualicen durante la importación.

Tiendas

Las tiendas representan las tiendas físicas u online. Consulta aquí para más información sobre tiendas.

Las siguientes opciones de configuración están disponibles para tiendas:

Opción de configuración	Obligatorio	Tipo de valor	Notas de descripción/uso
report recipients	Sí	lista de direcciones de email	Las direcciones de email de todos los destinatarios para recibir el informe cuando la importación se haya completado.
alert recipients	Sí	lista de direcciones de email	Las direcciones de email de todos los destinatarios para recibir alertas durante la importación.
overwrite with empty values	No	0 (no, por defecto) / 1 (sí)	Si se establece en «1» (sí), los valores existentes se sustituirán por NULL cuando se actualice un registro desde el archivo y el campo del archivo esté vacío.
create stores	No	0 (no) / 1 (sí, por defecto)	Permite crear nuevas tiendas durante la importación. Activada por defecto. Al desactivarla puedes prevenir que un determinado archivo de importación cree nuevas tiendas.
update stores	No	0 (no) / 1 (sí, por defecto)	Permite actualizar las tiendas existentes según el archivo de importación. Activada por defecto. Al desactivarla puedes prevenir que los registros de tiendas se actualicen durante la importación.

Pedidos

Los pedidos representan las compras realizadas por los contactos. Consulta aquí para más información sobre pedidos.

Las siguientes opciones de configuración están disponibles para pedidos:

Opción de configuración	Obligatorio	Tipo de valor	Notas de descripción/uso
report recipients	Sí	lista de direcciones de email	Las direcciones de email de todos los destinatarios para recibir el informe cuando la importación se haya completado.
alert recipients	Sí	lista de direcciones de email	Las direcciones de email de todos los destinatarios para recibir alertas durante la importación.
overwrite with empty values	No	0 (no, por defecto) / 1 (sí)	Si se establece en «1» (sí), los valores existentes se sustituirán por NULL cuando se actualice un registro desde el archivo y el campo del archivo esté vacío.
create orders	No	0 (no) / 1 (sí, por defecto)	Permite crear nuevos pedidos durante la importación. Activada por defecto. Al desactivarla puedes prevenir que un determinado archivo de importación cree nuevos pedidos.
update orders	No	0 (no) / 1 (sí, por defecto)	Permite actualizar pedidos existentes según el archivo de importación. Activada por defecto. Al desactivarla puedes prevenir que los registros de pedidos se actualicen durante la importación.
generate loyalty events	No	0 (no, por defecto) / 1 (sí)	Permite que los pedidos sean procesados como eventos por el motor Loyalty, para desencadenar normas como condiciones. Sin este parámetro, no se puede dar ningun reward de las normas desencadenadas por los pedidos. Compatible con el mismo parámetro de líneas de recibos.
only orders	No	0 (no, por defecto) / 1 (sí)	Permite que el motor Loyalty procese los pedidos sin líneas de recibos para reglas de Loyalty. Esta opción debería estar activada en pedidos o líneas de recibos para que las reglas de Loyalty asignen rewards (nunca sobre ambos).

Abandonedcarts

Abandonedcarts representa las compras que no fueron completadas. Consulta aquí para más información sobre abandonedcarts.

Las siguientes opciones de configuración están disponibles para abandonedcarts:

Opción de configuración	Obligatorio	Tipo de valor	Notas de descripción/uso
report recipients	Sí	lista de direcciones de email	Las direcciones de email de todos los destinatarios para recibir el informe cuando la importación se haya completado.
alert recipients	Sí	lista de direcciones de email	Las direcciones de email de todos los destinatarios para recibir alertas durante la importación.
overwrite with empty values	No	0 (no, por defecto) / 1 (sí)	Si se establece en «1» (sí), los valores existentes se sustituirán por NULL cuando se actualice un registro desde el archivo y el campo del archivo esté vacío.
create abandonedcarts	No	0 (no) / 1 (sí, por defecto)	Permite crear nuevos abandonedcarts durante la importación. Activada por defecto. Al desactivarla, puedes prevenir la creación de registros de abandonedcarts.
update abandonedcarts	No	0 (no) / 1 (sí, por defecto)	Permite actualizar abandonedcarts durante la importación. Activada por defecto. Al desactivarla, puedes prevenir la actualización de registros de abandonedcarts.

Líneas de recibos (ordersitems)

Las líneas de recibo representan los artículos individuales de un recibo o de un carrito de compra. Consulta aquí para más información sobre ordersitems.

Ten en cuenta que los productos de este alcance no se pueden actualizar a través de la importación, pero se borrarán siempre que un pedido o un carrito abandonado correspondiente sea importado (p. ej., actualizado).

Opción de configuración	Obligatorio	Tipo de valor	Notas de descripción/uso
report recipients	Sí	lista de direcciones de email	Las direcciones de email de todos los destinatarios para recibir el informe cuando la importación se haya completado.
alert recipients	Sí	lista de direcciones de email	Las direcciones de email de todos los destinatarios para recibir alertas durante la importación.
overwrite with empty values	No	0 (no, por defecto) / 1 (sí)	Si se establece en «1» (sí), los valores existentes se sustituirán por NULL cuando se actualice un registro desde el archivo y el campo del archivo esté vacío.
generate loyalty events	No	0 (no, por defecto) / 1 (sí)	Permite que los pedidos sean procesados como eventos por el motor Loyalty, para desencadenar normas como condiciones. Sin este parámetro, no se puede dar ningun reward de las normas desencadenadas por las líneas de recibos (productos). Compatible con el mismo parámetro de líneas de recibos.
only order items	No	0 (no, por defecto) / 1 (sí)	Permite que el motor Loyalty procese las líneas de recibos sin pedidos para reglas de Loyalty. Esta opción debería estar activada en pedidos o líneas de recibos para que las reglas de Loyalty asignen rewards (nunca sobre ambos).

Suscripciones Loyalty (cardcode)

Este alcance utiliza las mismas opciones de configuración que el anterior de Líneas de recibos.

Consulta aquí para más información sobre la importación Suscripciones Loyalty.

Cambio de nivel

Opción de configuración	Obligatorio	Tipo de valor	Descripción/usage notes
force_points	No	1 si quieres activarlo	Este parámetro atribuirá la cantidad de puntos calificables que faltan para alcanzar el nivel que has indicado en el cuerpo. Si no utilizas este parámetro, el miembro estará en el nivel sin la cantidad necesaria de puntos calificables y será degradado en el próximo cálculo de downgrade de nivel.

Acréditación de puntos (creditpoints), Eventos (events), Borrado de contactos (deletecontacts)

Este grupo de alcances de importación comparte las dos mismas opciones de configuración.

Consulta los siguientes artículos para más información sobre cada uno:

Opción de configuración	Obligatorio	Tipo de valor	Notas de descripción/uso
report recipients	Sí	lista de direcciones de email	Las direcciones de email de todos los destinatarios para recibir el informe cuando la importación se haya completado.
alert recipients	Sí	lista de direcciones de email	Las direcciones de email de todos los destinatarios para recibir alertas durante la importación.

Rewards (masterreward, earnreward, burnreward)

La importación de alcances relacionados con los rewards se describe en el documento Rewards.

Opción de configuración	Obligatorio	Tipo de valor	Notas de descripción/uso
report recipients	Sí	lista de direcciones de email	Las direcciones de email de todos los destinatarios para recibir el informe cuando la importación se haya completado.
alert recipients	Sí	lista de direcciones de email	Las direcciones de email de todos los destinatarios para recibir alertas durante la importación.
overwrite with empty values	No	0 (no, por defecto) / 1 (sí)	Solo para «Masterrewards» Si se establece en «1» (sí), los valores existentes se sustituirán por NULL cuando se actualice un registro desde el archivo y el campo del archivo esté vacío.

fullconfig.json
4 kB Download

Artículos en esta sección