---
schema_version: "1"
id: 22237ba2c1760ba88b4dfdba3c97cee8364f4afea72b85f627029598c55dd41f
title: DataStreamTemplate
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/api_meta/meta_datastreamtemplate.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_datastreamtemplate.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: a9bbf964522a8206a8b3ea3e828a50d64541aac18be276c6d255d10c85a15ce4
description: Represents the data stream that a user adds to a data kit.
---
# DataStreamTemplate

Represents the data stream that a user adds to a data kit.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm) 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.



 |
| fullRefreshIntervalDays | 

Field Type

FullRefreshIntervalDays (enumeration of type string)

Description

The interval when Data 360 performs a full refresh of the data stream. Available in API version 67.0 and later. Possible values are:

- NONE
- DAYS\_10
- DAYS\_25
- DAYS\_50





 |
| 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.

<DataStreamTemplate xmlns="http://soap.sforce.com/2006/04/metadata">
    <dataSourceBundleDefinition\>b2</dataSourceBundleDefinition\>
    <dataSourceObject\>sd3ds</dataSourceObject\>
    <masterLabel\>b2</masterLabel\>
    <objectCategory\>Profile</objectCategory\>
</DataStreamTemplate\>

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

 <types\>
        <members\>ssd3s</members\>
        <name\>DataStreamTemplate</name\>
    </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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).