Microsoft KB Archive/825123

= How to configure properties and settings that are used by pipeline Application Integration Components (AIC) in BizTalk Server 2000 and 2002 =

Article ID: 825123

Article Last Modified on 12/3/2004

-

APPLIES TO


 * Microsoft BizTalk Server 2000 Standard Edition
 * Microsoft BizTalk Server 2002 Standard Edition

-





IN THIS TASK

 * INTRODUCTION
 * Configuration dialog anatomy
 * Use different input methods for a configuration page
 * Use Get methods to retrieve data
 * Examples



INTRODUCTION
This article discusses how to configure various properties and settings that are used by pipeline Application Integration Components (AIC). You can configure the properties by creating configuration dialog boxes for pipeline AICs by using methods that are included in Microsoft BizTalk Server 2000 and Microsoft BizTalk Server 2002. To access these settings, click Advanced on the Channel Properties Advanced Configuration page in BizTalk Messaging Manager.

back to the top

Two Active Server Pages (ASP)
When you configure an AIC or one of the transports that are supplied with BizTalk Server, notice that the configuration is one page of input fields that is similar to a standard Windows form. However, behind the configuration dialog boxes are the following two ASP files:
 * A .asp page
 * A _post.asp page

These ASP pages supply the logic that is required for the configuration dialog box. These ASP pages are named after the AIC component that they configure. For example, a component with a program ID of Biztalk.AIC would have the following two configuration pages:
 * BizTalk_AIC.asp
 * BizTalk_AIC_post.asp

The .asp page contains the statements that draw the user interface for the configuration panel. The _post.asp page is called when the user submits the information. Therefore, the whole configuration dialog is a Web page with various inputs on it. These inputs must feed data back to the object for storage in a SQL Server database. The input methods that are described in this article help you store this data in a SQL Server database.

Configuration page details
Examine the configuration pages for the file transport in the following example. First, examine the BizTalk_SendLocalFile_1.asp file. From the naming convention, this must match up to a component with a program ID of &quot;BizTalk.SendLocalFile.1&quot;. <%@ LANGUAGE = VBScript %> <% '- ' '  BizTalk_SendLocalFile_1.asp ' '  Microsoft BizTalk Server 2002 '  Copyright (C) Microsoft Corporation, 1998-2002. All rights reserved. ' '- %>

<%   call DisplayReadonlyText(&quot;Filename&quot;) call InputTextAccel(&quot;Username&quot;, L_SendLocalFileUserName_Accelerator) call InputPasswordAccel(&quot;Password&quot;, L_SendLocalFilePassword_Accelerator) %>     

These ASP pages supply the logic that is required for the configuration dialog box. These ASP pages are named after the AIC component that they configure. For example, a component with a program ID of Biztalk.AIC would have the following two configuration pages:

Notice the calls to the following methods:
 * DisplayReadonlyText
 * InputTextAccel
 * InputPasswordAccel

These methods that are included in the Pe_edit_header.asp file generate input text boxes in the configuration dialog box.

The  tag creates a table. Because the code starts with , it implies that the table is already opened. If you examine the code for the Pe_edit_header.asp file, notice that one of the last actions of the code is to create a table. This action makes sure that any configuration page that you create is already hosted in a table structure. The table structure contains calls to the InputRadioAccel method. These calls create input methods in the configuration dialog box. In this example, three option buttons are created.

The Pe_edit_footer.asp file contains code to close the table that was opened in the Pe_edit_header.asp file. The Pe_edit_footer.asp file creates another table to host the OK, Cancel, and Help buttons.

The BizTalk_SendLocalFile_1.asp file, together with the header, the footer, and the other Pe_*.asp files that are on the computer, generate the configuration dialog box, including input text fields.

The BizTalk_SendLocalFile_1.asp file generates the input text fields, but it does not handle the values that are submitted by the user. That process is performed by the BizTalk_SendLocalFile_1_post.asp file that is listed in the following example: <%@ LANGUAGE = VBScript %> <% '- ' '  BizTalk_SendLocalFile_1_post.asp ' '  Microsoft BizTalk Server 2002 '  Copyright (C) Microsoft Corporation, 1998-2002. All rights reserved. ' '- %>

<%

call GetInputText(&quot;Filename&quot;, 1, bufsize_medium) call GetInputNumber(&quot;CopyMode&quot;, 0, 2)

call GetInputText(&quot;Username&quot;, 0, bufsize_medium) call GetInputText(&quot;Password&quot;, 0, bufsize_medium)

%> The code for generating a page and the logic to submit the data is contained in various Pe*.asp files. You only have to write code for two files that create the inputs and retrieve the values.

back to the top

Input methods
Many pre-built input methods are available in the Pe*.asp files that you can use for a configuration page. These input methods include the following:
 * InputTextArea
 * InputTextAccel
 * InputText
 * InputNumber
 * InputNumberAccel
 * InputFloat
 * InputFloatAccel
 * InputPassword
 * InputPasswordAccel
 * DisplayReadonlyText
 * InputSelection
 * InputArray
 * InputArrayAccel
 * InputSimpleList
 * InputSimpleListAccel
 * InputOption
 * InputRadio
 * InputRadioAccel
 * InputCheckBox
 * InputCheckBoxAccel

Parameters
The following table describes the parameters that are used in the input methods:

Many of these methods accept only one parameter of. This value is the name of a dictionary item that is used by this transport. For example, in the following code, any value that is entered will be stored in the &quot;file_path&quot; dictionary key for this AIC: InputText(&quot;file_path&quot;)

Considerations with input methods
Some methods, such as the InputRadioAccel method, are a more complex. When you use one of these methods, note the following considerations:
 * The input method tries to build the HTML elements that are required to display the input text field. The method takes the field that you specify. Then, it tries to look up a label to display next to the input text box. The input method does this by trying to find a string that matches the field name and the AIC component name in the strings table that was created by the Global.asa file.

For example, for the file transport and a field of, the input method looks for a string in the table that is named &quot;label_SendLocalFile_ &quot;. If it cannot find that string, the input method only looks for the field name. In this case, that field name is &quot;label_ &quot;. If you examine the Global.asa file that is located in the :\Program Files\Microsoft BizTalk Server\Messaging Manager folder, you will find an entry for &quot;strings.label_ &quot;.

This entry points to a static value that was created in the Strings.asp file in the same folder. In this instance, we have an entry of &quot;Destination file name&quot; before the input field. If there is no matching entry in the strings table, the input method displays the field name.
 * The input method performs the same actions for the &quot;help field&quot; as it does for the input text field. The &quot;help field&quot; is a string of additional information that appears under the field. The input method first looks for &quot;help_SendLocalFile_ &quot;. If the input method cannot find &quot;help_SendLocalFile_ &quot;, it tries to look for &quot;help_ &quot;. If the input method cannot find &quot;help_ &quot; either, nothing appears.

The input method also retrieves the current value of the dictionary item that is specified in the field value. Then, it populates the input dialog according to this data.

back to the top

Get methods
To retrieve the data that is submitted by the input methods, the following pre-built Get methods exist:
 * GetInputPassword
 * GetInputText
 * GetSelection
 * GetInputNumber
 * GetInputFloat
 * GetCheckBox

Parameters
The Get methods include the following parameters:

The following constants for minimum and maximum values are predefined:
 * bufsize_small = 256
 * bufsize_medium = 1000
 * bufsize_large = 4000
 * max_int = 2000000000

When you submit the data in the form, the values that you submit are passed to the _post.asp page. The Get methods pull in the data. Then, they validate the data by using the minimum and maximum criteria. If the data is not valid, the Get methods display an error message. Then, the data is stored in the dictionary field for the AIC.

back to the top

Examples
For many of these examples, examine the configuration pages that are included with BizTalk Server for the built-in transports.

The BizTalk_SendLocalFile_1*.asp files have examples of the following methods:
 * InputText
 * InputTextAccel
 * InputPasswordAccel
 * InputRadioAccel

The BizTalk_SendHTTPX_1*.asp files use the following methods, in addition to custom code to implement a certificate drop-down list:
 * DisplayReadonlyText
 * InputCheckBoxAccel
 * InputNumberAccel

Most of the input methods are covered in the ASP pages that are included with BizTalk Server. Only the input methods that use a list name or an array are missing. To use an array, you must pass an array of objects to the method call. For example, use the following syntax: InputArray(&quot;testarray&quot;,array(&quot;item1&quot;,&quot;item2&quot;,&quot;item3&quot;))

Keywords: kbhowtomaster KB825123

-

[mailto:TECHNET@MICROSOFT.COM Send feedback to Microsoft]

© Microsoft Corporation. All rights reserved.