1ldaptemplates.conf(4) File Formats ldaptemplates.conf(4)
2
6 ldaptemplates.conf - configuration file for LDAP display template rou‐
7 tines
8
10 /etc/opt/SUNWconn/ldap/current/ldaptemplates.conf
11
14 The ldaptemplates.conf file contains information used by the LDAP dis‐
15 play routines.
16 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 The first non-commment 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 Version 1
29 The current version is 1, so the above example is always the correct
34 first line.
35 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 "Person"
43 "People"
44 specifies appropriate names for a template designed to display person
49 information.
50 The next line specifies the name of the icon or similar element that is
53 associated with this template. For example,
54 "person icon"
56 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 "addable" "modrdn"
67 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 as‐
77 sociate more than one set of object classes with a given template. For
78 example,
79 emailPerson
81 orgPerson
82 END
83 means that the template is appropriate for display of emailPerson
88 entries or orgPerson entries.
89 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 "owner"
96 The next line is the default attribute to use when naming a new entry,
101 for example,
102 "cn"
104 The next line is the distinguished name of the default location under
109 which new entries are created. For example,
110 "o=XYZ, c=US"
112 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 constant associatedDomain XYZ.us
125 addersdn seeAlso
126 END
127 The last portion of the template is a list of items to display. It con‐
132 sists of one or more lines, followed by a terminating line that con‐
133 tains the single token END. Each line is must begin with the token
134 samerow or the token item
135 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 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 The item type token must be one of the following strings:
149 cis case-ignore string attributes
151 mls multiline string attributes
154 mail RFC-822 conformant mail address attributes
157 dn distinguished name pointer attributes
160 bool Boolean attributes
163 jpeg JPEG photo attributes
166 jpegbtn a button that will retrieve and show a JPEG photo
169 attribute
170 fax FAX T.4 format image attributes
173 faxbtn a button that will retrieve and show a FAX photo
176 attribute
177 audiobtn audio attributes
180 time UTC time attributes
183 date UTC time attributes where only the date portion should be
186 shown
187 url labeled Uniform Resource Locator attributes
190 searchact define an action that will do a directory search for
193 other entries
194 linkact define an action which is a link to another display tem‐
197 plate
198 protected for an encrypted attribute, with values displayed as
201 asterisks
202 An example of an item line for the drink attribute (displayed with
206 label "Work Phone"):
207 item cis "Work Phone" telephoneNumber
209
213 Example 1 A Sample Configuration File Containing a Template that Dis‐
214 plays People Entries
215 The following template configuration file contains a templates for dis‐
218 play of people entries.
219 #
222 # LDAP display templates
223 #
224 # Version must be 1 for now
225 #
226 Version 1
227 #
228 # Person template
229 "Person"
230 "People"
231 # name of the icon that is associated with this template
233 "person icon"
234 # blank-separated list of template options ("" for none)
236 "addable"
237 #
239 # objectclass list
240 person
241 END
242 #
244 # name of attribute to authenticate as ("" means auth as this entry)
245 ""
246 #
248 # default attribute name to use when forming RDN of a new entry
249 #
250 "cn"
251 #
253 # default location when adding new entries (DN; "" means no default)
254 "o=XYZ, c=US"
255 #
257 # rules used to define default values for new entries
258 END
259 #
261 # list of items for display
262 item jpegbtn "View Photo" jpegPhoto "Next Photo"
263 item audiobtn "Play Sound" audio
264 item cis "Also Known As" cn
265 item cis "Title" title
266 item mls "Work Address" postalAddress
267 item cis "Work Phone" telephoneNumber
268 item cis "Fax Number" facsimileTelephoneNumber
269 item mls "Home Address" homePostalAddress
270 item cis "Home Phone" homePhone
271 item cis "User ID" uid
272 item mail "E-Mail Address" mail
273 item cis "Description" description
274 item dn "See Also" seeAlso
275 END
276
280 See attributes(5) for a description of the following attributes:
281 ┌─────────────────────────────┬─────────────────────────────┐
286 │ ATTRIBUTE TYPE │ ATTRIBUTE VALUE │
287 ├─────────────────────────────┼─────────────────────────────┤
288 │Availability │SUNWlldap │
289 │Stability Level │Evolving │
290 └─────────────────────────────┴─────────────────────────────┘
291
293 ldap_disptmpl(3LDAP), ldap_entry2text(3LDAP), attributes(5)
294SunOS 5.11 9 Jul 2003 ldaptemplates.conf(4)