DataStreamTemplate | Metadata API Developer Guide

Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations.

Important

Parent Type

This type extends the Metadata metadata type and inherits its fullName field.

File Suffix and Directory Location

DataStreamTemplate components have the suffix .dataStreamTemplate and are stored in the dataStreamTemplates folder.

Version

DataStreamTemplate components are available in API version 53.0 and later.

Special Access Rules

You need the Salesforce Customize Application permission to access this metadata type.

Fields

Field Name	Description
`dataConnectionSourceParameters`	Field Type DataConnectionParamTmpl[] Description Input representation for the data connection source parameters.
dataSourceBundleDefinition	Field Type string Description Required. Reference to the bundle to which this template belongs.
dataSourceObject	Field Type string Description Required. Reference to the Data Source Objects (DSOs). A DSO represents the object from where the data was sourced.
`filterCriteria`	Field Type string Description Filter applied to the data stream before the information is sent to Data Cloud.
masterLabel	Field Type string Description Required. Name assigned to the data stream template.
objectCategory	Field Type string Description Required. Category of the Data Model Object (DMO).
`refreshDayOfMonth`	Field Type int Description The duration of the day of the month after which the data stream must be refreshed.
`refreshDayOfWeek`	Field Type int Description The duration of the day of the week after which the data stream must be refreshed.
refreshFrequency	Field Type DataImportRefreshFrequency (enumeration of type string) Description The frequency with which the datastream must be refreshed. Possible values are: `Batch` `NONE` `MINUTES_15` `MINUTES_30` `MINUTES_5` `HOURLY` `DAILY` `WEEKLY` `MONTHLY` `NOT_APPLICABLE` `STREAMING` Possible values available in API version 64.0 and later are: EVERY_12_HOURS EVERY_4_HOURS
refreshHours	Field Type string Description The duration after which the datastream must be refreshed.
refreshMode	Field Type DataImportRefreshMode (enumeration of type string) Description The mode of refresh. Possible values are: `FULL_REFRESH` `UPSERT` `INCREMENTAL` `REPLACE` `NEAR_REAL_TIME_INCREMENTAL` `NOT_APPLICABLE` `PARTIAL_UPDATE` `STREAMING`
`refreshStartDate`	Field Type date Description The date to retrieve data based on the refresh frequency data. Available in API version 62.0 and later.
`sourceObjectName`	Field Type string Description The name of the source object from which data is streamed. Available in API version 62.0 and later.
`streamType`	Field Type StreamType (enumeration of type string) Description The type of data stream. Available in API version 62.0 and later. Possible values are: `DIRECT_ACCESS` `DIRECT_ACCESS_ACCELERATED` `INGEST`
`streamingAppDataConnectorType`	Field Type streamingAppDataConnectorType (enumeration of type string) Description The connector app for data streaming. Available in API version 63.0 and later. Possible values are: `MobileApp` `WebApp`
`templateVersion`	Field Type int Description The version number of the template. Available in API version 62.0 and later.

Declarative Metadata Sample Definition

The following is an example of a DataStreamTemplate component.

1<DataStreamTemplate xmlns="http://soap.sforce.com/2006/04/metadata">
2    <dataSourceBundleDefinition>b2</dataSourceBundleDefinition>
3    <dataSourceObject>sd3ds</dataSourceObject>
4    <masterLabel>b2</masterLabel>
5    <objectCategory>Profile</objectCategory>
6</DataStreamTemplate>

The following is an example package.xml that references the previous definition.

1<types>
2        <members>ssd3s</members>
3        <name>DataStreamTemplate</name>
4    </types>

Wildcard Support in the Manifest File

This metadata type doesn’t support the wildcard character * (asterisk) in the package.xml manifest file. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.