/[pdpsoft]/trunk/nl.nikhef.ndpf.tools/nikhef-directory-tools/README.txt
ViewVC logotype

Contents of /trunk/nl.nikhef.ndpf.tools/nikhef-directory-tools/README.txt

Parent Directory Parent Directory | Revision Log Revision Log


Revision 2669 - (show annotations) (download)
Thu Sep 5 11:08:02 2013 UTC (8 years, 4 months ago) by davidg
File MIME type: text/plain
File size: 1883 byte(s)
Iniital release

1 nikEmployeeNumbers (nikENlib) - retrieval and manipulation of employee numbers
2 ------------------------------------------------------------------------------
3
4 nikEmployeeNumbers (nikENlib) - retrieval and manipulation of employee
5 numbers from the Nikhef LDAP directory. For proper functioning it MUST
6 connect to LDAP, and the password MUST be configured in an external file
7 (see config section below)
8
9 This module exports the following functions:
10
11 function nikENfindEmployeeNumberByUid($uid)
12 retrieve the employee number of user <uid>
13 function nikENfindUidByEmployeeNumber($employeeNumber)
14 retrieve the uid for employee <number>
15 function nikENfindCNByEmployeeNumber($employeeNumber)
16 retrieve the friendly common name for employee <number>
17 function nikENfindCNByUid($uid)
18 retrieve the friendly common name for user <uid>
19 function nikENlistAllElegibleUids()
20 get a list of all <uids> that match the LDAP filter
21 function nikENlistAllElegibleEmployeeNumbers()
22 get a list of all <employee numbers> that match the LDAP filter
23
24 If you want to do bulk-operations (such as reporting) it is faster
25 to first cache *all* of the possible entries. This is done implicitly
26 by the "nikENlistAllElegible*" functions, but it may be called
27 explicitly via function nikENcacheLdap()
28 retrieve all relevant entries from LDAP and cache in memory
29
30 USAGE
31 require("nikENlib.php");
32
33 NOTES
34 This library is designed to work with the NikIdM system, and may
35 not be suitable for any other purpose (or even for any purpose)
36
37 FILES /usr/local/etc/nikENconfig.conf
38 a <attribute> <value> file with the following permitted directives
39 "(binddn|bindpw|ldapurl|ldapdit|ldapfilter)"A
40 The default LDAP filter for finding elegible employees is
41 (&(employeeNumber=*)(eduPersonAffiliation=employee))
42 and any filter MUSt be enclosed in brackets
43
44 BUGS
45 may be present, exterminate them with DDT
46

Properties

Name Value
svn:keywords Id

grid.support@nikhef.nl
ViewVC Help
Powered by ViewVC 1.1.28