Marketing activity input file definitions

Use a MarketingActivity.csv input file to load information to create marketing activities in a store. After you load the data, business users can manage the new activities with the Marketing tool.

You can extract marketing activity objects with the Data Extract utility to create a MarketingActivity.csv input file that you can then load with the Data Load utility. For example, if you want to copy or move activities between stores or instances, such as for creating one or more test environments. Sample configuration files are provided for you to use with the Data Extract utility to extract the activity data from the DMACTIVITY database table. The SQL that the Data Extract utility uses to extract activities extracts data for only the activities that have the type 'WEB', 'DIALOG', 'EMAIL', and 'SEARCH'.

Sample configuration files are also provided for you to use with the Data Load utility to load the campaign data. When you load the MarketingActivity.csv file, the Data Load utility populates the DMACTIVITY database table.

For more information about extracting and loading marketing data, see

Depending on how your activities are structured, you might need to load additional information. For example, if you want to include activities within marketing campaigns, you must load data to create the campaigns. For more information about the marketing activity-related data that you can load, see:

Definitions

activityName

(Required, String) The activity name.

This column or element maps to DMACTIVITY.NAME.

description

(String) The description of the marketing activity.

This column or element maps to DMACTIVITY.DESCRIPTION.

activityType

(String) The activity type. You can set the following values for this column or element:

0: The activity is a web activity. This value is the default value.
1: The activity is a dialog activity.
2: The activity is an email activity.
3: The activity is used for search rules.
5: The activity is used for page layouts.

This column or element maps to DMACTTYPE.TYPE.

startDate

(String) The timestamp for the scheduled start of the activity. If the start time is null, then the marketing activity can start immediately.

This column or element maps to DMACTIVITY.STARTDATE.

endDate

(String) The timestamp for the scheduled end of the activity. If the end time is null, then the marketing activity runs indefinitely.

This column or element maps to DMACTIVITY.ENDDATE.

version

(Integer) The current version number of the marketing activity. If changes are made to the content of the marketing activity, then the version number is incremented. The default value is 1.

This column or element maps to DMACTIVITY.VERSION.

published

(Integer) The published version number of the marketing activity. This version is the version that is running on the storefront. The default value is 0.

This column or element maps to DMACTIVITY.PUBLISHED.

state

(Integer) The current state of the marketing activity. You can set one of the following values for this column or element:

0: The activity is inactive. This value is the default value.
1: The activity is active.

This column or element maps to DMACTIVITY.STATE.

priority

(Integer) The priority of the marketing activity. The default value is 0.

This column or element maps to DMACTIVITY.PRIORITY.

repeatable

(Integer) Indicates whether the activity is repeatable by customers.

This column or element maps to DMACTIVITY.REPEATABLE.

MarketingSpotBehavior

(Integer) Indicates whether the activity displays the same results to all customers or displays different results. The associated e-Marketing Spot can use this setting to determine how to cache the e-Marketing Spot results. You can set one of the following values for this column or element:

0: The activity displays the same results to all customers.
1: The activity is dynamic and can display different results to customers.

This column or element maps to DMACTIVITY.BEHAVIOR.

uiDisplayable

(Integer) Indicates whether the activity displays in Management Center. You can set one of the following values for this column or element:

1 or null: The activity displays in Management Center.
0: The activity does not display in Management Center.

This column or element maps to DMACTIVITY.UIDISPLAYABLE.

managingTool

(Integer) Indicates the Management Center tool that is used to manage the activity. You can set one of the following values for this column or element:

0 or null: The activity is managed with the Marketing tool.
1: The activity is managed with the Commerce Composer tool.

This column or element maps to DMACTIVITY.MANAGINGTOOL.

templateType

(String) The type of the marketing activity template.

This column or element maps to DMTEMPLATETYPE.TYPE.

experimentType

(String) The type of the marketing activity experiment.

This column or element maps to DMEXPTYPE.TYPE.

campaignName

(String) The name of the marketing campaign.

This column or element maps to DMCAMPAIGN.NAME.

familyActivityName

(String) The ID of the activity, which is the first activity from a set of activity versions. All versions of the same activity have the same name and family ID, but the sequence numbers are different. This ID resolves to the activity name from the DMACTIVITY database table.

This column or element maps to DMEXPFAMILY.FAMILY_ID.

activitySequence

(Integer) The sequence number of the activity.

This column or element maps to DMEXPFAMILY.SEQUENCE.

delete

(String) Indicates whether to delete the record. Specify 1 to delete the record.

Note: If you want to delete all of the database records that match the records in a file, you can run the Data Load utility in delete mode. For more information, see Configuring the data load order.