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, che viene 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 nel sqltable attributo:

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

• campo: nome dell’elemento preceduto da un prefisso definito secondo il tipo ("i" per numero intero, "d" per doppio, "s" per stringa, "ts" per date, ecc.)

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

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

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 <attribute> e <element> viene mappato su un campo SQL della tabella dello schema di dati. È tuttavia possibile fare riferimento a questo campo in formato XML anziché in formato SQL, il che significa che i dati vengono memorizzati in un campo Memo ("mData") della tabella contenente i valori di tutti i campi XML. La memorizzazione di questi dati è un documento XML che osserva la struttura dello schema.

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

Esempio: ecco due esempi di utilizzo dei campi 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" consente di memorizzare il contenuto HTML in un tag CDATA e di visualizzare uno speciale controllo di modifica HTML 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 consiste nell'utilizzo di meno risorse (dimensioni allocate ai campi SQL, limite al numero di campi per tabella, ecc.).

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 di dati.

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

Le chiavi rispettano le seguenti regole:

• Una chiave può fare riferimento a uno o più campi della tabella.
• Una chiave è nota come "primaria" (o "priorità") quando è la prima dello schema a essere compilata o se contiene interno con il valore "true".

Esempio:

• Aggiunta di una chiave all'indirizzo di posta elettronica 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">
     <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 nel campo del nome "id":

  <srcSchema name="recipient" namespace="cus">
    <element name="recipient">
      <key name="id" internal="true">
        <keyfield xpath="@id"/>
      </key>
  
      <key name="email">
        <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>
  
      <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 primaria - Identificatore

Nell'ambito di una Distribuzione aziendale (FFDA), la chiave primaria delle tabelle di Adobe Campaign è un ID universalmente univoco (UUID) generato automaticamente dal motore di database. Il valore chiave è univoco nell'intero database. Il contenuto della chiave viene generato automaticamente all’inserimento del record.

Esempio

Dichiarazione di una chiave incrementale nello schema di origine:

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

Lo schema generato:

<schema mappingType="sql" name="recipient" namespace="cus" xtkschema="xtk:schema">
  <element name="recipient"  autopk="true" autouuid="true" sqltable="CusRecipient">

    <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, allo schema esteso è stato aggiunto un campo numerico denominato "id" per contenere la chiave primaria generata automaticamente.

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 relative icone.

Per le relazioni di join con una tabella o un database di Campaign:

• 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, join esterno. Ad esempio, tra un destinatario e il suo paese. Un destinatario può essere correlato a una sola occorrenza del paese della tabella. Il contenuto della country table non verrà salvato.
• : Cardinalità 1-N. Ad esempio, tra un destinatario e la tabella delle sottoscrizioni. Un destinatario può essere correlato a diverse occorrenze nella tabella delle sottoscrizioni.

Per le relazioni di join che utilizzano Federated Database Access:

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

Per ulteriori informazioni sulle tabelle FDA, consulta Federated Data Access.

È necessario dichiarare un collegamento 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 rispettano le seguenti regole:

• La definizione di un collegamento viene immessa su un link-type <element> con i seguenti attributi:

  • nome: nome del collegamento dalla tabella di origine,

  • destinazione: 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 sorgente rispetto all’occorrenza della tabella di destinazione. I valori possibili sono i seguenti:

    • definire: è possibile eliminare l’occorrenza sorgente se un’occorrenza target non vi fa più riferimento,
    • normale: l’eliminazione dell’occorrenza sorgente inizializza le chiavi del collegamento all’occorrenza target (modalità predefinita); questo tipo di integrità inizializza tutte le chiavi esterne,
    • proprio: l’eliminazione dell’occorrenza sorgente determina l’eliminazione dell’occorrenza target,
    • owncopy: uguale a proprio (in caso di eliminazione) o duplica le occorrenze (in caso di duplicazione),
    • neutro: non esegue alcuna operazione.

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

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

  • externalJoin (facoltativo): forza l’outer join

  • revExternalJoin (facoltativo): forza il join esterno sul collegamento inverso

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

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

• Un join può essere un outer join se externalJoin con il valore "true" (supportato in PostgreSQL).

Esempio 1

Relazione 1-N con la 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">
    ...
    <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" autouuid="true">
    <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 collegamento 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 nello schema di origine)
• revLink: nome del collegamento inverso
• destinazione: 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 nello schema di origine).

Tieni presente che autouuid="true"Il parametro si applica nel contesto di un Distribuzione aziendale (FFDA) solo.

Esempio 2

In questo esempio, dichiareremo un collegamento verso la tabella dello schema "nms:address". Il join è un outer join e viene compilato esplicitamente con l'indirizzo di posta elettronica 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

1-1 relazione con la tabella dello schema "cus:extension":

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

Esempio 4

Collegamento 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 del tipo di parametro idoneo immesso nella funzione "DefaultFolder('nmsFolder')".

Esempio 5

In questo esempio, vogliamo creare una chiave su un collegamento (schema "company" to "cus:company") con xlink e un campo della tabella ("email"):

<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">
    <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 collegamento "company".