Variable Element
X-Ref:
- Ast Variable Node
- Ast Variable Base Node
Attributes
| Attribute | API Type | Default | Description |
|---|---|---|---|
| DataType | TypeCode | Empty | This value specifies the type of the variable selected from the list of variable types supported by the system. This is a required property |
| 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 | |
| EvaluateAsExpression | Boolean | false | This value specifies whether the string value provided in the Value property and any subsequent value setting should be preprocessed before use. If true, the Value property will be treated as an expression using the SSIS expression syntax. |
| Id | Guid | 00000000-0000-0000-0000-000000000000 | Allows the developer to specify a unique identifier (GUID) for the variable. This can be used to retain a consistent ID between builds. |
| IncludeInDebugDump | IncludeInDebugDump | Automatic | This value specifies whether the value of this variable will be included in a debug dump. |
| InheritFromPackageParentConfigurationId | Guid | 00000000-0000-0000-0000-000000000000 | Allows the developer to specify a unique identifier (GUID) for the package configuration created from the InheritFromPackageParentConfigurationString property. This can be used to retain a consistent ID between builds. |
| InheritFromPackageParentConfigurationString | String | This value specifies configuration information necessary to map the specified parent package variable value onto this variable value. | |
| Namespace | String | "User" | This value specifies the namespace to use for the variable definition. A common choice is 'User'. |
| RaiseChangedEvent | Boolean | False | This value specifies whether an event will be raised that will cause registered event handlers to execute when the value of this variable changes. |
| ReadOnly | Boolean | False | This value specifies whether the initial variable value is read-only. |
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. |