DS_Principal

Description

When you access an SAP Adaptive Server Enterprise database in PowerBuilder through Open Client, DS_Principal is one of several parameters that you can set to enable network-based directory services in your application. (For other directory services parameters, see the See Also section.)

Some directory service providers and drivers require an authenticated principal (user ID) name to control an application's access to directory entries. For those providers and drivers, DS_Principal and DS_Password specify the principal name and password your application should use to identify you to the directory service provider.

You must specify a value for DS_Principal before connecting to the database in PowerBuilder.

Using third-party directory service providers

For information about the third-party directory service providers and operating system platforms that has been tested with Open Client directory services, see the Open Client documentation.

Applies to

ASE, SYC SAP Adaptive Server Enterprise

Syntax

DS_Principal='principal_name'

Parameter

Description

principal_name

The principal (user ID) name your application should use to identify you to the directory service provider.


Default value

None

PowerBuilder does not set DS_Principal or the corresponding SAP Sybase Open Client Client-Library (CT-Lib) connection parameter CS_DS_PRINCIPAL if you do not specify a value.

Usage

When to use

If your directory service provider requires an authenticated principal name for directory access, set DS_Principal to the principal (user ID) name that goes with your directory service password.

Set Release parameter

For this parameter to take effect, you must also set the Release parameter to 11 or higher to specify that your application should use the appropriate version of SAP Sybase Open Client Client-Library (CT-Lib) behavior. See the description of the Release parameter for more information.

Requirements for use

To use DS_Principal or any other parameter supporting Open Client directory services, you must meet certain requirements for using directory services in your PowerBuilder application. For details, see the section called “Requirements for using Open Client directory services” in Connecting to Your Database.

Corresponding CT-Lib connection property

Specifying a value for DS_Principal sets the corresponding SAP Sybase CT-Lib connection property named CS_DS_PRINCIPAL.

Examples

To specify JSMITH as your application's principal name:

  • Database profile

    Type the following in the Principal Name box on the Directory Services page in the Database Profile Setup dialog box:

    JSMITH
  • Application

    Type the following in code:

    SQLCA.DBParm="DS_Principal='JSMITH'"

See also

DS_Alias

DS_Copy

DS_DitBase

DS_Failover

DS_Password

DS_Provider

DS_TimeLimit

Release