This action might not be possible to undo. Are you sure you want to continue?
com: Spring '10
Creating a Public Knowledge Base with Salesforce Knowledge
Last updated: February 7, 2010
© Copyright 2000-2010 salesforce.com, inc. All rights reserved. Salesforce.com is a registered trademark of salesforce.com, inc., as are other
names and marks. Other marks appearing herein may be trademarks of their respective owners.
...............................7 Customizing the Public Knowledge Base..............................................................................................................................................................................2 Installing the Public Knowledge Base Package.....................................................9 i ......................................................................................................................................................................................................Table of Contents Table of Contents Introduction...........4 Configuring your Force..............................com Site for Salesforce Knowledge..........................................................................................................................................................................................................3 Configuring the PKB Site Setup Object....................
note the following: Do not configure the site home page or the site template. Therefore. Configure the Force. 2.com provides a package on the AppExchange so you can set up a public knowledge base that customers can browse anonymously without having to authenticate as registered users. configure and customize the public knowledge base: 1. Do not configure the public access settings for your site. 2 . These settings are covered later in this guide. These settings are covered later in this guide.com Sites Implementation Guide for more information.com site already setup for your public knowledge base. This unmanaged package includes Visualforce pages that you can customize based on the needs of your organization. make sure: • • Salesforce Knowledge is set up in your organization. Customize the Public Knowledge Base on page 9. Refer to the Force. When setting up your Force. You have a Force.Introduction Introduction Available in: Enterprise.com site inactive until you complete all the steps in this guide. Installation Overview To install.com Site for Salesforce Knowledge on page 7.com site. and Unlimited Editions User Permissions Needed To install and customize the public knowledge base: “Customize Application” Overview A public knowledge base is one of the channels where articles display to users or customers.com site. Salesforce. Note: You can only display one category group per Force. Refer to the Salesforce Knowledge Implementation Guide for detailed information. Configure the PKB Site Setup Object on page 4. Keep your Force.com site. 4. Developer. Requirements Before installing and configuring the public knowledge base package. Install the Public Knowledge Base Package on page 3. 3. The public knowledge base does not support login and registration. you do not need to enable these functions in the portal associated with your Force.
force. and click Deploy. Click Deploy Now followed by Deploy. and click Get It Now: https://sites. checkbox. When you are ready to deploy the package. To deploy your package at a later time. 6. and Unlimited Editions User Permissions Needed To install packages: “Download AppExchange Packages” To install the public knowledge base package: 1.. This package is removed from your sandbox organization whenever you create a new sandbox copy. 4. When prompted that the package is ready to be installed.Installing the Public Knowledge Base Package Installing the Public Knowledge Base Package Available in: Enterprise. If the package is password protected. Select your sandbox location to install the package in your organization's sandbox. 8. and click Install. 7. select PKB Site Setup. enter the password you received from the package publisher. click Setup ➤ View Installed Packages. read the user terms.com/appexchange/apex/listingDetail?listingId=a0N30000001gFH9EAM 2. Choose the Grant access to admins only security option. if available. and click Continue. and click Continue. Developer. make sure the Ignore Apex test failures checkbox is not selected. When you receive a message that the components contained in the package have been successfully installed. and click Next. 5. Review the API access that package components have been granted to ensure they are acceptable. select the I have read and agreed. Go to the following URL on the AppExchange. 3. Review the package items to ensure this is the package you want to install.secure. Enter your username and password. you are ready to deploy the package. click Deploy Later. 3 ..
There is no validation to ensure you enter the correct name. A value of zero (0) disables caching. The Site Name of the Force. go to Setup ➤ Develop ➤ Sites and click Edit next to the Force.com site for Salesforce Knowledge. This field must match the Group Unique Name field of the category group you want to display in your public knowledge base. This field is case-sensitive. and Unlimited Editions User Permissions Needed To configure the PKB Site Setup object: “Customize Application” When you install the PKB package available on the AppExchange. To configure the PKB Site Setup object: 1.Configuring the PKB Site Setup Object Configuring the PKB Site Setup Object Available in: Enterprise. 4. Developer. Specify the following information: Field Name Associated PKB Site Name Description The name of this PKB Site Setup object. go to Setup ➤ Customize ➤ Data Categories and either hover over or double-click on the category group to display its unique name. To view the Site Name field. This object determines the category group and other information that displays on your public knowledge base site. Cache Max Age The amount of time (in seconds) the content delivery network (CDN) server caches the pages of your public knowledge base site.com site created for Salesforce Knowledge. a new custom object (PKB Site Setup) is automatically created. We recommend setting this to 300 seconds (5 minutes). Click New. To view the category groups defined for your organization.com sites. CDN caching is automatically enabled on Force. Figure 1: Viewing All Tabs in Salesforce. Click the plus icon (+) next to the main tabs to view all tabs available to you. Category Group 4 . Click the PKB Site Setup object.com 2. 3.
Home Advertising Title The text that appears on the home page of your public knowledge base site. The text that appears under the advertising title on the home page of your public knowledge base site. This field is case-sensitive. To view the categories defined for your organization. There is no validation to ensure you enter the correct unique name of a category group. You cannot provide descriptions for the children of the first-level categories. There is no validation to ensure you enter the correct root category name. and so on. The following example shows the location of the category descriptions. You can only provide descriptions for the first-level categories under the specified root category. Click Save. click Setup ➤ Customize ➤ Data Categories and select a category group. 5 . however. All child categories under the specified root are displayed. Category Description 2 describes the next category. Category Description The descriptions for the first-level categories located under the root category. This field is limited to 255 characters. This field is case-sensitive.000 characters. sibling categories of the specified root are not displayed in the public knowledge base. • Root Category This field must match the Category Unique Name field of the root category you want to display in your public knowledge base site. advertising title and advertising text on the home page of the public knowledge base site. Then hover over or double-click on a category within the group to display its unique name. Only an active category group can be displayed in the public knowledge base.com site.Configuring the PKB Site Setup Object Field Description Note the following: • • You can only display one category group per Force. Category Description 1 describes the first category under the specified root. This field is limited to 32. Home Advertising Text 5. The root must be a category within the category group specified in the previous field.
Configuring the PKB Site Setup Object Figure 2: Example of the Public Knowledge Base Home Page 6 .
2.com site for Salesforce Knowledge so it displays the correct active site home page and uses the new Apex classes and Visualforce pages that were included in the PKB package. Click Setup ➤ Develop ➤ Sites.com Site for Salesforce Knowledge Available in: Enterprise. On the Profile Detail page for your site. scroll down to the Enabled Apex Class Access section. In the General User Permissions section. select the View Articles checkbox. 7 . 3. On the Site Edit page: • • Set the Active Site Home Page field to knowledgeHome. enter the name of the cloned Visualforce page.com site for Salesforce Knowledge. 3. c. Set the Site Template field to knowledgeLayout. 5. Click Setup ➤ Develop ➤ Sites. 4. refer to the Salesforce Knowledge Implementation Guide. Enable the knowledge Apex classes: a. the template needs to include a body section (see the knowledgeLayout page for reference).Configuring your Force. and Unlimited Editions User Permissions Needed To edit a Force. 1. and click Edit. Note: If you specify your own custom site template. This ensures that the article type template (selected when setting up Salesforce Knowledge) displays properly in the public knowledge base. Click Save. Click Edit next to your Force.com site for Salesforce Knowledge. 4. For more information about article types. Selecting the Active Site Home Page The active site home page is the page that users land on when they visit your site. b. 1. Click the site label of your Force. The PKB package includes a default home page for Salesforce Knowledge. Click Edit at the top of the page. Click Save.com Site for Salesforce Knowledge Configuring your Force. Developer. Verify the View Articles permission is enabled: a. you need to configure your Force. If you cloned knowledgeHome and modified the cloned version. You also need to make sure users can view the articles associated with the category group displayed on your site.com site: “Customize Application” Once you configure the PKB Site Setup object. Configuring the Public Access Settings The PKB package includes new Apex classes and Visualforce pages that need to be enabled on your public knowledge base site using the public access settings. Click Public Access Settings. 2.
For example. Move the KnowledgeController class to the Enabled Apex Classes column. and click Edit. Click Setup ➤ Develop ➤ Sites and click Activate next to your site. Click Save. Make visible the root category that you specified when configuring the PKB Site Setup object. Select the category group to display in your public knowledge base: a. and click Edit next to the category group you specified when configuring the PKB Site Setup object. c. If you are not going to customize your public knowledge base. Scroll down to the Article Category Group Visibility Settings section. Click Save. If a child category was specified as the root category. 6. The public knowledge base does not support login and registration. Move all the knowledge* Visualforce pages to the Enabled Visualforce Pages column. select the All Categories option. Click Save. b. b. so the login.com site for Salesforce Knowledge. c. you can activate your site after you make the necessary customizations described in the next section. 8 . Enable the knowledge Visualforce pages: a. and password controllers should remain in the Available Apex Classes column.Configuring your Force. registration. if all categories were specified as the root category.com Site for Salesforce Knowledge b. c. Otherwise. Scroll down to the Enabled Visualforce Page Access section. click the Custom option and move the category you specified as the root category to the Selected Categories column. 8. activate your Force. 7.
Click Setup ➤ Develop ➤ Sites. c. Click the label of your Force. and enter the names of the newly cloned Visualforce pages in this new class: a. Do not modify the Visualforce pages or controller directly. and KnowledgeLayout) and Apex controller (KnowledgeController) that came with the public knowledge base package . In the Site Visualforce Pages section. 4. Enable your cloned Visualforce pages: a. Replace the name of the Visualforce pages (KnowledgeHome. Click Save when finished. and edit the KnowledgeController class. Click Setup ➤ Develop ➤ Pages. paste the contents into a new Apex class. KnowledgeSearch. However. 3. 7. Move your cloned Visualforce page to the Enabled column. KnowledgeProduct. Click Clone. and save your changes. Edit the cloned Visualforce page you created. Click Download. and click Activate next to your site.com site for Salesforce Knowledge. Click Setup ➤ Develop ➤ Sites. Create a new Apex class based on KnowledgeController. Click Setup ➤ Develop ➤ Apex Classes. c.com site for Salesforce Knowledge. e. Activate your Force. d. but must be different than other pages). you must have a migration strategy to re-implement your changes into the new pages and controller that come with the updated package. Test to make sure you have successfully overwritten the standard page. 9. From your Force. For information on modifying Visualforce pages. Copy the contents of the file. and then open the file in your choice of editor (such as Notepad or Eclipse). see the Visualforce Developer's Guide available in the Salesforce. we recommend you make copies of these pages and controller first and then modify the copies so your changes do not get overwritten when you install a new version of the package. or KnowledgeLayout) with the names of the newly cloned versions. 10 . 8. 6. 2. Click Save. and replace KnowledgeController with the name of the new Apex class. you can modify the Visualforce pages (KnowledgeHome.com site. b. Make the following changes: • • In the first line of the file. Select the name of the Visualforce page you want to modify. Make the necessary changes and give the page a unique label and name (the label and name can be the same. replace KnowledgeController with a unique name for this new class. click Edit. b. Note: When you install a new version of the PKB package. 5. specify the newly cloned page in the Active Site Home Page field. If you cloned and modified the KnowledgeHome page.Customizing the Public Knowledge Base Customizing the Visualforce Pages To customize your site beyond what is supported by the CSS.com online help. To copy and modify the Visualforce pages and controller: 1. KnowledgeSearch. KnowledgeProduct. 10. navigate to the new cloned page and make sure it appears instead of the standard page that you overwrote. d.
This action might not be possible to undo. Are you sure you want to continue?