Database Functoids Reference

 

Use Database functoids to extract data from a database for use in an output instance message.

Database functoids fall into two categories. The first category consists of the Database Lookup, Error Return, and Value Extractor functoids, which are designed for general purpose retrieval of database values using Microsoft ActiveX Data Objects (ADO) recordsets. The second category consists of the Format****Message, Get Application ID, Get Application Value, Get Common ID, Get Common Value, Remove Application ID, and Set Common ID functoids, which correspond to the methods of the CrossReferencing class of the Microsoft.BizTalk.CrossReferencing API.

Note

Unlike other functoids, which are written in C#, the first category of Database functoids (Database Lookup, Error Return, and Value Extractor) are not accessible from inline script that is run by using the Scripting functoid. This restriction is not true of the second category of Database functoids (that correspond to the methods of the CrossReferencing class).

The Cross Referencing functoids—Format Message, Get Application ID, Get Application Value, Get Common ID, Get Common Value, Remove Application ID, and Set Common ID—look for data in specific SQL Server tables. For more information about how populate those tables and the structure of the input files, see Importing Data for the Cross Referencing Functoids.

For conceptual information about Databasefunctoids, see Database Functoids.

The following table shows the functoids in the Database category.

Database functoid Description
 Database Lookup Retrieves a row from a database table as an ADO recordset.
 Error Return Captures error information, such as database connection failures, that occur during run time.
 Format Message Returns a formatted and localized string using argument substitution and, potentially, ID and value cross referencing.
 Get Application ID Retrieves an identifier for an application object.
 Get Application Value Retrieves an application value.
 Get Common ID Retrieves an identifier for a common object.
 Get Common Value Retrieves a common value.
 Remove Application ID Removes the identifier for an application object.
 Set Common ID Sets and returns an identifier for a common object.
 Value Extractor Extracts the value from a specified column in an ADO recordset returned by the Database Lookup functoid.

This section also contains:

See Also

How to Add Basic Functoids to a Map