Skip Navigation
Expand
Collapse
Submit a Service Request
Contact Information for Technical Support
My Service Notifications
KnowledgeSyndication Widget Configuration
Answer ID 12900   |   Last Review Date 09/19/2024

How do I configure the KnowledgeSyndication Widget?

Environment:
  Customer Portal, Syndicated Widget, Knowledge
 
Resolution:

Before you begin

     Your profile must have the CP Edit permission enabled and you must log in to the Customer Portal Administration site if you are not already logged in.
Procedure to add to a page:
 
  1. Enter https://your_site/ci/tags/syndicated_widgets/standard/KnowledgeSyndication to open the page for the KnowledgeSyndication widget.
  2. In the Configure Widget section, modify the widget attributes.
  3. To preview your changes, click Apply.
  4. Open the source code for the web page you want to add the widget to.
  5. On the widget page, click the top Select Text button to select the code in the first box and copy the code.
  6. Paste the code into your web page file just before the closing </body> tag.
    Even if you plan to use multiple syndicated widgets on the page, you need to paste this code only once.
  7. On the widget page, click the second Select Text button and copy the code that defines the widget.
  8. Paste the copied code just below the code you pasted in step 6.
  9. Add <div_id="myDiv"></div> to the page code where you want the widget to appear.
  10. Save the page.
To configure attributes of the KnowledgeSyndication Widget:
 
  1. To enable external document searching, select the check box for the ext_docs attribute.
  2. To open answers in an overlay instead of a separate window, select the check box for the display_answers_in_overlay attribute.
  3. To define products for a KnowledgeSyndication widget report, enter the product ID in the field for the p attribute.
  4. To define categories for a KnowledgeSyndication widget report, enter the category ID in the field for the c attribute.
  5. To retain the product and category search filters, select the check box for the persist_prodcat attribute.
  6. To use context-sensitive information to determine what answers should be returned, enter comma-separated HTML tags in the field for the context attribute.
  7. To define the number of characters that will be evaluated for each tag, enter the number in the field for the payload_size attribute.
  8. To hide answers until a search is performed, select the check box for the hide_initial_answers attribute.
  9. To set a keyword for a search query, enter the search word in the field for the q attribute.
    Note: If you’ve entered HTML tags in the context attribute, any values in the q attribute will be overridden.
  10. To disable spelling corrections and suggestions, clear the check box for the correction attribute.
  11. To disable answer descriptions in the search results, clear the check box for the description attribute.
  12. To disable the More Results link, clear the check box for the navigation attribute.
  13. To disable recommended documents, clear the check box for the recommended attribute.
  14. To disable suggested searches, clear the check box for the related attribute.
  15. To disable the keyword search box to prevent customers from entering search terms, clear the check box for the search_box attribute.
  16. To edit the default spelling suggestion label of “Did You Mean,” enter the new label in the field for the label_correction attribute.
  17. To edit the label for recommended documents, enter the new label in the field for the label_documents attribute.
  18. To edit the label for the More Results link, enter the new label in the field for the label_more_results attribute.
  19. To edit the No Results Found label, enter the new label in the field for the label_no_results attribute.
  20. To edit the related searches label, enter the new label in the field for the label_related_searches attribute.
  21. To edit the Search button label, enter the new label in the field for the label_search_button attribute.
  22. To edit the Created label, enter the new label in the field for the label_created attribute.
  23. To edit the Updated label, enter the new label in the field for the label_updated attribute.
  24. To change the target window that defines where linked documents and additional search results open, enter one of the following target values for the HTML anchor (<a>) tag in the field for the widget’s target attribute.

    • _blank—Opens the link in a new window.

    • _self—Opens the link in the current window.

    • _parent—Opens the link in the parent frameset.

    • _top—Opens the link in the full window.

  25. To edit the length of answer descriptions from the default of 100 characters, enter a numerical value in the field for the truncate_size attribute.  This attribute has a hard limit of 200 characters.
  26. To change the number of displayed answers from the default of ten, enter an integer in the field for the number_answers attribute.
  27. To edit the div element, enter a new name for the div element in the field for the div_id attribute.
  28. To edit the instance ID, replace the “0” in “skw_0” in the instance_id attribute with another value for each widget you add to the page.
  29. Click Apply.

Was this answer helpful?

Still have questions?

Notify Me
Forgot your username or password?
The page will refresh upon submission. Any pending input will be lost.