Biml Language Reference
Package Element
The AstPackageNode type corresponds directly to a SQL Server Integration Services package.
Attributes
  Attribute API Type Default Description
AutoCreateConfigurationsTableName AstTableNode
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.

[.NET API Property: AutoCreateConfigurationsTable]

AutoCreateConfigurationsType ConfigurationType
This value specifies whether or not package configurations will be automatically created and where they will be stored.

[.NET API Property: AutoCreateConfigurationsType]

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

[.NET API Property: CheckpointFileName]

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

[.NET API Property: CheckpointUsage]

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

[.NET API Property: ConstraintMode]

CreationDate DateTime
Specifies the date when the package was created. If this value is not specified, the current date at the time of build will be used.

[.NET API Property: CreationDate]

CreatorComputerName String
Specifies the name of the computer that was used to create this package. If this value is not specified, the computer name from the system environment will be used.

[.NET API Property: CreatorComputerName]

CreatorName String
Specifies the username of the person that created this package. If this value is not specified, the username from the system environment will be used.

[.NET API Property: CreatorName]

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]

DisablePackageConfigurations Boolean
Specifies whether package configurations should be disabled in the generated package. By default, configurations are enabled automatically when package configurations are defined. This property can be used to override that default behavior.

[.NET API Property: DisablePackageConfigurations]

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]

LogicalDisplayFolder String
Specifies a path that should be used for organizing the tree display of this object in the Logical View in BimlStudio.

[.NET API Property: LogicalDisplayFolder]

MaxConcurrentExecutables Int32
This value specifies the maximum number of concurrently running threads a package is allowed to create.

[.NET API Property: MaxConcurrentExecutables]

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]

PackagePassword String
Specifies the password to use when using password-based encryption. This value is only used when the package ProtectionLevel is set to EncryptAllWithPassword or EncryptSensitiveWithPassword. If a global password value is specified for SSIS encryption, this property will override that value.

[.NET API Property: PackagePassword]

PackageSubpath String
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\<PackageSubpath>\PackageName.dtsx

[.NET API Property: PackageSubpath]

PriorityClass PackagePriorityClass
This value specifies a thread processing priority level for the package.

[.NET API Property: PriorityClass]

ProtectionLevel ProtectionLevel
This value specifies the level of data protection for the package.

[.NET API Property: ProtectionLevel]

SaveCheckpoints Boolean
This value specifies whether checkpoints are saved during package execution. The value must be set to True to enable a package to be restarted.

[.NET API Property: SaveCheckpoints]

SsisPackageType SsisPackageType
This identifies the tool that created a package.

[.NET API Property: SsisPackageType]

SsisVersionComments String
This specifies the version comments for the package.

[.NET API Property: SsisVersionComments]

SuppressConfigurationWarnings Boolean
This value specifies whether warnings generated by configurations for this package are suppressed.

[.NET API Property: SuppressConfigurationWarnings]

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

[.NET API Property: TransactionMode]

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

[.NET API Property: PackageType]

VersionBuild Int32
This value specifies the build number for the package.

[.NET API Property: VersionBuild]

VersionMajor Int32
This value specifies the major version number for the package.

[.NET API Property: VersionMajor]

VersionMinor Int32
This value specifies the minor version number for the package.

[.NET API Property: VersionMinor]

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

[.NET API Property: PrecedenceConstraints]

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]

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

[.NET API Property: Connections]

<Tasks>
    Multiple Choices...
</Tasks>
AstTaskNode
Container for child task definitions.

[.NET API Property: Tasks]

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

<PackageConfigurations>
    <PackageConfiguration />
</PackageConfigurations>
AstPackageConfigurationNode
This is a collection of package configuration definitions.

[.NET API Property: PackageConfigurations]

<Parameters>
    <Parameter />
</Parameters>
AstParameterNode
Defines the collection of parameters for this package.

[.NET API Property: Parameters]

<RelatedFiles>
    <RelatedFile />
</RelatedFiles>
AstAttachedFileNode
This is a collection of attached file definitions for this package.

[.NET API Property: RelatedFiles]

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

[.NET API Property: SsisAnnotations]

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

[.NET API Property: Variables]