Varigence, Inc.

Expand Minimize
BIML Language Reference
Package Element
The AstPackageNode type corresponds directly to a SQL Server Integration Services package.
Attributes
 AttributeAPI TypeDefaultDescription
ConstraintModeContainerConstraintModeLinear
This value specifies the mode that should be used to execute the children of the container or package. Parallel directly matches the SSIS behavior and will require that precedence constraints are created manually for all task connections. Linear will automatically create precedence constraints so that tasks will run one after the other in the order that they are specified in the Biml. Linear is primarily useful for scripting scenarios where creating precedence constraints would be tedious.
NameString 
Specifies the name of the object. This name can be used to reference this object from anywhere else in the program.
AutoCreateConfigurationsTableNameAstTableNode 
This value specifies a direct reference to the table that will be used to store automatically created package configurations in the event that the AutoCreateConfigurationType property is set to Sql.
AutoCreateConfigurationsTypeConfigurationTypeXml
This value specifies whether or not package configurations will be automatically created and where they will be stored.
CheckpointFileNameString 
This value specifies the path to the file in which checkpoint information is saved. Checkpoint information can be used to restart a package if it fails.
CheckpointUsageCheckpointUsageNever
This value specifies whether a package can be restarted and how the checkpoint file is used. The default value is Never, which means that the package cannot be restarted.
DelayValidationBooleanfalse
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.
DisabledBooleanfalse
This value specifies whether the package is disabled. The default value is False.
DisableEventHandlersBooleanfalse
This value specifies whether the event handlers for this task, container, or package should be prevented from executing. The default value is False.
FailPackageOnFailureBooleanfalse
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.
FailParentOnFailureBooleanfalse
This value determines whether the parent container will fail when a child container failes. The default value is False.
ForcedExecutionValueString"0"
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.
ForcedExecutionValueDataTypeTypeCodeInt32
This property specifies the data type of the value stored in the ForceExecutionValue property.
ForceExecutionResultForceExecutionResultNone
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.
ForceExecutionValueBooleanfalse
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.
IdGuid00000000-0000-0000-0000-000000000000
Allows the developer to specify a unique identifier (GUID) for the package. This can be used to retain a consistent ID between builds.
IsolationLevelIsolationLevelSerializable
Sets the Isolation Level which controls how Transactions behave for this container.
LanguageLanguageInherited
This specifies the default language to be used by this task and its descendants.
LoggingModeLoggingModeInherit
This value specifies whether logging is enabled or disabled by the container or by the parent container. The default value is UseParentSetting.
MaxConcurrentExecutablesInt32-1
This value specifies the maximum number of concurrently running threads a package is allowed to create.
MaxErrorCountInt321
This value specifies the maximum number of errors allowed to occur before a package is forced to stop running. The default value is 1.
PackageSubpathString 
This specifies a file path fragment to use for emitting output files for this package. It is most commonly employed to ensure that the output files for multiple packages will be placed into the same output directory. PackageSubpath will override the default package location behavior. Packages will no longer be emitted under OutputDirectory\Type\PackageName.dtsx but instead OutputDirectory\\PackageName.dtsx
TypeString"ETL"
This is a tag for the type or use of this package. It is used for documentation and to determine the folder into which to place generated output files.
PriorityClassPackagePriorityClassDefault
This value specifies a thread processing priority level for the package.
ProtectionLevelProtectionLevelDontSaveSensitive
This value specifies the level of data protection for the package.
SaveCheckpointsBooleanfalse
This value specifies whether checkpoints are saved during package execution. The value must be set to True to enable a package to be restarted.
SuppressConfigurationWarningsBooleanfalse
This value specifies whether warnings generated by configurations for this package are suppressed.
TransactionModeContainerTransactionModeJoin
This value specifies the transaction context in which this task will execute.
Singleton Children
 ChildAPI TypeDescription
<PrecedenceConstraints />AstTaskflowPrecedenceConstraintsNodeThe AstTaskflowPrecedenceConstraintsNode type corresponds directly to a precedence constraint in a SQL Server Integration Services task control flow.
Collection Children
 ChildAPI TypeDescription
<Tasks>
    Multiple Choices...
</Tasks>
AstTaskNode
Container for child task definitions.
This is a container for child task definitions of this container or package.
<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.
<Connections>
    <Connection />
</Connections>
AstConnectionReferenceNode
This is a collection of references to connection definitions. It is the equivalent of the collection of connection managers in SSIS.
<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.
<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.
<LogEvents>
    <LogEvent />
</LogEvents>
AstLogEventNode
This is a container for log event definitions that are specific to this task, container, or package.
<LogProviders>
    Multiple Choices...
</LogProviders>
AstLogProviderBaseNode
Defines the log providers to use for the SSIS task or container
This is a container for log provider definitions that are specific to this task, container, or package.
<PackageConfigurations>
    <PackageConfiguration />
</PackageConfigurations>
AstPackageConfigurationNode
This is a collection of package configuration definitions.
<RelatedFiles>
    <RelatedFile />
</RelatedFiles>
AstAttachedFileNode
This is a collection of attached file definitions for this package.
<Variables>
    <Variable />
</Variables>
AstVariableNode
This is a container for variable definitions that are specific to this task, container, or package.