Previous Topic: CreateHostConfig Method—Creates Host Configuration Object

Next Topic: CreatePwdPolicy Method—Creates Password Policy

CreateODBCQueryScheme Method—Creates ODBC Query Scheme

The CreateODBCQueryScheme method creates and configures an ODBC query scheme. ODBC query schemes are also called SQL query schemes.

Note: Create a unique data source for each ODBC query scheme.

Syntax

The CreateODBCQueryScheme method has the following format:

Netegrity::PolicyMgtSession‑>CreateODBCQueryScheme(schemeName[, schemeDesc][, queryEnumerate][, queryGetObjInfo][, queryLookup][, queryInitUser][, queryAuthenticateUser][, queryGetUserProp][, querySetUserProp][, queryGetUserProps][, queryLookupUser][, queryGetGroups][, queryIsGroupMember][, queryGetGroupProp][, querySetGroupProp][, queryGetGroupProps][, queryLookupGroup][, querySetPassword])

Parameters

The CreateODBCQueryScheme method accepts the following parameters:

schemeName (string)

Specifies the ODBC query scheme's name.

schemeDesc (string)

(Optional) Specifies the ODBC query scheme's description.

queryEnumerate (string)

(Optional) Specifies a query that lists the names of user objects in the directory.

Note: For more information, see the method PolicyMgtODBCQueryScheme‑>QueryEnumerate.

queryGetObjInfo (string)

(Optional) Specifies a query that fetches the object's class.

Note: For more information, see the method PolicyMgtODBCQueryScheme‑>QueryGetObjInfo.

queryLookup (string)

(Optional) Specifies a query that returns objects based on the value of an attribute in a group table.

Note: For more information, see the method PolicyMgtODBCQueryScheme‑>QueryLookup.

queryInitUser (string)

(Optional) Specifies a query that determines if a user with a given name exists in the database.

Note: For more information, see the method PolicyMgtODBCQueryScheme‑>QueryInitUser.

queryAuthenticateUser (string)

(Optional) Specifies a query that retrieves the user's password.

Note: For more information, see the method PolicyMgtODBCQueryScheme‑>QueryAuthenticateUser.

queryGetUserProp (string)

(Optional) Specifies a query that retrieves the value of a user property.

Note: The property must be listed in the queryGetUserProps parameter string. For more information, see the method PolicyMgtODBCQueryScheme‑>QueryGetUserProp.

querySetUserProp (string)

(Optional) Specifies a query that sets the value of a user property.

Note: The property must be listed in the queryGetUserProps parameter string. For more information, see the method PolicyMgtODBCQueryScheme‑>QuerySetUserProp.

queryGetUserProps (string)

(Optional) Specifies a comma-separated list of user attributes that reside in the same table as the user name.

Note: For more information, see the method PolicyMgtODBCQueryScheme‑>QueryGetUserProps.

queryLookupUser (string)

(Optional) Specifies a query that retrieves a user name through an attribute of the user table.

Note: For more information, see the method PolicyMgtODBCQueryScheme‑>QueryLookupUser.

queryGetGroups (string)

(Optional) Specifies a query that retrieves the names of the groups to which the user belongs.

Note: For more information, see the method PolicyMgtODBCQueryScheme‑>QueryGetGroups.

queryIsGroupMember (string)

(Optional) Specifies a query that determines whether a particular user is a member of a group.

Note: For more information, see the method PolicyMgtODBCQueryScheme‑>QueryIsGroupMember.

queryGetGroupProp (string)

(Optional) Specifies a query that returns the value of a group property.

Note: The property must be listed in the queryGetGroupProps parameter string. For more information, see the method PolicyMgtODBCQueryScheme‑>QueryGetGroupProp.

querySetGroupProp (string)

(Optional) Specifies a query that sets the value of a group property.

Note: The property must be listed in the queryGetGroupProps parameter string. For more information, see the method PolicyMgtODBCQueryScheme‑>QuerySetGroupProp.

queryGetGroupProps (string)

(Optional) Specifies a comma-separated list of group attributes.

Note: For more information, see the method PolicyMgtODBCQueryScheme‑>QueryGetGroupProps.

queryLookupGroup (string)

(Optional) Specifies a query that retrieves a group name through an attribute of the group table.

Note: For more information, see the method PolicyMgtODBCQueryScheme‑>QueryLookupGroup.

querySetPassword (string)

(Optional) Specifies a query that changes a user's password.

Note: For more information, see the method PolicyMgtODBCQueryScheme‑>QuerySetPassword.

Return Value

The CreateODBCQueryScheme method returns one of the following values:


Copyright © 2010 CA. All rights reserved. Email CA about this topic