Options for LDAPPeopleRetriever and ADPeopleRetriever

• HOST - should match the address of your server. Keep in mind that this server must be accessible from the web server the framework is hosted on. Managing network and firewall settings is the responsibility of your network administrator.
• SEARCH_BASE - should manage the LDAP search base of your directory. You can get this value from the administrator of your LDAP directory. Examples would include “dc=example,dc=com”
• PORT - Optional (Default 389) The port to connect. Use 636 for SSL connections (recommended if available)
• ADMIN_DN - Some servers do not permit anonymous queries. If necessary you will need to provide a full distinguished name for an account that has access to the directory. For security this account should only have read access and be limited to the search bases to which it needs to access.
• ADMIN_PASSWORD - The password for the ADMIN_DN account.

다음 값들은 controller에게 searching 할 때 어떤 attributes들을 사용할 것인지를 알려 줍니다. 이 값들은 디폴트값고 다를 경우 사용할 필요가 있을 겁니다.

• LDAP_USERID_FIELD (uid, samaccountname for AD)- Stores the unique user name for this user. Do not choose an attribute that is sensitive as they are easily viewed by users
• LDAP_EMAIL_FIELD (mail) - The attribute of the user’s email address
• LDAP_FIRSTNAME_FIELD (givenname) - The attribute of the user’s first name
• LDAP_LASTNAME_FIELD (sn) - The attribute of the user’s last name
• LDAP_FULLNAME_FIELD (blank) - If you wish to use a single field for name (like cn), include this here.
• LDAP_PHONE_FIELD (telephonenumber) - The attribute of the user’s phone number
• 
  

Options for DatabasePeopleRetriever

DatabasePeopleRetriever 에는 사용할 수 있는 여러 configuration value들이 있습니다. 모두 optional 이죠. 데이터베이스 connection에 대한 configuration에 대해 자세히 알고 싶으시면 Database Access를 보세요.

만약 이중에 어떤 value 라도 생략되면은 디폴트를 세팅할 겁니다. (Configuring Database Connections)

아래 value는 데이터가 있는 테이블의 위치를 controller에게 알려 줍니다.

• DB_USER_TABLE - (users) The name of the table that stores the user records. This table should at least have fields for userID, name and email. Each row should contain a single user entry.

아래 값들은 controller 에게 주요 field 에 대한 정보를 줍니다. 이 값들은 디폴트값과 그 값이 다를 경우에 적용되게 됩니다.

• DB_USERID_FIELD (userID)- stores the userID in the user table. You can use any unique column for the userID field. Do not use sensitive values as they are easily viewed by users.
• DB_EMAIL_FIELD (email) - stores the email in the user table
• DB_FIRSTNAME_FIELD (firstname) - stores the first name of user.
• DB_LASTNAME_FIELD (firstname) - stores the last name of user.
• DB_PHONE_FIELD (no default) - stores the user’s phone number. If empty then the search will not use the phone number

다른 필드들은 아래 configuring the detail fields 에서 설명됩니다.

Creating groups of contacts

• NOTE - Creation of contact groups is not supported in the admin console at this time.

만약에 여러 contacts 를 카테고리로 묶어야 한다면 여러분들은 그것을 group으로 묶어야 합니다. contact group들을 만드시려면 아래와 같이 하시면 됩니다.

1. If it does not exist, create a file named SITE_DIR/config/people/contacts-groups.ini
2. Add a section to contacts-groups.ini with a short name of your group. This should be a lowercase alpha numeric value without spaces or special characters
3. This section should contain a “title” option that represents the title of the group. Optionally you can include a description value that will show at the top of the contacts list for the group
4. Create a file named SITE_DIR/config/people/contacts-groupname.ini where groupname is the short name of the group you created in contacts-groups.ini. This file should be formatted like contacts.ini with each entry being a numerically indexed section
5. To use this group, assign it to a entry in contacts.ini. Do not include a url, but rather add a value group with a value of the short name of the group. You can optionally add a title that will be used instead of the group title indicated in contacts-groups.ini

아래는 SITE_DIR/config/people/contacts-groups.ini의 예제입니다. 각 그룹은 섹션으로 표현되는데 그 안에는 title 이 있고 옵션으로 description 이 있습니다. 여러분이 원하는 만큼의 그룹을 만드실 수 있습니다.

[admissions]
title = "Admissions"

SITE_DIR/config/people/contacts-admissions.ini. 아래는 admissions group의 예제입니다. contacts.ini file과 같은 형식입니다.

[0]
title    = "Admissions Main Number"
subtitle = "(617-555-0001)"
url      = "tel:6175550001"
class    = "phone"

[1]
title    = "Admissions Hotline"
subtitle = "(617-555-0002)"
url      = "tel:6175550002"
class    = "phone"

SITE_DIR/config/people/contacts.ini. 그룹을 보이기 위해 group value가 있습니다. url value는 없습니다.

[0]
title    = "Static Entry 1"
subtitle = "(617-555-0001)"
url      = "tel:6175550001"
class    = "phone"

[1]
title    = "Admissions"
group    = "admissions"

Strings

description - 이 값은 리스트가 보일 때 위에 보일 스트링입니다.

description_footer - 이 값은 리스트가 보일 때 아래에 보일 스트링입니다.

Links

Links are editing in the links.ini configuration file. Each link is represented by a configuration section. Within each section, there are 3 possible keys:

링크들은 links.ini configuration file에서 편집합니다. 각각의 링크는 configuration section으로 나눠 집니다.

• title - The title of the link
• url - The url of the link
• icon - a optional icon that is displayed in the springboard display type. These files should be placed in the SITE_DIR/themes/default/modules/links/images/compliant folder.

[0]
title = "This is link 1"
url   = "http://example.com/urlforlink1"
icon  = "link1_icon.png"

[1]
title = "This is link 2"
url   = "http://example.com/urlforlink2"
icon  = "" ; link 2 does not have an icon

[2]
title = "This is link 3"
url   = "http://example.com/urlforlink3"
icon  = "link3_icon.png"

Creating groups of links

• NOTE - Creation of link groups is not supported in the admin console at this time.

비슷한 링크들을 하나의 카테고리로 묶기 위해 group을 만들 수 있습니다. 아래 스텝들을 따라 하시면 됩니다.

1. If it does not exist, create a file named SITE_DIR/config/links/links-groups.ini
2. Add a section to links-groups.ini with a short name of your group. This should be a lowercase alpha numeric value without spaces or special characters
3. This section should contain a “title” option that represents the title of the group. Optionally you can include a description value that will show at the top of the links list for the group. You can also include a display_type to include a different link display type than the main link list.
4. Create a file named SITE_DIR/config/people/links-groupname.ini where groupname is the short name of the group you created in links-groups.ini. This file should be formatted like links.ini with each entry being a numerically indexed section
5. To use this group, assign it to a entry in links.ini. Do not include a url, but rather add a value group with a value of the short name of the group. You can optionally add a title that will be used instead of the group title indicated in links-groups.ini

SITE_DIR/config/people/links-groups.ini에 대한 예제 파일 입니다. 각 그룹은 title을 포함한 섹션입니다. (옵션으로 description 이 있습니다. 원하는 만큼의 그룹을 만들 수 있습니다.

[admissions]
title = "Admissions"

SITE_DIR/config/people/contacts-admissions.ini. 아래는 admissions group에 대한 샘플 파일입니다.  contacts.ini file과 비슷한 format 입니다. :

[0]
title    = "Admissions Main Number"
subtitle = "(617-555-0001)"
url      = "tel:6175550001"
class    = "phone"

[1]
title    = "Admissions Hotline"
subtitle = "(617-555-0002)"
url      = "tel:6175550002"
class    = "phone"

SITE_DIR/config/people/contacts.ini. Include a group value to show a group, do not include a url value:

[0]
title    = "Static Entry 1"
subtitle = "(617-555-0001)"
url      = "tel:6175550001"
class    = "phone"

[1]
title    = "Admissions"
group    = "admissions"