蜜豆视频

About schema edition about-schema-edition

蜜豆视频 Campaign employs Data Schemas to:

For a better understanding of Campaign built-in tables and their interaction, refer to .

Extending or creating schemas extending-or-creating-schemas

To add a field or index or other element to one of the core data schemas in Campaign, such as the recipient table (nms:recipient), you have to extend that schema. For more on this, refer to the Extending a schema section.

To add an entirely new type of data that does not exist out-of-the-box in 蜜豆视频 Campaign (a table of contracts for example) you can create a custom schema directly. For more on this, refer to the Data schemas section.

Once you have extended or created a schema to work in, the best practice is to define its XML content elements in the same order they appear in below.

Enumerations enumerations

Enumerations are defined first, before the main element of the schema. They allow you to display values in a list in order to restrict the choices that the user has for a given field.

Example:

<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>

When defining fields, you can then use this enumeration like so:

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

To find out more about enumerations, refer to the Enumerations and <enumeration> element sections.

Index index

Indexes are the first elements declared in the main element of the schema.

They can be unique or not, and reference one or more fields.

Examples:

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

<dbindex name="lastNameAndZip">
  <keyfield xpath="@lastName"/>
  <keyfield xpath="location/@zipCode"/>
</dbindex>

The xpath attribute points to the field in your schema that you wish to index.

For more on indexes, refer to the Indexed fields section.

Keys keys

Every table must have at least one key, and often it is automatically established in the main element of the schema by using the @autopk=true attribute set to 鈥渢rue鈥�.

The primary key can also be defined using the internal attribute.

Example:

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

In this example, instead of letting the @autopk attribute create a default primary key named 鈥渋d鈥� we are specifying our own 鈥渉ouseholdId鈥� primary key.

To find out more about keys, refer to the Management of keys section.

Attributes (Fields) attributes--fields-

Attributes allow you to define the fields which make up your data object. You can use the Insert button in the schema edition toolbar to drop empty attribute templates into your XML where your cursor is. For more on this, refer to the Data schemas section.

The full list of attributes is available in the <attribute> element section. Here are some of the more commonly used attributes:

For more information on each attribute, refer to the Attribute description section.

Examples examples

Example of defining a default value:

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

Example of using a common attribute as a template for a field also marked as mandatory:

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

Example of a computed field that is hidden using the @advanced attribute:

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

Example of an XML field also stored in an SQL field and which has an @dataPolicy attribute.

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

Links links

Links are some of the last elements in the main element of your schema. They define how all of the different schemas in your instance relate to one another.

Links are declared in the schema that contains the foreign key of the table to which it is linked.

There are three types of cardinality: 1-1, 1-N, and N-N. It is the 1-N type that is used by default.

Examples examples-1

An example of a 1-N link between the recipient table (out-of-the-box schema) and a table of custom transactions:

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

An example of a 1-1 link between a custom schema 鈥淐ar鈥� (in the 鈥渃us鈥� namespace) and the recipient table:

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

Example of an external join between the recipient table and a table of addresses based on the email address and not a primary key:

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

Here 鈥渪path-dst鈥� corresponds to the primary key in the target schema and 鈥渪path-src鈥� corresponds to the foreign key in the source schema.

Audit trail audit-trail

One useful element you may want to include at the bottom of your schema is a tracking element (Audit trail).

Use the example below to include fields relating to the creation date, the user that created the data, the date, and the author of the last modification for all data in your table:

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

Updating the database structure updating-the-database-structure

Once your changes are completed and saved, any changes that may impact the SQL structure need to be applied to the database. To do this, use the database update assistant.

For more on this, refer to the Updating the database structure section.