Edit

Configure the sign in credentials for the SQL adapter

  • Article

The SQL adapter requires the adapter clients to provide client credentials. The adapter uses these credentials to authenticate the user with SQL Server and to establish a connection.

Adapter clients can provide the client credentials both when using Visual Studio and when using the BizTalk Server Administration console. When using Visual Studio, credentials are required to generate the metadata. When using the BizTalk Server Administration console, credentials are required to perform operations on SQL Server.

This section provides information about specifying client credentials in Visual Studio and the BizTalk Server Administration console.

Enter credentials from Visual Studio

From Visual Studio, you can specify the credentials using the Consume Adapter Service Add-in or the Add Adapter Metadata Wizard.

Using Consume Adapter Service Add-in

  1. Right-click your BizTalk project, point to Add, and then select Add Generated Items.

  2. In the Add Generated Items dialog box, do the following:

    Use this To do this
    Categories Click Consume Adapter Service.
    Templates Click Consume Adapter Service.

  3. To start the Consume Adapter Service dialog box, click Add.

  4. In the Consume Adapter Service dialog box, from the Select a binding list, select sqlBinding, and then click Configure.

  5. In the Configure Adapter dialog box, click the Security tab, and from the Client credential type list, do one of the following:

    Note

    If you are connecting to SQL Server using Windows Authentication, the Windows user with which you are logged in must be added to SQL Server as described in Connect to SQL Server Using Windows Authentication with the SQL adapter.

    Click this To do this
    None Connect to SQL Server by using Windows authentication.
    Windows Connect to SQL Server by using Windows authentication.
    Username Specify the user name and password to connect to SQL Server by specifying credentials for a user defined in SQL Server database. Note that the user name and password are case-sensitive. Note: If you leave the User name and Password fields as blank, the adapter connects to SQL Server using Windows authentication.

  6. Click OK.

Using Add Adapter Metadata Wizard

  1. Right-click your BizTalk project, point to Add, and then select Add Generated Items.

  2. In the Add Generated Items dialog box, do the following:

    Use this To do this
    Categories Click Add Adapter.
    Templates Click Add Adapter Metadata.

  3. Click Add. The Add Adapter Metadata Wizard opens.

  4. In the Add Adapter Wizard, select WCF-SQL. Select the computer on which BizTalk Server is installed and the name of the BizTalk database.

    Important

    If you already have a WCF-SQL port configured in BizTalk, select the port from the Port list.

  5. Click Next.

  6. In the Consume Adapter Service dialog box, from the Select a binding list, select sqlBinding, and then click Configure.

  7. In the Configure Adapter dialog box, click the Security tab, and from the Client credential type list, do one of the following:

    Note

    If you are connecting to SQL Server using Windows Authentication, the Windows user with which you are logged in must be added to SQL Server as described in Connect to SQL Server Using Windows Authentication with the SQL adapter.

    Click this To do this
    None Connect to SQL Server by using Windows authentication.
    Windows Connect to SQL Server by using Windows authentication.
    Username Specify the user name and password to connect to SQL Server by specifying credentials for a user defined in SQL Server database. Note that the user name and password are case-sensitive. Note: If you leave the User name and Password fields as blank, the adapter connects to SQL Server using Windows authentication.

  8. Click OK.

Enter credentials from the BizTalk Server Administration Console

From the BizTalk Server Administration console, you can specify the credentials as part of the WCF-Custom or WCF-SQL port configuration.

Enter credentials for the WCF-Custom port

  1. Start the BizTalk Server Administration console.

  2. In the console tree, expand BizTalk Group, then expand Applications, and then expand the application under which you want to create a port, and click Send Ports or Receive Ports. In the right pane, you can choose to create a port or select an existing port.

  3. In the port properties dialog box, from the Type drop-down list, select WCF-Custom, and then click Configure.

    Note

    To see the location properties dialog box for a receive port, click the Receive Location tab on the left pane of the port properties dialog box, and then click New.

  4. If you are creating a send port, in the WCF-Custom Transport Properties dialog box, click the Credentials tab, and do one of the following:

    • Select the Do not use Single Sign-On option, and specify the user name and password to connect to SQL Server. Note that the user name and password are case-sensitive.

      Note

      If you want to connect to SQL Server using Windows authentication, specify a blank user name and password. Before you do this, the Windows user with which you are logged in must be added to SQL Server as described in Connect to SQL Server Using Windows Authentication with the SQL adapter.

    • Select the Use Single Sign-On option, and specify an affiliate Enterprise Single Sign-on (SSO) application.

  5. If you are creating a receive port, in the WCF-Custom Transport Properties dialog box, click the Other tab, and do one of the following:

    • Select the User account option, and specify the user name and password to connect to SQL Server. Note that the user name and password are case-sensitive.

      Note

      If you want to connect to SQL Server using Windows authentication, specify a blank user name and password. Before you do this, the Windows user with which you are logged in must be added to SQL Server as described in Connect to SQL Server Using Windows Authentication with the SQL adapter.

    • Select the Get credentials from affiliate application option, and specify an affiliate SSO application.

  6. Click OK.

Enter credentials for the WCF-SQL port

  1. Start the BizTalk Server Administration console.

  2. Add the WCF-SQL adapter to the BizTalk Server Administration console. For instructions, see Adding the SQL Adapter to BizTalk Server Administration Console.

  3. In the console tree, expand BizTalk Group, then expand Applications, and then expand the application under which you want to create a port, and click Send Ports or Receive Ports. In the right pane, you can choose to create a port or select an existing port.

  4. In the port properties dialog box, from the Type drop-down list, select the WCF-SQL adapter you added earlier, and then click Configure.

    Note

    To see the location properties dialog box for a receive port, click the Receive Location tab on the left pane of the port properties dialog box, and then click New.

  5. If you are creating a send port, in the transport properties dialog box, click the Credentials tab, and do one of the following:

    • Select the Do not use Single Sign-On option, and specify the user name and password to connect to SQL Server. Note that the user name and password are case-sensitive.

      Note

      If you want to connect to SQL Server using Windows authentication, specify a blank user name and password. Before you do this, the Windows user with which you are logged in must be added to SQL Server as described in Connect to SQL Server Using Windows Authentication with the SQL adapter.

    • Select the Use Single Sign-On option, and specify an affiliate Enterprise Single Sign-on (SSO) application.

  6. If you are creating a receive port, in the transport properties dialog box, click the Other tab, and do one of the following:

    • Select the User account option, and specify the user name and password to connect to SQL Server. Note that the user name and password are case-sensitive.

      Note

      If you want to connect to SQL Server using Windows authentication, specify a blank user name and password. Before you do this, the Windows user with which you are logged in must be added to SQL Server as described in Connect to SQL Server Using Windows Authentication with the SQL adapter.

    • Select the Get credentials from affiliate application option, and specify an affiliate SSO application.

  7. Click OK.

See Also

Building blocks to develop BizTalk applications with the SQL adapter