Knowledge Base Custom Attributes

Who can use this feature?

To configure custom Knowledge Base attributes:

  • Available in TDAdmin
  • Administrative Access:
    • Global Administrator with full TDAdmin access, OR
    • Client Portal Application Administrator for the specific Client Portal containing the Knowledge Base

To view custom Knowledge Base attributes:

  • Available in the Client Portal Knowledge Base
  • License Requirement: Client or above
  • Application Access: User must have access to the specific Client Portal application containing the Knowledge Base
  • Application-level Security Role: User's security role in the Client Portal must include the 'Access Knowledge Base Details and Feed' permission

Administrators can define custom attributes for Knowledge Base articles. Custom attributes enable you to capture additional information about Knowledge Base articles. These can be used to communicate information to other content managers on article pages or included in reports within the Work Management application.

In this article, we'll cover:

Viewing Custom Attributes on an Article

Custom article attributes display in the article's Details sidebar on the right side of the page.

Custom attributes in article Details pane

Creating and Managing Custom Article Attributes

To create a custom article attribute:

  1. In TDAdmin, navigate to Applications > [Client Portal Name] > Knowledge Base > Article Attributes. 
  2. At the top of the page, click + New to create a new attribute. 
  3. In the popup, enter an Attribute Name.
  4. Enter Header Text, which is how the attribute will appear on reports, and is typically a shortened version of the Attribute Name.
  5. Choose an Attribute Type from the dropdown menu.
  6. Optionally, set the Sort Order, which determines the order in which custom attributes appear on the Knowledge Base article.
  7. Optionally, enter a Description/Help for the attribute to explain its purpose and use.
  8. Use the checkboxes to set other parameters:
    1. Optionally, check the Required box to make the attribute required when creating a new Knowledge Base article.
    2. Check the Active box to make the attribute available for use.
    3. Optionally, check the Client Visible box to make the attribute visible to Client Portal users. Users must have the 'Access Knowledge Base Details and Feed' permission to see it on the article page.
  9. At the top of the page, click Save.
  10. After you save, the popup will refresh, and you may see a second tab with further configuration options for your selected attribute type. For example, if you select the multiselect, checkbox list, or another option that allows multiple choices, you can manage those options on the second tab. 

To modify a custom article attribute:

  1. In TDAdmin, navigate to Applications > [Client Portal Name] > Knowledge Base > Article Attributes.
  2. Click the Name of the attribute you would like to modify.
  3. Make any necessary changes.
  4. Click Save.

To delete a custom article attribute:

  1. In TDAdmin, navigate to Applications > [Client Portal Name] > Knowledge Base > Article Attributes.
  2. To the right of the article you would like to delete, click Delete.
  3. In the confirmation box, click OK.

Editing Custom Attributes on Articles

To edit custom article attributes:

  1. In the Client Portal, open the Knowledge Base and navigate to the desired article.
  2. Click Edit Article.
  3. Click the Settings tab.
  4. Custom attributes are the last options below all other settings. Make the needed changes, then click Save.

When creating a new article, custom attributes can be set at the bottom of the New Article page. 

100% helpful - 3 reviews
Print Article