スキーマの操作 gs-ac-schemas

アプリケーションに格納されるデータの物理的および論理的構造は、XML で記述されます。スキーマ ​と呼ばれる Adobe Campaign 特有の文法に従います。

スキーマは、データベーステーブルに関連付けられた XML ドキュメントです。この中でデータ構造を定義し、表の SQL 定義を記述します。

また、データの格納に使用する XML 構造についても説明します。

スキーマを使用すると、データベース内にエンティティを定義できます。エンティティごとにスキーマがあります。

Adobe Campaign では、次の目的でデータスキーマを使用しています。

Adobe Campaign キャンペーンのビルトインテーブルとそのやり取りについて詳しくは、この節を参照してください。

スキーマの構文 syntax-of-schemas

スキーマのルート要素は <srcschema> です。<element> と <attribute> のサブ要素が含まれます。

最初の <element> サブ要素は、エンティティのルートに一致します。

<srcSchema name="recipient" namespace="cus">
  <element name="recipient">
    <attribute name="lastName"/>
    <attribute name="email"/>
    <element name="location">
      <attribute name="city"/>
   </element>
  </element>
</srcSchema>

<element> タグはエンティティ要素の名前を定義します。スキーマの <attribute> タグは、リンク先の <element> タグの属性の名前を定義します。

スキーマの ID identification-of-a-schema

データスキーマは、名前と名前空間で識別されます。

名前空間を使用すると、一連のスキーマを目標領域別にグループ化できます。例えば、cus 名前空間は、顧客固有の設定（customers）に使用します。

予約済み名前空間 reserved-namespaces

特定の名前空間は、Adobe Campaign アプリケーションの操作に必要なシステムエンティティの記述のために予約されています。次の名前空間は、大文字と小文字を任意に組み合わせて、新しいスキーマを識別するために​ 使用しないでください。

スキーマの識別キーは、名前空間と名前をコロンで区切った文字列です（例：nms:recipient）。

Campaign スキーマの作成または拡張 create-or-extend-schemas

Campaign の中核となるデータスキーマ（受信者テーブル nms:recipient など）にフィールドなどの要素を追加する場合は、スキーマを拡張する必要があります。

詳しくは、スキーマの拡張を参照してください。

Adobe Campaign に存在しないまったく新しいタイプのデータ（契約書のテーブルなど）を追加する場合は、カスタムスキーマを直接作成できます。

詳しくは、新しいスキーマの作成を参照してください。

作業するスキーマを作成または拡張したら、その XML コンテンツ要素を以下に示すのと同じ順序で定義することをお勧めします。

列挙 enumerations

定義済みリストは、スキーマのメイン要素より先に定義します。これにより、特定のフィールドに使用できる値のリストを表示して、ユーザーによる選択肢を制限することができます。

例：

<enumeration basetype="byte" name="exTransactionTypeEnum" default="store">
<value label="Website" name="web" value="0"/>
<value label="Call Center" name="phone" value="1"/>
<value label="In Store" name="store" value="2"/>
</enumeration>

フィールドを定義する際は、次のような定義済みリストを使用できます。

<attribute desc="Type of Transaction" label="Transaction Type" name="transactionType"
type="string" enum="exTransactionTypeEnum"/>

キー keys

各テーブルには少なくとも 1 つのキーが必要です。通常、autopk 属性を true に設定すると、スキーマのメイン要素にキーが自動的に設定されます。

さらに、エンタープライズ（FFDA）デプロイメントのコンテキストでは、@autouuid を使用し、true に設定します。

プライマリキーは、internal 属性を使用して定義することもできます。

例：

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

この例では、@autopk 属性もしくは @autouuid 属性で「id」という名前のデフォルトのプライマリキーを作成する代わりに、独自の「householdId」というプライマリキーを指定します。

キーについて詳しくは、この節を参照してください。

属性（フィールド） attributes--fields-

属性を使用すると、データオブジェクトを構成するフィールドを定義できます。スキーマエディションのツールバーの「挿入」ボタンを使用すると、カーソルのある XML に空の属性テンプレートをドロップできます。詳細については、この節を参照してください。

すべての属性のリストについて詳しくは、Campaign Classic v7 ドキュメントの <attribute> 要素の節を参照してください。よく使用される属性には、@advanced、@dataPolicy、@default、@desc、@enum、@expr、@label、@length、@name、@notNull、@required、@ref、@xml、@type などがあります。

各属性について詳しくは、Campaign Classic v7 ドキュメントの属性に関する説明を参照してください。

例 examples

デフォルト値の定義例：

<attribute name="transactionDate" label="Transaction Date" type="datetime" default="GetDate()"/>

必須のマークも付けるフィールドのテンプレートとして共通属性を使用する例：

<attribute name="mobile" label="Mobile" template="nms:common:phone" required="true" />

“”@advanced 属性を使用して非表示にする計算フィールドの例。

<attribute name="domain" label="Email domain" desc="Domain of recipient email address" expr="GetEmailDomain([@email])" advanced="true" />

@dataPolicy 属性を持ち、SQL フィールドにも格納される XML フィールドの例。

<attribute name="secondaryEmail" label="Secondary email address" length="100" xml="true" sql="true" dataPolicy="email" />

リンク links

スキーマのメイン要素の中で最後の要素のいくつかはリンクです。リンクは、インスタンス内の様々なスキーマを相互にどのように関連付けるかを定義します。

リンクは、リンク先のテーブルの​ 外部キー ​を含んだスキーマで宣言します。

カーディナリティには、1-1、1-N、N-N の 3 つのタイプがあります。デフォルトで使用するのは 1-N タイプです。

例 examples-1

受信者テーブル（標準提供のスキーマ）とカスタムトランザクションテーブルの間の 1 - N リンクの例：

<element label="Recipient" name="lnkRecipient" revLink="lnkTransactions" target="nms:recipient" type="link"/>

カスタムスキーマ「Car」（「cus」名前空間内）と受信者テーブルの間の 1 - 1 リンクの例：

<element label="Car" name="lnkCar" revCardinality="single" revLink="recipient" target="cus:car" type="link"/>

受信者テーブルと、プライマリキーでないメールアドレスで構成されるアドレステーブルとの外部結合の例：

<element name="emailInfo" label="Email Info" revLink="recipient" target="nms:address" type="link" externalJoin="true">
  <join xpath-dst="@address" xpath-src="@email"/>
</element>

「xpath-dst」はターゲットスキーマのプライマリキーに対応し、「xpath-src」はソーススキーマの外部キーに対応します。

監査記録 audit-trail

スキーマの最後に含めると便利な要素の 1 つは、トラッキング要素（監査記録）です。

次の例を使用すると、テーブル内のすべてのデータの作成日、作成者、最終更新日、最終更新者に関するフィールドを含めることができます。

<element aggregate="xtk:common:auditTrail" name="auditTrail"/>

データベース構造の更新 updating-the-database-structure

変更を完了して保存したらデータベースに適用する必要がありますが、この変更は SQL 構造に影響を与える可能性があります。データベースに適用するには、データベース更新ウィザードを使用します。

詳しくは、この節を参照してください。