GetDSAttr

This System tool retrieves data from an attribute in a key in CIC's Directory Services (DS). You should use GetDSAttr when you can't retrieve the value with the Lookup tool. While the Lookup tool can only retrieve values from certain predefined keys, GetDSAttr can retrieve values from all keys, including keys you have created yourself. GetDSAttr cannot return any value in your registry, only those within HKEY_LOCAL_MACHINE\Software\Interactive Intelligence\CIC\Directory Services\Root.

There are three special DS attributes. They are SERVER, SITE, and CONFIG.

All DS tools only access the part of the registry that affects CIC.

"SERVER" accesses

"... Directory Services\Root\<Site Name>\Production\<Server Name>"

"SITE" accesses

"... Directory Services\ Root \<Site Name>"

"CONFIG" accesses

"... Directory Services\ Root \<Site Name>\Production"

The reason these special cases were created is so that handlers could be generically created to run on any CIC Server. If these weren't used, you would have to modify every DS tool anytime you wanted to use the handler on a different machine."

Example 1

Suppose you want to look up the value of the Default Voice Mail Recipient from within a handler. Since this value is not one of the key types that can be accessed with the Lookup tool, you must use the GetDSAttr tool. You should use two GetDSAttr steps; the first to retrieve the path to the Config key and the second to retrieve the value of an attribute within that key.

The first GetDSAttr step Directory Services Path should be set to "" (empty string) to tell GetDSAttr that you want to start in the Root directory with Directory Services. The Directory Services Attribute you want to retrieve is "CONFIG" since Default Voice Mail Recipient is a child key of CONFIG. These settings return the path to the Config directory on any CIC server, so this handler will be easily transportable to other CIC servers. In this example, we'll place that value in a variable called lsConfigPath.

The second GetDSAttr step Directory Services Path should be set to GetHead(lsConfigPath) & "\\Configuration". This appends the path info onto the specific key name you want to search within. The Directory Services Attribute you want to retrieve is Default Voice Mail Recipient. Remember that the attribute name is context-sensitive and must match the case displayed in the registry. In this example, the first entry in the returned list is the default voice mail recipient mailbox.

Another use for this tool is to retrieve the value of a custom server or system parameter.

Inputs

Directory Services Path

The path to the Directory Services Key being accessed and the name of the key. DsPath is the default name for this variable.

Directory Services Attribute

The attribute to lookup in the specified Directory Services Key.

Outputs

List of Attribute Values

A variable of type ListofString that contains a list of values retrieved from the specified attribute. Null values are not retrieved.

Exit Paths

Success

This step takes the Success exit path if the Attribute exists and the path is correct.

Failure

This step takes the Failure exit path if the Attribute does not exist or if the path to the Attribute is incorrect.