1 LDAPTEMPLATES.CONF(4) File Formats and Configurations LDAPTEMPLATES.CONF(4)
2
3
4
5 NAME
6 ldaptemplates.conf - configuration file for LDAP display template
7 routines
8
9 SYNOPSIS
10 /etc/opt/SUNWconn/ldap/current/ldaptemplates.conf
11
12
13 DESCRIPTION
14 The ldaptemplates.conf file contains information used by the LDAP
15 display routines.
16
17
18 Blank lines and lines that start with a hash character ('#') are
19 treated as comments and ignored. Non-comment lines contain one or more
20 tokens. Tokens are separated by white space, and double quotes can be
21 used to include white space inside a token.
22
23
24 The first non-comment line specifies the version of the template
25 information and must contain the token Version followed by an integer
26 version number. For example,
27
28 Version 1
29
30
31
32
33 The current version is 1, so the above example is always the correct
34 first line.
35
36
37 The remainder of the file consists of one or more display templates.
38 The first two lines of the display template each contain a single token
39 that specifies singular and plural names for the template in a user-
40 friendly format. For example,
41
42 "Person"
43 "People"
44
45
46
47
48 specifies appropriate names for a template designed to display person
49 information.
50
51
52 The next line specifies the name of the icon or similar element that is
53 associated with this template. For example,
54
55 "person icon"
56
57
58
59
60 The next line is a blank-separated list of template options. "" can be
61 used if no options are desired. Available options are: addable (it is
62 appropriate to allow entries of this type to be added), modrdn (it is
63 appropriate to offer the modify rdn operation), altview (this template
64 is an alternate view of another template). For example,
65
66 "addable" "modrdn"
67
68
69
70
71 The next portion of the template is a list of X.500 object classes that
72 is used to determine whether the template should be used to display a
73 given entry. The object class information consists of one or more
74 lines, followed by a terminating line that contains the single token
75 END. Each line contains one or more object class names, all of which
76 must be present in a directory entry. Multiple lines can be used to
77 associate more than one set of object classes with a given template.
78 For example,
79
80 emailPerson
81 orgPerson
82 END
83
84
85
86
87 means that the template is appropriate for display of emailPerson
88 entries or orgPerson entries.
89
90
91 The next line after the object class list is the name of the attribute
92 to authenticate as to make changes (use "" if it is appropriate to
93 authenticate as the entry itself). For example,
94
95 "owner"
96
97
98
99
100 The next line is the default attribute to use when naming a new entry,
101 for example,
102
103 "cn"
104
105
106
107
108 The next line is the distinguished name of the default location under
109 which new entries are created. For example,
110
111 "o=XYZ, c=US"
112
113
114
115
116 The next section is a list of rules used to assign default values to
117 new entries. The list should be terminated with a line that contains
118 the single token END. Each line in this section should either begin
119 with the token constant and be followed by the name of the attribute
120 and a constant value to assign, or the line should begin with addersdn
121 followed by the name of an attribute whose value will be the DN of the
122 person who has authenticated to add the entry. For example,
123
124 constant associatedDomain XYZ.us
125 addersdn seeAlso
126 END
127
128
129
130
131 The last portion of the template is a list of items to display. It
132 consists of one or more lines, followed by a terminating line that
133 contains the single token END. Each line is must begin with the token
134 samerow or the token item
135
136
137 It is assumed that each item appears on a row by itself unless it was
138 preceded by a samerow line (in which case it should be displayed on the
139 same line as the previous item, if possible). Lines that begin with
140 samerow should not have any other tokens on them.
141
142
143 Lines that begin with item must have at least three more tokens on
144 them: an item type, a label, and an attribute name. Any extra tokens
145 are taken as extra arguments.
146
147
148 The item type token must be one of the following strings:
149
150 cis
151 case-ignore string attributes
152
153
154 mls
155 multiline string attributes
156
157
158 mail
159 RFC-822 conformant mail address attributes
160
161
162 dn
163 distinguished name pointer attributes
164
165
166 bool
167 Boolean attributes
168
169
170 jpeg
171 JPEG photo attributes
172
173
174 jpegbtn
175 a button that will retrieve and show a JPEG photo
176 attribute
177
178
179 fax
180 FAX T.4 format image attributes
181
182
183 faxbtn
184 a button that will retrieve and show a FAX photo
185 attribute
186
187
188 audiobtn
189 audio attributes
190
191
192 time
193 UTC time attributes
194
195
196 date
197 UTC time attributes where only the date portion should be
198 shown
199
200
201 url
202 labeled Uniform Resource Locator attributes
203
204
205 searchact
206 define an action that will do a directory search for
207 other entries
208
209
210 linkact
211 define an action which is a link to another display
212 template
213
214
215 protected
216 for an encrypted attribute, with values displayed as
217 asterisks
218
219
220
221 An example of an item line for the drink attribute (displayed with
222 label "Work Phone"):
223
224 item cis "Work Phone" telephoneNumber
225
226
227
228 EXAMPLES
229 Example 1 A Sample Configuration File Containing a Template that
230 Displays People Entries
231
232
233 The following template configuration file contains a templates for
234 display of people entries.
235
236
237 #
238 # LDAP display templates
239 #
240 # Version must be 1 for now
241 #
242 Version 1
243 #
244 # Person template
245 "Person"
246 "People"
247
248 # name of the icon that is associated with this template
249 "person icon"
250
251 # blank-separated list of template options ("" for none)
252 "addable"
253
254 #
255 # objectclass list
256 person
257 END
258
259 #
260 # name of attribute to authenticate as ("" means auth as this entry)
261 ""
262
263 #
264 # default attribute name to use when forming RDN of a new entry
265 #
266 "cn"
267
268 #
269 # default location when adding new entries (DN; "" means no default)
270 "o=XYZ, c=US"
271
272 #
273 # rules used to define default values for new entries
274 END
275
276 #
277 # list of items for display
278 item jpegbtn "View Photo" jpegPhoto "Next Photo"
279 item audiobtn "Play Sound" audio
280 item cis "Also Known As" cn
281 item cis "Title" title
282 item mls "Work Address" postalAddress
283 item cis "Work Phone" telephoneNumber
284 item cis "Fax Number" facsimileTelephoneNumber
285 item mls "Home Address" homePostalAddress
286 item cis "Home Phone" homePhone
287 item cis "User ID" uid
288 item mail "E-Mail Address" mail
289 item cis "Description" description
290 item dn "See Also" seeAlso
291 END
292
293
294
295 ATTRIBUTES
296 See attributes(5) for a description of the following attributes:
297
298
299
300
301 +----------------+-----------------+
302 |ATTRIBUTE TYPE | ATTRIBUTE VALUE |
303 |Stability Level | Evolving |
304 +----------------+-----------------+
305
306 SEE ALSO
307 ldap_disptmpl(3LDAP), ldap_entry2text(3LDAP), attributes(5)
308
309
310
311 July 9, 2003 LDAPTEMPLATES.CONF(4)