Configuring Contact details

The <ContactDetails> section of the Outbound E-mail configuration file OutboundEmail.xml allows you to specify the extended details fields for Contacts which need to reflect the extended details as defined in Outbound E-mail databases (for more information, see Creating custom Contact extended details (Microsoft SQL Server)).

Configuring the <ContactDetails> section involves doing the following:

  • Defining an ItemTitle element which is used to identify individual Contacts in the Content Manager Explorer.
  • Defining a ContactDetail element for every column in the Outbound E-mail database (extended details table) and setting its attributes accordingly.
  • Internationalizing each ContactDetail element, if necessary.

The following is an example of the <ContactDetails> section:

<ContactDetails>
    <ItemTitle format="{NAME} {SURNAME} ({MAIL})" />
    <ContactDetail name="IDENTIFICATION_KEY" enableSearch="false" isIdentificationKey="true">
      <Label>Identification key</Label>
    </ContactDetail>
    <ContactDetail name="IDENTIFICATION_SOURCE" enableSearch="false" isIdentificationKey="true">
      <Label>Import source</Label>
    </ContactDetail>
    <ContactDetail name="NAME" enableSearch="true">
      <Label>First name</Label>
    </ContactDetail>
    <ContactDetail name="SURNAME" enableSearch="true">
      <Label>Last name</Label>
    <ContactDetail name="MAIL" enableSearch="true" isEmailAddress="true">
      <Label>E-mail address</Label>
</ContactDetails>

The <ContactDetails> section contains the following elements:

ElementDescription
ItemTitleUsed to identify a Contact in the Content Manager Explorer.
ContactDetailAn extended details field as represented in the user interface and define in the Outbound E-mail database—for more information, see Creating custom Contact extended details (Microsoft SQL Server).

Defining the ItemTitle

You need to define an <ItemTitle> element to specify the value used to identify a Contact in the Content Manager Explorer. The <ItemTitle> element contains the following attribute:

AttributeDescription
formatThe string value that is displayed to identify a Contact in the Content Manager Explorer. It is typically comprised of one or more extended detail fields (you need to enclose the name of the ContactDetail in curly brackets {}) and may contain other formatting elements. For example:
<ItemTitle format="{NAME} {SURNAME} ({MAIL})" />

results in Alex Moody (amoody@sdltridion.com)

Specifying ContactDetails

You need to add a <ContactDetail> element for each column defined in the Outbound E-mail databases (in the CONTACTS_EXTENDED_DETAILS table). These fields appear in a Contact's extended details. The <ContactDetail> element contains the following attributes:

ContactDetail attributesDescription
name(Mandatory for all fields) The name of the field as defined in the Outbound E-mail databases (in the CONTACTS_EXTENDED_DETAILS table).
enableSearchSet to true to allow you to perform search and filter Contacts (create dynamic lists) based on the value of this field. The default value is false.
isIdentificationKeySet to true for Contact Details that are part of the database index used to uniquely identify Contacts. The default value is false. One or more columns can be used to form the index. For more information, see GUID-6E5F9A70-3029-45B7-9B88-5F83A6314D0C.html#TASK_2DDAFF2CF95E4430AA0F27AD7A91B5F8.
isEmailAddress(Mandatory for one field) Identifies the field containing the Contact's e-mail address.

The <ContactDetail> element contains (one or more) <Label> elements defining the name of the field as it appears in the Content Manager Explorer. The following is an example of a <ContactDetail> element:

 <ContactDetail name="IDENTIFICATION_KEY" enableSearch="false" isIdentificationKey="true">
   <Label>ID Key</Label>
SubelementDescription
LabelThe name of the Contact extended detail field as displayed in the Content Manager Explorer.

Internationalizing Contact Details

A <Label> element without a language attribute defines the default value used for the field. To translate the user interface, add <Label language="LanguageID">Value</Label> elements where the language is an integer defining the language ID and the value is the translated value. For example:

<ContactDetail name="SURNAME" enableSearch="true">
      <Label>Last name</Label>
      <Label language="1031">Familienname</Label><!--German-->
      <Label language="1036">Nom de famille</Label><!--French-->
      <Label language="3082">Apellido</Label><!--Spanish-->
</ContactDetail>

The <Label> element can contains the following attribute:

Label AttributeDescriptionPossible values
languageThe User Language ID of a language supported by the Content Manager.Common values include:
  • 1043 (Dutch)
  • 1033 (English)
  • 1036 (French)
  • 1031 (German)
  • 3082 (Spanish)
  • 1041 (Japanese)