Excel Add-In for Salesforce Marketing Cloud

Build 20.0.7695

DataExtension

Represents a data extension within an account.

Table-Specific Information

Select

The add-in uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The add-in processes other filters client-side within the add-in. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refer to other columns will cause an error.

For example, the following (but not only) queries are processed server side:

SELECT * FROM DataExtension

SELECT * FROM DataExtension WHERE CreatedDate > '2017/01/25'

Insert

You must specify the following fields when inserting to this table: Name, CustomerKey, and Fields.

Note: The Salesforce Marketing Cloud APIs have problems with DataExtensions with names longer than 40 characters. Try to limit the name to something relatively short.

INSERT INTO DataExtension (Name, CustomerKey,  Fields) VALUES('TestName', 'TestCustomerKey', 'fieldname1;fieldname2;fieldname3')

Update

You must specify the ObjectId or CustomerKey or Name in the WHERE clause when executing an update against this table.

UPDATE DataExtension SET ResetRetentionPeriodOnImport=true WHERE ObjectId='nzxcaslkjd-123'

Delete

You must specify the ObjectId or CustomerKey or Name in the WHERE clause when executing a delete against this table.

DELETE FROM DataExtension WHERE ObjectId = 'nzxcaslkjd-123'

Columns

Name Type ReadOnly Description
ObjectID [KEY] String False

System-controlled, text string identifier for object.

PartnerKey String False

Unique identifier provided by partner for an object, accessible only via API.

CustomerKey String False

User-supplied unique identifier for an object within an object type.

Name String False

Name of the object or property.

CreatedDate Datetime False

Date and time of the object's creation.

ModifiedDate Datetime False

Indicates the last time object information was modified.

Client_ID Int False

The Id of the client.

Description String False

Describes and provides information regarding the object.

IsSendable Bool False

Indicates whether you can use a data extension as part of an audience for a message send.

IsTestable Bool False

Indicates whether a sendable data extension can be used within tests sends for a message.

SendableDataExtensionField_Name String False

The name of the sendable data extension field.

SendableSubscriberField_Name String False

The name of the sendablesubscriber field.

Template_CustomerKey String False

User-supplied unique identifier for an object within an object type.

CategoryID Long False

Specifies the identifier of the folder.

Status String False

Defines status of the object.

IsPlatformObject Bool False

Indicated whether the object is a platform object.

DataRetentionPeriodLength Int False

Specifies the number of time units for which data will be retained.

DataRetentionPeriodUnitOfMeasure Int False

Specifies the units of time for which data will be retained.

RowBasedRetention Bool False

Indicates whether the data retention policy removes data by row or by entire data extension.

ResetRetentionPeriodOnImport Bool False

Indicates whether a data retention period should be reset after a successful import of new data.

DeleteAtEndOfRetentionPeriod Bool False

Indicates whether data should be deleted at the end of the retention period.

RetainUntil String False

Indicates the date that ends the retention period for a data extension.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
Fields String

A semi-colon separated list of names for the fields to add to this data entension.

Copyright (c) 2021 CData Software, Inc. - All rights reserved.
Build 20.0.7695