Panoramica
Questo documento illustra nel dettaglio la struttura del file di configurazione utilizzato per definire il comportamento del motore di import.
Pensa a questo articolo come a un sunto: invece di leggerlo dall'inizio alla fine, che può rivelarsi un compito piuttosto arduo, utilizzalo per trovare le informazioni di cui hai bisogno. L’articolo contiene collegamenti ipertestuali per agevolare la ricerca delle opzioni di configurazione per il tuo ambito.
Fai riferimento al tutorial sul file di configurazione per gli esempi.
Troverai un esempio di un file per questo ambito alla fine di questo articolo.
Prerequisiti
- Una conoscenza base o avanzata della sintassi JSON.
- Un contatto presso Splio per ricevere e convalidare il tuo file di configurazione.
- Un editor di testo o di codice.
Utilizza il tuo editor di testo o di codice preferito per creare e modificare i file di configurazione. È consigliabile utilizzare un editor che possa convalidare la sintassi JSON, poiché ti aiuterà a individuare gli errori di base più frequenti come virgole, punti interrogativi oppure parentesi mancanti. Se non conosci alcun software di questo tipo, puoi utilizzare JSON Editor Online, che è un software gratuito disponibile via Web.
Definizione del file di configurazione
Il file di configurazione è un file di testo conforme al formato JavaScript Object Notation (JSON).
|
Nome del file |
<universe>_imports_config.json |
|
Codifica |
UTF-8 without BOM |
|
Formato |
JSON |
Gli elementi a continuazione che devono essere sostituiti con i nomi e i valori reali sono contenuti tra parentesi angolari ("<>"). Le parti facoltative sono contenute tra parentesi quadre ("[]"). I puntini di sospensione (". . . ") sostituiscono le ripetizioni.
{
"<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
Il file deve contenere un oggetto "<universe>" (universo). Il nome di questo oggetto deve corrispondere al nome del tuo universo Splio nonché appartenere al nome del file.
Ambito
L'universo deve contenere almeno un oggetto "<scope>" (ambito). Gli ambiti costituiscono i tipi di dati che possono essere importati nel database Splio.
Sono disponibili i seguenti ambiti:
- contatti
- prodotti
- negozi
- ordini
- carrelli abbandonati
- righe scontrino
- premi loyalty (masterreward, earnreward, burnreward)
- accredito punti
- eventi
- eliminazione contatti
- iscrizioni loyalty (codici carte)
- tier change
Solamente all'ambito dei contatti corrisponde un ambito di eliminazione.
Sotto-sequenze
Ogni ambito deve contenere uno o più oggetti "<sub-sequence>" (sotto-sequenza). Le sotto-sequenze vengono utilizzate per definire i file di import appartenenti ad una specifica sotto-sequenza all'interno di un ambito. Le sotto-sequenze rappresentano varie sorgenti di dati (ad es. database esterni) o import all'interno dello stesso ambito realizzati per diverse ragioni.
Tutte le opzioni di configurazione sono definite all'interno delle sotto-sequenze.
Ambiti e opzioni di configurazione
Le seguenti sottosezioni elencano le opzioni di configurazione disponibili all'interno di ogni ambito.
Contatti (contacts)
Vedi qui per maggiori informazioni sui contatti.
Per i contatti sono disponibili le seguenti opzioni di configurazione:
|
Opzione di configurazione |
Necessaria |
Tipo di valore |
Descrizione/indicazioni per l'uso |
|
report dei destinatari |
Sì |
lista di indirizzi email |
Indirizzi email di tutti i destinatari che riceveranno il report al completamento dell'import. |
|
alert dei destinatari |
Sì |
lista di indirizzi email |
Indirizzi email di tutti i destinatari che riceveranno le notifiche in caso di errore. |
|
sovrascrivere con valori vuoti |
No |
0 (no, per impostazione predefinita) / 1 (sì) |
Se impostato su "1" (sì), i valori esistenti saranno sostituiti da NULL quando un record viene aggiornato da un file e il campo nel file è vuoto. |
|
prefisso cellulare predefinito |
Sì |
numerico |
Un prefisso (internazionale) da aggiungere a tutti i numeri di cellulare locali trovati nel file. Non sarà aggiunto ai numeri che contengono già un prefisso internazionale. |
|
init liste |
Sì |
lista di valori numerici |
Una lista che deve includere gli ID numerici di tutte le liste Splio che devono essere inizializzate (ossia svuotate) prima dell'import. |
|
creare contatti |
No |
0 (no) / 1 (sì, per impostazione predefinita) |
Consente la creazione di nuovi contatti durante l'import. È attivata per impostazione predefinita. Disattivandola puoi impedire a un determinato file di import di creare nuovi contatti. |
|
aggiornare contatti |
No |
0 (no) / 1 (sì, per impostazione predefinita) |
Consente l'aggiornamento dei contatti esistenti sulla base del file di import. È attivata per impostazione predefinita. Disattivandola ti assicuri che nessun record di contatto sia aggiornato quando viene importato il file. Puoi utilizzarla per iscrivere automaticamente dei contatti alle liste. |
Suggerimento: se non vuoi cancellare (inizializzare) alcuna lista, non fornire alcun valore come lista: "init list": [ ]
Prodotti (products)
I prodotti sono i vari articoli che i clienti possono acquistare o venir loro assegnati. Vedi qui per maggiori informazioni sui prodotti.
Per i prodotti sono disponibili le seguenti opzioni di configurazione:
|
Opzione di configurazione |
Necessaria |
Tipo di valore |
Descrizione/indicazioni per l'uso |
|
report dei destinatari |
Sì |
lista di indirizzi email |
Indirizzi email di tutti i destinatari che riceveranno il report al completamento dell'import. |
|
alert dei destinatari |
Sì |
lista di indirizzi email |
Indirizzi email di tutti i destinatari che riceveranno le notifiche in caso di errore. |
|
sovrascrivere con valori vuoti |
No |
0 (no, per impostazione predefinita) / 1 (sì) |
Se impostato su "1" (sì), i valori esistenti saranno sostituiti da NULL quando un record viene aggiornato da un file e il campo nel file è vuoto. |
|
creare prodotti |
No |
0 (no) / 1 (sì, per impostazione predefinita) |
Consente la creazione di nuovi prodotti durante l'import. È attivata per impostazione predefinita. Disattivandola puoi impedire a un determinato file di import di creare nuovi prodotti. |
|
aggiornare prodotti |
No |
0 (no) / 1 (sì, per impostazione predefinita) |
Consente l'aggiornamento dei prodotti esistenti sulla base del file di import. È attivata per impostazione predefinita. Disattivandola puoi impedire che nessun record di prodotto sia aggiornato quando viene importato il file. |
Negozi (stores)
I negozi rappresentano i negozi fisici oppure i negozi online. Vedi qui per maggiori informazioni sui negozi.
Per i negozi sono disponibili le seguenti opzioni di configurazione:
|
Opzione di configurazione |
Necessaria |
Tipo di valore |
Descrizione/indicazioni per l'uso |
|
report dei destinatari |
Sì |
lista di indirizzi email |
Indirizzi email di tutti i destinatari che riceveranno il report al completamento dell'import. |
|
alert dei destinatari |
Sì |
lista di indirizzi email |
Indirizzi email di tutti i destinatari che riceveranno le notifiche in caso di errore. |
|
sovrascrivere con valori vuoti |
No |
0 (no, per impostazione predefinita) / 1 (sì) |
Se impostato su "1" (sì), i valori esistenti saranno sostituiti da NULL quando un record viene aggiornato da un file e il campo nel file è vuoto. |
|
creare negozi |
No |
0 (no) / 1 (sì, per impostazione predefinita) |
Consente la creazione di nuovi negozi durante l'import. È attivata per impostazione predefinita. Disattivandola puoi impedire a un determinato file di import di creare nuovi negozi. |
|
aggiornare negozi |
No |
0 (no) / 1 (sì, per impostazione predefinita) |
Consente l'aggiornamento dei negozi esistenti sulla base del file di import. È attivata per impostazione predefinita. Disattivandola puoi impedire che nessun record di negozio sia aggiornato quando viene importato il file. |
Ordini (orders)
Gli scontrini rappresentano gli acquisti effettuati dai contatti. Vedi qui per maggiori informazioni sugli ordini.
Per gli scontrini sono disponibili le seguenti opzioni di configurazione:
|
Opzione di configurazione |
Necessaria |
Tipo di valore |
Descrizione/indicazioni per l'uso |
|
report dei destinatari |
Sì |
lista di indirizzi email |
Indirizzi email di tutti i destinatari che riceveranno il report al completamento dell'import. |
|
alert dei destinatari |
Sì |
lista di indirizzi email |
Indirizzi email di tutti i destinatari che riceveranno le notifiche in caso di errore. |
|
sovrascrivere con valori vuoti |
No |
0 (no, per impostazione predefinita) / 1 (sì) |
Se impostato su "1" (sì), i valori esistenti saranno sostituiti da NULL quando un record viene aggiornato da un file e il campo nel file è vuoto. |
|
creare ordini |
No |
0 (no) / 1 (sì, per impostazione predefinita) |
Consente la creazione di nuovi record di scontrini durante l'import. È attivata per impostazione predefinita. Disattivandola puoi impedire a un determinato file di import di creare nuovi scontrini. |
|
aggiornare ordini |
No |
0 (no) / 1 (sì, per impostazione predefinita) |
Consente l'aggiornamento degli scontrini esistenti sulla base del file di import. È attivata per impostazione predefinita. Disattivandola puoi impedire che nessun record di scontrino sia aggiornato quando viene importato il file. |
|
generare eventi loyalty |
No |
0 (no, per impostazione predefinita) / 1 (sì) |
Consente l'elaborazione degli scontrini come eventi dal motore Loyalty, per attivare regole come condizioni. Senza questo parametro non può essere fornito alcun risultato dalle regole attivate dagli scontrini. Compatibile con lo stesso parametro su "ordersitems". |
|
solo ordini |
No |
0 (no, per impostazione predefinita) / 1 (sì) |
Consente al motore Loyalty di elaborare scontrini senza righe scontrino per le regole Loyalty. Questa opzione dovrebbe essere attivata su "orders" o "ordersitems" per le regole Loyalty per assegnare risultati (mai su entrambi). |
Carrelli abbandonati (abandonedcarts)
I carrelli abbandonati rappresentano gli acquisti che non sono stati completati. Vedi qui per maggiori informazioni sui carrelli abbandonati.
Per i carrelli abbandonati sono disponibili le seguenti opzioni di configurazione:
|
Opzione di configurazione |
Necessaria |
Tipo di valore |
Descrizione/indicazioni per l'uso |
|
report dei destinatari |
Sì |
lista di indirizzi email |
Indirizzi email di tutti i destinatari che riceveranno il report al completamento dell'import. |
|
alert dei destinatari |
Sì |
lista di indirizzi email |
Indirizzi email di tutti i destinatari che riceveranno le notifiche in caso di errore. |
|
sovrascrivere con valori vuoti |
No |
0 (no, per impostazione predefinita) / 1 (sì) |
Se impostato su "1" (sì), i valori esistenti saranno sostituiti da NULL quando un record viene aggiornato da un file e il campo nel file è vuoto. |
|
creare carrelli abbandonati |
No |
0 (no) / 1 (sì, per impostazione predefinita) |
Consente la creazione di nuovi carrelli abbandonati durante l'import. È attivata per impostazione predefinita. Disattivandola puoi impedire la creazione di nuovi record di carrelli abbandonati. |
|
aggiornare carrelli abbandonati |
No |
0 (no) / 1 (sì, per impostazione predefinita) |
Consente l'aggiornamento di carrelli abbandonati durante l'import. È attivata per impostazione predefinita. Disattivandola puoi impedire la creazione di nuovi record di carrelli abbandonati. |
Righe scontrino (orderitems)
Le righe scontrino rappresentano i prodotti contenuti all'interno di uno scontrino o carrello abbandonato. Vedi qui per maggiori informazioni sulle righe scontrino.
Considera che gli oggetti in questo ambito non possono essere aggiornati tramite l'import, ma saranno eliminati quando lo scontrino oppure il carrello abbandonato corrispondente vengono importati (ad es. aggiornati).
|
Opzione di configurazione |
Necessaria |
Tipo di valore |
Descrizione/indicazioni per l'uso |
|
report dei destinatari |
Sì |
lista di indirizzi email |
Indirizzi email di tutti i destinatari che riceveranno il report al completamento dell'import. |
|
alert dei destinatari |
Sì |
lista di indirizzi email |
Indirizzi email di tutti i destinatari che riceveranno le notifiche in caso di errore. |
|
sovrascrivere con valori vuoti |
No |
0 (no, per impostazione predefinita) / 1 (sì) |
Se impostato su "1" (sì), i valori esistenti saranno sostituiti da NULL quando un record viene aggiornato da un file e il campo nel file è vuoto. |
|
generare eventi loyalty |
No |
0 (no, per impostazione predefinita) / 1 (sì) |
Consente l'elaborazione degli scontrini come eventi dal motore Loyalty, per attivare regole come condizioni. Senza questo parametro, non può essere fornito alcun risultato dalle regole attivate da ordersitems (prodotti). Compatibile con lo stesso parametro su "ordersitems". |
|
solo righe scontrino |
No |
0 (no, per impostazione predefinita) / 1 (sì) |
Consente al motore Loyalty di elaborare ordersitems senza orders per le regole Loyalty. Questa opzione dovrebbe essere attivata su orders o ordersitems per le regole Loyalty per assegnare risultati (mai su entrambi). |
Iscrizioni loyalty (cardcode)
Questo ambito utilizza il medesimo set di opzioni di configurazione di ordersitems di cui sopra.
Vedi qui per maggiori informazioni sull'import di iscrizioni loyalty.
Cambio di livello
|
Opzione di configurazione |
Obbligatorio |
Tipo di valore |
Descrizione/istruzioni per l'uso |
|
force_points |
No |
1 se vuoi attivarla |
Questo parametro attribuirà il numero di qpoint necessario per arrivare al livello precisato nel testo. Se non utilizzi questo parametro, il membro sarà nel livello in questione senza possedere il numero adeguato di qpoint e sarà declassato al successivo calcolo di downgrade |
Accredito punti (creditpoints), Eventi (events), Eliminazione contatti (deletecontacts)
Questo gruppo di ambiti di import condivide la medesima modalità di opzioni di configurazione.
Vedi questi articoli per maggiori informazioni sui singoli ambiti:
|
Opzione di configurazione |
Necessaria |
Tipo di valore |
Descrizione/indicazioni per l'uso |
|
report dei destinatari |
Sì |
lista di indirizzi email |
Indirizzi email di tutti i destinatari che riceveranno il report al completamento dell'import. |
|
alert dei destinatari |
Sì |
lista di indirizzi email |
Indirizzi email di tutti i destinatari che riceveranno le notifiche in caso di errore. |
Premi loyalty (masterreward, earnreward, burnreward)
L'import degli ambiti correlati ai premi è descritto nel documento Premi loyalty.
|
Opzione di configurazione |
Necessaria |
Tipo di valore |
Descrizione/indicazioni per l'uso |
|
report dei destinatari |
Sì |
lista di indirizzi email |
Indirizzi email di tutti i destinatari che riceveranno il report al completamento dell'import. |
|
alert dei destinatari |
Sì |
lista di indirizzi email |
Indirizzi email di tutti i destinatari che riceveranno le notifiche in caso di errore. |
|
sovrascrivere con valori vuoti |
No |
0 (no, per impostazione predefinita) / 1 (sì) |
solo per "masterrewards" Se impostata su "1" (sì), i valori esistenti saranno sostituiti da NULL quando un record viene aggiornato da un file e il campo nel file è vuoto. |