DTSCacheWarmer Object [C++]
Use this object to pre-execute dynamic OLAP reports stored in the Data Warehouse in order for the query results to be cached on the OLAP server. When this is done, subsequent execution of the reports can be twice as fast as the original report execution.
Run this object from within the context of a Data Transformation Services (DTS) package. Do not access the methods and properties directly. For more information about scripting the Report Caching DTS task, see Scripting the Report Caching DTS Task.
| ProgID: | Commerce.DTSCacheWarmer (Externally creatable) |
| COM Class Name: | DTSCacheWarmer |
| Type Library Name: | Microsoft Commerce 2002 OLAP Cache Warmer DTS Task Type Library |
| DLL Name: | CSDWDTSCacheWarm.dll |
| Threading Model: | Apartment |
[C++]
| COM Interface Name: | _DTSCacheWarmer |
| Interface ID Constant: | None |
| Header File: | None |
Methods
[C++]
| Method | Description |
|---|---|
| CustomTask_Execute | Executes the DTS task. This method is called indirectly when a task is run through a DTS package and should not be used when scripting this task. |
| PersistPropertyBag_Load | Loads the DTS task properties. This method is called indirectly when a task is run through a DTS package and should not be used when scripting this task. |
| PersistPropertyBag_Save | Saves the DTS task properties. This method is called indirectly when a task is run through a DTS package and should not be used when scripting this task. |
[Visual Basic]
| Method | Description |
|---|---|
| CustomTask_Execute | Executes the DTS task. This method is called indirectly when a task is run through a DTS package and should not be used when scripting this task. |
| PersistPropertyBag_Load | Loads the DTS task properties. This method is called indirectly when a task is run through a DTS package and should not be used when scripting this task. |
| PersistPropertyBag_Save | Saves the DTS task properties. This method is called indirectly when a task is run through a DTS package and should not be used when scripting this task. |
Properties
[C++]
| Property | Type | Description |
|---|---|---|
| NumRetries | long | Stores the number of retry attempts that will be made after a SQL connection/query failure.
This property is read/write. |
| RetryInterval | long | Stores the number of seconds between retry attempts.
This property is read/write. |
| SourceName | BSTR | Specifies the Web site or Data Warehouse for which this task is processing data.
This property is write-only. |
| SourceType | long | An enumeration that specifies the level on which the DTS task will operate.
This property is read/write. |
| TaskName | BSTR | The descriptive name of the task associated with the package.
This property is read/write. |
[Visual Basic]
| Property | Type | Description |
|---|---|---|
| NumRetries | Long | Stores the number of retry attempts that will be made after a SQL connection/query failure.
This property is read/write. |
| RetryInterval | Long | Stores the number of seconds between retry attempts.
This property is read/write. |
| SourceName | String | Specifies the Web site or Data Warehouse for which this task is processing data.
This property is write-only. |
| SourceType | Long | An enumeration that specifies the level on which the DTS task will operate.
This property is read/write. |
| TaskName | String | The descriptive name of the task associated with the package.
This property is read/write. |
Remarks
The Report Caching DTS task ignores errors that occur while running reports. For errors encountered during task execution that are not related to running reports, the task immediately stops processing and returns the error code through the Visual Basic error throwing mechanisms to the CustomTask_Execute error handler. The handler uses the IsRetryableError method to determine if the error code indicates a retry, for example, server unavailable, or if the error is a fatal error condition. The handler determines the error condition by checking the value of the RetryableErrors field in the registery key REG_MULTI_SZ under HKLM\SOFTWARE\MICROSOFT\Commerce Server\OLAPCacheWarmer. If the HRESULT for the error is in the list below, the error is considered retryable. Otherwise, the error is considered fatal. If the RetryableErrors value does not exist, the Report Caching DTS task creates it and populates it with a set of default HRESULT error values.
The following table lists the retryable HRESULT error values initialized in the registry key.
| HRESULT | Description |
|---|---|
| 2147221457 | DSO cannot locate NT server. |
| 2147221455 | DSO cannot connect to Analysis Services. |
| 2147221468 | DSO analysis object locked. |
| 2147467259 | dbnetlib cannot connect to SQL Server. |
| 2147221424 | DSO 2000 cannot connect to Analysis Services. |
| 231XXXXXXX | DSO cannot connect to Analysis Datasource. |
If the error is considered retryable, the DTS task logs a localized message in the Task History table that it is retrying due to error %X and re-initiates the task execution within the CustomTask_Execute method.
If the error is not considered retryable or the error is retryable but the task used the maximum number of retries, then the task logs a failure message in the Task History table, sets the global automation error object using the SetErrorInfo method, and returns DTSTaskExecResult_Failure from the CustomTask_Execute method.
See Also
ETL Process for the Report Caching DTS Task
Scripting the Report Caching DTS Task
[C++]DTSLogImport Object
[C++]DTSMarketingImport Object
[C++]DTSPostImport Object
[C++]DTSPredictor Object
[C++]DTSTransactionImport Object
[Visual Basic]DTSDeleteImport Object
[Visual Basic]DTSIPResolution Object
[Visual Basic]DTSLogImport Object
[Visual Basic]DTSMarketingImport Object
[Visual Basic]DTSPostImport Object
[Visual Basic]DTSPredictor Object
[Visual Basic]DTSSynchAdminData Object
[Visual Basic]DTSTransactionImport Object
[Visual Basic]DTSUPMCustomTask Object
Copyright © 2005 Microsoft Corporation.
All rights reserved.