Biml API Reference
AstCustomExtensionContainerTaskNode Type
BimlStudio 2017

Custom tasks to run additional code or scripts during the creation of a Table, Dimension, or Fact.
Inheritance Hierarchy
Assembly:
Biml (in Biml.dll)
Properties
  Name Summary
Annotations
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.
(Inherited from AstNode)
BimlFile
This value specifies the BimlFile in which the Biml code that defines AstNode resides.
(Inherited from AstNode)
CanAutoLayoutMoveSinkAnchors
Gets a value to indicate whether autolayout is permitted to rearrange sink anchors on the design surface to reduce edge overlapping
(Inherited from AstTaskNode)
CanAutoLayoutMoveSourceAnchors
Gets a value to indicate whether autolayout is permitted to rearrange source anchors on the design surface to reduce edge overlapping
(Inherited from AstTaskNode)
ConstraintMode
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.
(Inherited from AstContainerTaskBaseNode)
ConstraintModeDefaultValue
Gets the default value for the ConstraintMode property
(Inherited from AstContainerTaskBaseNode)
ContainerTasks
Gets a collection of all child tasks of this container that are themselves either container tasks or dataflow tasks
(Inherited from AstContainerTaskBaseNode)
DelayValidation
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.
(Inherited from AstTaskNode)
DelayValidationDefaultValue
Gets the default value for the DelayValidation property
(Inherited from AstTaskNode)
Disabled
This value specifies whether the item is disabled. The default value is False.
(Inherited from AstTaskNode)
DisabledDefaultValue
Gets the default value for the Disabled property
(Inherited from AstTaskNode)
DisableEventHandlers
This value specifies whether the event handlers for this task, container, or package should be prevented from executing. The default value is False.
(Inherited from AstTaskNode)
DisableEventHandlersDefaultValue
Gets the default value for the DisableEventHandlers property
(Inherited from AstTaskNode)
Error
Gets the error string for this node, if any
(Inherited from AstNode)
ErrorCount
Gets the count of error diagnostics that have been generated for this node
(Inherited from AstNode)
Events
This is a collection of event handlers that can respond to SQL Server Integration Services events that are raised on this task.
(Inherited from AstTaskNode)
ExpressionProperties
This collection holds properties that can be referenced by expressions. It's not necessarily the same properties that are available directly on the object. These AstPropertyNodes are here to support binding, not to be confused with the Properties collection on the generic control flow base object, which has "real" AstPropertyNodes.
(Inherited from AstTaskNode)
Expressions
This is a collection of SSIS expression definitions for property value overrides that are specific to this task, container, or package.
(Inherited from AstTaskNode)
FailPackageOnFailure
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.
(Inherited from AstTaskNode)
FailPackageOnFailureDefaultValue
Gets the default value for the FailPackageOnFailure property
(Inherited from AstTaskNode)
FailParentOnFailure
This value determines whether the parent container will fail when a child container failes. The default value is False.
(Inherited from AstTaskNode)
FailParentOnFailureDefaultValue
Gets the default value for the FailParentOnFailure property
(Inherited from AstTaskNode)
FlowFile
This value specifies the containing code file of this node for Xml Binding purposes.
(Inherited from AstNode)
ForcedExecutionValue
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.
(Inherited from AstTaskNode)
ForcedExecutionValueDataType
This property specifies the data type of the value stored in the ForceExecutionValue property.
(Inherited from AstTaskNode)
ForcedExecutionValueDefaultValue
Gets the default value for the ForcedExecutionValue property
(Inherited from AstTaskNode)
ForceDisableIncrementalChangeTracking
This value specifies whether changes to property values of this node should be automatically reflected in the corresponding Biml code. Its primary use is for temporary nodes that will never be persisted into BimlFiles.
(Inherited from AstNode)
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.
(Inherited from AstTaskNode)
ForceExecutionResultDefaultValue
Gets the default value for the ForceExecutionResult property
(Inherited from AstTaskNode)
ForceExecutionValue
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.
(Inherited from AstTaskNode)
ForceExecutionValueDefaultValue
Gets the default value for the ForceExecutionValue property
(Inherited from AstTaskNode)
FriendlyTypeName
Gets the friendly name of the type of this node
(Inherited from AstNode)
FriendlyTypeName
Gets the friendly name of the type of this node
(Inherited from AstNamedNode)
FriendlyTypeName
Gets the friendly name of the type of this node
(Inherited from AstScopeBoundaryNode)
FriendlyTypeName
Gets the friendly name of the type of this node
(Inherited from AstTaskNode)
FriendlyTypeName
Gets the friendly name of the type of this node
(Inherited from AstContainerTaskBaseNode)
FriendlyTypeName
Gets the friendly name of the type of this node
(Inherited from AstContainerTaskNode)
FriendlyTypeName
Gets the friendly name of the type of this node
FriendlyTypeNameStatic
Gets the friendly name of the type of this node
(Inherited from AstNode)
FriendlyTypeNameStatic
Gets the friendly name of the type of this node
(Inherited from AstNamedNode)
FriendlyTypeNameStatic
Gets the friendly name of the type of this node
(Inherited from AstScopeBoundaryNode)
FriendlyTypeNameStatic
Gets the friendly name of the type of this node
(Inherited from AstTaskNode)
FriendlyTypeNameStatic
Gets the friendly name of the type of this node
(Inherited from AstContainerTaskBaseNode)
FriendlyTypeNameStatic
Gets the friendly name of the type of this node
(Inherited from AstContainerTaskNode)
FriendlyTypeNameStatic
Gets the friendly name of the type of this node
Id
Allows the developer to specify a unique identifier (GUID) for the package. This can be used to retain a consistent ID between builds.
(Inherited from AstTaskNode)
IdDefaultValue
Gets the default value for the Id property
(Inherited from AstTaskNode)
ImportedScopeChildren
Gets this ScopeBoundary's referenceable items. This is used to notify the children items when this item's ScopedName changes.
(Inherited from AstScopeBoundaryNode)
IsAstNodeReadOnly
Gets a value indicating whether this node is currently in a read-only state
(Inherited from AstNode)
IsInBrokenLiveBimlScript
Specifies whether or not this object is part of a live BimlScript containing an error, which means that this is a cached object that may be out-of-date
(Inherited from AstNode)
IsolationLevel
Sets the Isolation Level which controls how Transactions behave for this container.
(Inherited from AstTaskNode)
IsolationLevelDefaultValue
Gets the default value for the IsolationLevel property
(Inherited from AstTaskNode)
ItemLabel
Gets a label that can be used to identify this node
(Inherited from AstNode)
Language
This specifies the default language to be used by this task and its descendants.
(Inherited from AstTaskNode)
LanguageDefaultValue
Gets the default value for the Language property
(Inherited from AstTaskNode)
LogEvents
This is a container for log event definitions that are specific to this task, container, or package.
(Inherited from AstTaskNode)
LoggingMode
This value specifies whether logging is enabled or disabled by the container or by the parent container. The default value is UseParentSetting.
(Inherited from AstTaskNode)
LoggingModeDefaultValue
Gets the default value for the LoggingMode property
(Inherited from AstTaskNode)
LogProviders
Defines the log providers to use for the SSIS task or container
(Inherited from AstTaskNode)
MaximumErrorCount
This value specifies the maximum number of errors allowed to occur before a package is forced to stop running. The default value is 1.
(Inherited from AstTaskNode)
MaximumErrorCountDefaultValue
Gets the default value for the MaximumErrorCount property
(Inherited from AstTaskNode)
MessageCount
Gets the count of message diagnostics that have been generated for this node
(Inherited from AstNode)
Name
Specifies the name of the object. This name can be used to reference this object from anywhere else in the program.
(Inherited from AstNamedNode)
NameDefaultValue
Gets the default value for the Name property
(Inherited from AstNamedNode)
ObjectTag
This property provides a general purpose storage mechanism for .NET objects to be associated with AstNode objects. It supplements the annotation system, which is intended for use with string-based metadata.
(Inherited from AstNode)
OutputPath
Gets a default OutputPath that all subsequent nodes will connect to, if they choose to create a precendence constraint
(Inherited from AstTaskNode)
ParentItem
This value specifies the parent of the current node. All nodes must have a valid parent in the Biml framework, except for the root node.
(Inherited from AstNode)
ParentXObjectMappingProvider
This value specifies the parent of the current node for Xml Binding purposes.
(Inherited from AstNode)
PrecedenceConstraints
This is a container for task precedence constraint definitions.
(Inherited from AstTaskNode)
PropertyChangeNotificationTarget
Gets a reference to the ViewModel object for this node. This property should only be used by the internal Biml framework.
(Inherited from AstNode)
ReferenceCount
Gets or sets the total number of other node properties that hold a reference to this node.
(Inherited from AstNamedNode)
References
Gets collection of FrameworkItemReference objects, which track rich information about the properties that hold references to this node.
(Inherited from AstNamedNode)
RefId
Returns the SSIS refid that is used to reference this item from within an SSIS package or dataflow.
(Inherited from AstNamedNode)
ScopeBoundary
Gets the scope boundary for this node
(Inherited from AstNode)
ScopeBoundary
Gets the ScopeBoundary for this referenceable item
(Inherited from AstNamedNode)
ScopedName
Gets the scoped name which can be used to uniquely identify this object among other objects of its type
(Inherited from AstNamedNode)
ScopedNamePrefix
Gets the prefix to use for ScopedName calculations
(Inherited from AstNamedNode)
SsisAnnotations
This is a collection of SSIS annotations that will be rendered on the SSIS design surface within the parent container object.
(Inherited from AstContainerTaskBaseNode)
SsisSafeName
Returns a version of the Name that has been cleaned of invalid characters for SSIS.
(Inherited from AstNamedNode)
SsisSafeScopedName
Returns a version of the ScopedName that has been cleaned of invalid characters for SSIS.
(Inherited from AstNamedNode)
StaticUserDefinedItems
Specifies a collection of items that are common across all instances of the same type in the framework.
(Inherited from AstTaskNode)
StaticUserDefinedItems
Specifies a collection of items that are common across all instances of the same type in the framework.
(Inherited from AstContainerTaskBaseNode)
StaticUserDefinedItems
Specifies a collection of items that are common across all instances of the same type in the framework.
(Inherited from AstContainerTaskNode)
StaticUserDefinedItems
Specifies a collection of items that are common across all instances of the same type in the framework.
SymbolTable
Gets a reference to the symbol table that stores a reference to this and all other named objects in the project
(Inherited from AstNamedNode)
SymbolTableProvider
Gets the symbol table provider for this node
(Inherited from AstNode)
SystemVariables
Gets a collection of all variables defined in this task that have been provided by SSIS as system variables
(Inherited from AstTaskNode)
Tasks
Container for child task definitions.
(Inherited from AstContainerTaskBaseNode)
TransactionMode
This value specifies the transaction context in which this task will execute.
(Inherited from AstTaskNode)
TransactionModeDefaultValue
Gets the default value for the TransactionMode property
(Inherited from AstTaskNode)
TreeDepth
Gets the distance between this node and the root item
(Inherited from AstNode)
UserDefinedItems
Gets the child items of this node that were defined in user code
(Inherited from AstNode)
Variables
This is a container for variable definitions that are specific to this task, container, or package.
(Inherited from AstTaskNode)
VisiblePackageParameters
Gets a collection of all package parameter nodes that are available to be used by this task.
(Inherited from AstTaskNode)
VisibleProjectParameters
Gets a collection of all project parameter nodes that are available to be used by this task. This include all parameters defined by all package projects that contain the parent package for this task.
(Inherited from AstTaskNode)
VisibleVariables
Gets a collection of all variable nodes that are available to be used by this task. It includes variables defined by this task and any tasks/packages that contain this task
(Inherited from AstTaskNode)
WarningCount
Gets the count of warning diagnostics that have been generated for this node
(Inherited from AstNode)
XmlMapping
Gets the XML binding information that is used to track the Biml code that corresponds to this node
(Inherited from AstNode)
Methods
  Name Summary
Events
  Name Summary
ItemLabelChanged
The ItemLabelChanged event occurs when the name of this node or any scope boundary ancestor (as determined by following ParentItem to the AstRootNode) name changes.
NameChanged
The NameChanged event occurs when the Name property of the current node has changed to a new value and that value has been committed.
NameChanging
The NameChanging event occurs when the Name property of the current node is receiving a new value but that value has not yet been committed.
ScopeBoundaryChanged
The ScopeBoundaryChanged event occurs when any ancestor (as determined by following ParentItem to the AstRootNode) changes in such a way as the ScopeBoundary for this node changes. This will force the ScopedName of this node to change if it is an AstNamedNode.
ScopedNameChanged
The ScopedNameChanged event occurs when the name of this node or any scope boundary ancestor (as determined by following ParentItem to the AstRootNode) name changes.
Extension Methods
  Name Summary
AddAnnotation(AnnotationType,String)
Adds an annotation to an AstNode
[Extension Method: Import namespace Varigence.Biml.Extensions]
AddAnnotation(AnnotationType,String,String)
Adds an annotation to an AstNode
[Extension Method: Import namespace Varigence.Biml.Extensions]
EnumerateAncestors
Returns the ancestors of the current node
[Extension Method: Import namespace Varigence.Biml.Extensions]
GetBiml()
Retrieve the Biml that represents the AstNode
[Extension Method: Import namespace Varigence.Biml.Extensions]
GetSinks
Returns the sink nodes of the task graph
[Extension Method: Import namespace Varigence.Biml.DataflowEngine]
GetSources
Returns the source nodes of the task graph
[Extension Method: Import namespace Varigence.Biml.DataflowEngine]
GetTag(String)
Gets the first annotation with a matching tag and returns the value. If the tag is not found, returns an empty string.
[Extension Method: Import namespace Varigence.Biml.Extensions]
GetTag(String,Boolean)
Gets the first annotation with a matching tag and returns the value. If the tag is not found, returns an empty string.
[Extension Method: Import namespace Varigence.Biml.Extensions]
GetTag(String,Boolean,Boolean)
Gets the first annotation with a matching tag and returns the value. If the tag is not found, returns an empty string.
[Extension Method: Import namespace Varigence.Biml.Extensions]
.NET API Metadata
Assembly:
Biml
Friendly Name:
CustomExtensionContainerTask
Abstract:
False
Referenceable:
True
Root Item:
False
Scope Boundary:
False
Symbol Table Provider:
False
Xml Schema Name:
Varigence.Languages.Biml.Task.AstCustomExtensionContainerTaskNode
Xsd Namespace:
http://schemas.varigence.com/biml.xsd
Referenceable:
True
Scope Boundary:
False