Package Element
X-Ref:
- Ast Package Node
- Ast Container Task Node
- Ast Container Task Base Node
- Ast Task Node
- Ast Scope Boundary Node
Attributes
| Attribute | API Type | Default | Description |
|---|---|---|---|
| Name | String | Specifies the name of the object. This name can be used to reference this object from anywhere else in the program. This is a required property | |
| 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. This references an existing definiton. | |
| AutoCreateConfigurationsType | ConfigurationType | None | This value specifies whether or not package configurations will be automatically created and where they will be stored. |
| 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. | |
| CheckpointUsage | CheckpointUsage | Never | 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. |
| ConstraintMode | ContainerConstraintMode | Parallel | 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. |
| CreationDate | DateTime | 1/1/0001 12:00:00 AM | 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. |
| 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. | |
| 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. | |
| DelayValidation | Boolean | false | 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. |
| Disabled | Boolean | false | This value specifies whether the item is disabled. The default value is False. |
| DisableEventHandlers | Boolean | false | This value specifies whether the event handlers for this task, container, or package should be prevented from executing. The default value is False. |
| DisablePackageConfigurations | Boolean | False | 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. |
| FailPackageOnFailure | Boolean | false | 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. |
| FailParentOnFailure | Boolean | false | This value determines whether the parent container will fail when a child container failes. The default value is False. |
| ForcedExecutionValue | String | "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. |
| ForcedExecutionValueDataType | TypeCode | Int32 | This property specifies the data type of the value stored in the ForceExecutionValue property. |
| ForceExecutionResult | ForceExecutionResult | None | 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. |
| ForceExecutionValue | Boolean | false | 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. |
| Id | Guid | 00000000-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. |
| IsolationLevel | IsolationLevel | Serializable | Sets the Isolation Level which controls how Transactions behave for this container. |
| Language | Language | Inherited | This specifies the default language to be used by this task and its descendants. |
| LoggingMode | LoggingMode | Inherit | This value specifies whether logging is enabled or disabled by the container or by the parent container. The default value is UseParentSetting. |
| LogicalDisplayFolder | String | string.Empty | Specifies a path that should be used for organizing the tree display of this object in the Logical View in BimlStudio. |
| MaxConcurrentExecutables | Int32 | -1 | This value specifies the maximum number of concurrently running threads a package is allowed to create. |
| MaxErrorCount | Int32 | 1 | This value specifies the maximum number of errors allowed to occur before a package is forced to stop running. The default value is 1. |
| 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. | |
| 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 | |
| Type | String | "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. |
| PriorityClass | PackagePriorityClass | Default | This value specifies a thread processing priority level for the package. |
| ProtectionLevel | ProtectionLevel | DontSaveSensitive | This value specifies the level of data protection for the package. |
| SaveCheckpoints | Boolean | false | This value specifies whether checkpoints are saved during package execution. The value must be set to True to enable a package to be restarted. |
| SsisPackageType | SsisPackageType | Default | This identifies the tool that created a package. |
| SsisVersionComments | String | This specifies the version comments for the package. | |
| SuppressConfigurationWarnings | Boolean | false | This value specifies whether warnings generated by configurations for this package are suppressed. |
| TransactionMode | ContainerTransactionMode | Join | This value specifies the transaction context in which this task will execute. |
| VersionBuild | Int32 | 0 | This value specifies the build number for the package. |
| VersionGuid | Guid | new Guid("9F80C91C-D671-4D1F-AB68-CFAE818FCB66") | Allows the developer to specify a unique version identifier (GUID) for the package. This can be used to retain a consistent VersionGUID between builds. |
| VersionMajor | Int32 | 0 | This value specifies the major version number for the package. |
| VersionMinor | Int32 | 0 | This value specifies the minor version number for the package. |
Singleton Children
| Child | API Type | Description |
|---|---|---|
| <PrecedenceConstraints /> | AstTaskflowPrecedenceConstraintsNode | The AstTaskflowPrecedenceConstraintsNode type corresponds directly to a precedence constraint in a SQL Server Integration Services task control flow. |
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. |
| <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. |
| <Parameters> <Parameter /> </Parameters> | AstParameterNode | Defines the collection of parameters for this package. |
| <RelatedFiles> <RelatedFile /> </RelatedFiles> | AstAttachedFileNode | This is a collection of attached file definitions for this package. |
| <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. |
| <Tasks> Multiple Choices... </Tasks> | AstTaskNode | Container for child task definitions. This is a container for child task definitions of this container or package. |
| <Variables> <Variable /> </Variables> | AstVariableNode | This is a container for variable definitions that are specific to this task, container, or package. |