Siebel Marketing Installation and Administration Guide > Designing Marketing List Formats >

Designing Marketing List Formats


The List Format Designer can generate lists in different formats for the specific purposes. You can find examples of each type of list format in the following location:

Shared Campaign Load Formats/Marketing/Example List Formats

Shared List Export Formats/Marketing/Example List Formats

Shared Email Server Formats/Marketing/Example List Formats

Shared Data Load Formats/Marketing/Example List Formats

This section contains the following topics:

Defining List Export Formats

A List Export format defines the customer data and other campaign-related information that is exported so that the campaign can be executed. For example, a list export format might provide a list file for the following purposes:

  • Sending a list of customers and addresses to a direct mail vendor for printing and mailing
  • Distributing a call list to employees in a sales organization
  • Exporting the campaign list to another IT application

In addition to using in campaigns, you can define list export formats for a wide variety of uses. The only requirement is that the data be accessible by the Analytics Server.

If you are using the standard metadata from the Siebel Analytics Administration Tool for the Siebel Data Warehouse, the application provides examples of List Export formats in the following location in the Web Catalog:

Shared List Export Formats/Marketing/Example List Formats

To create a list export format and add columns

  1. Using one of the following methods, navigate to the List Designer start page:
    • In the Siebel Marketing application, from the Site Map, choose Administration - Marketing > List Formats.
    • If you log in to the Marketing module directly, you click the Marketing screen tab and then click Create a List Format.
  2. From the list of Subject Areas on the right, select a subject area that includes the columns you want for your export file.

    NOTE:  Be sure to determine whether you want to pull data from the Siebel transactional database, the Siebel Data Warehouse, or another data source, and then select the corresponding Subject Area.

  3. Expand the folders in the selection panel and click each column name to add it to the format.
  4. If you want to modify the displayed name for a column, in the Column Properties dialog box, use the Custom Headings option.
  5. Click the properties button on a column to apply custom formatting.

    For information about column formatting options, see List Format Column Properties and Formatting Options.

  6. Add any filters that you want to apply to the list format contents every time a list is generated.

    NOTE:  If the campaign membership already constrains the expected set of output records, this step is not required.

  7. If you plan to use this export format for campaign execution, add filters to constrain the output to a specific campaign wave or set of waves using system data expressions.
  8. Click the save icon in the upper-right corner of the screen and follow the instructions in the dialog box.

To add filters to constrain output to the correct campaign waves

  1. From the selection panel, add the column that corresponds to the Campaign Wave Id.
  2. Select the formula button to add a filter based on the column.
  3. In the Edit Filter dialog box, click Add and select System Data.
  4. In the System Data list, select the Wave Id expression.
  5. Click OK to add the filter.
  6. Click the delete button to remove the column from the output columns (unless you want to include the Wave Id as an included column).

    For information about adding system data expressions, see Adding a System Data Expression as a Column in a List Format.

  7. Click the save icon in the upper-right corner of the screen and follow the instructions in the dialog box.

To set options, headers, and footers for list export formats

  1. Click the Options tab and select the following options based on the results you want to achieve:
    Attribute
    Option

    Purpose

    List Export

    (choose format)

    Delimited File or Fixed Width

    End of Field Delimiter

    (any)

    Text Qualifier

    optional

    Include Column Headers

    optional

  2. If you want to set up a custom header or footer, click the Headers and Footers tab.
  3. Click in the Header Content or Footer Content workspace and add any text you want to include.
  4. If required, add any System Data expression, to the header or footer content.

    For more information, see Adding Marketing List Format Headers and Footers. For a list of system data expressions, see Adding a System Data Expression as a Column in a List Format.

  5. Test your list format by previewing some sample contents of the list format.

    To preview a list format, see Previewing a Marketing List Format.

  6. To combine data from multiple subject areas, click Combine with list from another Subject Area.

    For details, see Combining Lists From Different Subject Areas.

    NOTE:  You must apply column formatting to the combined results.

  7. Click the save icon in the upper-right corner of the screen and follow the instructions in the dialog box.

Defining Email Personalization (Email Server) Formats

An Email Personalization format (Email Server format) is used to export the members of an email campaign to the Siebel Email Marketing Server. The Email Personalization Format provides the columns that can be used as merge fields to personalize the email message sent to each recipient. You can find examples of email personalization formats in the following location:

Shared Email Server Formats/Marketing/Example List Formats

To define an email personalization (server) format

  1. Using one of the following methods, navigate to the List Designer start page:
    • In the Siebel Marketing application, from the Site Map, choose Administration - Marketing > List Formats.
    • If you log in to the Marketing module directly, click the Marketing screen tab and then click Create a List Format.
  2. From the list of Subject Areas on the right, select a subject area that includes the columns you want for your email server file.

    In most situations, the Subject Area corresponds to data pulled directly from the campaign history in the Siebel transactional database.

  3. Expand the folders in the selection panel and click each column name to add it to the format.
  4. Add the columns from the Subject Area that you want to be available as merge fields in the email template.
  5. Add the required columns.

    The following columns are required for all email server formats:

    • First Name
    • Last Name
    • Email Address
    • Camp Con Id
    • Contact Id
    • Prospect Id
    • Batch Number

      NOTE:  When you add the Batch Number column, you must include the column in the sort order and assign a split value. For more information, see Adding Columns to List Formats.

  6. Make sure that the displayed name of the column exactly matches the values in the list in Step 3.
    • If a Subject Area column that you select from the required columns list does not have a column label that exactly matches the name in the list, in the Column Properties dialog box, use Custom Headings option to modify the heading.
    • You can add additional columns as needed. If you need to modify the displayed name for a column, in the Column Properties dialog box, use Custom Headings option.
  7. Remove the table heading portion of the column header caption for all the columns.

    The Email Marketing Server expects each column header in the email file to contain the column header, not the table header caption. For each column in the format, use the following steps to remove the table heading portion of the column header caption:

    1. Select Column Properties on the column.
    2. In the Column Properties dialog, select the Custom Headings check box.
    3. Delete the value in the Table Heading field.
    4. Click OK.
  8. Click the properties button on a column to apply any custom formatting that you want for the column.

    For information about column formatting options, see List Format Column Properties and Formatting Options.

  9. Add a filter to constrain the output based on the runtime Campaign Wave by adding the system data expression (Wave Id) to the column formula in the following steps:
    1. Add the Wave Id column to the format.
    2. Click the filter button and add the Wave ID System Data Expression in the filter.

      For details about adding system data expression to a list format, see Adding a System Data Expression as a Column in a List Format.

    3. Click the delete button to delete the Wave ID from the displayed columns.
  10. If your email content needs to be filtered based on a secondary Qualified List Item, select the the following check box in the Filter section of the Columns view:

    Re-qualify list results against original segment criteria

  11. If necessary, click the Options tab and select the following options:
    Attribute
    Option

    Purpose

    Email Personalization

    (choose format)

    Delimited File

    End of Field Delimiter

    Comma

    Text Qualifier

    ""

  12. Test your list format by previewing some sample contents of the list format. To preview a list format, see Previewing a Marketing List Format.
  13. If you want to combine data from multiple subject areas, click Combine with list from another Subject Area.

    For details, see Combining Lists From Different Subject Areas.

    NOTE:  You must apply column formatting to the combined results.

  14. Click the save icon in the upper-right corner of the screen.

Defining Data Load or Customer Synchronization Formats

The Analytics data load format is used to import any type of data into the Siebel transactional database. The customer synchronization format is used to import a batch of new customers into the Siebel transactional database or to update a set of customer profiles. You can find examples of data load formats in the following location:

Shared Data Load Formats/Marketing/Example List Formats

Column Headings Must Match Field Names in Integration Components

If you use one of the standard subject areas provided for data load, the column names are already set to match the field names in the Integration Components in the Siebel enterprise application. If you want to load data that does not exist in these subject areas, you need to use other subject areas.

CAUTION:  Data Load and Customer Synchronization formats must have columns that exactly match the fields names of the Siebel integration components where the data is loaded.

If necessary, use Custom Headings in the Column Properties dialog box to rename any columns whose label does not exactly match the name of the integration component field name in the Siebel enterprise application.

For customer data (Contacts, Accounts, and Prospects), the standard application provides example subject areas that are already set up for Analytics Data Load. The standard application provides the following three subject areas that can be used for this purpose:

  • Campaign Load - Contacts
  • Campaign Load - Accounts
  • Campaign Load - Prospects
Preconfigured Integration Objects Used in Headers and Footers

The standard Siebel application provides the following preconfigured integration objects that you can use in headers and footers:

  • Analytics Account
  • Analytics Contact
  • Analytics Household

In the standard Siebel repository (SRF file), only certain fields from the extension tables in the business objects for Contacts, Accounts, and Households are enabled for update by default using the Analytics Data Load process. For example, in the Contacts business component, only the extension columns Attribute 49 through Attribute 64 are automatically set up for this purpose. If you need to update additional extension columns, confirm that all the business component fields are enabled for update through the corresponding Integration Component.

For more information about the available fields in the Analytics Data Load integration components, see Field Names for Marketing Integration Components.

To define data load or customer synchronization formats

  1. Using one of the following methods, navigate to the List Designer start page:
    • In the Siebel Marketing application, from the Site Map, choose Administration - Marketing > List Formats.
    • If you log in to the Marketing module directly, you click the Marketing screen tab and then click Create a List Format.
  2. From the list of Subject Areas on the right, select a subject area that includes columns you want to load into the Siebel enterprise application.
  3. Expand the folders in the selection panel and click each column name to add it to the format.
  4. Verify that you have included the required columns for the Siebel Business Component you want load. For more information about business components, see Configuring Siebel eBusiness Applications.
  5. If necessary, in the Column Properties dialog box, use Custom Headings option to rename any columns whose label does not exactly match the name of the integration component field name in the Siebel enterprise application. For more information, see Column Headings Must Match Field Names in Integration Components.

    CAUTION:  Data Load and Customer Synchronization formats must have columns that exactly match the fields names of the Siebel integration components where the data is loaded.

  6. Apply filters to constrain the data you want to load.

    For example, if you want to load contacts that have been added to the Data Warehouse since 01/01/2004, you could add a filter similar to the following:

    Contact Created Date is greater than 01/01/2004 12:00:00 AM

  7. Click the Options tab and select the following options:
    Attribute
    Option

    Purpose

    Analytics Data Load or Customer Synchronization

    (choose format)

    Delimited File

    End of Field Delimiter

    Comma

    Text Qualifier

    ""

    Max # Records

    1000

  8. Click the Headers and Footers tab.
  9. In the Headers and Footers field, type the integration object name that you want to load using the following format. See the following example:
    Format
    Example

    # integration object name

    #

    # Analytics Contact

    #

    CAUTION:  You should not add additional text or a system data expression to the header. Additionally, do not press enter at the end of the second line. For EAI formatting, there must not be an end-of-line character at the end of the header.

    For more information, see Preconfigured Integration Objects Used in Headers and Footers.

  10. Test your list format by previewing some sample contents of the list format. To preview a list format, see Previewing a Marketing List Format.
  11. If you want to combine data from multiple subject areas, see Combining Lists From Different Subject Areas.
  12. Click the save icon in the upper-right corner of the screen.

Adding Columns to List Formats

You select the columns in a subject area to include in a list format. The subject area for the request is listed in the selection pane with the tables and columns it contains.

After you have added a column, you can use the buttons on the column to modify the column formatting, add a formula, add a filter, or sort or split the contents.

CAUTION:  If you click the refresh button in the browser window before you finish creating a request, be aware that the browser reloads all frames and deletes your changes.

To add a column to the list format

  1. Using one of the following methods, navigate to the List Designer start page:
    • In the Siebel Marketing application, from the Site Map, choose Administration - Marketing > List Formats.
    • If you log in to the Marketing module directly, you click the Marketing screen tab and then click Create a List Format.
  2. Create a new list format or open an existing format.
  3. Click columns in the selection pane to add them to the list format definition.
  4. Use the column buttons shown in Table 10 to control the use of each column in the request.
Table 10.  List Format Button Descriptions
Button
Description

The order by button allows you to include a column in sort order and specifies the order in which results should be returned, ascending or descending. The button appears as gray (unavailable), up and down arrows if the column has not been added to the sort order. When a column is part of the sort order, the button changes to an up or a down arrow.

You can order results by more than one column. If you choose more than one column, the order sequence number appears on the order by button. To remove or change the sort order from a column, click the order by button until the sorting is changed or removed.

The properties button lets you edit various format properties for the column. For more information, see List Format Column Properties and Formatting Options.

The edit formula button lets you change the column heading, create a formula for the column (such as adding a Rank or Percentile function), or add a system data expression. For more information, see Adding Calculated Fields and System Fields to a List Format.

The add filter button lets you create or edit a filter for the column. For information about adding filters to a criteria block, see Siebel Analytics User Guide.

The split button allows you to split the contents of the file by unique values in that column. The split button is not available unless the column is part of the sort order. When the split is active, a separate file generates for each distinct value for that column in the results.

The delete button deletes the column from the request.

The action button opens a menu of available options.

To sort a list or split a list into multiple files

  1. Using one of the following methods, navigate to the List Designer start page:
    • In the Siebel Marketing application, from the Site Map, choose Administration - Marketing > List Formats.
    • If you log in to the Marketing module directly, click the Marketing screen tab and then click Create a List Format.
  2. Locate the column or columns by which you want to sort or split.
  3. Use the column buttons described in Table 10 to activate sorting or splitting.

Combining Lists From Different Subject Areas

You can use a List Format to combine two or more lists from different Subject Areas. For example, you can combine a set of customers from your data warehouse with a set of customers from your Siebel transactional database.

To combine data sets from multiple subject areas, you select a similar column set from each subject area. After you have combined two or more column sets, you can use standard set operators (Intersect, Union, Union All, and Minus) to determine the final result set.

Each column set from each subject area must have the same number of columns and the data types for corresponding columns must match.

To combine data sets across subject areas

  1. Using one of the following methods, navigate to the List Designer start page:
    • In the Siebel Marketing application, from the Site Map, choose Administration - Marketing > List Formats.
    • If you log in to the Marketing module directly, you click the Marketing screen tab and then click Create a List Format.
  2. Select a column set from your first subject area.
  3. Add filters to control the contents of the first data set.
  4. Click Combine with list from another Subject Area.
  5. Select the Subject Area for your second column set.
  6. After you have added all the columns for each column set, click the Combined Results link.
  7. Click the buttons on the columns in the Combined Results to control the formatting, sorting and splitting of the combined list.

Adding Calculated Fields and System Fields to a List Format

The column formula dialog box allows you to add a calculated column or a column based on a system data expression to the list format.

Calculated fields can be created using a wide variety of formulas based on other columns in subject area.

System Data are variables that can be added to a list format at run time. For example, if you are exporting a campaign file, you may want to include a column displaying the segment for each customer in the list. To do this, you add System Data for the Segment Name to the list format, and the system determines the correct segment for the file based on the campaign being executed. System Data can also be used for filtering the contents of the file based on the context of a campaign or other use.

Adding a System Data Expression as a Column in a List Format

If you want to automatically populate campaign contact columns with values that are determined by the list generation process at run time, you need to set up the Campaign Contact columns to use system data expressions.

If you use list export format for campaign execution, you can add columns to constrain the output using system data expressions.

If you want to add a filter to constrain the output based on the run-time campaign wave, add the system data expression wave ID.

To add a system data expression

  1. Using one of the following methods, navigate to the List Designer start page:
    • In the Siebel Marketing application, from the Site Map, choose Administration - Marketing > List Formats.
    • If you log in to the Marketing module directly, click the Marketing screen tab and then click Create a List Format.
  2. In the List Format Designer, select a column from the selection pane.
  3. Click the fx button.
  4. In the Edit column Formula dialog box, select the Custom Headings check box.
  5. Delete the text from the Column Formula workspace.
  6. Click the Available System Data link.
  7. In the System Data list, select a system data expression.

    For example, if you choose the Campaign Id expression, the following appears

    @{campaignID}{0}

    NOTE:  The value in the braces at the end of the expression is the default value for the expression. If you do not provide an input value for the list generation request, the default value is used.

  8. If you want the System Data Expression column displayed in the file, leave the column in the column set at the top of the page.
  9. If you want to filter the content but do not want the column to appear, perform the appropriate steps from the following list:
    • Add the column.
    • Apply the data expression to the Column Formula.
    • Delete the column from the column set by clicking the delete button on the column.

System Data Expressions Used in List Format Elements

Each list format element (Column formula, Headers/Footers, and Filters) can contain one or more system data expressions. Table 11 shows which system data expressions can be used in each list format element.

Table 11.  System Data Expressions Used in List Format Elements
System Data Expression
Column Formulas
(Y=Supported)
Filters
(Y=Supported)
Headers/Footers
(Y=Supported)

File Size in Bytes

 

 

Y

Record Count

 

 

Y

Current Date and Time

 

 

Y

Current User

 

 

Y

Bytes per Record

 

 

Y

Campaign Name

 

 

Y

Campaign Id

Y

Y

Y

Campaign Source Code

Y

Y

Y

Load Number

Y

Y

Y

Wave Id

Y

Y

Y

Segment Id

Y

Y

 

Qualifying Segment

Y

Y

 

Segment Tree Path

Y

Y

 

Segment Tree Node Path

Y

Y

 

Segment Path

Y

Y

 

Split Details

 

 

Y

Token Number

Y

Y

 

Email Batch Number

Y

Y

 

DNIS Number

Y

Y

Y

File Counter

 

 

Y

Offer Code

Y

Y

Y

Offer Name

Y

Y

Y

List Format Types and Valid System Data Expressions

All system data expressions cannot be used with every list format. Table 12 contains the list formats and shows which system data expressions can be used with each one.

Table 12.  List Format Types and Valid System Data Expressions
List Format Type
Valid System Data Expressions

Analytics Data Load

No System Data Expressions

Customer Sync

No System Data Expressions

Campaign Load

Campaign Id

Load Number

Token Number

Email Batch Number

Segment Id

List Export

Campaign Name

Campaign Id

Campaign Source Code

Wave Id

Offer Code

Offer Name

DNIS Number

Split Details

File Counter

Record Count

File Size in Bytes

Bytes Per Record

Current Data and Time

Current User

Campaign Name

Campaign Id

Campaign Source Code

Offer Code

Offer Name

DNIS Number

Campaign Id

Segment Id

Wave Id

Email Personalization

Campaign Name

Campaign Id

Campaign Source Code

Wave Id

Offer Code

Offer Name

DNIS Number

Split Details

File Counter

Record Count

File Size in Bytes

Bytes Per Record

Current Data and Time

Current User

Campaign Name

Campaign Id

Campaign Source Code

Offer Code

Offer Name

DNIS Number

Campaign Id

Segment Id

Wave Id

Siebel Marketing Installation and Administration Guide