2.7.1.1.1.1.1.1.2 PipelineComponentPropertyNameEnum

  • Article

The PipelineComponentPropertyNameEnum type contains the allowed values for the name attribute on the component element of a Pipeline Task executable. The allowed values for the property element for each task are more restricted than the values that are specified formally by the XSD.

Each name attribute value MUST NOT be used for any component except for the components that are specified in the subsections of this section. Some components allow no properties.

The additional restrictions specified in the subsections of this section MUST be followed for the name attribute on the property element children of the component element.

The following is the XSD for the PipelineComponentPropertyNameEnum type.

   <xs:simpleType name="PipelineComponentPropertyNameEnum">
     <xs:restriction base="xs:string">
       <!--Transforms-->
       <!--Aggregate Task-->
       <xs:enumeration value="KeyScale"/>
       <xs:enumeration value="Keys"/>
       <xs:enumeration value="CountDistinctScale"/>
       <xs:enumeration value="CountDistinctKeys"/>
       <xs:enumeration value="AutoExtendFactor"/>
       <!--Audit (none)-->
       <!--Cache Transform (none)-->
       <!--Character Map (none)-->
       <!--Conditional Split (none)-->
       <!--Copy Column (none)-->
       <!--Data Conversion (none)-->
       <!--Data Mining Query-->
       <xs:enumeration value="ObjectRef"/>
       <xs:enumeration value="QueryText"/>
       <xs:enumeration value="CatalogName"/>
       <!--Derived Column Query (none)-->
       <!--Export Column Query (none)-->
       <!--Fuzzy Grouping-->
       <xs:enumeration value="MinSimilarity"/>
       <xs:enumeration value="Delimiters"/>
       <xs:enumeration value="MaxMemoryUsage"/>
       <xs:enumeration value="Exhaustive"/>
       <!--Fuzzy Lookup-->
       <xs:enumeration value="MatchIndexOptions"/>
       <xs:enumeration value="MaxMemoryUsage"/>
       <xs:enumeration value="MatchIndexName"/>
       <xs:enumeration value="ReferenceTableName"/>
       <xs:enumeration value="DropExistingMatchIndex"/>
       <xs:enumeration value="CopyReferenceTable"/>
       <xs:enumeration value="MaxOutputMatchesPerInput"/>
       <xs:enumeration value="MinSimilarity"/>
       <xs:enumeration value="Delimiters"/>
       <xs:enumeration value="ReferenceMetadataXml"/>
       <xs:enumeration value="Exhaustive"/>
       <xs:enumeration value="WarmCaches"/>
       <!--Import Column (none)-->
       <!--Lookup-->
       <xs:enumeration value="SqlCommand"/>
       <xs:enumeration value="SqlCommandParam"/>
       <xs:enumeration value="ConnectionType"/>
       <xs:enumeration value="CacheType"/>
       <xs:enumeration value="NoMatchBehavior"/>
       <xs:enumeration value="NoMatchCachePercentage"/>
       <xs:enumeration value="MaxMemoryUsage"/>
       <xs:enumeration value="MaxMemoryUsage64"/>
       <xs:enumeration value="ReferenceMetadataXml"/>
       <xs:enumeration value="ParameterMap"/>
       <xs:enumeration value="DefaultCodePage"/>
       <!--Merge (none)-->
       <!--MergeJoin (none)-->
       <xs:enumeration value="JoinType"/>
       <xs:enumeration value="NumKeyColumns"/>
       <xs:enumeration value="TreatNullsAsEqual"/>
       <xs:enumeration value="MaxBuffersPerInput"/>
       <!--Multicast (none)-->
       <!--OLE DB Command-->
       <xs:enumeration value="CommandTimeout"/>
       <xs:enumeration value="SqlCommand"/>
       <xs:enumeration value="DefaultCodePage"/>
       <!--Percentage Sampling-->
       <xs:enumeration value="SamplingValue"/>
       <xs:enumeration value="SamplingSeed"/>
       <!--Pivot (none)-->
       <!--RowCount-->
       <xs:enumeration value="VariableName"/>
       <!--Row Sampling-->
       <xs:enumeration value="SamplingValue"/>
       <xs:enumeration value="SamplingSeed"/>
       <!--Script Component-->
       <xs:enumeration value="SourceCode"/>
       <xs:enumeration value="BinaryCode"/>
       <xs:enumeration value="VSTAProjectName"/>
       <xs:enumeration value="ScriptLanguage"/>
       <xs:enumeration value="ReadOnlyVariables"/>
       <xs:enumeration value="ReadWriteVariables"/>
       <xs:enumeration value="BreakpointCollection"/>
       <xs:enumeration value="UserComponentTypeName"/>
       <!--Slowly Changing Dimension-->
       <xs:enumeration value="SqlCommand"/>
       <xs:enumeration value="CurrentRowWhere"/>
       <xs:enumeration value="UpdateChangingAttributeHistory"/>
       <xs:enumeration value="FailOnFixedAttributeChange"/>
       <xs:enumeration value="InferredMemberIndicator"/>
       <xs:enumeration value="EnableInferredMember"/>
       <xs:enumeration value="FailOnLookupFailure"/>
       <xs:enumeration value="IncomingRowChangeType"/>
       <xs:enumeration value="DefaultCodePage"/>
       <!--Sort-->
       <xs:enumeration value="EliminateDuplicates"/>
       <xs:enumeration value="MaximumThreads"/>
       <!--Term Extraction-->
       <xs:enumeration value="NeedReferenceData"/>
       <xs:enumeration value="OutTermTable"/>
       <xs:enumeration value="OutTermColumn"/>
       <xs:enumeration value="WordOrPhrase"/>
       <xs:enumeration value="ScoreType"/>
       <xs:enumeration value="FrequencyThreshold"/>
       <xs:enumeration value="MaxLengthOfTerm"/>
       <xs:enumeration value="IsCaseSensitive"/>
       <!--Term Lookup-->
       <xs:enumeration value="RefTermTable"/>
       <xs:enumeration value="RefTermColumn"/>
       <xs:enumeration value="IsCaseSensitive"/>
       <!--UnionAll (none)-->
       <!--Unpivot (none)--> 
       <!--Data Destinations-->
       <!--ADO.Net Destination-->
       <xs:enumeration value="TableOrViewName"/>
       <xs:enumeration value="BatchSize"/>
       <xs:enumeration value="CommandTimeout"/>
       <xs:enumeration value="UserComponentTypeName"/>
       <!--Excel Destination-->
       <xs:enumeration value="CommandTimeout"/>
       <xs:enumeration value="OpenRowset"/>
       <xs:enumeration value="OpenRowsetVariable"/>
       <xs:enumeration value="SqlCommand"/>
       <xs:enumeration value="AccessMode"/>
       <xs:enumeration value="FastLoadKeepIdentity"/>
       <xs:enumeration value="FastLoadKeepNulls"/>
       <xs:enumeration value="FastLoadOptions"/>
       <xs:enumeration value="FastLoadMaxInsertCommitSize"/>
       <!--Flat File Destination-->
       <xs:enumeration value="Overwrite"/>
       <xs:enumeration value="Header"/>
       <!--OLE DB Destination-->
       <xs:enumeration value="CommandTimeout"/>
       <xs:enumeration value="OpenRowset"/>
       <xs:enumeration value="OpenRowsetVariable"/>
       <xs:enumeration value="SqlCommand"/>
       <xs:enumeration value="DefaultCodePage"/>
       <xs:enumeration value="AlwaysUseDefaultCodePage"/>
       <xs:enumeration value="AccessMode"/>
       <xs:enumeration value="FastLoadKeepIdentity"/>
       <xs:enumeration value="FastLoadKeepNulls"/>
       <xs:enumeration value="FastLoadOptions"/>
       <xs:enumeration value="FastLoadMaxInsertCommitSize"/>
       <!--Raw File Destination-->
       <xs:enumeration value="AccessMode"/>
       <xs:enumeration value="FileName"/>
       <xs:enumeration value="FileNameVariable"/>
       <xs:enumeration value="WriteOption"/>
       <!--DataReader Destination-->
       <xs:enumeration value="ReadTimeout"/>
       <xs:enumeration value="DataReader"/>
       <xs:enumeration value="FailOnTimeout"/>
       <xs:enumeration value="UserComponentTypeName"/>
       <!--Data Mining Model Training-->
       <xs:enumeration value="ObjectRef"/>
       <!--Dimension Processing-->
       <xs:enumeration value="ObjectRef"/>
       <xs:enumeration value="UseDefaultConfiguration"/>
       <xs:enumeration value="KeyErrorLimit"/>
       <xs:enumeration value="KeyErrorLogFile"/>
       <xs:enumeration value="KeyErrorAction"/>
       <xs:enumeration value="KeyErrorLimitAction"/>
       <xs:enumeration value="KeyNotFound"/>
       <xs:enumeration value="KeyDuplicate"/>
       <xs:enumeration value="NullKeyConvertedToUnknown"/>
       <xs:enumeration value="NullKeyNotAllowed"/>
       <xs:enumeration value="ProcessType"/>
       <!--Partition Processing-->
       <xs:enumeration value="ObjectRef"/>
       <xs:enumeration value="UseDefaultConfiguration"/>
       <xs:enumeration value="KeyErrorLimit"/>
       <xs:enumeration value="KeyErrorLogFile"/>
       <xs:enumeration value="KeyErrorAction"/>
       <xs:enumeration value="KeyErrorLimitAction"/>
       <xs:enumeration value="KeyNotFound"/>
       <xs:enumeration value="KeyDuplicate"/>
       <xs:enumeration value="NullKeyConvertedToUnknown"/>
       <xs:enumeration value="NullKeyNotAllowed"/>
       <xs:enumeration value="ProcessType"/>
       <!--RecordSet Destination-->
       <xs:enumeration value="VariableName"/>
       <!--SQL Server Compact Destination-->
       <xs:enumeration value="Table Name"/>
       <xs:enumeration value="UserComponentTypeName"/>
       <!--SQL Server Destination-->
       <xs:enumeration value="DefaultCodePage"/>
       <xs:enumeration value="AlwaysUseDefaultCodePage"/>
       <xs:enumeration value="BulkInsertTableName"/>
       <xs:enumeration value="BulkInsertCheckConstraints"/>
       <xs:enumeration value="BulkInsertFirstRow"/>
       <xs:enumeration value="BulkInsertFireTriggers"/>
       <xs:enumeration value="BulkInsertKeepIdentity"/>
       <xs:enumeration value="BulkInsertKeepNulls"/>
       <xs:enumeration value="BulkInsertLastRow"/>
       <xs:enumeration value="BulkInsertMaxErrors"/>
       <xs:enumeration value="BulkInsertOrder"/>
       <xs:enumeration value="BulkInsertTablock"/>
       <xs:enumeration value="Timeout"/>
       <xs:enumeration value="MaxInsertCommitSize"/>
       <!--Data Sources-->
       <!--ADO.Net Source-->
       <xs:enumeration value="SqlCommand"/>
       <xs:enumeration value="CommandTimeout"/>
       <xs:enumeration value="AllowImplicitStringConversion"/>
       <xs:enumeration value="TableOrViewName"/>
       <xs:enumeration value="AccessMode"/>
       <xs:enumeration value="UserComponentTypeName"/>
       <!--Excel Source-->
       <xs:enumeration value="CommandTimeout"/>
       <xs:enumeration value="OpenRowset"/>
       <xs:enumeration value="OpenRowsetVariable"/>
       <xs:enumeration value="SqlCommand"/>
       <xs:enumeration value="SqlCommandVariable"/>
       <xs:enumeration value="AccessMode"/>
       <xs:enumeration value="ParameterMapping"/>
       <!--Flat File Source-->
       <xs:enumeration value="RetainNulls"/>
       <xs:enumeration value="FileNameColumnName"/>
       <!--OLEDB Source Task-->
       <xs:enumeration value="CommandTimeout"/>
       <xs:enumeration value="OpenRowset"/>
       <xs:enumeration value="OpenRowsetVariable"/>
       <xs:enumeration value="SqlCommand"/>
       <xs:enumeration value="SqlCommandVariable"/>
       <xs:enumeration value="DefaultCodePage"/>
       <xs:enumeration value="AlwaysUseDefaultCodePage"/>
       <xs:enumeration value="AccessMode"/>
       <xs:enumeration value="ParameterMapping"/>
       <!--Raw File Source-->
       <xs:enumeration value="AccessMode"/>
       <xs:enumeration value="FileName"/>
       <xs:enumeration value="FileNameVariable"/>
       <!--XML Source-->
       <xs:enumeration value="UserComponentTypeName"/>
       <xs:enumeration value="XMLData"/>
       <xs:enumeration value="XMLDataVariable"/>
       <xs:enumeration value="AccessMode"/>
       <xs:enumeration value="XMLSchemaDefinition"/>
       <xs:enumeration value="UseInlineSchema"/>
     </xs:restriction>
   </xs:simpleType>
 

This section presents no tabular explanation of the properties that are specified in the preceding XSD. Tabular explanations are, however, presented in the following subsections when values are allowed.

2.7.1.1.1.1.1.1.2.1   Aggregate Component

Aggregate Component aggregates values by using functions such as sum and average.  Aggregate Component MUST NOT use any Name attribute value on a property element except for those that are listed in the table in this section.

The following table specifies the Name attribute values that are allowed for the Aggregate Component, in addition to any restrictions on the element value. These restrictions MUST be followed.

Name attribute value

Description

KeyScale

An integer value that specifies the approximate number of groups that is expected by the operation. This value is used to optimize computation.

The possible enumeration values are interpreted as follows:

0 – The key scale is not used.

1 – Aggregation writes approximately 500,000 keys.

2 – Aggregation writes approximately 25,000,000 keys.

3 – Aggregation writes more than 25,000,000 keys.

Keys

An integer value that specifies the number of groups that is expected by the operation. This value is used to optimize computation.

If this value is specified, it overrides the value that is specified for the KeyScale attribute.

CountDistinctScale

An integer value that specifies the approximate number of groups that is expected by a distinct count operation. This value is used to optimize computation.

The enumeration values are interpreted as follows:

0 – The key scale is not used.

1 – Aggregation writes approximately 500,000 keys.

2 – Aggregation writes approximately 25,000,000 keys.

3 – Aggregation writes more than 25,000,000 keys.

CountDistinctKeys

An integer value that specifies the number of groups that is expected by a distinct count operation. This value is used to optimize computation.

If this value is specified, it overrides the value that is specified for the CountDistinctKeys attribute.

AutoExtendFactor

An integer value that specifies the percentage amount by which memory is extended during the aggregate operation.

2.7.1.1.1.1.1.1.2.2   Audit Component

Audit Component allows information about the run-time environment of the package to be inserted into the data flow. Audit Component MUST NOT have any properties.

2.7.1.1.1.1.1.1.2.3   Cache Transform Component

Cache Transform Component copies its inputs to a cache for fast processing. Cache Transform Component MUST NOT have any properties.

2.7.1.1.1.1.1.1.2.4   Character Map Component

Character Map Component processes character strings by applying string functions to the strings, such as converting case and byte order. Character Map Component MUST NOT have any properties.

2.7.1.1.1.1.1.1.2.5   Conditional Split Component

Conditional Split Component splits its input into several outputs, based on conditional logic to determine which output to use for each input row. Conditional Split Component MUST NOT have any properties.

2.7.1.1.1.1.1.1.2.6   Copy Column Component

Copy Column Component produces a copy of a column on its output. Copy Column Component MUST NOT have any properties.

2.7.1.1.1.1.1.1.2.7   Data Conversion Component

Data Conversion Component converts the data type of a column to a different data type. Data Conversion Component MUST NOT have any properties.

2.7.1.1.1.1.1.1.2.8   Data Mining Query Component

Data Mining Query Component runs data mining prediction queries. Data Mining Query Component MUST NOT use any Name attribute value on a property element except for those that are listed in the table in this section.

The following table specifies the Name attribute values that are allowed for the Data Mining Query Component, in addition to any restrictions on the element value. These restrictions MUST be followed.

Name attribute value

Description

ObjectRef

A string value that specifies an XML tag that identifies the mining structure that the task uses.

QueryText

A string value that specifies a Data Mining Query Language (DMX) query string. For more information about the DMX language, see [MSDN-DMXR].

CatalogName

A string value that specifies the catalog name in the host database for the data mining model.

2.7.1.1.1.1.1.1.2.9   Derived Column Component

Derived Column Component produces new columns by computing them from an expression. Derived Column Component MUST NOT have any properties.

2.7.1.1.1.1.1.1.2.10   Export Column Component

Export Column Component takes data from the data flow and inserts it into files. Export Column Component MUST NOT have any properties.

2.7.1.1.1.1.1.1.2.11   Fuzzy Grouping Component

Fuzzy Grouping Component identifies rows of data that are similar enough to be grouped, if the grouping criteria is considered to be fuzzy and not exact. Fuzzy Grouping Component MUST NOT use any Name attribute value on a property element except for those that are listed in the table in this section.

The following table specifies the Name attribute values that are allowed for the Fuzzy Grouping Component, in addition to any restrictions on the element value. All stated restrictions MUST be followed.

Name attribute value

Description

MinSimilarity

A single-precision number value between 0 and 1, inclusive, that specifies the similarity threshold that the task uses to identify duplicates.

Delimiters

A string value that specifies the tokens that the task uses as delimiters.

MaxMemoryUsage

An integer value that specifies the maximum memory usage for the task in bytes.<26>

Exhaustive

A Boolean value that specifies whether each input record is compared to every other input record.

TRUE specifies that each input record is compared to every other input record.

FALSE specifies that each input record is not compared to every other input record.

2.7.1.1.1.1.1.1.2.12   Fuzzy Lookup Component

Fuzzy Lookup Component looks up values in a table and matches them based on similarity and, therefore, does not require an exact match. The match is considered to have been made based on fuzzy criteria. Fuzzy Lookup Component MUST NOT use any Name attribute value on a property element except for those that are listed in the table in this section.

The following table specifies the Name attribute values that are allowed for Fuzzy Lookup Component, in addition to any restrictions on the element value. All stated restrictions MUST be followed.

Name attribute value

Description

MatchIndexOptions

An integer value that specifies how the match index is managed.

The possible values have the following meanings:

0 – Reuse existing index.

1 – Generate a new index.

2 – Generate and persist a new index.

3 – Generate and maintain a new index.

MaxMemoryUsage

An integer value that specifies the maximum size for the cache table in bytes.<27>

MatchIndexName

A string value that specifies the name of the match index. The match index is the table in which the transformation creates and saves the index that it uses.

ReferenceTableName

A string value that specifies the name of the lookup table.<28>

DropExistingMatchIndex

A Boolean value that specifies whether the match index that is specified in the MatchIndexName attribute is deleted when the MatchIndexOptions attribute is not set to the value "ReuseExistingIndex".

CopyReferenceTable

A Boolean value that specifies whether a copy of the reference table is made for index construction and for subsequent lookups.

TRUE specifies that a copy of the reference table is made.

FALSE specifies that a copy of the reference table is not made.

MaxOutputMatchesPerInput

An integer value that specifies the maximum number of matches that can be returned for each input row.

MinSimilarity

A single-precision number between 0 and 1, inclusive, that specifies the similarity threshold that the task uses to identify duplicates.

Delimiters

A string value that specifies the tokens that the task uses as delimiters.

ReferenceMetadataXml

A string value.<29>

Exhaustive

A Boolean value that specifies whether each input record is compared to every other input record.

TRUE specifies that each input record is compared to every other input record.

FALSE specifies that each input record is not compared to every other input record.

WarmCaches

A Boolean value that specifies whether the index and reference table are partially loaded into memory before the operation begins.

TRUE specifies that the index and reference table are partially loaded into memory before the operation begins.

FALSE specifies that the index and reference table are not partially loaded into memory before the operation begins.

2.7.1.1.1.1.1.1.2.13   Import Column Component

Import Column Component reads data from a file and inserts it into a data flow. Import Column Component MUST NOT have any properties.

2.7.1.1.1.1.1.1.2.14   Lookup Component

Lookup Component looks up values in a table and, based on exact matches only, matches those values to data. Lookup Component MUST NOT use any Name attribute value on a property element except for those that are listed in the table in this section.

The following table specifies the Name attribute values that are allowed for the Lookup Component, in addition to any restrictions on the element value. These restrictions MUST be followed.

Name attribute value

Description

SqlCommand

A string value that specifies an SQL SELECT command string that populates the lookup table.

SqlCommandParam

A string value that specifies a parameterized SQL statement that populates the lookup table.

ConnectionType

An integer value that specifies the connection type.

The allowed values are the following:

0 – The connection is OLE DB.

1 – The connection is to a cache.

CacheType

An integer value that specifies the cache type for the lookup table.

The allowed values are interpreted as follows:

0 – Full.

1 – Partial.

2 – No cache.

NoMatchBehavior

An integer value that specifies the behavior when rows with no matching value in the reference dataset are encountered in the data flow.

The allowed values are interpreted as follows:

0 – Rows with no matching entries are treated as errors.

1 – Rows with no matching entries are sent to the "no match" output.

NoMatchCachePercentage

An integer value between 0 and 100, inclusive, that specifies the maximum percentage of cache memory that can be allocated to data for which a match has not been found.

MaxMemoryUsage

An integer value that specifies the maximum memory size in megabytes for the cache on a 32-bit platform.

MaxMemoryUsage64

An integer value that specifies the maximum memory size in megabytes for the cache on a 64-bit platform.

ReferenceMetadataXml

A string value.<30>

ParameterMap

A string value that specifies the parameters that are mapped to the SQL command. The string is delimited by a semicolon.

DefaultCodePage

An integer value that specifies the default code page to use if code page information is not available from the data source.

2.7.1.1.1.1.1.1.2.15   Merge Component

Merge Component merges, based on values in key columns, two sorted datasets into one output. Merge Component MUST NOT have any properties.

2.7.1.1.1.1.1.1.2.16   MergeJoin Component

MergeJoin Component merges two sorted tables by using a FULL, LEFT, or INNER join. MergeJoin Component MUST NOT use any Name attribute value on a property element except for those that are listed in the table in this section.

The following table specifies the Name attribute values that are allowed for the MergeJoin Component, in addition to any restrictions on the element value. These restrictions MUST be followed.

Name attribute value

Description

JoinType

An integer value that specifies the type of join to be performed.

The interpretation of the possible values is as follows:

0 – Full join.

1 – Left outer join.

2 – Inner join.

NumKeyColumns

An integer value that specifies the number of key columns used in the join.

TreatNullsAsEqual

A Boolean value that specifies whether NULL values are treated as equal for the purpose of a join.

TRUE specifies that NULL values are treated as equal.

FALSE specifies that NULL values are not treated as equal and are treated as they are normally treated by the database server.

MaxBuffersPerInput

An integer value that specifies the maximum number of buffers that are used per input.

2.7.1.1.1.1.1.1.2.17   Multicast Component

Multicast Component duplicates the input onto all of its outputs. Multicast Component MUST NOT have any properties.

2.7.1.1.1.1.1.1.2.18   OLE DB Command Component

OLE DB Command Component runs an SQL statement for every row in its data flow. OLE DB Command Component MUST NOT use any Name attribute value on a property element except for those that are listed in the table in this section.

The following table specifies the Name attribute values that are allowed for the OLE DB Command Component, in addition to any restrictions on the element value. These restrictions MUST be followed.

Name attribute value

Description

CommandTimeout

An integer value that specifies the timeout interval, in seconds, for the command.

SqlCommand

A string value that specifies the SQL command string.

DefaultCodePage

An integer value that specifies the default code page to use if the code page is not available from the data source.

2.7.1.1.1.1.1.1.2.19   Percentage Sampling Component

Percentage Sampling Component creates a sample data set by randomly selecting a percentage of the transformation input rows. Percentage Sampling Component MUST NOT use any Name attribute value on a property element except for those that are listed in the table in this section.

The following table specifies the Name attribute values that are allowed for Percentage Sampling Component, in addition to any restrictions on the element value. These restrictions MUST be followed.

Name attribute value

Description

SamplingValue

An integer value that represents the percentage of the source that is taken as a sample.

SamplingSeed

An integer value that specifies the random number generator seed that is used for generating a random sample.

2.7.1.1.1.1.1.1.2.20   Pivot Component

Pivot Component makes a normalized data set into a less normalized but more compact version by pivoting the input data on a column value. Pivot Component MUST NOT have any properties.

2.7.1.1.1.1.1.1.2.21   RowCount Component

RowCount Component counts rows in the data flow and stores the result in a variable. RowCount Component MUST NOT use any Name attribute value on a property element except for those that are listed in the table in this section.

The following table specifies the Name attribute values that are allowed for RowCount Component, in addition to any restrictions on the element value. These restrictions MUST be followed.

Name attribute value

Description

VariableName

A string value that specifies the name of the variable that holds the row count.

2.7.1.1.1.1.1.1.2.22   Row Sampling Component

Row Sampling Component is used to extract a randomly selected subset of the input data. Row Sampling Component MUST NOT use any Name attribute value on a property element except for those that are listed in the table in this section.

The following table specifies the Name attribute values that are allowed for Row Sampling Component, in addition to any restrictions on the element value. These restrictions MUST be followed.

Name attribute value

Description

SamplingValue

An integer value that specifies the number of rows in the sample.

SamplingSeed

An integer value that specifies the seed value for the random number generator.

2.7.1.1.1.1.1.1.2.23   Script Component

Script Component runs custom code that is created in a programming environment within the data flow. Script Component MUST NOT use any Name attribute value on a property element except for those that are listed in the table in this section.

The following table specifies the Name attribute values that are allowed for the Script Component, in addition to any restrictions on the element value. These restrictions MUST be followed.

Name attribute value

Description

SourceCode

Specifies the source code for the Script Component. The property element value MUST be empty. The SourceCode property element MUST contain the arrayElements element.

BinaryCode

Specifies the binary code for the Script Component. The property element value MUST be empty. The BinaryCode property element MUST contain the arrayElements element.

VSTAProjectName

A string value that specifies the project name for the Script Component.<31>

ScriptLanguage

A string value that specifies the language of the script project. The valid string values are as follows:

CSharp –C# language

VisualBasic –Visual Basic language

ReadOnlyVariables

A string value that specifies the read-only variables in the package that are available to the Script Component.

ReadWriteVariables

A string value that specifies the read-write variables in the package that are available to the Script Component.

BreakpointCollection

Specifies a collection of breakpoints for the Script Component. The property element value MUST be empty. The BreakpointCollection property element MUST contain the arrayElement element.

UserComponentTypeName

A string value that specifies the fully qualified assembly name for the component.

2.7.1.1.1.1.1.1.2.24   Slowly Changing Dimension Component

Slowly Changing Dimension Component configures the updating of a slowly changing dimension. Slowly Changing Dimension Component MUST NOT use any Name attribute value on a property element except for those that are listed in the table in this section.

The following table specifies the Name attribute values that are allowed for Slowly Changing Dimension Component, in addition to any restrictions on the element value. These restrictions MUST be followed.

Name attribute value

Description

SqlCommand

A string value that specifies an SQL statement that is used to create a schema rowset.

CurrentRowWhere

A string value that specifies a WHERE clause of an SQL SELECT statement that selects the current row among the rows that have the same key value.

UpdateChangingAttributeHistory

A Boolean value that specifies whether historical attribute updates are directed to the transformation output for changing attribute updates.

FailOnFixedAttributeChange

A Boolean value that specifies whether the transformation fails when rows where the columns with fixed attributes contain changes or when the lookup in the dimension table fails.

TRUE specifies that when fixed attributes change or the lookup fails, the operation fails.

FALSE specifies that when fixed attributes change or the lookup fails, the operation identifies a new record.

InferredMemberIndicator

A string value that specifies the column name for the inferred member.

EnableInferredMember

A Boolean value that specifies whether inferred member updates are detected.

TRUE specifies that inferred member updates are detected.

FALSE specifies that inferred member updates are not detected.

FailOnLookupFailure

A Boolean value that specifies whether a lookup failure results in a task failure.

TRUE specifies that a lookup failure results in a task failure.

FALSE specifies that a lookup failure does not result in a task failure.

IncomingRowChangeType

An integer value that specifies the incoming row change type.

The allowed values are as follows:

0 – All incoming rows are considered to be new rows.

1 – The system detects which incoming rows are new.

DefaultCodePage

An integer value that specifies the default code page to use if code page information is not available from the data source.

2.7.1.1.1.1.1.1.2.25   Sort Component

Sort Component sorts data. Sort Component MUST NOT use any Name attribute value on a property element except for those that are listed in the table in this section.

The following table specifies the Name attribute values that are allowed for Sort Component, in addition to any restrictions on the element value. These restrictions MUST be followed.

Name attribute value

Description

EliminateDuplicates

A Boolean value that specifies whether to remove duplicate rows from the output.

TRUE specifies that duplicate rows are removed from the output.

FALSE specifies that duplicate rows are not removed from the output.

MaximumThreads

An integer value that specifies the maximum number of threads to use for sorting.<32>

2.7.1.1.1.1.1.1.2.26   Term Extraction Component

Term Extraction Component extracts words from text, based on grammatical rules (English language only) to normalize the words. Term Extraction Component MUST NOT use any Name attribute value on a property element except for those that are listed in the table in this section.

The following table specifies the Name attribute values that are allowed for Term Extraction Component, in addition to any restrictions on the element value. These restrictions MUST be followed.

Name attribute value

Description

NeedReferenceData

A Boolean value that specifies whether a table of excluded terms is used.

TRUE specifies that a table of excluded terms is used.

FALSE specifies that a table of excluded terms is not used.

OutTermTable

A string value that specifies the table name that contains the excluded terms.

OutTermColumn

A string value that specifies the column name that contains the excluded terms.

WordOrPhrase

An integer value that specifies how terms are determined.

The valid enumeration values are as follows:

0 – Words only.

1 – Noun phrases only.

2 – Words and noun phrases.

ScoreType

An integer value that specifies what type of score is associated with the term.

The valid enumeration values are as follows:

0 – The frequency of the term is its score.

1 – The TFIDF Score is the term's score.

FrequencyThreshold

An integer value that specifies the number of occurrences of a term before it is extracted.

MaxLengthOfTerm

An integer value that specifies the maximum length of terms in characters. It applies only to phrases.

IsCaseSensitive

A Boolean value that specifies whether case sensitivity is used when detecting nouns and noun phrases.

TRUE specifies that case is used when detecting nouns and noun phrases.

FALSE specifies that case is ignored when detecting nouns and noun phrases.

2.7.1.1.1.1.1.1.2.27   Term Lookup Component

Term Lookup Component looks for a specified set of terms among terms that are extracted by using the same methodology that Term Extraction Component uses. Term Lookup Component MUST NOT use any Name attribute value on a property element except for those that are listed in the table in this section.

The following table specifies the Name attribute values that are allowed for Term Lookup Component, in addition to any restrictions on the element value. These restrictions MUST be followed.

Name attribute value

Description

RefTermTable

A string value that specifies the name of the table that contains the reference terms.

RefTermColumn

A string value that specifies the name of the column that contains the reference terms.

IsCaseSensitive

A Boolean value that specifies whether case sensitivity is applied to matching input terms with reference terms.

TRUE specifies that case is used when matching input terms with reference terms.

FALSE specifies that case is ignored when matching input terms with reference terms.

2.7.1.1.1.1.1.1.2.28   Union All Component

Union All Component combines multiple inputs into one output stream. Union All Component MUST NOT have any properties.

2.7.1.1.1.1.1.1.2.29   Unpivot Component

Unpivot Component makes an unnormalized dataset into a more normalized version by expanding values from multiple columns in a single record into multiple records with the same values in a single column. Unpivot Component MUST NOT have any properties.

2.7.1.1.1.1.1.1.2.30   ADO.NET Destination Component

ADO.NET Destination Component loads data into an ADO.NET-compliant database. ADO.NET Destination Component MUST NOT use any Name attribute value on a property element except for those that are listed in the table in this section.

The following table specifies the Name attribute values that are allowed for ADO.NET Destination Component, in addition to any restrictions on the element value. These restrictions MUST be followed.

Name attribute value

Description

TableOrViewName

A string value that specifies the name of the table or view for the task.

BatchSize

An integer value that specifies the number of rows that are sent to the server at a time.<33>

CommandTimeout

An integer value that specifies the number of seconds that elapse before the command times out.<34>

UserComponentTypeName

A string value that specifies the fully qualified Microsoft .NET Framework assembly name for the component.

2.7.1.1.1.1.1.1.2.31   Excel Destination Component

Excel Destination Component writes data to a Microsoft Office Excel workbook. Excel Destination Component MUST NOT use any Name attribute value on a property element except for those that are listed in the table in this section.

The following table specifies the Name attribute values that are allowed for Excel Destination Component, in addition to any restrictions on the element value. These restrictions MUST be followed.

Name attribute value

Description

CommandTimeout

An integer value that specifies the number of seconds that elapse before the command times out.<35>

OpenRowset

A string value that specifies the name of the table or view that is used. This value is used when the AccessMode attribute is set to the value "0" or "3".

OpenRowsetVariable

A string value that specifies the name of the variable that contains the name of the table or view that is used. This value is used when the AccessMode attribute is set to the value "1" or "4".

SqlCommand

A string value that specifies the SQL command that is used. This value is used when the AccessMode attribute is set to the value "2".

AccessMode

An integer value that specifies how to access the database at its destination.

The allowed values are as follows:

0 – The name of a table or view is user-specified.

1 – The name of a variable that contains the name of a table or view is specified.

2 – A user-specified SQL statement is used.

3 – Open the rowset with a fast load operation together with a specified table name or view name.

4 – Open the rowset with a fast load operation together with the table name or view name specified in a variable.

FastLoadKeepIdentity

A Boolean value that specifies whether to copy identity values during a fast load operation. This value is used if the AccessMode attribute is set to the value "3" or "4".

TRUE specifies that identity values are copied.

FALSE specifies that identity values are not copied.

FastLoadKeepNulls

A Boolean value that specifies whether to copy NULL values during a fast load operation. This value is used if the AccessMode attribute is set to the value "3" or "4".

TRUE specifies that NULL values are to be copied.

FALSE specifies that NULL values are not to be copied.

FastLoadOptions<36>

A string value that specifies the fast load options that are selected. The string is a comma-separated list of fast load options. For more information about fast load options, see [MSDN-PBCO].

FastLoadMaxInsertCommitSize

An integer value that specifies the commit size, in rows, that is used when the AccessMode attribute is set to value "3" or "4".

2.7.1.1.1.1.1.1.2.32   Flat File Destination Component

Flat File Destination Component writes data to a flat file. Flat File Destination Component MUST NOT use any Name attribute value on a property element except for those that are listed in the table in this section.

The following table specifies the Name attribute values that are allowed for Flat File Destination Component, in addition to any restrictions on the element value. These restrictions MUST be followed.

Name attribute value

Description

Header

A string value that contains a string that is inserted into the file header before data is written to the file.

Overwrite

A Boolean value that specifies whether to overwrite or to append to an existing destination file that has the same name.

TRUE specifies to overwrite a destination file that has the same name.

FALSE specifies to append to a destination file that has the same name.

2.7.1.1.1.1.1.1.2.33   OLE DB Destination Component

OLE DB Destination Component loads data into an OLE DB–compliant database. OLE DB Destination Component MUST NOT use any Name attribute value on a property element except for those that are listed in the table in this section.

The following table specifies the Name attribute values that are allowed for OLE DB Destination Component, in addition to any restrictions on the element value. These restrictions MUST be followed.

Name attribute value

Description

CommandTimeout

An integer value that specifies the number of seconds that elapse before the command times out.<37>

OpenRowset

A string value that specifies the name of the table or view that is used. This value is used when the AccessMode attribute is set to the value "0" or "3".

OpenRowsetVariable

A string value that specifies the name of the variable that contains the name of the table or view that is used. This value is used when the AccessMode attribute is set to the value "1" or "4".

SqlCommand

A string value that specifies the SQL command that is used. This value is used when the AccessMode attribute is set to value "2".

DefaultCodePage

An integer value that specifies the default code page to use if code page information is not available from the data source.

AlwaysUseDefaultCodePage

A Boolean value that specifies whether to always use the value for the code page given in the DefaultCodePage attribute.

TRUE specifies to always use the value that is given in the DefaultCodePage attribute for the code page value.

FALSE specifies to first try to derive the code page value from the data source. If the code page value cannot be derived from the data source, the DefaultCodePage attribute value is used.

AccessMode

An integer value that specifies how to access the database at its destination.

The allowed values are as follows:

0 – The name of a table or view is user-specified.

1 – The name of a variable that contains the name of a table or view is specified.

2 – A user-specified SQL statement is used.

3 –The rowset is opened by using a fast load operation, with a specified table name or view name.

4 –The rowset is opened by using a fast load operation, with the table name or view name that is specified in a variable.

FastLoadKeepIdentity

A Boolean value that specifies whether to copy identity values during a fast load operation. This value is used if the AccessMode attribute is set to the value "3" or "4".

TRUE specifies that identity values are copied.

FALSE specifies that identity values are not copied.

FastLoadKeepNulls

A Boolean value that specifies whether to copy NULL values during a fast load operation. This value is used if the AccessMode attribute is set to the value "3" or "4".

TRUE specifies that NULL values are to be copied.

FALSE specifies that NULL values are not to be copied.

FastLoadOptions

A string value that specifies the fast load options that are selected. The string is a comma-separated list of fast load options. For more information about fast load options, see [MSDN-PBCO].<38>

FastLoadMaxInsertCommitSize

An integer value that specifies the commit size, in rows, that is used when AccessMode is set to value "3" or "4".

2.7.1.1.1.1.1.1.2.34   DataReader Destination Component

DataReader Destination Component exposes the data in a data flow by using the ADO.NET DataReader interface. The data can then be consumed by other applications. DataReader Destination Component MUST NOT use any Name attribute value on a property element except for those that are listed in the table in this section.

The following table specifies the Name attribute values that are allowed for DataReader Destination Component, in addition to any restrictions on the element value. These restrictions MUST be followed.

Name attribute value

Description

ReadTimeout

An integer value that specifies the number of milliseconds that elapse before the operation times out.

DataReader

A string value that specifies the class name of the data reader object at the destination.

FailOnTimeout

A Boolean value that specifies whether to fail if the value for the ReadTimeout attribute is reached.

TRUE specifies to fail if the ReadTimeout attribute value is reached.

FALSE specifies not to fail if the ReadTimeout attribute value is reached.

UserComponentTypeName

A string value that specifies the fully qualified .NET Framework assembly name for the component.

2.7.1.1.1.1.1.1.2.35   Data Mining Model Training Destination Component

Data Mining Model Training Destination Component applies data mining model training algorithms to the data that it receives from the data flow. Data Mining Model Training Destination Component MUST NOT use any Name attribute value on a property element except for those that are listed in the table in this section.

The following table specifies the Name attribute values that are allowed for Data Mining Model Training Destination Component, in addition to any restrictions on the element value. These restrictions MUST be followed.

Name attribute value

Description

ObjectRef

A string value that specifies an XML tag that identifies the mining structure that the task uses.

2.7.1.1.1.1.1.1.2.36   Dimension Processing Destination Component

Dimension Processing Destination Component loads and processes an Analysis Services dimension. Dimension Processing Destination Component MUST NOT use any Name attribute value on a property element except for those that are listed in the table in this section.

The following table specifies the Name attribute values that are allowed for Dimension Processing Destination Component, in addition to any restrictions on the element value. These restrictions MUST be followed.

Name attribute value

Description

ObjectRef

A string value that contains a reference to an Analysis Management Objects (AMO) object that represents the dimension, after it is looked up.<39>

UseDefaultConfiguration

A Boolean value that specifies whether to use the existing default configuration on the server.

TRUE specifies to use the existing default configuration on the server.

FALSE specifies to not use the default configuration on the server. If the value is FALSE, the value that is used is specified in the values of the properties of the component.

KeyErrorLimit

An integer value that specifies the number of key errors after which processing fails. This value is used only if the UseDefaultConfiguration attribute value is set to FALSE.

KeyErrorLogFile

A string value that specifies the file path to the file that is used to log key errors. This value is used only if the UseDefaultConfiguration attribute value is set to FALSE.

KeyErrorAction

An integer value that specifies the action to take upon encountering a key processing error.

The allowed values are the following:

0 – Convert the key to the "unknown" value.

1 – Discard the record.

This value is used only if the UseDefaultConfiguration attribute value is set to FALSE.

KeyErrorLimitAction

An integer value that specifies the action to take upon reaching the key error limit.

The allowed values are the following:

0 – Stop processing.

1 – Continue processing and stop logging.

This value is used only if the UseDefaultConfiguration attribute value is set to FALSE.

KeyNotFound

An integer value that specifies the action to take if a key is not found.

The allowed values are the following:

0 – Ignore the error.

1 – Report the error and continue.

2 – Report the error and stop processing.

This value is used only if the UseDefaultConfiguration attribute value is set to FALSE.

KeyDuplicate

An integer value that specifies the action to take if a duplicate key is found.

The allowed values are the following:

0 – Ignore the error.

1 – Report the error and continue.

2 – Report the error and stop processing.

This value is used only if the UseDefaultConfiguration attribute value is set to FALSE.

NullKeyConvertedToUnknown

An integer value that specifies the action to take if a null key is found and converted to "unknown".

The allowed values are the following:

0 – Ignore the error.

1 – Report the error and continue.

2 – Report the error and stop processing.

This value is used only if the UseDefaultConfiguration attribute value is set to FALSE.

NullKeyNotAllowed

An integer value that specifies the action to take if a null key is found that is not allowed.

The allowed values are the following:

0 – Ignore the error.

1 – Report the error and continue.

2 – Report the error and stop processing.

This value is used only if the UseDefaultConfiguration attribute value is set to FALSE.

ProcessType

An integer value that specifies the type of processing that is performed on the dimension.

The allowed values are the following:<40>

0 – Full processing.

1 – Processing to add to dimension.

2 – Update processing.

2.7.1.1.1.1.1.1.2.37   Partition Processing Destination Component

Partition Processing Destination Component loads and processes an Analysis Services partition. Partition Processing Destination Component MUST NOT use any Name attribute value on a property element except for those that are listed in the table in this section.

The following table specifies the Name attribute values that are allowed for Partition Processing Destination Component, in addition to any restrictions on the element value. These restrictions MUST be followed.

Name attribute value

Description

ObjectRef

A string value that contains a reference to an Analysis Management Objects (AMO) object that represents the partition, after it is looked up.<41>

UseDefaultConfiguration

A Boolean value that specifies whether to use the existing default configuration on the server.

TRUE specifies to use the existing default configuration on the server.

FALSE specifies to not use the default configuration on the server. If the value is FALSE, the values that are used are specified in the values of the properties of the component.

KeyErrorLimit

An integer value that specifies the number of key errors after which processing fails. This value is used only if the UseDefaultConfiguration attribute value is set to FALSE.

KeyErrorLogFile

A string value that specifies the file path to the file that is used to log key errors. This value is used only if the UseDefaultConfiguration attribute value is set to FALSE.

KeyErrorAction

An integer value that specifies the action to take upon encountering a key processing error.

The allowed values are the following:

0 – Convert the key to the "unknown" value.

1 – Discard the record.

This value is used only if the UseDefaultConfiguration attribute value is set to FALSE.

KeyErrorLimitAction

An integer value that specifies the action to take upon reaching the key error limit.

The allowed values are the following:

0 – Stop processing.

1 – Continue processing and stop logging.

This value is used only if the UseDefaultConfiguration attribute value is set to FALSE.

KeyNotFound

An integer value that specifies the action to take if a key is not found.

The allowed values are the following:

0 – Ignore the error.

1 – Report the error and continue.

2 – Report the error and stop processing.

This value is used only if the UseDefaultConfiguration attribute value is set to FALSE.

KeyDuplicate

An integer value that specifies the action to take if a duplicate key is found.

The allowed values are the following:

0 – Ignore the error.

1 – Report the error and continue.

2 – Report the error and stop processing.

This value is used only if the UseDefaultConfiguration attribute value is set to FALSE.

NullKeyConvertedToUnknown

An integer value that specifies the action to take if a null key is found and converted to "unknown".

The allowed values are the following:

0 – Ignore the error.

1 – Report the error and continue.

2 – Report the error and stop processing.

This value is used only if the UseDefaultConfiguration attribute value is set to FALSE.

NullKeyNotAllowed

An integer value that specifies the action to take if a null key is found that is not allowed.

The allowed values are the following:

0 – Ignore the error.

1 – Report the error and continue.

2 – Report the error and stop processing.

This value is used only if the UseDefaultConfiguration attribute value is set to FALSE.

ProcessType

An integer value that specifies the type of processing that is performed on the dimension. The allowed values are the following:<42>

0 – Full processing.

1 – Processing to add to dimension.

2 – Update processing.

2.7.1.1.1.1.1.1.2.38   Raw File Destination Component

Raw File Destination Component writes raw data to a file in a format that is native to the file type. Raw File Destination Component MUST NOT use any Name attribute value on a property element except for those that are listed in the table in this section.

The following table specifies the Name attribute values that are allowed for Raw File Destination Component, in addition to any restrictions on the element value. These restrictions MUST be followed.

Name attribute value

Description

AccessMode

An integer value that specifies whether the file is specified in the XML or is specified as the value of a variable.

The allowed values are the following:

0 – The file name is specified in the XML.

1 – The file name is specified as the value of a variable.

FileName

A string value that specifies the name of the file for output. This value is used only if the value of the AccessMode attribute is "0".

FileNameVariable

A string value that specifies the name of the variable that contains the file name for the output file. This value applies only if the value for the AccessMode attribute is equal to "1".

WriteOption

An integer value that specifies the action to take for the file write operation.

The allowed values are the following:

0 – Always create the file.

1 – Create the file one time only.

2 – Append to an existing file.

3 – Truncate the file and append.

2.7.1.1.1.1.1.1.2.39   RecordSet Destination Component

RecordSet Destination Component creates and populates an in-memory ADO recordset. RecordSet Destination Component MUST NOT use any Name attribute value on a property element except for those that are listed in the table in this section.

The following table specifies the Name attribute values that are allowed for RecordSet Destination Component, in addition to any restrictions on the element value. These restrictions MUST be followed.

Name attribute value

Description

VariableName

A string value that specifies the name of the variable that holds the ADO recordset.

2.7.1.1.1.1.1.1.2.40   SQL Server Compact Edition Destination Component

SQL Server Compact Edition Destination Component loads data into a SQL Server Compact Edition database. SQL Server Compact Edition Destination Component MUST NOT use any Name attribute value on a property element except for those that are listed in the table in this section.

The following table specifies the Name attribute values that are allowed for SQL Server Compact Edition Destination Component, in addition to any restrictions on the element value. These restrictions MUST be followed.

Name attribute value

Description

TableName

A string value that specifies the name of the destination table in the SQL Server Compact Edition database.

UserComponentTypeName

A string value that specifies the fully qualified .NET Framework assembly name for the component.

2.7.1.1.1.1.1.1.2.41   SQL Server Destination Component

SQL Server Destination Component connects to a local SQL Server database and bulk loads data into SQL Server tables and views on a server that is local to where the package is executing. SQL Server Destination Component MUST NOT use any Name attribute value on a property element except for those that are listed in the table in this section.

The following table specifies the Name attribute values that are allowed for SQL Server Destination Component, in addition to any restrictions on the element value. These restrictions MUST be followed.

Name attribute value

Description

DefaultCodePage

An integer value that specifies the default code page to use if code page information is not available from the data source.

AlwaysUseDefaultCodePage

A Boolean value that specifies whether to always use the value for the code page that is given in the DefaultCodePage attribute.

TRUE specifies to always use the value that is given in the DefaultCodePage attribute for the code page value.

FALSE specifies to first try to derive the code page value from the data source. If the code page value cannot be derived from the data source, the DefaultCodePage attribute value is used.

BulkInsertTableName

A string value that specifies the table name to use for the bulk insert operation.

BulkInsertCheckConstraints

A Boolean value that specifies whether constraints on the table are checked during the bulk insert operation.

TRUE specifies that constraints are checked.

FALSE specifies that constraints are not checked.

BulkInsertFirstRow

An integer value that specifies the row in the table at which insertion begins.<43>

BulkInsertFireTriggers

A Boolean value that specifies whether insert triggers that are specified for the table are fired during the bulk insert operation.

TRUE specifies that triggers are fired during the bulk insert operation.

FALSE specifies that triggers are not fired during the bulk insert operation.

BulkInsertKeepIdentity

A Boolean value that specifies whether to keep data values from the data file for values for identity columns.

TRUE specifies that the values that are present in the data file are kept for identity columns.

FALSE specifies that the values that are present in the data file for identity columns are not kept.

BulkInsertKeepNulls

A Boolean value that specifies whether null values in the input are retained.

TRUE specifies that null values in the input are retained.

FALSE specifies that a default value is used if a null value is encountered in the input.

BulkInsertLastRow

An integer value that specifies the row in the data file at which insertion ends.<44>

BulkInsertMaximumErrors

An integer value that specifies the maximum number of errors that are allowed.

BulkInsertOrder

A string value that specifies the columns that are used for sorting.

BulkInsertTablock

A Boolean value that specifies whether a table level lock is acquired for the bulk insert operation.

TRUE specifies that a table level lock is acquired for the bulk insert operation.

FALSE specifies that a table level lock is not acquired for the bulk insert operation.

Timeout

An integer value that specifies the number of seconds that the destination waits for records to insert before the operation times out.<45>

MaxInsertCommitSize

An integer value that specifies the maximum number of rows to insert in a single batch.<46>

2.7.1.1.1.1.1.1.2.42   ADO.NET Source Component

ADO.NET Source Component accepts data from an ADO.NET-compliant database as its source of data. ADO.NET Source Component MUST NOT use any Name attribute value on a property element except for those that are listed in the table in this section.

The following table specifies the Name attribute values that are allowed for ADO.NET Source Component, in addition to any restrictions on the element value. These restrictions MUST be followed.

Name attribute value

Description

SqlCommand

A string value that specifies an SQL SELECT command string that populates the lookup table.

CommandTimeout

An integer value that specifies the number of seconds that elapse before the command times out.<47>

AllowImplicitStringConversion

A Boolean value that specifies whether external metadata types are converted to the type that the destination requires.

TRUE specifies that external types are converted to strings.

FALSE specifies that no error is generated if there is a mismatch between the external metadata type and a column that requires a string.<48>

TableOrViewName

A string value that specifies the name of the table or view for the task.

AccessMode

An integer value that specifies the access mode to the ADO.NET data.

The allowed values are the following:

0 – Table or view.

2 – SQL command.

UserComponentTypeName

A string value that specifies the fully qualified .NET Framework assembly name for the component.

2.7.1.1.1.1.1.1.2.43   Excel Source Component

Excel Source Component accepts data from an Office Excel workbook as its source of data. Excel Source Component MUST NOT use any Name attribute value on a property element except for those that are listed in the table in this section.

The following table specifies the Name attribute values that are allowed for Excel Source Component, in addition to any restrictions on the element value. These restrictions MUST be followed.

Name attribute value

Description

CommandTimeout

An integer value that specifies the number of seconds that elapse before the command times out.<49>

OpenRowset

A string value that specifies the name of the table or view that is used. This value is used when the AccessMode attribute is set to the value "0" or "3".

OpenRowsetVariable

A string value that specifies the name of the variable that contains the name of the table or view that is used. This value is used when the AccessMode attribute is set to the value "1" or "4".

SqlCommand

A string value that specifies the SQL command that is used. This value is used when the AccessMode attribute is set to the value "2".

SqlCommandVariable

A string value that specifies the name of the variable that contains the SQL command that is executed.

AccessMode

An integer value that specifies how to access the data in the Office Excel sheet.

The allowed values are the following:

0 – Use "open rowset" to open the Office Excel data.

1 – Use "open rowset" from the value that is contained in a variable to open the Office Excel data.

2 – Use an SQL command to open the Office Excel data.

3 – Use an SQL command that is contained in a variable to open the Office Excel data.

ParameterMapping

A string value that specifies the mapping of SQL parameters to values that are contained in variables.

2.7.1.1.1.1.1.1.2.44   Flat File Source Component

Flat File Source Component accepts data from a flat file as its source of data. Flat File Source Component MUST NOT use any Name attribute value on a property element except for those that are listed in the table in this section.

The following table specifies the Name attribute values that are allowed for Flat File Source Component, in addition to any restrictions on the element value. These restrictions MUST be followed.

Name attribute value

Description

RetainNulls

A Boolean value that specifies whether to retain NULL values that are obtained from the source during the pipeline processing.

TRUE specifies that NULL values are retained during pipeline processing.

FALSE specifies that NULL values are not retained.

FileNameColumnName

A string value that specifies the name of the output column that contains the file name for the flat file source file.

2.7.1.1.1.1.1.1.2.45   OLE DB Source Component

OLE DB Source Component accepts data from an OLE DB–compliant database as its source of data. OLE DB Source Component MUST NOT use any Name attribute value on a property element except for those that are listed in the table in this section.

The following table specifies the Name attribute values that are allowed for OLE DB Source Component, in addition to any restrictions on the element value. These restrictions MUST be followed.

Name attribute value

Description

CommandTimout

An integer value that specifies the number of seconds that elapse before the command times out.<50>

OpenRowset

A string value that specifies the name of the table or view that is used. This value is used when the AccessMode attribute is set to the value "0" or "3".

OpenRowsetVariable

A string value that specifies the name of the variable that contains the name of the table or view that is used. This value is used when the AccessMode attribute is set to the value "1" or "4".

SqlCommand

A string value that specifies the SQL command that is used. This value is used when the AccessMode attribute is set to value "2".

DefaultCodePage

An integer value that specifies the default code page to use if code page information is not available from the data source.

AlwaysUseDefaultCodePage

A Boolean value that specifies whether to always use the value for the code page given in the DefaultCodePage attribute.

TRUE specifies to always use the value given in the DefaultCodePage attribute for the code page value.

FALSE specifies to first try to derive the code page value from the data source. If the code page value cannot be derived from the data source, the DefaultCodePage attribute value is used.

AccessMode

An integer value that specifies how to access the data in the Microsoft Office Excel sheet. The allowed values are the following:

0 – Use "open rowset" to open the Office Excel data.

1 – Use "open rowset" from the value that is contained in a variable to open the Office Excel data.

2 – Use an SQL command to open the Office Excel data.

3 – Use an SQL command that is contained in a variable to open the Office Excel data.

ParameterMapping

A string value that specifies the mapping of SQL parameters to values that are contained in variables.

2.7.1.1.1.1.1.1.2.46   Raw File Source Component

Raw File Source Component accepts data from a raw file as its source of data. Raw File Source Component MUST NOT use any Name attribute value on a property element except for those that are listed in the table in this section.

The following table specifies the Name attribute values that are allowed for Raw File Source Component, in addition to any restrictions on the element value. These restrictions MUST be followed.

Name attribute value

Description

AccessMode

An integer value that specifies whether the file is specified in the XML or is specified as the value of a variable.

The allowed values are the following:

0 – File name is specified in the package file.

1 – File name is specified as the value of a variable.

FileName

A string value that specifies the name of the file for output. This value is used only if the value of the AccessMode attribute is "0".

FileNameVariable

A string value that specifies the name of the variable that contains the file name for the output file. This value applies only if the value for the AccessMode attribute is equal to "1".

2.7.1.1.1.1.1.1.2.47   XML Source Component

XML Source Component accepts data from an XML file as its source of data. XML Source Component MUST NOT use any Name attribute value on a property element except for those that are listed in the table in this section.

The following table specifies the Name attribute values that are allowed for XML Source Component, in addition to any restrictions on the element value. These restrictions MUST be followed.

Name attribute value

Description

UserComponentTypeName

A string value that specifies the fully qualified .NET Framework assembly name for the component.

XMLData

A string value that specifies the file name or variable name that contains the XML. The content of the string is dependent upon the value of the AccessMode attribute.

XMLDataVariable

A string value that specifies the name of the variable that contains the XML data.

AccessMode

An integer value that specifies the mode of access of the XML.

The allowed values are the following:

0 – XML file.

1 - XML file from the value of a variable.

2 – XML data from the value of a variable.

XMLSchemaDefinition

A string value that contains an inline XML Schema definition. This value is used only if the UseInlineSchema attribute value is set to TRUE.

UseInlineSchema

A Boolean value that specifies whether an inline XML Schema definition is used.

TRUE specifies that an inline XML Schema definition is used.

FALSE specifies that an inline XML Schema definition is not used.