Home > Articles > Data > SQL Server

Creating a User Interface for a Custom DTS Task

Marcelino Santos shows you how to add a user interface when creating a custom DTS task. This article builds on the example of creating a custom DTS task as outlined in the book. The custom task example takes an ADO recordset data previously saved (by an ExecuteSQL task) in a global variable. The custom task then generates an HTML table containing the recordset data and writes the HTML text to a text file. The file can then be easily "included" in a Web page and displayed.
This article is excerpted from SQL Server DTS, by Steve Hughes, Steve Miller, Jim Samuelson, Marcelino Santos, and Brian Sullivan.
Like this article? We recommend

Like this article? We recommend

When creating a custom DTS task, a property page is typically used to display all the properties of the task object. The default properties provider in DTS Designer will display a default property page if you do not implement a custom task user interface for your custom task. If you plan to provide a user interface for your custom task, you can create a form that will be the property page for that user interface.

In Visual Basic, choose Add Form from the Project menu to bring up the Add Form dialog box.

Make sure that the icon named Form is selected; then click on the Open button. This will add a regular form named Form1 to your project. Change the name of the form to frmGenHTMLTaskProperties (or whatever form name you prefer). Also, change the form's caption to Generate HTML Task Properties.

With the form selected in the Project window, choose Object from the View menu to display the blank form. Add the form elements in Table 1 to the form.

Table 1 Form Elements for the Property Page



















Generate HTML Task: undefined








Global Variable:









2-Drop-down List





















The form needs a TaskObject property that will contain the instance of the task object provided to the form during run time. When this property is set, it needs to do several things:

  • Display the task description in the form.

  • Load the names of global variables into the combo box.

  • Select the current global variable in the combo box (if already set).

  • Set the drive, path, and filename in DriveListBox, DirListBox, and FileListBox.

  • Display the current filename in the form.

Listing 1 shows the code that does all these things.

Listing 1-Initializing a Properties Form for the Custom Task

Private oTask As DTS.Task
Private oCustomTask As clsMyTask

Public Property Set TaskObject (ByVal pTask As DTS.Task)
   Dim oTasks As DTS.Tasks
   Dim oPkg As DTS.Package
   Dim i As Integer
   Dim SaveIndex As Integer

   On Error Resume Next

   If Not pTask Is Nothing Then
    If TypeOf pTask Is DTS.Task Then
     Set oTask = pTask
     Set oCustomTask = pTask.CustomTask

     'Display the custom task's description
     txtDescription.Text = oCustomTask.Description

     'Get a reference to the containing package
     Set oTasks = oTask.Parent
     Set oPkg = oTasks.Parent

     'Load the names of the global variables into the combobox
     For i = 1 To oPkg.GlobalVariables.Count
       'Add only variables of type recordset
       If TypeName(oPkg.GlobalVariables(i).Value) = "Recordset" Then
        cboGlobalVars.AddItem oPkg.GlobalVariables(i).Name
       End If
     Next I

     'Select the current global variable in the combobox
     If oCustomTask.GlobalVarName <> "" Then
       For i = 0 To cboGlobalVars.ListCount - 1
        If cboGlobalVars.List(i) = oCustomTask.GlobalVarName Then
         cboGlobalVars.ListIndex = I
         Exit For
        End If
       Next i
     End If

     'Display the current path and file names
     drvDestination.Drive = Left(oCustomTask.Pathname, 1)
     dirDestination.Path = oCustomTask.Pathname
     filDestination.Filename = oCustomTask.Filename
     txtFilename.Text = oCustomTask.Filename
     Err.Raise 1027 + vbObjectError, Me.Name, "Parameter pTask is not a Task "
    End If
    Err.Raise 1027 + vbObjectError, Me.Name, "Parameter pTask is Nothing"
   End If
End Property

When the Cancel button is clicked, the form will have to be unloaded:
Private Sub cmdCancel_Click()
   Unload Me
End Sub

Finally, when the Close button is clicked, the properties have to be updated, and the form has to be unloaded (see Listing 2). 1

Listing 2-Setting the Custom Task's Custom Properties

Private Sub cmdClose_Click()
   If txtDescription.Text = "" Then
    MsgBox "Please enter a description.",, "Description"
    Exit Sub
    oCustomTask.Description = txtDescription.Text
   End If

   If cboGlobalVars.Text = "" Then
    MsgBox "Please select a global variable.",,"Global Variable"
    Exit Sub
    oCustomTask.GlobalVarName = cboGlobalVars.Text
   End If

   oCustomTask.Pathname = dirDestination.Path

   If txtFilename.Text = "" Then
    MsgBox "Please enter a filename.",, "Filename"
    Exit Sub
    oCustomTask.Filename = txtFilename.Text
   End If

   Unload Me
End Sub

About This Article

This article is excerpted from SQL Server DTS by Steve Hughes, Steve Miller, Jim Samuelson, Marcelino Santos, and Brian Sullivan (New Riders Publishing (http://www.newriders.com), 2001, ISBN 0735711232). Refer to Chapter 16, "Creating Your Own Custom Task," for more detailed information on the material covered in this article.

InformIT Promotional Mailings & Special Offers

I would like to receive exclusive offers and hear about products from InformIT and its family of brands. I can unsubscribe at any time.


Pearson Education, Inc., 221 River Street, Hoboken, New Jersey 07030, (Pearson) presents this site to provide information about products and services that can be purchased through this site.

This privacy notice provides an overview of our commitment to privacy and describes how we collect, protect, use and share personal information collected through this site. Please note that other Pearson websites and online products and services have their own separate privacy policies.

Collection and Use of Information

To conduct business and deliver products and services, Pearson collects and uses personal information in several ways in connection with this site, including:

Questions and Inquiries

For inquiries and questions, we collect the inquiry or question, together with name, contact details (email address, phone number and mailing address) and any other additional information voluntarily submitted to us through a Contact Us form or an email. We use this information to address the inquiry and respond to the question.

Online Store

For orders and purchases placed through our online store on this site, we collect order details, name, institution name and address (if applicable), email address, phone number, shipping and billing addresses, credit/debit card information, shipping options and any instructions. We use this information to complete transactions, fulfill orders, communicate with individuals placing orders or visiting the online store, and for related purposes.


Pearson may offer opportunities to provide feedback or participate in surveys, including surveys evaluating Pearson products, services or sites. Participation is voluntary. Pearson collects information requested in the survey questions and uses the information to evaluate, support, maintain and improve products, services or sites, develop new products and services, conduct educational research and for other purposes specified in the survey.

Contests and Drawings

Occasionally, we may sponsor a contest or drawing. Participation is optional. Pearson collects name, contact information and other information specified on the entry form for the contest or drawing to conduct the contest or drawing. Pearson may collect additional personal information from the winners of a contest or drawing in order to award the prize and for tax reporting purposes, as required by law.


If you have elected to receive email newsletters or promotional mailings and special offers but want to unsubscribe, simply email information@informit.com.

Service Announcements

On rare occasions it is necessary to send out a strictly service related announcement. For instance, if our service is temporarily suspended for maintenance we might send users an email. Generally, users may not opt-out of these communications, though they can deactivate their account information. However, these communications are not promotional in nature.

Customer Service

We communicate with users on a regular basis to provide requested services and in regard to issues relating to their account we reply via email or phone in accordance with the users' wishes when a user submits their information through our Contact Us form.

Other Collection and Use of Information

Application and System Logs

Pearson automatically collects log data to help ensure the delivery, availability and security of this site. Log data may include technical information about how a user or visitor connected to this site, such as browser type, type of computer/device, operating system, internet service provider and IP address. We use this information for support purposes and to monitor the health of the site, identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents and appropriately scale computing resources.

Web Analytics

Pearson may use third party web trend analytical services, including Google Analytics, to collect visitor information, such as IP addresses, browser types, referring pages, pages visited and time spent on a particular site. While these analytical services collect and report information on an anonymous basis, they may use cookies to gather web trend information. The information gathered may enable Pearson (but not the third party web trend services) to link information with application and system log data. Pearson uses this information for system administration and to identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents, appropriately scale computing resources and otherwise support and deliver this site and its services.

Cookies and Related Technologies

This site uses cookies and similar technologies to personalize content, measure traffic patterns, control security, track use and access of information on this site, and provide interest-based messages and advertising. Users can manage and block the use of cookies through their browser. Disabling or blocking certain cookies may limit the functionality of this site.

Do Not Track

This site currently does not respond to Do Not Track signals.


Pearson uses appropriate physical, administrative and technical security measures to protect personal information from unauthorized access, use and disclosure.


This site is not directed to children under the age of 13.


Pearson may send or direct marketing communications to users, provided that

  • Pearson will not use personal information collected or processed as a K-12 school service provider for the purpose of directed or targeted advertising.
  • Such marketing is consistent with applicable law and Pearson's legal obligations.
  • Pearson will not knowingly direct or send marketing communications to an individual who has expressed a preference not to receive marketing.
  • Where required by applicable law, express or implied consent to marketing exists and has not been withdrawn.

Pearson may provide personal information to a third party service provider on a restricted basis to provide marketing solely on behalf of Pearson or an affiliate or customer for whom Pearson is a service provider. Marketing preferences may be changed at any time.

Correcting/Updating Personal Information

If a user's personally identifiable information changes (such as your postal address or email address), we provide a way to correct or update that user's personal data provided to us. This can be done on the Account page. If a user no longer desires our service and desires to delete his or her account, please contact us at customer-service@informit.com and we will process the deletion of a user's account.


Users can always make an informed choice as to whether they should proceed with certain services offered by InformIT. If you choose to remove yourself from our mailing list(s) simply visit the following page and uncheck any communication you no longer want to receive: www.informit.com/u.aspx.

Sale of Personal Information

Pearson does not rent or sell personal information in exchange for any payment of money.

While Pearson does not sell personal information, as defined in Nevada law, Nevada residents may email a request for no sale of their personal information to NevadaDesignatedRequest@pearson.com.

Supplemental Privacy Statement for California Residents

California residents should read our Supplemental privacy statement for California residents in conjunction with this Privacy Notice. The Supplemental privacy statement for California residents explains Pearson's commitment to comply with California law and applies to personal information of California residents collected in connection with this site and the Services.

Sharing and Disclosure

Pearson may disclose personal information, as follows:

  • As required by law.
  • With the consent of the individual (or their parent, if the individual is a minor)
  • In response to a subpoena, court order or legal process, to the extent permitted or required by law
  • To protect the security and safety of individuals, data, assets and systems, consistent with applicable law
  • In connection the sale, joint venture or other transfer of some or all of its company or assets, subject to the provisions of this Privacy Notice
  • To investigate or address actual or suspected fraud or other illegal activities
  • To exercise its legal rights, including enforcement of the Terms of Use for this site or another contract
  • To affiliated Pearson companies and other companies and organizations who perform work for Pearson and are obligated to protect the privacy of personal information consistent with this Privacy Notice
  • To a school, organization, company or government agency, where Pearson collects or processes the personal information in a school setting or on behalf of such organization, company or government agency.


This web site contains links to other sites. Please be aware that we are not responsible for the privacy practices of such other sites. We encourage our users to be aware when they leave our site and to read the privacy statements of each and every web site that collects Personal Information. This privacy statement applies solely to information collected by this web site.

Requests and Contact

Please contact us about this Privacy Notice or if you have any requests or questions relating to the privacy of your personal information.

Changes to this Privacy Notice

We may revise this Privacy Notice through an updated posting. We will identify the effective date of the revision in the posting. Often, updates are made to provide greater clarity or to comply with changes in regulatory requirements. If the updates involve material changes to the collection, protection, use or disclosure of Personal Information, Pearson will provide notice of the change through a conspicuous notice on this site or other appropriate way. Continued use of the site after the effective date of a posted revision evidences acceptance. Please contact us if you have questions or concerns about the Privacy Notice or any objection to any revisions.

Last Update: November 17, 2020