Mappatura del database

La mappatura SQL dello schema di esempio fornisce il seguente documento XML:

<schema mappingType="sql" name="recipient" namespace="cus" xtkschema="xtk:schema">
  <enumeration basetype="byte" name="gender">    
    <value label="Not specified" name="unknown" value="0"/>    
    <value label="Male" name="male" value="1"/>    
    <value label="Female" name="female" value="2"/> 
  </enumeration>  

  <element name="recipient" sqltable="CusRecipient">    
    <attribute desc="Recipient e-mail address" label="Email" length="80" name="email" sqlname="sEmail" type="string"/>    
    <attribute default="GetDate()" label="Date of creation" name="created" sqlname="tsCreated" type="datetime"/>    
    <attribute enum="gender" label="Gender" name="gender" sqlname="iGender" type="byte"/>    
    <element label="Location" name="location">      
      <attribute label="City" length="50" name="city" sqlname="sCity" type="string" userEnum="city"/>    
    </element>  
  </element>
</schema>

Descrizione

L'elemento principale dello schema non è più <srcschema>, ma <schema>.

Questo ci porta a un altro tipo di documento, generato automaticamente dallo schema di origine, semplicemente denominato schema. Questo schema verrà utilizzato dall'applicazione Adobe Campaign.

I nomi SQL vengono determinati automaticamente in base al nome e al tipo dell'elemento.

Le regole di denominazione SQL sono le seguenti:

  • tabella: concatenazione dello spazio dei nomi e del nome dello schema

    Nel nostro esempio, il nome della tabella viene immesso tramite l’elemento principale dello schema nell’attributo sqltable :

    <element name="recipient" sqltable="CusRecipient">

  • campo: nome dell’elemento preceduto da un prefisso definito in base al tipo ('i' per integer, 'd' per double, 's' per string, 'ts' per date, ecc.)

    Il nome del campo viene immesso tramite l'attributo sqlname per ciascun tipo <attribute> e <element>:

    <attribute desc="E-mail address of recipient" label="Email" length="80" name="email" sqlname="sEmail" type="string"/>
NOTA

I nomi SQL possono essere sovraccaricati dallo schema di origine. A questo scopo, compila gli attributi "sqltable" o "sqlname" sull’elemento interessato.

Lo script SQL per creare la tabella generata dallo schema esteso è il seguente:

CREATE TABLE CusRecipient(
  iGender NUMERIC(3) NOT NULL Default 0,   
  sCity VARCHAR(50),   
  sEmail VARCHAR(80),
  tsCreated TIMESTAMP Default NULL);

I vincoli del campo SQL sono i seguenti:

  • nessun valore nullo nei campi numerici e di data,
  • i campi numerici sono inizializzati a 0.

Campi XML

Per impostazione predefinita, qualsiasi elemento <attribute> e <element> digitato viene mappato su un campo SQL della tabella dello schema dati. È tuttavia possibile fare riferimento a questo campo in XML anziché in SQL, il che significa che i dati vengono memorizzati in un campo Memo ("mData") della tabella contenente i valori di tutti i campi XML. L'archiviazione di questi dati è un documento XML che osserva la struttura dello schema.

Per compilare un campo in XML, è necessario aggiungere l'attributo xml con il valore "true" all'elemento interessato.

Esempio: di seguito sono riportati due esempi di utilizzo del campo XML.

  • Campo commento su più righe:

    <element name="comment" xml="true" type="memo" label="Comment"/>

  • Descrizione dei dati in formato HTML:

    <element name="description" xml="true" type="html" label="Description"/>

    Il tipo "html" ti consente di memorizzare il contenuto HTML in un tag CDATA e di visualizzare un controllo di modifica HTML speciale nell’interfaccia client di Adobe Campaign.

L’utilizzo di campi XML consente di aggiungere campi senza dover modificare la struttura fisica del database. Un altro vantaggio è l'utilizzo di meno risorse (dimensioni assegnate ai campi SQL, limite al numero di campi per tabella, ecc.).

Lo svantaggio principale è l'impossibilità di indicizzare o filtrare un campo XML.

Campi indicizzati

Gli indici consentono di ottimizzare le prestazioni delle query SQL utilizzate nell'applicazione.

Un indice viene dichiarato dall'elemento principale dello schema dati.

<dbindex name="name_of_index" unique="true/false">
  <keyfield xpath="xpath_of_field1"/>
  <keyfield xpath="xpath_of_field2"/>
  ...
</key>

Gli indici obbediscono alle seguenti regole:

  • Un indice può fare riferimento a uno o più campi della tabella.
  • Un indice può essere univoco (per evitare duplicati) in tutti i campi se l'attributo univoco contiene il valore "true".
  • Il nome SQL dell'indice è determinato dal nome SQL della tabella e dal nome dell'indice.
NOTA

Come standard, gli indici sono i primi elementi dichiarati dall’elemento principale dello schema.

NOTA

Gli indici vengono creati automaticamente durante la mappatura della tabella (standard o FDA).

Esempio:

  • Aggiunta di un indice all'indirizzo e-mail e alla città:

    <srcSchema name="recipient" namespace="cus">
  <element name="recipient">
    <dbindex name="email">
      <keyfield xpath="@email"/> 
      <keyfield xpath="location/@city"/> 
    </dbindex>

    <attribute name="email" type="string" length="80" label="Email" desc="E-mail address of recipient"/>
    <element name="location" label="Location">
      <attribute name="city" type="string" length="50" label="City" userEnum="city"/>
    </element>
  </element>
</srcSchema>

  • Aggiunta di un indice univoco al campo del nome "id":

    <srcSchema name="recipient" namespace="cus">
  <element name="recipient">
    <dbindex name="id" unique="true">
      <keyfield xpath="@id"/> 
    </dbindex>

    <dbindex name="email">
      <keyfield xpath="@email"/> 
    </dbindex>

    <attribute name="id" type="long" label="Identifier"/>
    <attribute name="email" type="string" length="80" label="Email" desc="E-mail address of recipient"/>
  </element>
</srcSchema>

Gestione delle chiavi

Una tabella deve avere almeno una chiave per identificare un record nella tabella.

Una chiave viene dichiarata dall'elemento principale dello schema dati.

<key name="name_of_key">
  <keyfield xpath="xpath_of_field1"/>
  <keyfield xpath="xpath_of_field2"/>
  ...
</key>

Le chiavi obbediscono alle seguenti regole:

  • Una chiave può fare riferimento a uno o più campi della tabella.
  • Una chiave è nota come "primaria" (o "priorità") quando è la prima nello schema da compilare o se contiene l’attributo interno con il valore "true".
  • Un indice univoco viene dichiarato implicitamente per ogni definizione di chiave. È possibile impedire la creazione di un indice sulla chiave aggiungendo l'attributo noDbIndex con il valore "true".
NOTA

Come standard, le chiavi sono gli elementi dichiarati dall'elemento principale dello schema dopo la definizione degli indici.

NOTA

Le chiavi vengono create durante la mappatura della tabella (standard o FDA), Adobe Campaign trova indici univoci.

Esempio:

  • Aggiunta di una chiave all'indirizzo e-mail e alla città:

    <srcSchema name="recipient" namespace="cus">
  <element name="recipient">
    <key name="email">
      <keyfield xpath="@email"/> 
      <keyfield xpath="location/@city"/> 
    </key>

    <attribute name="email" type="string" length="80" label="Email" desc="E-mail address of recipient"/>
    <element name="location" label="Location">
      <attribute name="city" type="string" length="50" label="City" userEnum="city"/>
    </element>
  </element>
</srcSchema>

    Lo schema generato:

    <schema mappingType="sql" name="recipient" namespace="cus" xtkschema="xtk:schema">  
  <element name="recipient" sqltable="CusRecipient">    
   <dbindex name="email" unique="true">      
     <keyfield xpath="@email"/>      
     <keyfield xpath="location/@city"/>    
   </dbindex>    

   <key name="email">      
    <keyfield xpath="@email"/>      
    <keyfield xpath="location/@city"/>    
   </key>    

   <attribute desc="E-mail address of recipient" label="Email" length="80" name="email" sqlname="sEmail" type="string"/>    
   <element label="Location" name="location">      
     <attribute label="City" length="50" name="city" sqlname="sCity" type="string" userEnum="city"/>    
   </element>  
  </element>
</schema>

  • Aggiunta di una chiave primaria o interna al campo del nome "id":

    <srcSchema name="recipient" namespace="cus">
  <element name="recipient">
    <key name="id" internal="true">
      <keyfield xpath="@id"/> 
    </key>

    <key name="email" noDbIndex="true">
      <keyfield xpath="@email"/> 
    </key>

    <attribute name="id" type="long" label="Identifier"/>
    <attribute name="email" type="string" length="80" label="Email" desc="E-mail address of recipient"/>
  </element>
</srcSchema>

    Lo schema generato:

    <schema mappingType="sql" name="recipient" namespace="cus" xtkschema="xtk:schema">  
  <element name="recipient" sqltable="CusRecipient">    
    <key name="email">      
      <keyfield xpath="@email"/>    
    </key>    

    <dbindex name="id" unique="true">      
      <keyfield xpath="@id"/>    
    </dbindex>    

    <key internal="true" name="id">      
     <keyfield xpath="@id"/>    
    </key>    

    <attribute label="Identifier" name="id" sqlname="iRecipientId" type="long"/>    
    <attribute desc="E-mail address of recipient" label="Email" length="80" name="email" sqlname="sEmail" type="string"/>  
  </element>
</schema>

Chiave incrementale automatica

La chiave primaria della maggior parte delle tabelle Adobe Campaign è un numero intero lungo 32 bit generato automaticamente dal motore di database. Il calcolo del valore chiave dipende da una sequenza (per impostazione predefinita, la funzione SQL XtkNewId) che genera un numero univoco nell'intero database. Il contenuto della chiave viene immesso automaticamente all'inserimento del record.

Il vantaggio di una chiave incrementale è che fornisce una chiave tecnica non modificabile per i join tra tabelle. Inoltre, questa chiave non occupa molta memoria perché utilizza un numero intero a doppio byte.

È possibile specificare nello schema di origine il nome della sequenza da utilizzare con l'attributo pkSequence . Se questo attributo non è specificato nello schema di origine, verrà utilizzata la sequenza predefinita XtkNewId. L'applicazione utilizza sequenze dedicate per gli schemi nms:wideLog e nms:trackingLog (NmsBroadLogId e NmsTrackingLogId), rispettivamente, perché queste sono le tabelle che contengono il maggior numero di record.

Da ACC 18.10, XtkNewId non è più il valore predefinito per la sequenza negli schemi predefiniti. Ora puoi creare uno schema o estendere lo schema esistente con una sequenza dedicata.

IMPORTANTE

Durante la creazione di un nuovo schema o durante un'estensione dello schema, è necessario mantenere lo stesso valore di sequenza della chiave primaria (@pkSequence) per l'intero schema.

NOTA

Una sequenza a cui si fa riferimento in uno schema Adobe Campaign (NmsTrackingLogId ad esempio) deve essere associata a una funzione SQL che restituisce il numero di ID nei parametri, separati da virgole. Questa funzione deve essere denominata GetNew XXX Ids, dove XXX è il nome della sequenza (GetNewNmsTrackingLogIds ad esempio). Per ripristinare l'esempio di un'applicazione nella directory datakit/nms/sql/>, visualizzare i file postgres-nms.sql , mssql-nms.sql o oracle-nms/sql/Creazione della sequenza NmsTrackingLogId per ogni motore di database.

Per dichiarare una chiave univoca, compila l'attributo autopk (con valore "true") sull'elemento principale dello schema dati.

Esempio:

Dichiarazione di una chiave incrementale nello schema di origine:

<srcSchema name="recipient" namespace="cus">
  <element name="recipient" autopk="true">
  ...
  </element>
</srcSchema>

Lo schema generato:

<schema mappingType="sql" name="recipient" namespace="cus" xtkschema="xtk:schema">  
  <element name="recipient" autopk="true" pkSequence="XtkNewId" sqltable="CusRecipient"> 
    <dbindex name="id" unique="true">
      <keyfield xpath="@id"/>
    </dbindex>

    <key internal="true" name="id">
      <keyfield xpath="@id"/>
    </key>

    <attribute desc="Internal primary key" label="Primary key" name="id" sqlname="iRecipientId" type="long"/>
  </element>
</schema>

Oltre alla definizione della chiave e del relativo indice, allo schema esteso è stato aggiunto un campo numerico denominato "id" per contenere la chiave primaria generata automaticamente.

IMPORTANTE

Al momento della creazione della tabella viene inserito automaticamente un record con una chiave primaria impostata su 0. Questo record viene utilizzato per evitare i join esterni, che non sono efficaci nelle tabelle dei volumi. Per impostazione predefinita, tutte le chiavi esterne vengono inizializzate con il valore 0 in modo che sia sempre possibile restituire un risultato sul join quando l'elemento dati non è popolato.

Collegamenti: relazione tra tabelle

Un collegamento descrive l’associazione tra una tabella e un’altra.

I vari tipi di associazioni (note come "cardinalità") sono i seguenti:

  • Cardinalità 1-1: una occorrenza della tabella sorgente può avere al massimo una occorrenza corrispondente della tabella di destinazione.
  • Cardinalità 1-N: una occorrenza della tabella sorgente può avere diverse occorrenze corrispondenti della tabella di destinazione, ma una occorrenza della tabella di destinazione può avere al massimo una occorrenza corrispondente della tabella sorgente.
  • Cardinalità N-N: una occorrenza della tabella sorgente può avere diverse occorrenze corrispondenti della tabella di destinazione e viceversa.

Nell’interfaccia è possibile distinguere facilmente i diversi tipi di relazioni grazie alle loro icone.

Per le relazioni di unione con una tabella/database della campagna:

  • : Cardinalità 1-1. Ad esempio, tra un destinatario e un ordine corrente. Un destinatario può essere correlato a una sola occorrenza della tabella dell'ordine corrente alla volta.
  • : Cardinalità 1-1, unione esterna. Ad esempio, tra un destinatario e il proprio paese. Un destinatario può essere correlato a una sola occorrenza del paese della tabella. Il contenuto della tabella del paese non verrà salvato.
  • : Cardinalità 1-N. Ad esempio, tra un destinatario e la tabella Abbonamenti. Un destinatario può essere correlato a diverse occorrenze nella tabella Abbonamenti.

Per le relazioni di unione che utilizzano Federated Database Access:

  • : Cardinalità 1-1
  • : Cardinalità 1-N

Per ulteriori informazioni sulle tabelle FDA, vedere Accesso a un database esterno.

Un collegamento deve essere dichiarato nello schema contenente la chiave esterna della tabella collegata tramite l’elemento principale:

<element name="name_of_link" type="link" target="key_of_destination_schema">
  <join xpath-dst="xpath_of_field1_destination_table" xpath-src="xpath_of_field1_source_table"/>
  <join xpath-dst="xpath_of_field2_destination_table" xpath-src="xpath_of_field2_source_table"/>
  ...
</element>

I collegamenti obbediscono alle seguenti regole:

  • La definizione di un collegamento viene inserita in un tipo link <element> con i seguenti attributi:

    • nome: nome del collegamento dalla tabella sorgente,

    • target: nome dello schema di destinazione,

    • etichetta: etichetta del collegamento,

    • revLink (facoltativo): nome del collegamento inverso dallo schema di destinazione (dedotto automaticamente per impostazione predefinita),

    • integrità (facoltativo): integrità referenziale dell'occorrenza della tabella di origine all'occorrenza della tabella di destinazione. I valori possibili sono i seguenti:

      • definisci: è possibile eliminare l'occorrenza sorgente se non è più referenziata da un'occorrenza di destinazione,
      • normale: l'eliminazione dell'occorrenza di origine inizializza le chiavi del collegamento all'occorrenza di destinazione (modalità predefinita). Questo tipo di integrità inizializza tutte le chiavi esterne,
      • propri: l'eliminazione dell'occorrenza di origine porta all'eliminazione dell'occorrenza di destinazione,
      • owncopy: uguale al proprio (in caso di eliminazione) o duplica gli eventi (in caso di duplicazione),
      • neutro: non fa nulla.

    • revIntegrity (facoltativo): integrità dello schema di destinazione (facoltativo, "normale" per impostazione predefinita),

    • revCardinalità (facoltativo): con il valore "single" popola la cardinalità con il tipo 1-1 (1-N per impostazione predefinita).

    • externalJoin (facoltativo): forza il join esterno

    • revExternalJoin (facoltativo): forza l'unione esterna sul collegamento inverso

  • Un collegamento fa riferimento a uno o più campi dalla tabella di origine alla tabella di destinazione. I campi che compongono l’elemento join ( <join> ) non devono essere compilati perché vengono detratti automaticamente per impostazione predefinita utilizzando la chiave interna dello schema di destinazione.

  • Un indice viene aggiunto automaticamente alla chiave esterna del collegamento nello schema esteso.

  • Un collegamento è costituito da due collegamenti parziali, in cui il primo è dichiarato dallo schema di origine e il secondo viene creato automaticamente nello schema esteso dello schema di destinazione.

  • Un join può essere un join esterno se viene aggiunto l'attributo externalJoin con il valore "true" (supportato in PostgreSQL).

NOTA

Come standard, i collegamenti sono gli elementi dichiarati alla fine dello schema.

Esempio 1

Relazione 1-N alla tabella dello schema "cus:company":

<srcSchema name="recipient" namespace="cus">
  <element name="recipient">
    ...
    <element label="Company" name="company" revIntegrity="define" revLabel="Contact" target="cus:company" type="link"/>
  </element>
</srcSchema>

Lo schema generato:

<schema mappingType="sql" name="recipient" namespace="cus" xtkschema="xtk:schema">  
  <element name="recipient" sqltable="CusRecipient"> 
    <dbindex name="companyId">      
      <keyfield xpath="@company-id"/>    
    </dbindex>
    ...
    <element label="Company" name="company" revLink="recipient" target="cus:company" type="link">      
      <join xpath-dst="@id" xpath-src="@company-id"/>    
    </element>    
    <attribute advanced="true" label="Foreign key of 'Company' link (field 'id')" name="company-id" sqlname="iCompanyId" type="long"/>
  </element>
</schema>

La definizione del collegamento è completata dai campi che compongono il join, ovvero la chiave primaria con il relativo XPath ("@id") nello schema di destinazione, e la chiave esterna con il relativo XPath ("@company-id") nello schema.

La chiave esterna viene aggiunta automaticamente in un elemento che utilizza le stesse caratteristiche del campo associato nella tabella di destinazione, con la seguente convenzione di denominazione: nome dello schema di destinazione seguito dal nome del campo associato ("company-id" nel nostro esempio).

Schema esteso del target ("cus:company"):

<schema mappingType="sql" name="company" namespace="cus" xtkschema="xtk:schema">  
  <element name="company" sqltable="CusCompany" autopk="true"> 
    <dbindex name="id" unique="true">     
      <keyfield xpath="@id"/>    
    </dbindex>   
    <key internal="true" name="id">      
      <keyfield xpath="@id"/>    
    </key>
    ...
    <attribute desc="Internal primary key" label="Primary key" name="id" sqlname="iCompanyId" type="long"/>
    ...
    <element belongsTo="cus:recipient" integrity="define" label="Contact" name="recipient" revLink="company" target="nms:recipient" type="link" unbound="true">      
      <join xpath-dst="@company-id" xpath-src="@id"/>    
    </element>
  </element>
</schema>

È stato aggiunto un link inverso alla tabella "cus:recipient" con i seguenti parametri:

  • nome: dedotto automaticamente dal nome dello schema di origine (può essere forzato con l'attributo "revLink" nella definizione del collegamento sullo schema di origine)
  • revLink: nome del link inverso
  • target: chiave dello schema collegato ( schema "cus:recipient")
  • non associato: il collegamento viene dichiarato come elemento di raccolta per una cardinalità 1-N (per impostazione predefinita)
  • integrità: "define" per impostazione predefinita (può essere forzato con l'attributo "revIntegrity" nella definizione del collegamento sullo schema di origine).

Esempio 2

In questo esempio, dichiareremo un collegamento verso la tabella di schema "nms:address". Il join è un join esterno ed è popolato in modo esplicito con l'indirizzo e-mail del destinatario e il campo "@address" della tabella collegata ("nms:address").

<srcSchema name="recipient" namespace="cus">
  <element name="recipient"> 
    ...
    <element integrity="neutral" label="Info about email" name="emailInfo" revIntegrity="neutral" revLink="recipient" target="nms:address" type="link" externalJoin="true">      
      <join xpath-dst="@address" xpath-src="@email"/>
    </element>
  </element>
</srcSchema>

Esempio 3

Relazione 1-1 alla tabella dello schema "cus:extension":

<element integrity="own" label="Extension" name="extension" revCardinality="single" revLink="recipient" target="cus:extension" type="link"/>

Esempio 4

Collega a una cartella ("schema xtk:folder"):

<element default="DefaultFolder('nmsFolder')" label="Folder" name="folder" revDesc="Recipients in the folder" revIntegrity="own" revLabel="Recipients" target="xtk:folder" type="link"/>

Il valore predefinito restituisce l'identificatore del primo file di tipo di parametro idoneo immesso nella funzione "DefaultFolder('nmsFolder')".

Esempio 4

In questo esempio, desideriamo creare una chiave su un collegamento ("azienda" a schema "cus:company") con l'attributo xlink e un campo della tabella ("e-mail"):

<srcSchema name="recipient" namespace="cus">
  <element name="recipient">
    <key name="companyEmail"> 
      <keyfield xpath="@email"/>
      <keyfield xlink="company"/>
    </key>
    
    <attribute name="email" type="string" length="80" label="Email" desc="Recipient email"/>
    <element label="Company" name="company" revIntegrity="define" revLabel="Contact" target="cus:company" type="link"/>
  </element>
</srcSchema>

Lo schema generato:

<schema mappingType="sql" name="recipient" namespace="cus" xtkschema="xtk:schema">  
  <element name="recipient" sqltable="CusRecipient"> 
    <dbindex name="companyId">      
      <keyfield xpath="@company-id"/>    
    </dbindex>

    <dbindex name="companyEmail" unique="true">
      <keyfield xpath="@email"/>      
      <keyfield xpath="@company-id"/>    
    </dbindex>    

    <key name="companyEmail">      
      <keyfield xpath="@email"/>      
      <keyfield xpath="@company-id"/>    
    </key>

    <attribute desc="E-mail address of recipient" label="Email" length="80" name="email" sqlname="sEmail" type="string"/>
    <element label="Company" name="company" revLink="recipient" target="sfa:company" type="link">      
      <join xpath-dst="@id" xpath-src="@company-id"/>    
    </element>    
    <attribute advanced="true" label="Foreign key of link 'Company' (field 'id')" name="company-id" sqlname="iCompanyId" type="long"/>
  </element>
</schema>

La definizione della chiave del nome "companyEmail" è stata estesa con la chiave esterna del link "company". Questa chiave genera un indice univoco su entrambi i campi.

In questa pagina