DataStreamTemplate

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

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 Metadata and inherits its fields.

File Suffix and Directory Location 

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

Version 

Introduced in API version 53.0.

Special Access Rules 

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

Fields 

dataConnectionSourceParameters 

dataSourceBundleDefinition 

  • Type: string
  • Required: Yes
  • Description: Required. Reference to the bundle to which this template belongs.

dataSourceObject 

  • Type: string
  • Required: Yes
  • Description: Required. Reference to the Data Source Objects (DSOs). A DSO represents the object from where the data was sourced.

filterCriteria 

  • Type: string
  • Required: No

fullRefreshIntervalDays 

  • Type: FullRefreshIntervalDays (enumeration of type string)
  • Required: No
  • Introduced: API version 67.0
  • Description: The interval when Data 360 performs a full refresh of the data stream. Possible values are:

masterLabel 

  • Type: string
  • Required: Yes
  • Description: Required. Name assigned to the data stream template.

objectCategory 

  • Type: string
  • Required: Yes
  • Description: Required. Category of the Data Model Object (DMO).

refreshDayOfMonth 

  • Type: int
  • Required: No

refreshDayOfWeek 

  • Type: int
  • Required: No

refreshFrequency 

  • Type: DataImportRefreshFrequency (enumeration of type string)

  • Required: No

  • Description: The frequency with which the datastream must be refreshed. Possible values available in API version 64.0 and later are:

    • EVERY_12_HOURS
    • EVERY_4_HOURS
  • Possible values:

    • Batch
    • NONE
    • MINUTES_15
    • MINUTES_30
    • MINUTES_5
    • HOURLY
    • DAILY
    • WEEKLY
    • MONTHLY
    • NOT_APPLICABLE
    • STREAMING

refreshHours 

  • Type: string
  • Required: No
  • Description: The duration after which the datastream must be refreshed.

refreshMode 

  • Type: DataImportRefreshMode (enumeration of type string)
  • Required: No
  • Description: The mode of refresh.
  • Possible values:
    • FULL_REFRESH
    • UPSERT
    • INCREMENTAL
    • REPLACE
    • NEAR_REAL_TIME_INCREMENTAL
    • NOT_APPLICABLE
    • PARTIAL_UPDATE
    • STREAMING

refreshStartDate 

  • Type: date
  • Required: No

sourceObjectName 

  • Type: string
  • Required: No

streamingAppDataConnectorType 

  • Type: StreamingAppDataConnectorType (enumeration of type string)
  • Required: No

streamType 

  • Type: StreamType (enumeration of type string)
  • Required: No

templateVersion 

  • Type: int
  • Required: No

DataConnectionParamTmpl Type 

Parent Type 

This type extends Metadata and inherits its fields.

Fields 

paramName 

  • Type: string
  • Required: Yes

value 

  • Type: string
  • Required: Yes

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.