search.htm 31 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682
  1. <!-- --- BEGIN COPYRIGHT BLOCK ---
  2. This Program is free software; you can redistribute it and/or modify it under
  3. the terms of the GNU General Public License as published by the Free Software
  4. Foundation; version 2 of the License.
  5. This Program is distributed in the hope that it will be useful, but WITHOUT
  6. ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  7. FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
  8. You should have received a copy of the GNU General Public License along with
  9. this Program; if not, write to the Free Software Foundation, Inc., 59 Temple
  10. Place, Suite 330, Boston, MA 02111-1307 USA.
  11. In addition, as a special exception, Red Hat, Inc. gives You the additional
  12. right to link the code of this Program with code not covered under the GNU
  13. General Public License ("Non-GPL Code") and to distribute linked combinations
  14. including the two, subject to the limitations in this paragraph. Non-GPL Code
  15. permitted under this exception must only link to the code of this Program
  16. through those well defined interfaces identified in the file named EXCEPTION
  17. found in the source code files (the "Approved Interfaces"). The files of
  18. Non-GPL Code may instantiate templates or use macros or inline functions from
  19. the Approved Interfaces without causing the resulting work to be covered by
  20. the GNU General Public License. Only Red Hat, Inc. may make changes or
  21. additions to the list of Approved Interfaces. You must obey the GNU General
  22. Public License in all respects for all of the Program code and other code used
  23. in conjunction with the Program except the Non-GPL Code covered by this
  24. exception. If you modify this file, you may extend this exception to your
  25. version of the file, but you are not obligated to do so. If you do not wish to
  26. provide this exception without modification, you must delete this exception
  27. statement from your version and license this file solely under the GPL without
  28. exception.
  29. Copyright (C) 2001 Sun Microsystems, Inc. Used by permission.
  30. Copyright (C) 2005 Red Hat, Inc.
  31. All rights reserved.
  32. --- END COPYRIGHT BLOCK --- -->
  33. <html>
  34. <head>
  35. <title>Searching the Directory Tree</title>
  36. </head>
  37. <body>
  38. <h1><a name="search"></a>Searching the Directory Tree</h1>
  39. <p>The Directory Server
  40. contains information about the people and resources in
  41. your organization. Using the Directory Server interface, you can
  42. easily find the information you need. To simplify the search
  43. process, the Directory Server interface provides two types of
  44. searches:</p>
  45. <ul>
  46. <li><a href="/clients/dsgw/bin/lang?<!-- GCONTEXT -->&file=.MANUAL/search.htm#standard">Standard Search</a> -- Selects an
  47. appropriate method of searching based on the value you
  48. specify. For example, if you search for [email protected],
  49. Standard Search searches for matching email
  50. addresses. </li>
  51. <P>
  52. <li><a href="/clients/dsgw/bin/lang?<!-- GCONTEXT -->&file=.MANUAL/search.htm#advanced">Advanced Search</a> -- Provides a
  53. simple method for searching against specific entry
  54. attributes. For example, you can specify that you want to
  55. search for users whose last names start with <b>k</b> and
  56. whose phone numbers end with <b>2110</b>. </li>
  57. </ul>
  58. <p>Both types of searches allow you select the type of entry to
  59. search for. You can search for any of the following types of
  60. entries:</p>
  61. <table border="2">
  62. <tr>
  63. <th><a name="type"></a><b>Type of Entry</b></th>
  64. <th>Description</th>
  65. </tr>
  66. <tr>
  67. <td valign="top">People</td>
  68. <td valign="top">Entries that describe a person. </td>
  69. </tr>
  70. <tr>
  71. <td valign="top">NT people</td>
  72. <td valign="top">Entries that describe an NT user.</td>
  73. </tr>
  74. <tr>
  75. <td valign="top">Groups<b> </b></td>
  76. <td valign="top">Entries that describe a group. Groups
  77. are collections of one or more directory
  78. entries. For example, groups may be defined at your site
  79. that include the System Administrators, the Technical
  80. Writers, or all the people interested in fishing. Note
  81. that a group does not always have to identify a
  82. collection of people. For example, a group could be
  83. defined that identifies all the color printers or fax machines
  84. at your site. Groups can also contain other groups. </td>
  85. </tr>
  86. <tr>
  87. <td>NT Groups</td>
  88. <td>Entries that describe a group of NT users.</td>
  89. </tr>
  90. <tr>
  91. <td valign="top">Organizations</td>
  92. <td valign="top">Entries that describe an organization.
  93. An organization is usually a single, very
  94. large organization such as a corporation or a university.
  95. An organization differs from a group in that a
  96. group is typically an arbitrary collection of people or
  97. devices that is subject to change as entities are added
  98. to or removed from the directory. Organizations, however,
  99. represent a major, relatively static, subdivision or
  100. branching of the directory. Additions and
  101. subtractions of entities within the directory do not usually
  102. affect organization entries.</td>
  103. </tr>
  104. <tr>
  105. <td valign="top">Domain Components</td>
  106. <td valign="top">Entries that describe your domain.
  107. The Domain Component represents your directory suffix by
  108. breaking your domain name into its component parts. In a
  109. single enterprise environment, a directory suffix typically
  110. aligns with a DNS name or Internet domain name of your
  111. enterprise. For example, if your enterprise owns the domain
  112. name of example.com, then your directory suffix would be of
  113. the form dc=example,dc=com.
  114. </tr>
  115. <tr>
  116. <td valign="top">Org-Units</td>
  117. <td valign="top">Entries that describe an organizational
  118. unit. Organizational units usually identify major
  119. subdivisions within a larger organization. In contrast to
  120. entries from a single, very large organization such as a
  121. corporation or university, organizational units describe
  122. smaller organizations such as accounting, marketing, the
  123. humanities, or Biology. </td>
  124. </tr>
  125. <tr>
  126. <td valign="top">Anything </td>
  127. <td valign="top">Any type of entry within the directory
  128. that matches the search criteria. Use Anything
  129. if you are unsure of how the directory manager
  130. represented an entry within the directory. Anything is
  131. also useful if the type of entry for which you are
  132. searching is not a person, group, or organization.</td>
  133. </tr>
  134. </table>
  135. <p>After the Directory Server completes the search, the Directory
  136. Server interface displays the <a href="/clients/dsgw/bin/lang?<!-- GCONTEXT -->&file=.MANUAL/search.htm#results">search results</a>,
  137. which provide links to all matching entries. When you click an
  138. entry displayed on the search results list, the Directory Server
  139. displays detailed information about the entry. If the entry is a
  140. person, you can also choose to <a href="/clients/dsgw/bin/lang?<!-- GCONTEXT -->&file=.MANUAL/search.htm#vCard">view the person's
  141. digital business card</a>, or vCard. Using the vCard, you can
  142. add the person to your Communicator address book with a
  143. click of a button.</p>
  144. <h2><a name="standard"></a>Standard Search</h2>
  145. <p>Standard search performs different types of searches according to the
  146. nature of the data that you specify. Depending on what
  147. you type in the search field, Standard Search attempts to find
  148. matching <a href="/clients/dsgw/bin/lang?<!-- GCONTEXT -->&file=.MANUAL/search.htm#Name">names</a>, <a href="/clients/dsgw/bin/lang?<!-- GCONTEXT -->&file=.MANUAL/search.htm#phone">telephone
  149. numbers</a>, or <a href="/clients/dsgw/bin/lang?<!-- GCONTEXT -->&file=.MANUAL/search.htm#email">email addresses</a>. </p>
  150. <p>Depending on what you enter, Standard Search
  151. determines whether to find entries that exactly match your
  152. criteria, entries that contain your criteria, or entries that
  153. contain words or syllables that sound like your criteria. You can also use
  154. an LDAP (Lightweight Directory Access Protocol) <a href="/clients/dsgw/bin/lang?<!-- GCONTEXT -->&file=.MANUAL/search.htm#filter">search filter</a>
  155. in the Standard Search field.</p>
  156. <h3><a name="Performing a Standard Search"></a>Performing a
  157. Standard Search</h3>
  158. <ol>
  159. <li>Click the Standard Search tab.</li>
  160. <li>Select the <a href="/clients/dsgw/bin/lang?<!-- GCONTEXT -->&file=.MANUAL/search.htm#type">type of entry</a> you want to
  161. search for from the Find drop-down list.</li>
  162. <li>Enter the value you want to find in the "Search
  163. for" field. The "Search for" field
  164. is not case sensitive. You can enter any of the following:
  165. <ul type="disc">
  166. <li>A <a href="/clients/dsgw/bin/lang?<!-- GCONTEXT -->&file=.MANUAL/search.htm#Name">name</a> or part of a name </li>
  167. <li>A person's <a href="/clients/dsgw/bin/lang?<!-- GCONTEXT -->&file=.MANUAL/search.htm#initials">initials</a> </li>
  168. <li>Some or all of a <a href="/clients/dsgw/bin/lang?<!-- GCONTEXT -->&file=.MANUAL/search.htm#phone">phone number</a>
  169. </li>
  170. <li>Some or all of an <a href="/clients/dsgw/bin/lang?<!-- GCONTEXT -->&file=.MANUAL/search.htm#email">email
  171. address</a> </li>
  172. <li>An LDAP <a href="/clients/dsgw/bin/lang?<!-- GCONTEXT -->&file=.MANUAL/search.htm#filter">search filter</a></li>
  173. </ul>
  174. </li>
  175. <li>Click Submit. <br>
  176. Once the form data has been submitted to the Directory
  177. Server, the server searches for any entries
  178. that exactly match, partially match, or sound like the
  179. value you supplied. The resulting matches are displayed
  180. as a <a href="/clients/dsgw/bin/lang?<!-- GCONTEXT -->&file=.MANUAL/search.htm#results">search results</a> table.</li>
  181. </ol>
  182. <h4><a name="Name"></a>Searching for Names</h4>
  183. <p>If the string you specify:</p>
  184. <ul>
  185. <li>contains characters other than numbers </li>
  186. <li>does not contain an at (@) symbol </li>
  187. </ul>
  188. <p>Standard Search attempts to find full names, first names, or
  189. last names that exactly match, partially match, or sound like the
  190. supplied value.</p>
  191. <p>For example, specifying the string <font face="Courier">son</font>
  192. could return results such as: </p>
  193. <p>
  194. <ul>
  195. <li>Gary Stevenson</li>
  196. <li>Mary Sun</li>
  197. <li>Allison Barker</li>
  198. </ul>
  199. <h4><a name="initials"></a>Searching for Names with Initials</h4>
  200. <p>If you specify a value that includes the following items in
  201. the following order:</p>
  202. <ol>
  203. <li>a single letter </li>
  204. <li>a space ( ), period (.), or period and space in any order</li>
  205. <li>one or more characters </li>
  206. </ol>
  207. <p>then Standard Search executes the search as if you
  208. requested a first initial followed by a last name. For example,
  209. specifying the string &quot;S.Anderson&quot; could return results
  210. such as:</p>
  211. <ul>
  212. <li>Sally Anderson</li>
  213. <li>Steve Anderson</li>
  214. <li>Sue Anderson</li>
  215. </ul>
  216. <p>Similarly, if you specify a value that has the following items
  217. in the following order:</p>
  218. <ol>
  219. <li>more than one character</li>
  220. <li>a space ( ), period (.), or period and space in any order</li>
  221. <li>a single character </li>
  222. </ol>
  223. <p>then Standard Search executes the search as if you
  224. requested a first name followed by a last initial. For example,
  225. specifying the string <font face="Courier New">&quot;</font>Mark
  226. .P&quot; could return search results such as:</p>
  227. <ul>
  228. <li>Mark Payne</li>
  229. <li>Mark Peck</li>
  230. <li>Mark Polk</li>
  231. </ul>
  232. <blockquote>
  233. <p><b>Note: </b></p>
  234. <p>When you use initials Standard Search looks only for exact matches.
  235. It returns entries with names that use the
  236. same initial and name as you specify on the search.
  237. Approximate (or &quot;sounds-like&quot;) and substring
  238. searches are not performed. </p>
  239. </blockquote>
  240. <h4><a name="phone"></a>Searching for Phone Numbers</h4>
  241. <p>Standard Search automatically searches for a phone number if
  242. the value you enter consists only of numerical digits. A single
  243. hyphen (-) is also allowed if at least one digit precedes
  244. it.</p>
  245. <p>This type of search is an &quot;ends with&quot; search. That
  246. is, the Directory Server searches for any phone numbers that end
  247. with the specified value. For example, if you enter a value such
  248. as <tt>123</tt>, the Directory Server searches for all phone numbers that
  249. end with 123.</p>
  250. <h4><a name="email"></a>Searching for Email Addresses</h4>
  251. <p>Standard Search automatically searches for matching email
  252. addresses if you provide a value that contains an at (@) symbol.
  253. Standard Search first searches for any email addresses that
  254. exactly match the value you entered. If Standard Search doesn't
  255. find any matching entries, it then searches for any entries that
  256. start with the value you entered. </p>
  257. <p>For example, specifying the string <font face="Courier">son@</font>
  258. could return:</p>
  259. <ul>
  260. <li>son@</li>
  261. </ul>
  262. or, if no exact match exists in the directory:
  263. <ul>
  264. <li>[email protected]</li>
  265. <li>[email protected]</li>
  266. </ul>
  267. <h4><a name="filter"></a>Using Search Filters</h4>
  268. <p>Rather than allowing Standard Search to determine the correct
  269. type of search, you can explicitly specify an LDAP search filter.
  270. An LDAP search filter allows you to search for entries with a
  271. specific <a href="/clients/dsgw/bin/lang?<!-- GCONTEXT -->&file=.MANUAL/attribut.htm">attribute</a> value.
  272. Standard Search assumes that any string containing an equal sign
  273. (=) is an LDAP search filter. For example,</p>
  274. <pre>cn=*eve*</pre>
  275. <p>is an LDAP search filter that performs a substring search for
  276. any common name (CN) containing the string <tt>eve</tt>.
  277. When specifying attributes within an LDAP search filter, you
  278. must use the attribute label used by the Directory Server
  279. internally, the internal ID, rather than the attribute
  280. field name as displayed in the Directory Server interface.
  281. For example, the internal ID for the Full Name attribute field
  282. is <TT>cn</TT>. When you enter a search filter in Standard Search,
  283. use the internal ID (commonName) rather than the attribute field name (Full Name)
  284. as follows:
  285. </P>
  286. <P><TT>commonName=Smith Fukuda</TT></P>
  287. <P>Some attribute fields also have a second, abbreviated internal ID. For example, the Full Name field has two
  288. internal IDs: commonName and cn. You can use either name in the search filter.
  289. </p>
  290. <p>For more information on search filters, refer to
  291. the <em>Directory Server Administrator's Guide</em>.</p>
  292. <h2><a name="advanced"></a>Advanced Search</h2>
  293. <p>With Advanced Search, you can search for entries that have
  294. specific values for certain attributes. For example, Advanced
  295. Search allows you to look for a person whose email address is a
  296. specified value. Advanced Search also allows you to look up
  297. entries that do <i>not</i> include a specified attribute value. For
  298. example, you can find all the people whose last name is not
  299. &quot;Smith&quot; (such a search is likely to return a
  300. large number of results, so you may want to avoid these kinds of
  301. searches).</p>
  302. <p>Advanced Search performs an exact search, returning entries
  303. that exactly match the words you enter. There are four fields in
  304. the Advanced Search form that you use to construct your search.
  305. Together these four fields represent a sentence specifying the
  306. search. In general, the sentence is constructed as follows: </p>
  307. <p><a href="/clients/dsgw/bin/lang?<!-- GCONTEXT -->&file=.MANUAL/search.htm#type">Find:</a><i> [a type of entry] </i><a
  308. href="/clients/dsgw/bin/lang?<!-- GCONTEXT -->&file=.MANUAL/search.htm#wherethe">where the:</a><i> [attribute] </i><a
  309. href="/clients/dsgw/bin/lang?<!-- GCONTEXT -->&file=.MANUAL/search.htm#typeofsearch">[type of search]</a><i> [search
  310. string]</i></p>
  311. <p>The options
  312. for the first three of these fields are provided in pull-down
  313. menus. The last field contains the actual search string. For example, you can
  314. construct a search to:</p>
  315. <p><b>Find:</b><i> </i>[People]<i> </i><b>where the: </b>[Last
  316. Name] [is] [Bowker]</p>
  317. <p>Or you can construct a search to: </p>
  318. <p><b>Find: </b>[People] <b>where the: </b>[Full Name] [sounds
  319. like] [tree]</p>
  320. <h3><a name="Performing an Advanced Search"></a>Performing an
  321. Advanced Search</h3>
  322. <ol>
  323. <li>Click the Advanced Search tab.</li>
  324. <li>Select the <a href="/clients/dsgw/bin/lang?<!-- GCONTEXT -->&file=.MANUAL/search.htm#type">type of entry</a> you want to
  325. search for from the Find drop-down list.</li>
  326. <li>Select the attribute you want to search for from the "where
  327. the" field drop-down list. The choices
  328. vary depending on the type of entry you selected in the Find
  329. field. The options are explained in the following table.<br>
  330. <P>
  331. <table border="2">
  332. <tr>
  333. <th><a name="wherethe"></a><b>If the Find field
  334. is . . .</b></th>
  335. <th><b>You can choose . . .</b></th>
  336. </tr>
  337. <tr>
  338. <td>People</td>
  339. <td><a href="/clients/dsgw/bin/lang?<!-- GCONTEXT -->&file=.MANUAL/attribut.htm#cn">full name</a>,
  340. <a href="/clients/dsgw/bin/lang?<!-- GCONTEXT -->&file=.MANUAL/attribut.htm#surname">last name</a>, <a
  341. href="/clients/dsgw/bin/lang?<!-- GCONTEXT -->&file=.MANUAL/attribut.htm#telephoneNumber">phone number</a>,
  342. <a href="/clients/dsgw/bin/lang?<!-- GCONTEXT -->&file=.MANUAL/attribut.htm#mail">email address</a>, <a
  343. href="/clients/dsgw/bin/lang?<!-- GCONTEXT -->&file=.MANUAL/attribut.htm#uid">user ID</a>, or <a
  344. href="/clients/dsgw/bin/lang?<!-- GCONTEXT -->&file=.MANUAL/attribut.htm#title">title</a></td>
  345. </tr>
  346. <tr>
  347. <td>Groups</td>
  348. <td><a href="/clients/dsgw/bin/lang?<!-- GCONTEXT -->&file=.MANUAL/attribut.htm#cn">name</a>,
  349. <a href="/clients/dsgw/bin/lang?<!-- GCONTEXT -->&file=.MANUAL/attribut.htm#description">description</a>,
  350. <a href="/clients/dsgw/bin/lang?<!-- GCONTEXT -->&file=.MANUAL/attribut.htm#owner">owner</a>, or
  351. <a href="/clients/dsgw/bin/lang?<!-- GCONTEXT -->&file=.MANUAL/attribut.htm#member">member</a></td>
  352. </tr>
  353. <tr>
  354. <td>Organizations</td>
  355. <td><a href="/clients/dsgw/bin/lang?<!-- GCONTEXT -->&file=.MANUAL/attribut.htm#cn">name</a>,
  356. <a href="/clients/dsgw/bin/lang?<!-- GCONTEXT -->&file=.MANUAL/attribut.htm#l">location</a>,
  357. <a href="/clients/dsgw/bin/lang?<!-- GCONTEXT -->&file=.MANUAL/attribut.htm#telephoneNumber">phone
  358. number</a>, or <a href="/clients/dsgw/bin/lang?<!-- GCONTEXT -->&file=.MANUAL/attribut.htm#description">description</a></td>
  359. </tr>
  360. <tr>
  361. <td>Domaincomponent</td>
  362. <td><a href="/clients/dsgw/bin/lang?<!-- GCONTEXT -->&file=.MANUAL/attribut.htm#cn">name</a>,
  363. <a href="/clients/dsgw/bin/lang?<!-- GCONTEXT -->&file=.MANUAL/attribut.htm#l">location</a>,
  364. <a href="/clients/dsgw/bin/lang?<!-- GCONTEXT -->&file=.MANUAL/attribut.htm#telephoneNumber">phone
  365. number</a>, or <a href="/clients/dsgw/bin/lang?<!-- GCONTEXT -->&file=.MANUAL/attribut.htm#description">description</a></td>
  366. </tr>
  367. <tr>
  368. <td>Org-Units</td>
  369. <td><a href="/clients/dsgw/bin/lang?<!-- GCONTEXT -->&file=.MANUAL/attribut.htm#cn">name</a>,
  370. <a href="/clients/dsgw/bin/lang?<!-- GCONTEXT -->&file=.MANUAL/attribut.htm#l">location</a>,
  371. <a href="/clients/dsgw/bin/lang?<!-- GCONTEXT -->&file=.MANUAL/attribut.htm#telephoneNumber">phone
  372. number</a>, or <a href="/clients/dsgw/bin/lang?<!-- GCONTEXT -->&file=.MANUAL/attribut.htm#description">description</a></td>
  373. </tr>
  374. <tr>
  375. <td>Anything</td>
  376. <td><a href="/clients/dsgw/bin/lang?<!-- GCONTEXT -->&file=.MANUAL/attribut.htm#cn">name</a> or
  377. <a href="/clients/dsgw/bin/lang?<!-- GCONTEXT -->&file=.MANUAL/attribut.htm#description">description</a></td>
  378. </tr>
  379. </table>
  380. </li>
  381. <P>
  382. <li>Select the type of search you want to perform. <br>
  383. <br>
  384. In general, this field indicates if the search is to be
  385. an equality search, substring search, or approximate
  386. (&quot;sounds like&quot;) search. The following defines
  387. all of the available keywords and the type of search
  388. that each represents. Not all of these keywords
  389. are available for every search; the actual keywords you
  390. can use depends on the values you select for the 'Find'
  391. and "where the" fields. You can
  392. choose one of the following:
  393. <p>
  394. <table border="2">
  395. <tr>
  396. <th><a name="typeofsearch"></a><b>Type of search</b></th>
  397. <th><b>Description</b></th>
  398. </tr>
  399. <tr>
  400. <td>is</td>
  401. <td>Finds an exact match. That is,
  402. this option specifies an equality search. Use
  403. this option when you know the exact value of an
  404. entry's attribute. For example, if you know the
  405. exact spelling of a person's last name, use this
  406. option. </td>
  407. </tr>
  408. <tr>
  409. <td>is not</td>
  410. <td>Returns all the entries having an attribute value
  411. that does not exactly match the search string. That
  412. is, if you want to find all the people in the
  413. directory whose last name is not
  414. &quot;Smith,&quot; use this option. Be aware,
  415. however, that use of this option can return an
  416. extremely large number of entries. </td>
  417. </tr>
  418. <tr>
  419. <td>sounds like</td>
  420. <td>Finds phonetic matches. Use this option if you know an
  421. attribute's value, but you are unsure of the
  422. spelling. For example, if you are not sure if a
  423. person's last name is spelled &quot;Sarret,&quot;
  424. &quot;Sarette,&quot; or &quot;Sarett,&quot; use
  425. this option. </td>
  426. </tr>
  427. <tr>
  428. <td>starts with</td>
  429. <td>Performs a substring search.
  430. Entries having attributes with values starting with the
  431. specified search string are returned. For
  432. example, if you know a person's first name is
  433. &quot;Steve,&quot; but you do not know the last
  434. name, use this option on a full name search. </td>
  435. </tr>
  436. <tr>
  437. <td>ends with</td>
  438. <td>Performs a substring search.
  439. Entries having attributes with values ending with the specified
  440. search string are returned. For example, if you
  441. know the last four digits of a person's telephone
  442. number are &quot;9876,&quot; use this option to
  443. locate the person's entry. </td>
  444. </tr>
  445. <tr>
  446. <td>contains</td>
  447. <td>Performs a substring search.
  448. Entries having attributes with values containing the specified
  449. search string are returned. For example, if you
  450. know an organization's description
  451. contains the word &quot;support,&quot; use this
  452. option with the search string &quot;support&quot;
  453. to find the organization's entry.</td>
  454. </tr>
  455. </table>
  456. </li>
  457. <p>
  458. <li>Enter the string you want to search against in the text
  459. box and click Search.<br>
  460. Once the form data has been submitted to the directory
  461. server, the Directory Server searches for any entries
  462. that exactly match the value you supplied. The resulting
  463. matches are displayed as a search results list.</li>
  464. </ol>
  465. <h3><a name="Advanced Search Examples"></a>Advanced Search
  466. Examples</h3>
  467. <p>The following examples show a few possible uses of the
  468. Advanced Search form. The vertical bars (|) delimit the various
  469. fields in the form.</p>
  470. <table border="2">
  471. <tr>
  472. <th><b>To find . . .</b></th>
  473. <th><b>Enter . . .</b></th>
  474. </tr>
  475. <tr>
  476. <td>All people named Darlene</td>
  477. <td><b>Find:</b> People | <b>where the:</b> full name |
  478. starts with | Darlene</td>
  479. </tr>
  480. <tr>
  481. <td>All people with the last name Sweeney</td>
  482. <td><b>Find:</b> People | <b>where the:</b> last name |
  483. is | Sweeny</td>
  484. </tr>
  485. <tr>
  486. <td>All the people who are vice presidents</td>
  487. <td><b>Find:</b> People | <b>where the:</b> title |
  488. contains | Vice President</td>
  489. </tr>
  490. <tr>
  491. <td>The organization named Accounting</td>
  492. <td><b>Find:</b> Organization | <b>where the:</b> name |
  493. is | Accounting</td>
  494. </tr>
  495. <tr>
  496. <td>Groups interested in scuba diving</td>
  497. <td><b>Find:</b> Groups | <b>where the:</b> description |
  498. contains | scuba</td>
  499. </tr>
  500. <tr>
  501. <td>Any entry with a name that contains the word
  502. &quot;printer&quot;</td>
  503. <td><b>Find:</b> Anything | <b>where the:</b> name |
  504. contains | printer</td>
  505. </tr>
  506. </table>
  507. <h2><a name="results"></a>Viewing Search Results</h2>
  508. <p>When you perform a search using either a Standard Search or an
  509. Advanced Search, the Directory Server interface sends the search
  510. data to the Directory Server. The Directory Server performs the
  511. search and then returns any matching entries to the directory
  512. server interface. The resulting display depends on whether there
  513. were:</p>
  514. <ul>
  515. <li><a href="/clients/dsgw/bin/lang?<!-- GCONTEXT -->&file=.MANUAL/search.htm#nomatch">no matches</a></li>
  516. <li><a href="/clients/dsgw/bin/lang?<!-- GCONTEXT -->&file=.MANUAL/search.htm#single">a single match</a></li>
  517. <li><a href="/clients/dsgw/bin/lang?<!-- GCONTEXT -->&file=.MANUAL/search.htm#multiple">multiple matches</a></li>
  518. </ul>
  519. <p>This section also discusses some of the <a href="/clients/dsgw/bin/lang?<!-- GCONTEXT -->&file=.MANUAL/search.htm#problems">other
  520. problems</a> you may run into when attempting to search the
  521. directory tree.</p>
  522. <h3><a name="nomatch"></a>No Matches </h3>
  523. <p>A search result that returns no matches means one of the
  524. following. </p>
  525. <ul>
  526. <li>No entries in the directory match your search
  527. criteria. If you believe that this is the problem, try
  528. another search using slightly different parameters to
  529. see if you can get any other results.</li>
  530. <li>You did not <a href="/clients/dsgw/bin/lang?<!-- GCONTEXT -->&file=.MANUAL/auth.htm#1016877">authenticate</a>
  531. before performing the search. The directory administrator
  532. determines Authentication requirements. Your
  533. directory administrator can set the access control on the
  534. directory so that you are required to
  535. authenticate before you can search the tree. This access
  536. control can be set for the entire directory or for
  537. just part of it. If you are required to
  538. authenticate before you can search the directory tree,
  539. and you do not authenticate before running the search,
  540. the Directory Server acts as if no matching
  541. entries were found in the directory; no message informs you
  542. that you need to authenticate. This is for security reasons. Contact your
  543. directory administrator to find out if you must
  544. authenticate to the Directory Server before running a
  545. search. See Chapter 5, &quot;Authentication&quot;
  546. for more information on authentication.</li>
  547. <li>The access control for the tree disallows you
  548. from viewing the entry or entries; regardless of authentication.</li>
  549. </ul>
  550. <h3><a name="single"></a>A Single Match<b> </b></h3>
  551. <p>If one and only one match is returned in response to an
  552. &quot;is&quot; search, the Directory Server interface displays
  553. information about that entry as a result of the search. If the
  554. single result was found using any other search method, it is
  555. displayed in a table, and you must click the link to view
  556. detailed information about the entry. This form
  557. contains a button that allows you to <a href="/clients/dsgw/bin/lang?<!-- GCONTEXT -->&file=.MANUAL/mod.htm">edit</a>
  558. the entry. You must have the appropriate permissions to edit an
  559. entry, and you need to <a href="/clients/dsgw/bin/lang?<!-- GCONTEXT -->&file=.MANUAL/auth.htm#userauth">authenticate</a>
  560. before doing so. </p>
  561. <h3><a name="multiple"></a>Multiple Matches<b> </b></h3>
  562. <p>If multiple matches are found in response to your
  563. search, the directory interface displays
  564. a table listing each of the matching entries and
  565. certain relevant information for each entry, such as the entry's
  566. phone number and email address. The type of entry for which
  567. you are searching determines this information.
  568. To view more information on a specific entry, click the
  569. entry's name in the first column of the table. </p>
  570. <h3><a name="problems"></a><b>Other Problems</b></h3>
  571. <p>You may see odd results if you are searching for numerical
  572. values because the Directory Server stores all values as
  573. strings, regardless of whether they are actually numerical values
  574. (such as telephone or room numbers). Consequently, when you
  575. search for numerical values, be sure to include all spaces and
  576. leading zeros, if any. </p>
  577. <p>Also note that the Directory Server interface strips all
  578. leading and trailing blank spaces from your search criteria.
  579. While it is unlikely that directory entries actually have leading
  580. and trailing blank spaces in their values, the possibility still
  581. exists. Because of this, exact matches against values that have
  582. leading and trailing blank spaces fail. If you encounter
  583. this problem, try using a substring search (a
  584. &quot;contains&quot; search) instead of an exact search. </p>
  585. <h2><a name="vCard"></a>Viewing a vCard</h2>
  586. <p>A vCard is a digital business card. Like a regular business
  587. card, a vCard contains contact information about a person such as
  588. name, title, telephone and fax numbers, and email
  589. address. Unlike a regular business card, however, the vCard can
  590. also contain multimedia elements such as graphics, sound,
  591. and video. To view a vCard, do the following:</p>
  592. <ol>
  593. <li>Use the <a href="/clients/dsgw/bin/lang?<!-- GCONTEXT -->&file=.MANUAL/search.htm#standard">Standard Search</a> or <a
  594. href="/clients/dsgw/bin/lang?<!-- GCONTEXT -->&file=.MANUAL/search.htm#advanced">Advanced Search</a> mechanism to locate
  595. the person whose vCard you want to view.</li>
  596. <li>Click the View Card button.<br>
  597. The Directory Server interface displays a condensed
  598. version of the vCard.</li>
  599. <li>If you want to see more details, click View
  600. Complete Card.</li>
  601. <li>If you want to add the person to your Communicator
  602. address book, click "Add to Address Book"
  603. and then click OK.</li>
  604. </ol>
  605. </body>
  606. </html>