Biml Language Reference
DataflowTask Element
The AstEtlRootNode type corresponds directly to a SQL Server Integration Services dataflow task.
Attributes
  Attribute API Type Default Description
AutoAdjustBufferSize Boolean
This value specifies whether the size of the dataflow pipeline buffer should be set manually using the DefaultBufferSize property or if the buffer size should be automatically calculated based on the DefaultBufferMaxRows property and size of each row.

[.NET API Property: AutoAdjustBufferSize]

BLOBTempStoragePath String
This value specifies the location for temporary storage of binary large objects. These objects will by default include at least the contents of the TMP and TEMP environment variables.

[.NET API Property: BlobTempStoragePath]

BufferTempStoragePath String
This value specifies the location for temporary storage of buffer data.

[.NET API Property: BufferTempStoragePath]

DefaultBufferMaxRows Int32
This value specifies the number of rows that will be stored in the row buffer being processed by the dataflow task. The default value is 10,000 rows.

[.NET API Property: DefaultBufferMaxRows]

DefaultBufferSize Int32
This value specifies the size of the buffer that will be used to store rows being processed by the dataflow task. The default value is 10 megabytes. This value may not exceed 100 megabytes.

[.NET API Property: DefaultBufferSize]

DelayValidation Boolean
This value specifies whether the validation of the Dataflow task in SSIS should be delayed until the package is executed. DelayValidation is most often used when the ETL process references tables and other server assets that were created in an earlier stage of the data processing run.

[.NET API Property: DelayValidation]

Disabled Boolean
This value specifies whether the item is disabled. The default value is False.

[.NET API Property: Disabled]

DisableEventHandlers Boolean
This value specifies whether the event handlers for this task, container, or package should be prevented from executing. The default value is False.

[.NET API Property: DisableEventHandlers]

EngineThreads Int32
This value specifies how many threads can be used during execution. The default value is 10. This value may not be set lower than 3. Note that SSIS will only use as many threads as it determines it can use, even if this property is specified to be a higher number. Also note that in some circumstances, SSIS may use more threads than specified, if necessary.

[.NET API Property: EngineThreads]

ExecutionValueVariableName AstVariableBaseNode
Specifies a variable to hold the execution results of this component.

[.NET API Property: ExecutionValueVariable]

FailPackageOnFailure Boolean
This value determines whether the container will fail when a container component fails. If this container corresponds to a package, then the only valid value is False.

[.NET API Property: FailPackageOnFailure]

FailParentOnFailure Boolean
This value determines whether the parent container will fail when a child container failes. The default value is False.

[.NET API Property: FailParentOnFailure]

ForcedExecutionValue String
If the ForceExecutionValue property is set to True, then the container will return the value stored in this property as its execution value. Otherwise, this value will be ignored. The default value for ForecedExecutionValue is 0.

[.NET API Property: ForcedExecutionValue]

ForcedExecutionValueDataType TypeCode
This property specifies the data type of the value stored in the ForceExecutionValue property.

[.NET API Property: ForcedExecutionValueDataType]

ForceExecutionResult ForceExecutionResult
This value indicates whether a specified execution result value will result if the container runs. The default value is None, which means that the container does not force a specified outcome.

[.NET API Property: ForceExecutionResult]

ForceExecutionValue Boolean
Gets or sets a Boolean that indicates whether the execution value of the container should be forced to contain the value specified in the ForcedExecutionValue property.

[.NET API Property: ForceExecutionValue]

Id Guid
Allows the developer to specify a unique identifier (GUID) for the package. This can be used to retain a consistent ID between builds.

[.NET API Property: Id]

IsolationLevel IsolationLevel
Sets the Isolation Level which controls how Transactions behave for this container.

[.NET API Property: IsolationLevel]

Language Language
This specifies the default language to be used by this task and its descendants.

[.NET API Property: Language]

LoggingMode LoggingMode
This value specifies whether logging is enabled or disabled by the container or by the parent container. The default value is UseParentSetting.

[.NET API Property: LoggingMode]

MaxErrorCount Int32
This value specifies the maximum number of errors allowed to occur before a package is forced to stop running. The default value is 1.

[.NET API Property: MaximumErrorCount]

Name String
Specifies the name of the object. This name can be used to reference this object from anywhere else in the program.

[.NET API Property: Name]

RunInOptimizedMode Boolean
This value specifies whether the task runs in optimized mode, meaning that unused columns, outputs, and components are removed from the data flow to improve performance. The default value is true.

[.NET API Property: RunInOptimizedMode]

TransactionMode ContainerTransactionMode
This value specifies the transaction context in which this task will execute.

[.NET API Property: TransactionMode]

Singleton Children
  Child API Type Description
<PrecedenceConstraints /> AstTaskflowPrecedenceConstraintsNode
This is a container for task precedence constraint definitions.

[.NET API Property: PrecedenceConstraints]

<SsisAnnotation /> AstSsisAnnotationNode
This is a collection of SSIS annotations that will be rendered on the SSIS design surface within the parent dataflow object.

[.NET API Property: SsisAnnotations]

Collection Children
  Child API Type Description
<Annotations>
    <Annotation />
</Annotations>
AstAnnotationNode
This is a collection of annotation items that can be used to specify documentation, tags, or other information. Annotations are particularly useful for storing information about nodes that can be used by BimlScript code.

[.NET API Property: Annotations]

<LogProviders>
    Multiple Choices...
</LogProviders>
AstLogProviderBaseNode
Defines the log providers to use for the SSIS task or container

[.NET API Property: LogProviders]

<Events>
    <Event />
</Events>
AstTaskEventHandlerNode
This is a collection of event handlers that can respond to SQL Server Integration Services events that are raised on this task.

[.NET API Property: Events]

<Expressions>
    <Expression />
</Expressions>
AstPropertyExpressionNode
This is a collection of SSIS expression definitions for property value overrides that are specific to this task, container, or package.

[.NET API Property: Expressions]

<LogEvents>
    <LogEvent />
</LogEvents>
AstLogEventNode
This is a container for log event definitions that are specific to this task, container, or package.

[.NET API Property: LogEvents]

<Transformations>
    Multiple Choices...
</Transformations>
AstTransformationNode
Container for child dataflow transformations definitions.

[.NET API Property: Transformations]

<Variables>
    <Variable />
</Variables>
AstVariableNode
This is a container for variable definitions that are specific to this task, container, or package.

[.NET API Property: Variables]